],
"returns" : []
},
+ {
+ "name" : "from",
+ "type" : "function",
+ "desc" : "from",
+ "sig" : "(o)",
+ "static" : true,
+ "memberOf" : "",
+ "isStatic" : true,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "o",
+ "type" : "Array",
+ "desc" : "Or Array like object (eg. nodelist)",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
{
"name" : "indexOf",
"type" : "function",
],
"isAbstract" : false,
"isBuilderTop" : false,
- "childClasses" : { },
+ "implementations" : [],
"tree_children" : [],
"tree_parent" : []
},
"name" : "getElapsed",
"type" : "function",
"desc" : "Returns the number of milliseconds between this date and date",
- "sig" : "(date)",
+ "sig" : "(date, interval)",
"static" : false,
"memberOf" : "",
"isStatic" : false,
"type" : "Date",
"desc" : "(optional) Defaults to now",
"isOptional" : false
+ },
+ {
+ "name" : "interval",
+ "type" : "String",
+ "desc" : "(optional) Default Date.MILLI, A valid date interval enum value (eg. Date.DAY)",
+ "isOptional" : false
}
],
"returns" : [
{
"name" : "",
"type" : "Number",
- "desc" : "The diff in milliseconds"
+ "desc" : "The diff in milliseconds or units of interval"
}
]
},
],
"isAbstract" : false,
"isBuilderTop" : false,
- "childClasses" : { },
+ "implementations" : [],
"tree_children" : [],
"tree_parent" : []
},
],
"isAbstract" : false,
"isBuilderTop" : false,
- "childClasses" : { },
+ "implementations" : [],
"tree_children" : [],
"tree_parent" : []
},
],
"isAbstract" : false,
"isBuilderTop" : false,
- "childClasses" : { },
+ "implementations" : [],
"tree_children" : [],
"tree_parent" : []
},
"Roo" : {
- "props" : [],
+ "props" : [
+ {
+ "name" : "grid",
+ "type" : "Roo.grid.Grid",
+ "desc" : "The grid for this panel",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "layout",
+ "type" : "Roo.BorderLayout",
+ "desc" : "The layout for this panel",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ }
+ ],
"events" : [],
"methods" : [
{
}
]
},
+ {
+ "name" : "log",
+ "type" : "function",
+ "desc" : "Logs to console if it can.",
+ "sig" : "(string)",
+ "static" : true,
+ "memberOf" : "",
+ "isStatic" : true,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "string",
+ "type" : "String|Object",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "namespace",
+ "type" : "function",
+ "desc" : "Creates namespaces to be used for scoping variables and classes so that they are not global. Usage:\n<pre><code>\nRoo.namespace('Company', 'Company.data');\nCompany.Widget = function() { ... }\nCompany.data.CustomStore = function(config) { ... }\n</code></pre>",
+ "sig" : "(namespace1, namespace2, etc)",
+ "static" : true,
+ "memberOf" : "",
+ "isStatic" : true,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "namespace1",
+ "type" : "String",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "namespace2",
+ "type" : "String",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "etc",
+ "type" : "String",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
{
"name" : "onReady",
"type" : "function",
],
"isAbstract" : false,
"isBuilderTop" : false,
- "childClasses" : { },
+ "implementations" : [],
"tree_children" : [],
"tree_parent" : []
},
{
"name" : "autoAbort",
"type" : "Boolean",
- "desc" : "(Optional) Whether a new request should abort any pending requests. (defaults to false)",
- "memberOf" : ""
+ "desc" : "Whether a new request should abort any pending requests. (defaults to false)",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "defaultHeaders",
"type" : "Object",
"desc" : "An object containing request headers which are added to each request made by this object. (defaults to undefined)",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "disableCaching",
"type" : "Boolean",
- "desc" : "(Optional) True to add a unique cache-buster param to GET requests. (defaults to true)",
- "memberOf" : ""
+ "desc" : "True to add a unique cache-buster param to GET requests. (defaults to true)",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "extraParams",
"type" : "Object",
"desc" : "An object containing properties which are used as extra parameters to each request made by this object. (defaults to undefined)",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"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"
+ "memberOf" : "Roo.util.Observable",
+ "isOptional" : false,
+ "optvals" : []
},
{
"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" : ""
+ "desc" : "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" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "timeout",
"type" : "Number",
- "desc" : "(Optional) The timeout in milliseconds to be used for requests. (defaults to 30000)",
- "memberOf" : ""
+ "desc" : "The timeout in milliseconds to be used for requests. (defaults to 30000)",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "url",
"type" : "String",
"desc" : "The default URL to be used for requests to the server. (defaults to undefined)",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
}
],
"events" : [
{
"name" : "transactionId",
"type" : "Number",
- "desc" : "(Optional) defaults to the last transaction",
+ "desc" : "defaults to the last transaction",
"isOptional" : false
}
],
{
"name" : "transactionId",
"type" : "Number",
- "desc" : "(Optional) defaults to the last transaction",
+ "desc" : "defaults to the last transaction",
"isOptional" : false
}
],
{
"name" : "options",
"type" : "Object",
- "desc" : "An object which may contain the following properties:<ul>\n<li><b>url</b> {String} (Optional) The URL to which to send the request. Defaults to configured URL</li>\n<li><b>params</b> {Object/String/Function} (Optional) An object containing properties which are used as parameters to the\nrequest, a url encoded string or a function to call to get either.</li>\n<li><b>method</b> {String} (Optional) The HTTP method to use for the request. Defaults to the configured method, or\nif no method was configured, \"GET\" if no parameters are being sent, and \"POST\" if parameters are being sent.</li>\n<li><b>callback</b> {Function} (Optional) The function to be called upon receipt of the HTTP response.\nThe callback is called regardless of success or failure and is passed the following parameters:<ul>\n<li>options {Object} The parameter to the request call.</li>\n<li>success {Boolean} True if the request succeeded.</li>\n<li>response {Object} The XMLHttpRequest object containing the response data.</li>\n</ul></li>\n<li><b>success</b> {Function} (Optional) The function to be called upon success of the request.\nThe callback is passed the following parameters:<ul>\n<li>response {Object} The XMLHttpRequest object containing the response data.</li>\n<li>options {Object} The parameter to the request call.</li>\n</ul></li>\n<li><b>failure</b> {Function} (Optional) The function to be called upon failure of the request.\nThe callback is passed the following parameters:<ul>\n<li>response {Object} The XMLHttpRequest object containing the response data.</li>\n<li>options {Object} The parameter to the request call.</li>\n</ul></li>\n<li><b>scope</b> {Object} (Optional) The scope in which to execute the callbacks: The \"this\" object\nfor the callback function. Defaults to the browser window.</li>\n<li><b>form</b> {Object/String} (Optional) A form object or id to pull parameters from.</li>\n<li><b>isUpload</b> {Boolean} (Optional) True if the form object is a file upload (will usually be automatically detected).</li>\n<li><b>headers</b> {Object} (Optional) Request headers to set for the request.</li>\n<li><b>xmlData</b> {Object} (Optional) XML document to use for the post. Note: This will be used instead of\nparams for the post data. Any params will be appended to the URL.</li>\n<li><b>disableCaching</b> {Boolean} (Optional) True to add a unique cache-buster param to GET requests.</li>\n</ul>",
+ "desc" : "An object which may contain the following properties:<ul>\n<li><b>url</b> {String} The URL to which to send the request. Defaults to configured URL</li>\n<li><b>params</b> {Object/String/Function} An object containing properties which are used as parameters to the\nrequest, a url encoded string or a function to call to get either.</li>\n<li><b>method</b> {String} The HTTP method to use for the request. Defaults to the configured method, or\nif no method was configured, \"GET\" if no parameters are being sent, and \"POST\" if parameters are being sent.</li>\n<li><b>callback</b> {Function} The function to be called upon receipt of the HTTP response.\nThe callback is called regardless of success or failure and is passed the following parameters:<ul>\n<li>options {Object} The parameter to the request call.</li>\n<li>success {Boolean} True if the request succeeded.</li>\n<li>response {Object} The XMLHttpRequest object containing the response data.</li>\n</ul></li>\n<li><b>success</b> {Function} The function to be called upon success of the request.\nThe callback is passed the following parameters:<ul>\n<li>response {Object} The XMLHttpRequest object containing the response data.</li>\n<li>options {Object} The parameter to the request call.</li>\n</ul></li>\n<li><b>failure</b> {Function} The function to be called upon failure of the request.\nThe callback is passed the following parameters:<ul>\n<li>response {Object} The XMLHttpRequest object containing the response data.</li>\n<li>options {Object} The parameter to the request call.</li>\n</ul></li>\n<li><b>scope</b> {Object} The scope in which to execute the callbacks: The \"this\" object\nfor the callback function. Defaults to the browser window.</li>\n<li><b>form</b> {Object/String} A form object or id to pull parameters from.</li>\n<li><b>isUpload</b> {Boolean} True if the form object is a file upload (will usually be automatically detected).</li>\n<li><b>headers</b> {Object} Request headers to set for the request.</li>\n<li><b>xmlData</b> {Object} XML document to use for the post. Note: This will be used instead of\nparams for the post data. Any params will be appended to the URL.</li>\n<li><b>disableCaching</b> {Boolean} True to add a unique cache-buster param to GET requests.</li>\n</ul>",
"isOptional" : false
}
],
],
"isAbstract" : false,
"isBuilderTop" : false,
- "childClasses" : { },
+ "implementations" : [],
"tree_children" : [],
"tree_parent" : []
},
"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" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "autoCreate",
"type" : "Boolean/DomHelper",
"desc" : "True to auto create from scratch, or using a DomHelper Object (defaults to false)",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "autoScroll",
"type" : "Boolean",
"desc" : "True to allow the dialog body contents to overflow and display scrollbars (defaults to false)",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "autoTabs",
"type" : "Boolean",
"desc" : "If true, all elements with class 'x-dlg-tab' will get automatically converted to tabs (defaults to false)",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "buttonAlign",
"type" : "String",
"desc" : "Valid values are \"left,\" \"center\" and \"right\" (defaults to \"right\")",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "buttons",
"type" : "Array",
"desc" : "Array of buttons",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "closable",
"type" : "Boolean",
"desc" : "False to remove the built-in top-right corner close button (defaults to true)",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "collapsible",
"type" : "Boolean",
"desc" : "False to remove the built-in top-right corner collapse button (defaults to true)",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "constraintoviewport",
"type" : "Boolean",
"desc" : "True to keep the dialog constrained within the visible viewport boundaries (defaults to true)",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "draggable",
"type" : "Boolean",
"desc" : "False to disable dragging of the dialog within the viewport (defaults to true)",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "fixedcenter",
"type" : "Boolean",
"desc" : "True to ensure that anytime the dialog is shown or resized it gets centered (defaults to false)",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "height",
"type" : "Number",
"desc" : "Height of the dialog in pixels (can also be set via CSS). Determined by browser if unspecified.",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"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"
+ "memberOf" : "Roo.util.Observable",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "minButtonWidth",
"type" : "Number",
"desc" : "Minimum width of all dialog buttons (defaults to 75)",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "minHeight",
"type" : "Number",
"desc" : "The minimum allowable height for a resizable dialog (defaults to 80)",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "minWidth",
"type" : "Number",
"desc" : "The minimum allowable width for a resizable dialog (defaults to 200)",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "modal",
"type" : "Boolean",
"desc" : "True to show the dialog modally, preventing user interaction with the rest of the page (defaults to false)",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"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" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "resizable",
"type" : "Boolean",
"desc" : "False to disable manual dialog resizing (defaults to true)",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"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" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "shadow",
"type" : "Boolean/String",
"desc" : "True or \"sides\" for the default effect, \"frame\" for 4-way shadow, and \"drop\" for bottom-right\nshadow (defaults to false)",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "shadowOffset",
"type" : "Number",
"desc" : "The number of pixels to offset the shadow if displayed (defaults to 5)",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "shim",
"type" : "Boolean",
"desc" : "True to create an iframe shim that prevents selects from showing through (defaults to false)",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "syncHeightBeforeShow",
"type" : "Boolean",
"desc" : "True to cause the dimensions to be recalculated before the dialog is shown (defaults to false)",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "tabTag",
"type" : "String",
"desc" : "The tag name of tab elements, used when autoTabs = true (defaults to 'div')",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "title",
"type" : "String",
"desc" : "Default text to display in the title bar (defaults to null)",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "width",
"type" : "Number",
"desc" : "Width of the dialog in pixels (can also be set via CSS). Determined by browser if unspecified.",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "x",
"type" : "Number",
"desc" : "The default left page coordinate of the dialog (defaults to center screen)",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "y",
"type" : "Number",
"desc" : "The default top page coordinate of the dialog (defaults to center screen)",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
}
],
"events" : [
],
"isAbstract" : false,
"isBuilderTop" : false,
- "childClasses" : {
- "Roo.BasicDialog" : [
- "Roo.LayoutDialog"
- ]
- },
+ "implementations" : [
+ "Roo.LayoutDialog"
+ ],
"tree_children" : [],
- "tree_parent" : []
+ "tree_parent" : [
+ "none",
+ "builder"
+ ]
},
"Roo.BasicLayoutRegion" : {
"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"
+ "memberOf" : "Roo.util.Observable",
+ "isOptional" : false,
+ "optvals" : []
}
],
"events" : [
],
"isAbstract" : false,
"isBuilderTop" : false,
- "childClasses" : {
- "Roo.LayoutRegion" : [
- "Roo.SplitLayoutRegion",
- "Roo.bootstrap.layout.Split"
- ],
- "Roo.BasicLayoutRegion" : [
- "Roo.LayoutRegion"
- ]
- },
+ "implementations" : [
+ "Roo.LayoutRegion",
+ "Roo.SplitLayoutRegion",
+ "Roo.bootstrap.layout.Split"
+ ],
"tree_children" : [],
"tree_parent" : []
},
"name" : "center",
"type" : "Roo.LayoutRegion",
"desc" : "",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "east",
"type" : "Roo.LayoutRegion",
"desc" : "",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"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"
+ "memberOf" : "Roo.util.Observable",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "north",
"type" : "Roo.LayoutRegion",
"desc" : "",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "south",
"type" : "Roo.LayoutRegion",
"desc" : "",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "west",
"type" : "Roo.LayoutRegion",
"desc" : "",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
}
],
"events" : [
],
"isAbstract" : false,
"isBuilderTop" : false,
- "childClasses" : {
- "Roo.BorderLayout" : [
- "Roo.ReaderLayout"
- ]
- },
+ "implementations" : [
+ "Roo.ReaderLayout"
+ ],
"tree_children" : [
"Roo.ContentPanel",
"Roo.GridPanel",
"name" : "actionMode",
"type" : "String",
"desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el' for forms you probably want to set this to fieldEl",
- "memberOf" : "Roo.Component"
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "allowDomMove",
"type" : "Boolean",
"desc" : "Whether the component can move the Dom node when rendering (defaults to true).",
- "memberOf" : "Roo.Component"
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "disableClass",
"type" : "String",
"desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").",
- "memberOf" : "Roo.Component"
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "height",
"type" : "Number",
"desc" : "height (optional) size of component",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "hideMode",
"type" : "String",
- "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".",
- "memberOf" : "Roo.Component"
+ "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display",
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : [
+ "display",
+ "visibility"
+ ]
},
{
"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"
+ "memberOf" : "Roo.util.Observable",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "style",
+ "type" : "String",
+ "desc" : "css styles to add to component\neg. text-align:right;",
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "width",
"type" : "Number",
"desc" : "width (optional) size of component",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
}
],
"events" : [
],
"isAbstract" : false,
"isBuilderTop" : false,
- "childClasses" : {
- "Roo.form.Field" : [
- "Roo.form.Checkbox",
- "Roo.form.DayPicker",
- "Roo.form.DisplayField",
- "Roo.form.GridField",
- "Roo.form.HtmlEditor",
- "Roo.form.Signature",
- "Roo.form.TextField"
- ],
- "Roo.form.TextArea" : [
- "Roo.form.FCKeditor"
- ],
- "Roo.BoxComponent" : [
- "Roo.form.ComboBoxArray.Item",
- "Roo.form.Field",
- "Roo.form.TextItem"
- ],
- "Roo.form.Checkbox" : [
- "Roo.form.Radio"
- ],
- "Roo.form.TextField" : [
- "Roo.form.ComboBoxArray",
- "Roo.form.Hidden",
- "Roo.form.NumberField",
- "Roo.form.TextArea",
- "Roo.form.TriggerField"
- ],
- "Roo.form.TriggerField" : [
- "Roo.form.ComboBox",
- "Roo.form.DateField",
- "Roo.form.MonthField",
- "Roo.form.Select"
- ],
- "Roo.form.ComboBox" : [
- "Roo.form.ComboCheck",
- "Roo.form.ComboNested"
- ]
- },
+ "implementations" : [
+ "Roo.dialog.UploadCropbox",
+ "Roo.form.Checkbox",
+ "Roo.form.ComboBox",
+ "Roo.form.ComboBoxArray",
+ "Roo.form.ComboBoxArray.Item",
+ "Roo.form.ComboCheck",
+ "Roo.form.ComboNested",
+ "Roo.form.DateField",
+ "Roo.form.DayPicker",
+ "Roo.form.DisplayField",
+ "Roo.form.FCKeditor",
+ "Roo.form.Field",
+ "Roo.form.GridField",
+ "Roo.form.Hidden",
+ "Roo.form.HtmlEditor",
+ "Roo.form.MonthField",
+ "Roo.form.NumberField",
+ "Roo.form.Radio",
+ "Roo.form.Select",
+ "Roo.form.Signature",
+ "Roo.form.TextArea",
+ "Roo.form.TextField",
+ "Roo.form.TextItem",
+ "Roo.form.TriggerField"
+ ],
"tree_children" : [],
"tree_parent" : []
},
"name" : "clickEvent",
"type" : "String",
"desc" : "The type of event to map to the button's event handler (defaults to 'click')",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "cls",
"type" : "String",
"desc" : "A CSS class to apply to the button's main element.",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "disabled",
"type" : "Boolean",
"desc" : "True to start disabled (defaults to false)",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "enableToggle",
"type" : "Boolean",
"desc" : "True to enable pressed/not pressed toggling (defaults to false)",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "handleMouseEvents",
"type" : "Boolean",
"desc" : "False to disable visual cues on mouseover, mouseout and mousedown (defaults to true)",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "handler",
"type" : "Function",
"desc" : "A function called when the button is clicked (can be used instead of click event)",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "hidden",
"type" : "Boolean",
"desc" : "True to start hidden (defaults to false)",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"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" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"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" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"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"
+ "memberOf" : "Roo.util.Observable",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "menu",
"type" : "Roo.menu.Menu",
"desc" : "Standard menu attribute consisting of a reference to a menu object, a menu id or a menu config blob (defaults to undefined).",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"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" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "minWidth",
"type" : "Number",
"desc" : "The minimum width for this button (used to give a set of buttons a common width)",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "pressed",
"type" : "Boolean",
"desc" : "True to start pressed (only if enableToggle = true)",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "renderTo",
"type" : "String/HTMLElement/Element",
"desc" : "The element to append the button to",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"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" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "scope",
"type" : "Object",
"desc" : "The scope of the handler",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "tabIndex",
"type" : "Number",
"desc" : "The DOM tabIndex for this button (defaults to undefined)",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"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" : ""
+ "desc" : "An {@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" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "text",
"type" : "String",
"desc" : "The button text",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "toggleGroup",
"type" : "String",
"desc" : "The group this toggle button is a member of (only 1 per group can be pressed, only\n applies if enableToggle = true)",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "tooltip",
"type" : "String/Object",
"desc" : "The tooltip for the button - can be a string or QuickTips config object",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "tooltipType",
"type" : "String",
"desc" : "The type of tooltip to use. Either \"qtip\" (default) for QuickTips or \"title\" for title attribute.",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "type",
"type" : "String",
"desc" : "The button's type, corresponding to the DOM input element type attribute. Either \"submit,\" \"reset\" or \"button\" (default).",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
}
],
"events" : [
],
"returns" : []
},
+ {
+ "name" : "setPressed",
+ "type" : "function",
+ "desc" : "Similar to toggle, but does not trigger event.",
+ "sig" : "(state)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "state",
+ "type" : "Boolean",
+ "desc" : "[required] Force a particular state",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
{
"name" : "setText",
"type" : "function",
],
"isAbstract" : false,
"isBuilderTop" : false,
- "childClasses" : {
- "Roo.Button" : [
- "Roo.SplitButton",
- "Roo.Toolbar.Button"
- ],
- "Roo.SplitButton" : [
- "Roo.Toolbar.SplitButton"
- ]
- },
+ "implementations" : [
+ "Roo.SplitButton",
+ "Roo.Toolbar.Button",
+ "Roo.Toolbar.SplitButton"
+ ],
"tree_children" : [],
"tree_parent" : []
},
"name" : "actionMode",
"type" : "String",
"desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el' for forms you probably want to set this to fieldEl",
- "memberOf" : "Roo.Component"
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "allowDomMove",
"type" : "Boolean",
"desc" : "Whether the component can move the Dom node when rendering (defaults to true).",
- "memberOf" : "Roo.Component"
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "disableClass",
"type" : "String",
"desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").",
- "memberOf" : "Roo.Component"
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "hideMode",
"type" : "String",
- "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".",
- "memberOf" : "Roo.Component"
+ "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display",
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : [
+ "display",
+ "visibility"
+ ]
},
{
"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"
+ "memberOf" : "Roo.util.Observable",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "style",
+ "type" : "String",
+ "desc" : "css styles to add to component\neg. text-align:right;",
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
}
],
"events" : [
],
"isAbstract" : false,
"isBuilderTop" : false,
- "childClasses" : { },
+ "implementations" : [],
"tree_children" : [],
"tree_parent" : []
},
"name" : "actionMode",
"type" : "String",
"desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el' for forms you probably want to set this to fieldEl",
- "memberOf" : "Roo.Component"
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "allowDomMove",
"type" : "Boolean",
"desc" : "Whether the component can move the Dom node when rendering (defaults to true).",
- "memberOf" : "Roo.Component"
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "allowReselect",
"type" : "Boolean",
"desc" : "If set to true then reselecting a color that is already selected fires the selection event",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "disableClass",
"type" : "String",
"desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").",
- "memberOf" : "Roo.Component"
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "hideMode",
"type" : "String",
- "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".",
- "memberOf" : "Roo.Component"
+ "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display",
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : [
+ "display",
+ "visibility"
+ ]
},
{
"name" : "itemCls",
"type" : "String",
"desc" : "The CSS class to apply to the containing element (defaults to \"x-color-palette\")",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"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"
+ "memberOf" : "Roo.util.Observable",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "style",
+ "type" : "String",
+ "desc" : "css styles to add to component\neg. text-align:right;",
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "value",
"type" : "String",
"desc" : "The initial color to highlight (should be a valid 6-digit color hex code without the # symbol). Note that\nthe hex codes are case-sensitive.",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
}
],
"events" : [
],
"isAbstract" : false,
"isBuilderTop" : false,
- "childClasses" : { },
+ "implementations" : [],
"tree_children" : [],
"tree_parent" : []
},
"name" : "actionMode",
"type" : "String",
"desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el' for forms you probably want to set this to fieldEl",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "allowDomMove",
"type" : "Boolean",
"desc" : "Whether the component can move the Dom node when rendering (defaults to true).",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "disableClass",
"type" : "String",
"desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "hideMode",
"type" : "String",
- "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".",
- "memberOf" : ""
+ "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : [
+ "display",
+ "visibility"
+ ]
},
{
"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"
+ "memberOf" : "Roo.util.Observable",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "style",
+ "type" : "String",
+ "desc" : "css styles to add to component\neg. text-align:right;",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
}
],
"events" : [
],
"isAbstract" : false,
"isBuilderTop" : false,
- "childClasses" : {
- "Roo.bootstrap.nav.Bar" : [
- "Roo.bootstrap.nav.Sidebar",
- "Roo.bootstrap.nav.Simplebar"
- ],
- "Roo.form.Field" : [
- "Roo.form.Checkbox",
- "Roo.form.DayPicker",
- "Roo.form.DisplayField",
- "Roo.form.GridField",
- "Roo.form.HtmlEditor",
- "Roo.form.Signature",
- "Roo.form.TextField"
- ],
- "Roo.bootstrap.nav.Simplebar" : [
- "Roo.bootstrap.PagingToolbar",
- "Roo.bootstrap.PopoverNav",
- "Roo.bootstrap.form.HtmlEditorToolbarStandard",
- "Roo.bootstrap.nav.Headerbar"
- ],
- "Roo.bootstrap.Button" : [
- "Roo.bootstrap.ButtonUploader",
- "Roo.bootstrap.form.CardUploader"
- ],
- "Roo.bootstrap.Column" : [
- "Roo.bootstrap.TabGroup"
- ],
- "Roo.bootstrap.form.TriggerField" : [
- "Roo.bootstrap.form.ComboBox",
- "Roo.bootstrap.form.PhoneInput"
- ],
- "Roo.bootstrap.form.TextArea" : [
- "Roo.bootstrap.form.HtmlEditor",
- "Roo.bootstrap.form.Markdown"
- ],
- "Roo.form.TextArea" : [
- "Roo.form.FCKeditor"
- ],
- "Roo.Component" : [
- "Roo.BoxComponent",
- "Roo.CalendarPanel",
- "Roo.ColorPalette",
- "Roo.DatePicker",
- "Roo.Editor",
- "Roo.HtmlEditorCore",
- "Roo.bootstrap.Component",
- "Roo.form.Layout",
- "Roo.menu.BaseItem"
- ],
- "Roo.bootstrap.layout.Manager" : [
- "Roo.bootstrap.layout.Border"
- ],
- "Roo.BoxComponent" : [
- "Roo.form.ComboBoxArray.Item",
- "Roo.form.Field",
- "Roo.form.TextItem"
- ],
- "Roo.bootstrap.Element" : [
- "Roo.bootstrap.CardFooter",
- "Roo.bootstrap.CardHeader",
- "Roo.bootstrap.CardImageTop",
- "Roo.bootstrap.DropTarget"
- ],
- "Roo.form.Checkbox" : [
- "Roo.form.Radio"
- ],
- "Roo.Editor" : [
- "Roo.grid.GridEditor",
- "Roo.tree.TreeEditor"
- ],
- "Roo.menu.BaseItem" : [
- "Roo.menu.Adapter",
- "Roo.menu.Item",
- "Roo.menu.Separator",
- "Roo.menu.TextItem"
- ],
- "Roo.bootstrap.nav.Item" : [
- "Roo.bootstrap.nav.SidebarItem"
- ],
- "Roo.form.TextField" : [
- "Roo.form.ComboBoxArray",
- "Roo.form.Hidden",
- "Roo.form.NumberField",
- "Roo.form.TextArea",
- "Roo.form.TriggerField"
- ],
- "Roo.form.Layout" : [
- "Roo.form.Column",
- "Roo.form.FieldSet",
- "Roo.form.Row"
- ],
- "Roo.menu.Item" : [
- "Roo.menu.CheckItem"
- ],
- "Roo.menu.Adapter" : [
- "Roo.menu.ColorItem",
- "Roo.menu.DateItem"
- ],
- "Roo.bootstrap.Component" : [
- "Roo.bootstrap.Alert",
- "Roo.bootstrap.BezierSignature",
- "Roo.bootstrap.Body",
- "Roo.bootstrap.Brick",
- "Roo.bootstrap.Button",
- "Roo.bootstrap.ButtonGroup",
- "Roo.bootstrap.Calendar",
- "Roo.bootstrap.Card",
- "Roo.bootstrap.Column",
- "Roo.bootstrap.Container",
- "Roo.bootstrap.DocumentManager",
- "Roo.bootstrap.DocumentSlider",
- "Roo.bootstrap.DocumentViewer",
- "Roo.bootstrap.Element",
- "Roo.bootstrap.Graph",
- "Roo.bootstrap.Header",
- "Roo.bootstrap.Img",
- "Roo.bootstrap.LayoutMasonry",
- "Roo.bootstrap.LayoutMasonryAuto",
- "Roo.bootstrap.Link",
- "Roo.bootstrap.LocationPicker",
- "Roo.bootstrap.MasonryBrick",
- "Roo.bootstrap.MessageBar",
- "Roo.bootstrap.Modal",
- "Roo.bootstrap.Pagination",
- "Roo.bootstrap.PaginationItem",
- "Roo.bootstrap.Popover",
- "Roo.bootstrap.Progress",
- "Roo.bootstrap.ProgressBar",
- "Roo.bootstrap.Row",
- "Roo.bootstrap.Slider",
- "Roo.bootstrap.TabPanel",
- "Roo.bootstrap.Table",
- "Roo.bootstrap.TableBody",
- "Roo.bootstrap.TableCell",
- "Roo.bootstrap.TableRow",
- "Roo.bootstrap.UploadCropbox",
- "Roo.bootstrap.breadcrumb.Item",
- "Roo.bootstrap.breadcrumb.Nav",
- "Roo.bootstrap.dash.NumberBox",
- "Roo.bootstrap.dash.TabBox",
- "Roo.bootstrap.dash.TabPane",
- "Roo.bootstrap.form.DateSplitField",
- "Roo.bootstrap.form.FieldLabel",
- "Roo.bootstrap.form.Form",
- "Roo.bootstrap.form.Input",
- "Roo.bootstrap.form.Radio",
- "Roo.bootstrap.layout.Manager",
- "Roo.bootstrap.menu.Item",
- "Roo.bootstrap.menu.Menu",
- "Roo.bootstrap.menu.Separator",
- "Roo.bootstrap.nav.Bar",
- "Roo.bootstrap.nav.Group",
- "Roo.bootstrap.nav.Item",
- "Roo.bootstrap.nav.ProgressBar",
- "Roo.bootstrap.nav.ProgressBarItem"
- ],
- "Roo.bootstrap.form.ComboBox" : [
- "Roo.bootstrap.form.MoneyField"
- ],
- "Roo.form.TriggerField" : [
- "Roo.form.ComboBox",
- "Roo.form.DateField",
- "Roo.form.MonthField",
- "Roo.form.Select"
- ],
- "Roo.form.ComboBox" : [
- "Roo.form.ComboCheck",
- "Roo.form.ComboNested"
- ],
- "Roo.bootstrap.form.Input" : [
- "Roo.bootstrap.form.CheckBox",
- "Roo.bootstrap.form.DateField",
- "Roo.bootstrap.form.MonthField",
- "Roo.bootstrap.form.NumberField",
- "Roo.bootstrap.form.RadioSet",
- "Roo.bootstrap.form.SecurePass",
- "Roo.bootstrap.form.TextArea",
- "Roo.bootstrap.form.TimeField",
- "Roo.bootstrap.form.TriggerField"
- ]
- },
+ "implementations" : [
+ "Roo.BoxComponent",
+ "Roo.CalendarPanel",
+ "Roo.ColorPalette",
+ "Roo.DatePicker",
+ "Roo.Editor",
+ "Roo.HtmlEditorCore",
+ "Roo.bootstrap.Alert",
+ "Roo.bootstrap.BezierSignature",
+ "Roo.bootstrap.Body",
+ "Roo.bootstrap.Brick",
+ "Roo.bootstrap.Button",
+ "Roo.bootstrap.ButtonGroup",
+ "Roo.bootstrap.ButtonUploader",
+ "Roo.bootstrap.Calendar",
+ "Roo.bootstrap.Card",
+ "Roo.bootstrap.CardFooter",
+ "Roo.bootstrap.CardHeader",
+ "Roo.bootstrap.CardImageTop",
+ "Roo.bootstrap.Column",
+ "Roo.bootstrap.Component",
+ "Roo.bootstrap.Container",
+ "Roo.bootstrap.DocumentManager",
+ "Roo.bootstrap.DocumentSlider",
+ "Roo.bootstrap.DocumentViewer",
+ "Roo.bootstrap.DropTarget",
+ "Roo.bootstrap.Element",
+ "Roo.bootstrap.Graph",
+ "Roo.bootstrap.Header",
+ "Roo.bootstrap.Img",
+ "Roo.bootstrap.LayoutMasonry",
+ "Roo.bootstrap.LayoutMasonryAuto",
+ "Roo.bootstrap.Link",
+ "Roo.bootstrap.LocationPicker",
+ "Roo.bootstrap.MasonryBrick",
+ "Roo.bootstrap.MessageBar",
+ "Roo.bootstrap.Modal",
+ "Roo.bootstrap.Pagination",
+ "Roo.bootstrap.PaginationItem",
+ "Roo.bootstrap.PagingToolbar",
+ "Roo.bootstrap.Popover",
+ "Roo.bootstrap.PopoverNav",
+ "Roo.bootstrap.Progress",
+ "Roo.bootstrap.ProgressBar",
+ "Roo.bootstrap.Row",
+ "Roo.bootstrap.Slider",
+ "Roo.bootstrap.TabGroup",
+ "Roo.bootstrap.TabPanel",
+ "Roo.bootstrap.Table",
+ "Roo.bootstrap.TableBody",
+ "Roo.bootstrap.TableCell",
+ "Roo.bootstrap.TableRow",
+ "Roo.bootstrap.UploadCropbox",
+ "Roo.bootstrap.breadcrumb.Item",
+ "Roo.bootstrap.breadcrumb.Nav",
+ "Roo.bootstrap.dash.NumberBox",
+ "Roo.bootstrap.dash.TabBox",
+ "Roo.bootstrap.dash.TabPane",
+ "Roo.bootstrap.form.CardUploader",
+ "Roo.bootstrap.form.CheckBox",
+ "Roo.bootstrap.form.ComboBox",
+ "Roo.bootstrap.form.DateField",
+ "Roo.bootstrap.form.DateSplitField",
+ "Roo.bootstrap.form.FieldLabel",
+ "Roo.bootstrap.form.Form",
+ "Roo.bootstrap.form.HtmlEditor",
+ "Roo.bootstrap.form.HtmlEditorToolbarStandard",
+ "Roo.bootstrap.form.Input",
+ "Roo.bootstrap.form.Markdown",
+ "Roo.bootstrap.form.MoneyField",
+ "Roo.bootstrap.form.MonthField",
+ "Roo.bootstrap.form.NumberField",
+ "Roo.bootstrap.form.PhoneInput",
+ "Roo.bootstrap.form.Radio",
+ "Roo.bootstrap.form.RadioSet",
+ "Roo.bootstrap.form.SecurePass",
+ "Roo.bootstrap.form.TextArea",
+ "Roo.bootstrap.form.TimeField",
+ "Roo.bootstrap.form.TriggerField",
+ "Roo.bootstrap.layout.Border",
+ "Roo.bootstrap.layout.Manager",
+ "Roo.bootstrap.menu.Item",
+ "Roo.bootstrap.menu.Menu",
+ "Roo.bootstrap.menu.Separator",
+ "Roo.bootstrap.nav.Bar",
+ "Roo.bootstrap.nav.Group",
+ "Roo.bootstrap.nav.Headerbar",
+ "Roo.bootstrap.nav.Item",
+ "Roo.bootstrap.nav.ProgressBar",
+ "Roo.bootstrap.nav.ProgressBarItem",
+ "Roo.bootstrap.nav.Sidebar",
+ "Roo.bootstrap.nav.SidebarItem",
+ "Roo.bootstrap.nav.Simplebar",
+ "Roo.dialog.UploadCropbox",
+ "Roo.form.Checkbox",
+ "Roo.form.Column",
+ "Roo.form.ComboBox",
+ "Roo.form.ComboBoxArray",
+ "Roo.form.ComboBoxArray.Item",
+ "Roo.form.ComboCheck",
+ "Roo.form.ComboNested",
+ "Roo.form.DateField",
+ "Roo.form.DayPicker",
+ "Roo.form.DisplayField",
+ "Roo.form.FCKeditor",
+ "Roo.form.Field",
+ "Roo.form.FieldSet",
+ "Roo.form.GridField",
+ "Roo.form.Hidden",
+ "Roo.form.HtmlEditor",
+ "Roo.form.Layout",
+ "Roo.form.MonthField",
+ "Roo.form.NumberField",
+ "Roo.form.Radio",
+ "Roo.form.Row",
+ "Roo.form.Select",
+ "Roo.form.Signature",
+ "Roo.form.TextArea",
+ "Roo.form.TextField",
+ "Roo.form.TextItem",
+ "Roo.form.TriggerField",
+ "Roo.grid.GridEditor",
+ "Roo.menu.Adapter",
+ "Roo.menu.BaseItem",
+ "Roo.menu.CheckItem",
+ "Roo.menu.ColorItem",
+ "Roo.menu.DateItem",
+ "Roo.menu.Item",
+ "Roo.menu.Separator",
+ "Roo.menu.TextItem",
+ "Roo.tree.TreeEditor"
+ ],
"tree_children" : [],
"tree_parent" : []
},
],
"isAbstract" : false,
"isBuilderTop" : false,
- "childClasses" : { },
+ "implementations" : [],
"tree_children" : [],
"tree_parent" : []
},
{
"name" : "domReplace",
"type" : "Boolean",
- "desc" : "(Optional) True to remove and replace the element in the document too.",
+ "desc" : "True to remove and replace the element in the document too.",
"isOptional" : false
}
],
],
"isAbstract" : false,
"isBuilderTop" : false,
- "childClasses" : {
- "Roo.CompositeElement" : [
- "Roo.CompositeElementLite"
- ]
- },
+ "implementations" : [
+ "Roo.CompositeElementLite"
+ ],
"tree_children" : [],
"tree_parent" : []
},
{
"name" : "domReplace",
"type" : "Boolean",
- "desc" : "(Optional) True to remove and replace the element in the document too.",
+ "desc" : "True to remove and replace the element in the document too.",
"isOptional" : false
}
],
],
"isAbstract" : false,
"isBuilderTop" : false,
- "childClasses" : { },
+ "implementations" : [],
"tree_children" : [],
"tree_parent" : []
},
"name" : "adjustments",
"type" : "Array",
"desc" : "Values to <b>add</b> to the width/height when doing a {@link #fitToFrame} (default is [0, 0])",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"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" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "autoScroll",
"type" : "Boolean",
"desc" : "True to scroll overflow in this panel (use with {@link #fitToFrame})",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "background",
"type" : "Boolean",
"desc" : "True if the panel should not be activated when it is added (defaults to false)",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "closable",
"type" : "Boolean",
"desc" : "True if the panel can be closed/removed",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "content",
"type" : "String",
"desc" : "Raw content to fill content panel with (uses setContent on construction.)",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "fitContainer",
"type" : "Boolean",
"desc" : "When using {@link #fitToFrame} and {@link #resizeEl}, you can also fit the parent container (defaults to false)",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "fitToFrame",
"type" : "Boolean",
"desc" : "True for this panel to adjust its size to fit when the region resizes (defaults to false)",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"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"
+ "memberOf" : "Roo.util.Observable",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "loadOnce",
"type" : "Boolean",
"desc" : "When used with {@link #url}, calls {@link #setUrl} with this value",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "menu",
"type" : "Roo.menu.Menu",
"desc" : "popup menu",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "params",
"type" : "String|Object",
"desc" : "When used with {@link #url}, calls {@link #setUrl} with this value",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "region",
"type" : "String",
- "desc" : "[required] (center|north|south|east|west) which region to put this panel on (when used with xtype constructors)",
- "memberOf" : ""
+ "desc" : "t) which region to put this panel on (when used with xtype constructor",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : [
+ "center",
+ "north",
+ "south",
+ "east",
+ "west"
+ ]
},
{
"name" : "resizeEl",
"type" : "String|HTMLElement|Element",
"desc" : "An element to resize if {@link #fitToFrame} is true (instead of this panel's element)",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "style",
"type" : "String",
"desc" : "Extra style to add to the content panel",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "title",
"type" : "String",
"desc" : "The title for this panel",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "toolbar",
"type" : "Roo.Toolbar",
"desc" : "A toolbar for this panel",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "url",
"type" : "String",
"desc" : "Calls {@link #setUrl} with this value",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
}
],
"events" : [
}
],
"isAbstract" : false,
- "isBuilderTop" : true,
- "childClasses" : {
- "Roo.ContentPanel" : [
- "Roo.GridPanel",
- "Roo.NestedLayoutPanel",
- "Roo.TreePanel"
- ]
- },
+ "isBuilderTop" : false,
+ "implementations" : [
+ "Roo.GridPanel",
+ "Roo.NestedLayoutPanel",
+ "Roo.TreePanel"
+ ],
"tree_children" : [
"Roo.form.Form",
"Roo.JsonView",
"Roo.View",
"Roo.JsonView"
],
- "tree_parent" : []
+ "tree_parent" : [
+ "Roo.BorderLayout",
+ "Roo.LayoutDialog",
+ "builder"
+ ]
},
"Roo.DDView" : {
"props" : [
"name" : "allowCopy",
"type" : "Boolean",
"desc" : "Causes ctrl/drag operations to copy nodes rather than move.",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "copy",
"type" : "Boolean",
"desc" : "Causes drag operations to copy nodes rather than move.",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "dragGroup",
"type" : "String/Array",
"desc" : "The ddgroup name(s) for the View's DragZone.",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "dropGroup",
"type" : "String/Array",
"desc" : "The ddgroup name(s) for the View's DropZone.",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
}
],
"events" : [],
],
"isAbstract" : false,
"isBuilderTop" : false,
- "childClasses" : { },
+ "implementations" : [],
"tree_children" : [],
"tree_parent" : []
},
"name" : "actionMode",
"type" : "String",
"desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el' for forms you probably want to set this to fieldEl",
- "memberOf" : "Roo.Component"
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "allowDomMove",
"type" : "Boolean",
"desc" : "Whether the component can move the Dom node when rendering (defaults to true).",
- "memberOf" : "Roo.Component"
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "cancelText",
"type" : "String",
"desc" : "The text to display on the cancel button",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "constrainToViewport",
"type" : "Boolean",
"desc" : "True to constrain the date picker to the viewport (defaults to true)",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "dayNames",
"type" : "Array",
"desc" : "An array of textual day names which can be overriden for localization support (defaults to Date.dayNames)",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "disableClass",
"type" : "String",
"desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").",
- "memberOf" : "Roo.Component"
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "disabledDatesRE",
"type" : "RegExp",
"desc" : "JavaScript regular expression used to disable a pattern of dates (defaults to null)",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "disabledDatesText",
"type" : "String",
"desc" : "The tooltip text to display when the date falls on a disabled date (defaults to \"\")",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"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" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "disabledDaysText",
"type" : "String",
"desc" : "The tooltip to display when the date falls on a disabled day (defaults to \"\")",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"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" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "hideMode",
"type" : "String",
- "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".",
- "memberOf" : "Roo.Component"
+ "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display",
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : [
+ "display",
+ "visibility"
+ ]
},
{
"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"
+ "memberOf" : "Roo.util.Observable",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "maxDate",
"type" : "Date",
"desc" : "Maximum allowable date (JavaScript date object, defaults to null)",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "maxText",
"type" : "String",
"desc" : "The error text to display if the maxDate validation fails (defaults to \"This date is after the maximum date\")",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "minDate",
"type" : "Date",
"desc" : "Minimum allowable date (JavaScript date object, defaults to null)",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "minText",
"type" : "String",
"desc" : "The error text to display if the minDate validation fails (defaults to \"This date is before the minimum date\")",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "monthNames",
"type" : "Array",
"desc" : "An array of textual month names which can be overriden for localization support (defaults to Date.monthNames)",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "monthYearText",
"type" : "String",
"desc" : "The header month selector tooltip (defaults to 'Choose a month (Control+Up/Down to move years)')",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "nextText",
"type" : "String",
"desc" : "The next month navigation button tooltip (defaults to 'Next Month (Control+Right)')",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "okText",
"type" : "String",
"desc" : "The text to display on the ok button",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "prevText",
"type" : "String",
"desc" : "The previous month navigation button tooltip (defaults to 'Previous Month (Control+Left)')",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "showClear",
"type" : "Bool",
"desc" : "Show a clear button (usefull for date form elements that can be blank.)",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "startDay",
"type" : "Number",
"desc" : "Day index at which the week should begin, 0-based (defaults to 0, which is Sunday)",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "style",
+ "type" : "String",
+ "desc" : "css styles to add to component\neg. text-align:right;",
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "todayText",
"type" : "String",
"desc" : "The text to display on the button that selects the current date (defaults to \"Today\")",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "todayTip",
"type" : "String",
"desc" : "The tooltip to display for the button that selects the current date (defaults to \"{current date} (Spacebar)\")",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
}
],
"events" : [
],
"isAbstract" : false,
"isBuilderTop" : false,
- "childClasses" : { },
+ "implementations" : [],
"tree_children" : [],
"tree_parent" : []
},
],
"isAbstract" : false,
"isBuilderTop" : false,
- "childClasses" : { },
+ "implementations" : [],
"tree_children" : [],
"tree_parent" : []
},
"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"
+ "memberOf" : "Roo.util.Observable",
+ "isOptional" : false,
+ "optvals" : []
}
],
"events" : [],
],
"isAbstract" : false,
"isBuilderTop" : false,
- "childClasses" : { },
+ "implementations" : [],
"tree_children" : [],
"tree_parent" : []
},
"desc" : "The new node"
}
]
+ },
+ {
+ "name" : "update",
+ "type" : "function",
+ "desc" : "Updates the first element with the spec from the o (replacing if necessary)\nThis iterates through the children, and updates attributes / children etc..",
+ "sig" : "(el, o)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "el",
+ "type" : "String/HTMLElement/Element",
+ "desc" : "The context element",
+ "isOptional" : false
+ },
+ {
+ "name" : "o",
+ "type" : "Object/String",
+ "desc" : "The Dom object spec (and children) or raw HTML blob",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
}
],
"isAbstract" : false,
"isBuilderTop" : false,
- "childClasses" : { },
+ "implementations" : [],
"tree_children" : [],
"tree_parent" : []
},
],
"isAbstract" : false,
"isBuilderTop" : false,
- "childClasses" : { },
+ "implementations" : [],
"tree_children" : [],
"tree_parent" : []
},
"name" : "html",
"type" : "String",
"desc" : "The HTML fragment or an array of fragments to join(\"\") or multiple arguments to join(\"\")",
- "memberOf" : "Roo.Template"
+ "memberOf" : "Roo.Template",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "onLoad",
"type" : "Function",
"desc" : "Called after the template has been loaded and complied (usually from a remove source)",
- "memberOf" : "Roo.Template"
+ "memberOf" : "Roo.Template",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "url",
"type" : "String",
"desc" : "The Url to load the template from. beware if you are loading from a url, the data may not be ready if you use it instantly..\n it should be fixed so that template is observable...",
- "memberOf" : "Roo.Template"
+ "memberOf" : "Roo.Template",
+ "isOptional" : false,
+ "optvals" : []
}
],
"events" : [],
],
"isAbstract" : false,
"isBuilderTop" : false,
- "childClasses" : { },
+ "implementations" : [],
"tree_children" : [],
"tree_parent" : []
},
"name" : "actionMode",
"type" : "String",
"desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el' for forms you probably want to set this to fieldEl",
- "memberOf" : "Roo.Component"
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "alignment",
"type" : "String",
"desc" : "The position to align to (see {@link Roo.Element#alignTo} for more details, defaults to \"c-c?\").",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "allowDomMove",
"type" : "Boolean",
"desc" : "Whether the component can move the Dom node when rendering (defaults to true).",
- "memberOf" : "Roo.Component"
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"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" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "cancelOnEsc",
"type" : "Boolean",
"desc" : "True to cancel the edit when the escape key is pressed (defaults to false)",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "completeOnEnter",
"type" : "Boolean",
"desc" : "True to complete the edit when the enter key is pressed (defaults to false)",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "constrain",
"type" : "Boolean",
"desc" : "True to constrain the editor to the viewport",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "disableClass",
"type" : "String",
"desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").",
- "memberOf" : "Roo.Component"
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "hideEl",
"type" : "Boolean",
"desc" : "False to keep the bound element visible while the editor is displayed (defaults to true)",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "hideMode",
"type" : "String",
- "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".",
- "memberOf" : "Roo.Component"
+ "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display",
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : [
+ "display",
+ "visibility"
+ ]
},
{
"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" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"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"
+ "memberOf" : "Roo.util.Observable",
+ "isOptional" : false,
+ "optvals" : []
},
{
"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" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"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" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "style",
+ "type" : "String",
+ "desc" : "css styles to add to component\neg. text-align:right;",
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "updateEl",
"type" : "Boolean",
"desc" : "True to update the innerHTML of the bound element when the update completes (defaults to false)",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "value",
"type" : "Mixed",
"desc" : "The data value of the underlying field (defaults to \"\")",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
}
],
"events" : [
],
"isAbstract" : false,
"isBuilderTop" : false,
- "childClasses" : {
- "Roo.Editor" : [
- "Roo.grid.GridEditor",
- "Roo.tree.TreeEditor"
- ]
- },
+ "implementations" : [
+ "Roo.grid.GridEditor",
+ "Roo.tree.TreeEditor"
+ ],
"tree_children" : [],
"tree_parent" : []
},
{
"name" : "msgCls",
"type" : "String",
- "desc" : "(optional) A css class to apply to the msg element",
+ "desc" : "(optional) A css class to apply to the msg element - use no-spinner to hide the spinner on bootstrap",
"isOptional" : false
}
],
],
"isAbstract" : false,
"isBuilderTop" : false,
- "childClasses" : {
- "Roo.Element" : [
- "Roo.Layer"
- ]
- },
+ "implementations" : [
+ "Roo.Layer"
+ ],
"tree_children" : [],
"tree_parent" : []
},
],
"isAbstract" : false,
"isBuilderTop" : false,
- "childClasses" : { },
+ "implementations" : [],
"tree_children" : [],
"tree_parent" : []
},
],
"isAbstract" : false,
"isBuilderTop" : false,
- "childClasses" : { },
+ "implementations" : [],
"tree_children" : [],
"tree_parent" : []
},
"name" : "afterCls",
"type" : "String",
"desc" : "A css class to apply after the effect",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "afterStyle",
"type" : "String/Object/Function",
"desc" : "A style specification string, e.g. \"width:100px\", or an object in the form {width:\"100px\"}, or\na function which returns such a specification that will be applied to the Element after the effect finishes",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "block",
"type" : "Boolean",
"desc" : "Whether the effect should block other effects from queueing while it runs",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "callback",
"type" : "Function",
"desc" : "A function called when the effect is finished",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "concurrent",
"type" : "Boolean",
"desc" : "Whether to allow subsequently-queued effects to run at the same time as the current effect, or to ensure that they run in sequence",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "duration",
"type" : "Number",
"desc" : "The length of time (in seconds) that the effect should last",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "easing",
"type" : "String",
"desc" : "A valid Easing value for the effect",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "remove",
"type" : "Boolean",
"desc" : "Whether the Element should be removed from the DOM and destroyed after the effect finishes",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "scope",
"type" : "Object",
"desc" : "The scope of the effect function",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "stopFx",
"type" : "Boolean",
"desc" : "Whether subsequent effects should be stopped and removed after the current effect finishes",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "useDisplay",
"type" : "Boolean",
"desc" : "Whether to use the <i>display</i> CSS property instead of <i>visibility</i> when hiding Elements (only applies to \neffects that end with the element being visually hidden, ignored otherwise)",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
}
],
"events" : [],
],
"isAbstract" : false,
"isBuilderTop" : false,
- "childClasses" : { },
+ "implementations" : [],
"tree_children" : [],
"tree_parent" : []
},
"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"
+ "memberOf" : "Roo.ContentPanel",
+ "isOptional" : false,
+ "optvals" : []
},
{
"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"
+ "memberOf" : "Roo.ContentPanel",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "autoScroll",
"type" : "Boolean",
"desc" : "True to scroll overflow in this panel (use with {@link #fitToFrame})",
- "memberOf" : "Roo.ContentPanel"
+ "memberOf" : "Roo.ContentPanel",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "background",
"type" : "Boolean",
"desc" : "True if the panel should not be activated when it is added (defaults to false)",
- "memberOf" : "Roo.ContentPanel"
+ "memberOf" : "Roo.ContentPanel",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "closable",
"type" : "Boolean",
"desc" : "True if the panel can be closed/removed",
- "memberOf" : "Roo.ContentPanel"
+ "memberOf" : "Roo.ContentPanel",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "content",
"type" : "String",
"desc" : "Raw content to fill content panel with (uses setContent on construction.)",
- "memberOf" : "Roo.ContentPanel"
+ "memberOf" : "Roo.ContentPanel",
+ "isOptional" : false,
+ "optvals" : []
},
{
"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"
+ "memberOf" : "Roo.ContentPanel",
+ "isOptional" : false,
+ "optvals" : []
},
{
"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"
+ "memberOf" : "Roo.ContentPanel",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "grid",
+ "type" : "Roo.grid.Grid",
+ "desc" : "The grid for this panel",
+ "memberOf" : "Roo",
+ "isOptional" : false,
+ "optvals" : []
},
{
"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"
+ "memberOf" : "Roo.util.Observable",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "loadOnce",
"type" : "Boolean",
"desc" : "When used with {@link #url}, calls {@link #setUrl} with this value",
- "memberOf" : "Roo.ContentPanel"
+ "memberOf" : "Roo.ContentPanel",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "menu",
"type" : "Roo.menu.Menu",
"desc" : "popup menu",
- "memberOf" : "Roo.ContentPanel"
+ "memberOf" : "Roo.ContentPanel",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "params",
"type" : "String|Object",
"desc" : "When used with {@link #url}, calls {@link #setUrl} with this value",
- "memberOf" : "Roo.ContentPanel"
+ "memberOf" : "Roo.ContentPanel",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "region",
"type" : "String",
- "desc" : "[required] (center|north|south|east|west) which region to put this panel on (when used with xtype constructors)",
- "memberOf" : "Roo.ContentPanel"
+ "desc" : "t) which region to put this panel on (when used with xtype constructor",
+ "memberOf" : "Roo.ContentPanel",
+ "isOptional" : false,
+ "optvals" : [
+ "center",
+ "north",
+ "south",
+ "east",
+ "west"
+ ]
},
{
"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"
+ "memberOf" : "Roo.ContentPanel",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "style",
"type" : "String",
"desc" : "Extra style to add to the content panel",
- "memberOf" : "Roo.ContentPanel"
+ "memberOf" : "Roo.ContentPanel",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "title",
"type" : "String",
"desc" : "The title for this panel",
- "memberOf" : "Roo.ContentPanel"
+ "memberOf" : "Roo.ContentPanel",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "toolbar",
"type" : "Roo.Toolbar",
"desc" : "A toolbar for this panel",
- "memberOf" : "Roo.ContentPanel"
+ "memberOf" : "Roo.ContentPanel",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "url",
"type" : "String",
"desc" : "Calls {@link #setUrl} with this value",
- "memberOf" : "Roo.ContentPanel"
+ "memberOf" : "Roo.ContentPanel",
+ "isOptional" : false,
+ "optvals" : []
}
],
"events" : [
],
"isAbstract" : false,
"isBuilderTop" : false,
- "childClasses" : { },
+ "implementations" : [],
"tree_children" : [],
- "tree_parent" : []
+ "tree_parent" : [
+ "Roo.BorderLayout",
+ "Roo.LayoutDialog",
+ "builder"
+ ]
},
"Roo.HtmlEditorCore" : {
"props" : [
"name" : "actionMode",
"type" : "String",
"desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el' for forms you probably want to set this to fieldEl",
- "memberOf" : "Roo.Component"
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "allowComments",
"type" : "boolean",
- "desc" : "- default false - allow comments in HTML source - by default they are stripped - if you are editing email you may need this.",
- "memberOf" : ""
+ "desc" : "- default false - allow comments in HTML source\n - by default they are stripped - if you are editing email you may need this.",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "allowDomMove",
"type" : "Boolean",
"desc" : "Whether the component can move the Dom node when rendering (defaults to true).",
- "memberOf" : "Roo.Component"
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "autoClean",
+ "type" : "boolean",
+ "desc" : "- default true - loading and saving will remove quite a bit of formating,\n if you are doing an email editor, this probably needs disabling, it's designed",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "disableClass",
"type" : "String",
"desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").",
- "memberOf" : "Roo.Component"
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "enableBlocks",
+ "type" : "boolean",
+ "desc" : "- default true - if the block editor (table and figure should be enabled)",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "height",
"type" : "Number",
"desc" : "(in pixels)",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "hideMode",
"type" : "String",
- "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".",
- "memberOf" : "Roo.Component"
+ "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display",
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : [
+ "display",
+ "visibility"
+ ]
+ },
+ {
+ "name" : "language",
+ "type" : "String",
+ "desc" : "default en - language of text (usefull for rtl languages)",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"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"
+ "memberOf" : "Roo.util.Observable",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "resizable",
"type" : "String",
"desc" : "'s' or 'se' or 'e' - wrapps the element in a\n Roo.resizable.",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "style",
+ "type" : "String",
+ "desc" : "css styles to add to component\neg. text-align:right;",
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "stylesheets",
"type" : "Array",
"desc" : "url of stylesheets. set to [] to disable stylesheets.",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "the",
"type" : "Roo.form.HtmlEditor|Roo.bootstrap.HtmlEditor",
"desc" : "owner field",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "width",
"type" : "Number",
"desc" : "(in pixels)",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
}
],
"events" : [
{
"name" : "cleanTableWidths",
"type" : "function",
- "desc" : "cleanTableWidths.\n\nQuite often pasting from word etc.. results in tables with column and widths.\nThis does not work well on fluid HTML layouts - like emails. - so this code should hunt an destroy them..",
+ "desc" : "",
"sig" : "()\n{\n\n}",
"static" : false,
"memberOf" : "",
"isConstructor" : false,
"isPrivate" : false,
"example" : "",
- "deprecated" : "",
+ "deprecated" : "This has been deprecated: - use filters",
"since" : "",
"see" : "",
"exceptions" : "",
"isConstructor" : false,
"isPrivate" : false,
"example" : "",
- "deprecated" : "",
+ "deprecated" : "This has been deprecated: - use filter directly",
"since" : "",
"see" : "",
"exceptions" : "",
"params" : [],
"returns" : []
},
- {
- "name" : "iterateChildren",
- "type" : "function",
- "desc" : "iterateChildren of a Node, calling fn each time, using this as the scole..",
- "sig" : "(node, fn)",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "node",
- "type" : "DomNode",
- "desc" : "node to iterate children of.",
- "isOptional" : false
- },
- {
- "name" : "fn",
- "type" : "Function",
- "desc" : "method of this class to call on each item.",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
{
"name" : "on",
"type" : "function",
{
"name" : "pushValue",
"type" : "function",
- "desc" : "Protected method that will not generally be called directly. Pushes the value of the textarea\ninto the iframe editor.",
+ "desc" : "TEXTAREA -> EDITABLE\nProtected method that will not generally be called directly. Pushes the value of the textarea\ninto the iframe editor.",
"sig" : "()\n{\n\n}",
"static" : false,
"memberOf" : "",
],
"returns" : []
},
+ {
+ "name" : "selectNode",
+ "type" : "function",
+ "desc" : "Select a dom node",
+ "sig" : "(node)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "node",
+ "type" : "DomElement",
+ "desc" : "the node to select",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
{
"name" : "setDisabled",
"type" : "function",
],
"isAbstract" : false,
"isBuilderTop" : false,
- "childClasses" : { },
+ "implementations" : [],
"tree_children" : [],
"tree_parent" : []
},
"name" : "dataName",
"type" : "String",
"desc" : "the named area of the template to use as the data area\n Works with domtemplates roo-name=\"name\"",
- "memberOf" : "Roo.View"
+ "memberOf" : "Roo.View",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "el",
"type" : "String|Roo.Element",
"desc" : "The container element.",
- "memberOf" : "Roo.View"
+ "memberOf" : "Roo.View",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "emptyText",
"type" : "String",
"desc" : "The empty text to show when nothing is loaded.",
- "memberOf" : "Roo.View"
+ "memberOf" : "Roo.View",
+ "isOptional" : false,
+ "optvals" : []
},
{
"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"
+ "memberOf" : "Roo.util.Observable",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "multiSelect",
"type" : "Boolean",
"desc" : "Allow multiple selection",
- "memberOf" : "Roo.View"
+ "memberOf" : "Roo.View",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "selectedClass",
"type" : "String",
"desc" : "The css class to add to selected nodes",
- "memberOf" : "Roo.View"
+ "memberOf" : "Roo.View",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "singleSelect",
"type" : "Boolean",
"desc" : "Allow single selection",
- "memberOf" : "Roo.View"
+ "memberOf" : "Roo.View",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "store",
"type" : "Roo.data.Store",
"desc" : "Data store to load data from.",
- "memberOf" : "Roo.View"
+ "memberOf" : "Roo.View",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "text",
"type" : "String",
"desc" : "to display on mask (default Loading)",
- "memberOf" : "Roo.View"
+ "memberOf" : "Roo.View",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "tickable",
"type" : "Boolean",
"desc" : "- selecting",
- "memberOf" : "Roo.View"
+ "memberOf" : "Roo.View",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "toggleSelect",
"type" : "Boolean",
"desc" : "- selecting",
- "memberOf" : "Roo.View"
+ "memberOf" : "Roo.View",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "tpl",
"type" : "String|Roo.Template",
"desc" : "The template used by this View",
- "memberOf" : "Roo.View"
+ "memberOf" : "Roo.View",
+ "isOptional" : false,
+ "optvals" : []
}
],
"events" : [
],
"isAbstract" : false,
"isBuilderTop" : false,
- "childClasses" : { },
+ "implementations" : [],
"tree_children" : [],
"tree_parent" : []
},
],
"isAbstract" : false,
"isBuilderTop" : false,
- "childClasses" : { },
+ "implementations" : [],
"tree_children" : [],
"tree_parent" : []
},
"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" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "disabled",
"type" : "Boolean",
"desc" : "True to disable this KeyNav instance (defaults to false)",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "forceKeyDown",
"type" : "Boolean",
"desc" : "Handle the keydown event instead of keypress (defaults to false). KeyNav automatically does this for IE since\nIE does not propagate special keys on keypress, but setting this to true will force other browsers to also\nhandle keydown instead of keypress.",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
}
],
"events" : [],
],
"isAbstract" : false,
"isBuilderTop" : false,
- "childClasses" : { },
+ "implementations" : [],
"tree_children" : [],
"tree_parent" : []
},
"name" : "cls",
"type" : "String",
"desc" : "CSS class to add to the element",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "constrain",
"type" : "Boolean",
"desc" : "False to disable constrain to viewport (defaults to true)",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "dh",
"type" : "Object",
"desc" : "DomHelper object config to create element with (defaults to {tag: \"div\", cls: \"x-layer\"}).",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"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" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "shadowOffset",
"type" : "Number",
"desc" : "Number of pixels to offset the shadow (defaults to 3)",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "shim",
"type" : "Boolean",
"desc" : "False to disable the iframe shim in browsers which need one (defaults to true)",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "zindex",
"type" : "Number",
"desc" : "Starting z-index (defaults to 11000)",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
}
],
"events" : [],
{
"name" : "msgCls",
"type" : "String",
- "desc" : "(optional) A css class to apply to the msg element",
+ "desc" : "(optional) A css class to apply to the msg element - use no-spinner to hide the spinner on bootstrap",
"isOptional" : false
}
],
],
"isAbstract" : false,
"isBuilderTop" : false,
- "childClasses" : { },
+ "implementations" : [],
"tree_children" : [],
"tree_parent" : []
},
"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"
+ "memberOf" : "Roo.BasicDialog",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "autoCreate",
"type" : "Boolean/DomHelper",
"desc" : "True to auto create from scratch, or using a DomHelper Object (defaults to false)",
- "memberOf" : "Roo.BasicDialog"
+ "memberOf" : "Roo.BasicDialog",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "autoScroll",
"type" : "Boolean",
"desc" : "True to allow the dialog body contents to overflow and display scrollbars (defaults to false)",
- "memberOf" : "Roo.BasicDialog"
+ "memberOf" : "Roo.BasicDialog",
+ "isOptional" : false,
+ "optvals" : []
},
{
"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"
+ "memberOf" : "Roo.BasicDialog",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "buttonAlign",
"type" : "String",
"desc" : "Valid values are \"left,\" \"center\" and \"right\" (defaults to \"right\")",
- "memberOf" : "Roo.BasicDialog"
+ "memberOf" : "Roo.BasicDialog",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "buttons",
"type" : "Array",
"desc" : "Array of buttons",
- "memberOf" : "Roo.BasicDialog"
+ "memberOf" : "Roo.BasicDialog",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "buttons[]",
"type" : "Roo.Button",
"desc" : "Bottom buttons..",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "center",
"type" : "Roo.LayoutRegion",
"desc" : "",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "closable",
"type" : "Boolean",
"desc" : "False to remove the built-in top-right corner close button (defaults to true)",
- "memberOf" : "Roo.BasicDialog"
+ "memberOf" : "Roo.BasicDialog",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "collapsible",
"type" : "Boolean",
"desc" : "False to remove the built-in top-right corner collapse button (defaults to true)",
- "memberOf" : "Roo.BasicDialog"
+ "memberOf" : "Roo.BasicDialog",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "constraintoviewport",
"type" : "Boolean",
"desc" : "True to keep the dialog constrained within the visible viewport boundaries (defaults to true)",
- "memberOf" : "Roo.BasicDialog"
+ "memberOf" : "Roo.BasicDialog",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "draggable",
"type" : "Boolean",
"desc" : "False to disable dragging of the dialog within the viewport (defaults to true)",
- "memberOf" : "Roo.BasicDialog"
+ "memberOf" : "Roo.BasicDialog",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "east",
"type" : "Roo.LayoutRegion",
"desc" : "",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"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"
+ "memberOf" : "Roo.BasicDialog",
+ "isOptional" : false,
+ "optvals" : []
},
{
"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"
+ "memberOf" : "Roo.BasicDialog",
+ "isOptional" : false,
+ "optvals" : []
},
{
"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"
+ "memberOf" : "Roo.util.Observable",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "minButtonWidth",
"type" : "Number",
"desc" : "Minimum width of all dialog buttons (defaults to 75)",
- "memberOf" : "Roo.BasicDialog"
+ "memberOf" : "Roo.BasicDialog",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "minHeight",
"type" : "Number",
"desc" : "The minimum allowable height for a resizable dialog (defaults to 80)",
- "memberOf" : "Roo.BasicDialog"
+ "memberOf" : "Roo.BasicDialog",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "minWidth",
"type" : "Number",
"desc" : "The minimum allowable width for a resizable dialog (defaults to 200)",
- "memberOf" : "Roo.BasicDialog"
+ "memberOf" : "Roo.BasicDialog",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "modal",
"type" : "Boolean",
"desc" : "True to show the dialog modally, preventing user interaction with the rest of the page (defaults to false)",
- "memberOf" : "Roo.BasicDialog"
+ "memberOf" : "Roo.BasicDialog",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "north",
"type" : "Roo.LayoutRegion",
"desc" : "",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"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"
+ "memberOf" : "Roo.BasicDialog",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "resizable",
"type" : "Boolean",
"desc" : "False to disable manual dialog resizing (defaults to true)",
- "memberOf" : "Roo.BasicDialog"
+ "memberOf" : "Roo.BasicDialog",
+ "isOptional" : false,
+ "optvals" : []
},
{
"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"
+ "memberOf" : "Roo.BasicDialog",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "shadow",
"type" : "Boolean/String",
"desc" : "True or \"sides\" for the default effect, \"frame\" for 4-way shadow, and \"drop\" for bottom-right\nshadow (defaults to false)",
- "memberOf" : "Roo.BasicDialog"
+ "memberOf" : "Roo.BasicDialog",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "shadowOffset",
"type" : "Number",
"desc" : "The number of pixels to offset the shadow if displayed (defaults to 5)",
- "memberOf" : "Roo.BasicDialog"
+ "memberOf" : "Roo.BasicDialog",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "shim",
"type" : "Boolean",
"desc" : "True to create an iframe shim that prevents selects from showing through (defaults to false)",
- "memberOf" : "Roo.BasicDialog"
+ "memberOf" : "Roo.BasicDialog",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "south",
"type" : "Roo.LayoutRegion",
"desc" : "",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "syncHeightBeforeShow",
"type" : "Boolean",
"desc" : "True to cause the dimensions to be recalculated before the dialog is shown (defaults to false)",
- "memberOf" : "Roo.BasicDialog"
+ "memberOf" : "Roo.BasicDialog",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "tabTag",
"type" : "String",
"desc" : "The tag name of tab elements, used when autoTabs = true (defaults to 'div')",
- "memberOf" : "Roo.BasicDialog"
+ "memberOf" : "Roo.BasicDialog",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "title",
"type" : "String",
"desc" : "Default text to display in the title bar (defaults to null)",
- "memberOf" : "Roo.BasicDialog"
+ "memberOf" : "Roo.BasicDialog",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "west",
"type" : "Roo.LayoutRegion",
"desc" : "",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"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"
+ "memberOf" : "Roo.BasicDialog",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "x",
"type" : "Number",
"desc" : "The default left page coordinate of the dialog (defaults to center screen)",
- "memberOf" : "Roo.BasicDialog"
+ "memberOf" : "Roo.BasicDialog",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "y",
"type" : "Number",
"desc" : "The default top page coordinate of the dialog (defaults to center screen)",
- "memberOf" : "Roo.BasicDialog"
+ "memberOf" : "Roo.BasicDialog",
+ "isOptional" : false,
+ "optvals" : []
}
],
"events" : [
}
],
"isAbstract" : false,
- "isBuilderTop" : true,
- "childClasses" : { },
+ "isBuilderTop" : false,
+ "implementations" : [],
"tree_children" : [
"Roo.ContentPanel",
"Roo.GridPanel",
"Roo.NestedLayoutPanel",
"Roo.TreePanel"
],
- "tree_parent" : []
+ "tree_parent" : [
+ "builder",
+ "none"
+ ]
},
"Roo.LayoutManager" : {
"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"
+ "memberOf" : "Roo.util.Observable",
+ "isOptional" : false,
+ "optvals" : []
}
],
"events" : [
],
"isAbstract" : false,
"isBuilderTop" : false,
- "childClasses" : {
- "Roo.BorderLayout" : [
- "Roo.ReaderLayout"
- ],
- "Roo.LayoutManager" : [
- "Roo.BorderLayout"
- ]
- },
+ "implementations" : [
+ "Roo.BorderLayout",
+ "Roo.ReaderLayout"
+ ],
"tree_children" : [],
"tree_parent" : []
},
"name" : "alwaysShowTabs",
"type" : "Boolean",
"desc" : "True to always display tabs even when there is only 1 panel (defaults to false)",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "animate",
"type" : "Boolean",
"desc" : "True to animate expand/collapse (defaults to false)",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "autoHide",
"type" : "Boolean",
"desc" : "False to disable auto hiding when the mouse leaves the \"floated\" region (defaults to true)",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "autoScroll",
"type" : "Boolean",
"desc" : "True to enable overflow scrolling (defaults to false)",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "closeOnTab",
"type" : "Boolean",
"desc" : "True to place the close icon on the tabs instead of the region titlebar (defaults to false)",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"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" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "collapsed",
"type" : "Boolean",
"desc" : "True to set the initial display to collapsed (defaults to false)",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "collapsedTitle",
"type" : "String",
"desc" : "Optional string message to display in the collapsed block of a north or south region",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "collapsible",
"type" : "Boolean",
"desc" : "False to disable collapsing (defaults to true)",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "disableTabTips",
"type" : "Boolean",
"desc" : "True to disable tab tooltips",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "floatable",
"type" : "Boolean",
"desc" : "False to disable floating (defaults to true)",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "height",
"type" : "Number",
"desc" : "For North/South panels",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "hidden",
"type" : "Boolean",
"desc" : "True to start the region hidden (defaults to false)",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "hideTabs",
"type" : "Boolean",
"desc" : "True to hide the tab strip (defaults to false)",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "hideWhenEmpty",
"type" : "Boolean",
"desc" : "True to hide the region when it has no panels",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"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"
+ "memberOf" : "Roo.util.Observable",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "margins",
"type" : "Object",
"desc" : "Margins for the element (defaults to {top: 0, left: 0, right:0, bottom: 0})",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "minTabWidth",
"type" : "Number",
"desc" : "The minimum tab width (defaults to 40)",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "preferredTabWidth",
"type" : "Number",
"desc" : "The preferred tab width (defaults to 150)",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "preservePanels",
"type" : "Boolean",
"desc" : "True to preserve removed panels so they can be readded later (defaults to false)",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"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" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "showPin",
"type" : "Boolean",
"desc" : "True to show a pin button",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "split",
"type" : "Boolean",
"desc" : "To show the splitter",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "tabPosition",
"type" : "String",
- "desc" : "m) \"top\" or \"bottom\" (defaults to \"bottom\")",
- "memberOf" : ""
+ "desc" : "m) \"top\" or \"bottom\" (defaults to \"bottom",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : [
+ "top",
+ "bottom"
+ ]
},
{
"name" : "title",
"type" : "String",
"desc" : "The title for the region (overrides panel titles)",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "titlebar",
"type" : "Boolean",
"desc" : "True to display a title bar (defaults to true)",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "toolbar",
"type" : "Boolean",
"desc" : "xtype configuration for a toolbar - shows on right of tabbar",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "width",
"type" : "Number",
"desc" : "For East/West panels",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
}
],
"events" : [
],
"isAbstract" : false,
"isBuilderTop" : false,
- "childClasses" : {
- "Roo.LayoutRegion" : [
- "Roo.SplitLayoutRegion",
- "Roo.bootstrap.layout.Split"
- ]
- },
+ "implementations" : [
+ "Roo.SplitLayoutRegion",
+ "Roo.bootstrap.layout.Split"
+ ],
"tree_children" : [],
"tree_parent" : []
},
"name" : "msg",
"type" : "String",
"desc" : "The text to display in a centered loading message box (defaults to 'Loading...')",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "msgCls",
"type" : "String",
"desc" : "The CSS class to apply to the loading message element (defaults to \"x-mask-loading\")",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"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" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
}
],
"events" : [],
],
"isAbstract" : false,
"isBuilderTop" : false,
- "childClasses" : { },
+ "implementations" : [],
"tree_children" : [],
"tree_parent" : []
},
"name" : "html",
"type" : "String",
"desc" : "The HTML fragment or an array of fragments to join(\"\") or multiple arguments to join(\"\")",
- "memberOf" : "Roo.Template"
+ "memberOf" : "Roo.Template",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "onLoad",
"type" : "Function",
"desc" : "Called after the template has been loaded and complied (usually from a remove source)",
- "memberOf" : "Roo.Template"
+ "memberOf" : "Roo.Template",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "url",
"type" : "String",
"desc" : "The Url to load the template from. beware if you are loading from a url, the data may not be ready if you use it instantly..\n it should be fixed so that template is observable...",
- "memberOf" : "Roo.Template"
+ "memberOf" : "Roo.Template",
+ "isOptional" : false,
+ "optvals" : []
}
],
"events" : [],
],
"isAbstract" : false,
"isBuilderTop" : false,
- "childClasses" : { },
+ "implementations" : [],
+ "tree_children" : [],
+ "tree_parent" : []
+ },
+ "Roo.MessageBox" : {
+ "props" : [],
+ "events" : [],
+ "methods" : [
+ {
+ "name" : "alert",
+ "type" : "function",
+ "desc" : "Displays a standard read-only message box with an OK button (comparable to the basic JavaScript Window.alert).\nIf a callback function is passed it will be called after the user clicks the button, and the\nid of the button that was clicked will be passed as the only parameter to the callback\n(could also be the top-right close button).",
+ "sig" : "(title, msg, fn, scope)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "title",
+ "type" : "String",
+ "desc" : "The title bar text",
+ "isOptional" : false
+ },
+ {
+ "name" : "msg",
+ "type" : "String",
+ "desc" : "The message box body text",
+ "isOptional" : false
+ },
+ {
+ "name" : "fn",
+ "type" : "Function",
+ "desc" : "(optional) The callback function invoked after the message box is closed",
+ "isOptional" : false
+ },
+ {
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "(optional) The scope of the callback function",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.MessageBox",
+ "desc" : "This message box"
+ }
+ ]
+ },
+ {
+ "name" : "confirm",
+ "type" : "function",
+ "desc" : "Displays a confirmation message box with Yes and No buttons (comparable to JavaScript's Window.confirm).\nIf a callback function is passed it will be called after the user clicks either button, and the id of the\nbutton that was clicked will be passed as the only parameter to the callback (could also be the top-right close button).",
+ "sig" : "(title, msg, fn, scope)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "title",
+ "type" : "String",
+ "desc" : "The title bar text",
+ "isOptional" : false
+ },
+ {
+ "name" : "msg",
+ "type" : "String",
+ "desc" : "The message box body text",
+ "isOptional" : false
+ },
+ {
+ "name" : "fn",
+ "type" : "Function",
+ "desc" : "(optional) The callback function invoked after the message box is closed",
+ "isOptional" : false
+ },
+ {
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "(optional) The scope of the callback function",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.MessageBox",
+ "desc" : "This message box"
+ }
+ ]
+ },
+ {
+ "name" : "getDialog",
+ "type" : "function",
+ "desc" : "Returns a reference to the underlying {@link Roo.BasicDialog} element",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.BasicDialog",
+ "desc" : "The BasicDialog element"
+ }
+ ]
+ },
+ {
+ "name" : "hide",
+ "type" : "function",
+ "desc" : "Hides the message box if it is displayed",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
+ {
+ "name" : "isVisible",
+ "type" : "function",
+ "desc" : "Returns true if the message box is currently displayed",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Boolean",
+ "desc" : "True if the message box is visible, else false"
+ }
+ ]
+ },
+ {
+ "name" : "progress",
+ "type" : "function",
+ "desc" : "Displays a message box with a progress bar. This message box has no buttons and is not closeable by\nthe user. You are responsible for updating the progress bar as needed via {@link Roo.MessageBox#updateProgress}\nand closing the message box when the process is complete.",
+ "sig" : "(title, msg)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "title",
+ "type" : "String",
+ "desc" : "The title bar text",
+ "isOptional" : false
+ },
+ {
+ "name" : "msg",
+ "type" : "String",
+ "desc" : "The message box body text",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.MessageBox",
+ "desc" : "This message box"
+ }
+ ]
+ },
+ {
+ "name" : "prompt",
+ "type" : "function",
+ "desc" : "Displays a message box with OK and Cancel buttons prompting the user to enter some text (comparable to\nJavaScript's Window.prompt). The prompt can be a single-line or multi-line textbox. If a callback function\nis passed it will be called after the user clicks either button, and the id of the button that was clicked\n(could also be the top-right close button) and the text that was entered will be passed as the two\nparameters to the callback.",
+ "sig" : "(title, msg, fn, scope, multiline)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "title",
+ "type" : "String",
+ "desc" : "The title bar text",
+ "isOptional" : false
+ },
+ {
+ "name" : "msg",
+ "type" : "String",
+ "desc" : "The message box body text",
+ "isOptional" : false
+ },
+ {
+ "name" : "fn",
+ "type" : "Function",
+ "desc" : "(optional) The callback function invoked after the message box is closed",
+ "isOptional" : false
+ },
+ {
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "(optional) The scope of the callback function",
+ "isOptional" : false
+ },
+ {
+ "name" : "multiline",
+ "type" : "Boolean/Number",
+ "desc" : "(optional) True to create a multiline textbox using the defaultTextHeight\nproperty, or the height in pixels to create the textbox (defaults to false / single-line)",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.MessageBox",
+ "desc" : "This message box"
+ }
+ ]
+ },
+ {
+ "name" : "show",
+ "type" : "function",
+ "desc" : "Displays a new message box, or reinitializes an existing message box, based on the config options\npassed in. All functions (e.g. prompt, alert, etc) on MessageBox call this function internally.\nThe following config object properties are supported:\n<pre>\nProperty Type Description\n---------- --------------- ------------------------------------------------------------------------------------\nanimEl String/Element An id or Element from which the message box should animate as it opens and\n closes (defaults to undefined)\nbuttons Object/Boolean A button config object (e.g., Roo.MessageBox.OKCANCEL or {ok:'Foo',\n cancel:'Bar'}), or false to not show any buttons (defaults to false)\nclosable Boolean False to hide the top-right close button (defaults to true). Note that\n progress and wait dialogs will ignore this property and always hide the\n close button as they can only be closed programmatically.\ncls String A custom CSS class to apply to the message box element\ndefaultTextHeight Number The default height in pixels of the message box's multiline textarea if\n displayed (defaults to 75)\nfn Function A callback function to execute after closing the dialog. The arguments to the\n function will be btn (the name of the button that was clicked, if applicable,\n e.g. \"ok\"), and text (the value of the active text field, if applicable).\n Progress and wait dialogs will ignore this option since they do not respond to\n user actions and can only be closed programmatically, so any required function\n should be called by the same code after it closes the dialog.\nicon String A CSS class that provides a background image to be used as an icon for\n the dialog (e.g., Roo.MessageBox.WARNING or 'custom-class', defaults to '')\nmaxWidth Number The maximum width in pixels of the message box (defaults to 600)\nminWidth Number The minimum width in pixels of the message box (defaults to 100)\nmodal Boolean False to allow user interaction with the page while the message box is\n displayed (defaults to true)\nmsg String A string that will replace the existing message box body text (defaults\n to the XHTML-compliant non-breaking space character ' ')\nmultiline Boolean True to prompt the user to enter multi-line text (defaults to false)\nprogress Boolean True to display a progress bar (defaults to false)\nprogressText String The text to display inside the progress bar if progress = true (defaults to '')\nprompt Boolean True to prompt the user to enter single-line text (defaults to false)\nproxyDrag Boolean True to display a lightweight proxy while dragging (defaults to false)\ntitle String The title text\nvalue String The string value to set into the active textbox element if displayed\nwait Boolean True to display a progress bar (defaults to false)\nwidth Number The width of the dialog in pixels\n</pre>\n\nExample usage:\n<pre><code>\nRoo.Msg.show({\n title: 'Address',\n msg: 'Please enter your address:',\n width: 300,\n buttons: Roo.MessageBox.OKCANCEL,\n multiline: true,\n fn: saveAddress,\n animEl: 'addAddressBtn'\n});\n</code></pre>",
+ "sig" : "(config)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "config",
+ "type" : "Object",
+ "desc" : "Configuration options",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.MessageBox",
+ "desc" : "This message box"
+ }
+ ]
+ },
+ {
+ "name" : "updateProgress",
+ "type" : "function",
+ "desc" : "Updates a progress-style message box's text and progress bar. Only relevant on message boxes\ninitiated via {@link Roo.MessageBox#progress} or by calling {@link Roo.MessageBox#show} with progress: true.",
+ "sig" : "(value, text)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "value",
+ "type" : "Number",
+ "desc" : "Any number between 0 and 1 (e.g., .5)",
+ "isOptional" : false
+ },
+ {
+ "name" : "text",
+ "type" : "String",
+ "desc" : "(optional) If defined, the message box's body text is replaced with the specified string (defaults to undefined)",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.MessageBox",
+ "desc" : "This message box"
+ }
+ ]
+ },
+ {
+ "name" : "updateText",
+ "type" : "function",
+ "desc" : "Updates the message box body text",
+ "sig" : "(text)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "text",
+ "type" : "String",
+ "desc" : "(optional) Replaces the message box element's innerHTML with the specified string (defaults to\nthe XHTML-compliant non-breaking space character '&#160;')",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.MessageBox",
+ "desc" : "This message box"
+ }
+ ]
+ },
+ {
+ "name" : "wait",
+ "type" : "function",
+ "desc" : "Displays a message box with an infinitely auto-updating progress bar. This can be used to block user\ninteraction while waiting for a long-running process to complete that does not have defined intervals.\nYou are responsible for closing the message box when the process is complete.",
+ "sig" : "(msg, title)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "msg",
+ "type" : "String",
+ "desc" : "The message box body text",
+ "isOptional" : false
+ },
+ {
+ "name" : "title",
+ "type" : "String",
+ "desc" : "(optional) The title bar text",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.MessageBox",
+ "desc" : "This message box"
+ }
+ ]
+ }
+ ],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "implementations" : [],
"tree_children" : [],
"tree_parent" : []
},
"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"
+ "memberOf" : "Roo.ContentPanel",
+ "isOptional" : false,
+ "optvals" : []
},
{
"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"
+ "memberOf" : "Roo.ContentPanel",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "autoScroll",
"type" : "Boolean",
"desc" : "True to scroll overflow in this panel (use with {@link #fitToFrame})",
- "memberOf" : "Roo.ContentPanel"
+ "memberOf" : "Roo.ContentPanel",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "background",
"type" : "Boolean",
"desc" : "True if the panel should not be activated when it is added (defaults to false)",
- "memberOf" : "Roo.ContentPanel"
+ "memberOf" : "Roo.ContentPanel",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "closable",
"type" : "Boolean",
"desc" : "True if the panel can be closed/removed",
- "memberOf" : "Roo.ContentPanel"
+ "memberOf" : "Roo.ContentPanel",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "content",
"type" : "String",
"desc" : "Raw content to fill content panel with (uses setContent on construction.)",
- "memberOf" : "Roo.ContentPanel"
+ "memberOf" : "Roo.ContentPanel",
+ "isOptional" : false,
+ "optvals" : []
},
{
"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"
+ "memberOf" : "Roo.ContentPanel",
+ "isOptional" : false,
+ "optvals" : []
},
{
"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"
+ "memberOf" : "Roo.ContentPanel",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "layout",
+ "type" : "Roo.BorderLayout",
+ "desc" : "The layout for this panel",
+ "memberOf" : "Roo",
+ "isOptional" : false,
+ "optvals" : []
},
{
"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"
+ "memberOf" : "Roo.util.Observable",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "loadOnce",
"type" : "Boolean",
"desc" : "When used with {@link #url}, calls {@link #setUrl} with this value",
- "memberOf" : "Roo.ContentPanel"
+ "memberOf" : "Roo.ContentPanel",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "menu",
"type" : "Roo.menu.Menu",
"desc" : "popup menu",
- "memberOf" : "Roo.ContentPanel"
+ "memberOf" : "Roo.ContentPanel",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "params",
"type" : "String|Object",
"desc" : "When used with {@link #url}, calls {@link #setUrl} with this value",
- "memberOf" : "Roo.ContentPanel"
+ "memberOf" : "Roo.ContentPanel",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "region",
"type" : "String",
- "desc" : "[required] (center|north|south|east|west) which region to put this panel on (when used with xtype constructors)",
- "memberOf" : "Roo.ContentPanel"
+ "desc" : "t) which region to put this panel on (when used with xtype constructor",
+ "memberOf" : "Roo.ContentPanel",
+ "isOptional" : false,
+ "optvals" : [
+ "center",
+ "north",
+ "south",
+ "east",
+ "west"
+ ]
},
{
"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"
+ "memberOf" : "Roo.ContentPanel",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "style",
"type" : "String",
"desc" : "Extra style to add to the content panel",
- "memberOf" : "Roo.ContentPanel"
+ "memberOf" : "Roo.ContentPanel",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "title",
"type" : "String",
"desc" : "The title for this panel",
- "memberOf" : "Roo.ContentPanel"
+ "memberOf" : "Roo.ContentPanel",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "toolbar",
"type" : "Roo.Toolbar",
"desc" : "A toolbar for this panel",
- "memberOf" : "Roo.ContentPanel"
+ "memberOf" : "Roo.ContentPanel",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "url",
"type" : "String",
"desc" : "Calls {@link #setUrl} with this value",
- "memberOf" : "Roo.ContentPanel"
+ "memberOf" : "Roo.ContentPanel",
+ "isOptional" : false,
+ "optvals" : []
}
],
"events" : [
],
"isAbstract" : false,
"isBuilderTop" : false,
- "childClasses" : { },
+ "implementations" : [],
"tree_children" : [],
- "tree_parent" : []
+ "tree_parent" : [
+ "Roo.BorderLayout",
+ "Roo.LayoutDialog",
+ "builder"
+ ]
},
"Roo.PagingToolbar" : {
"props" : [
"name" : "container",
"type" : "String/HTMLElement/Element",
"desc" : "container The id or element that will contain the toolbar",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "displayInfo",
"type" : "Boolean",
"desc" : "True to display the displayMsg (defaults to false)",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "displayMsg",
"type" : "String",
"desc" : "The paging status message to display (defaults to \"Displaying {start} - {end} of {total}\")",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "emptyMsg",
"type" : "String",
"desc" : "The message to display when no records are found (defaults to \"No data to display\")",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "items",
"type" : "Array",
"desc" : "array of button configs or elements to add (will be converted to a MixedCollection)",
- "memberOf" : "Roo.Toolbar"
+ "memberOf" : "Roo.Toolbar",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "pageSize",
"type" : "Number",
"desc" : "The number of records to display per page (defaults to 20)",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "text",
"type" : "string",
"desc" : "",
- "memberOf" : "Roo.Toolbar"
+ "memberOf" : "Roo.Toolbar",
+ "isOptional" : false,
+ "optvals" : []
}
],
"events" : [],
}
]
},
+ {
+ "name" : "onClick",
+ "type" : "function",
+ "desc" : "event that occurs when you click on the navigation buttons - can be used to trigger load of a grid.",
+ "sig" : "(which)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "which",
+ "type" : "String",
+ "desc" : "(first|prev|next|last|refresh) which button to press.",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
{
"name" : "show",
"type" : "function",
],
"isAbstract" : false,
"isBuilderTop" : false,
- "childClasses" : { },
+ "implementations" : [],
"tree_children" : [
"Roo.Toolbar.Item",
"Roo.Toolbar.Fill",
"Roo.Toolbar.Separator",
"Roo.Toolbar.Spacer",
"Roo.Toolbar.TextItem",
+ "Roo.Toolbar.Button",
+ "Roo.Toolbar.SplitButton",
"Roo.form.Field",
"Roo.form.Checkbox",
"Roo.form.ComboBox",
"tree_parent" : []
},
"Roo.QuickTips" : {
- "props" : [],
+ "props" : [
+ {
+ "name" : "Delay",
+ "type" : "Number",
+ "desc" : "in milliseconds before the quick tip hides when autoDismiss = true (defaults to 5000)",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "True",
+ "type" : "Boolean",
+ "desc" : "to automatically hide the quick tip after a set period of time, regardless of the user's actions\n(defaults to true). Used in conjunction with autoDismissDelay.",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "animate",
+ "type" : "Boolean",
+ "desc" : "True to turn on fade animation. Defaults to false (ClearType/scrollbar flicker issues in IE7).",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "autoHide",
+ "type" : "Boolean",
+ "desc" : "True to automatically hide the quick tip after the mouse exits the target element (defaults to true).\nUsed in conjunction with hideDelay.",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "cls",
+ "type" : "String",
+ "desc" : "A CSS class to apply to the base quick tip element (defaults to '').",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "hideDelay",
+ "type" : "Number",
+ "desc" : "Delay in milliseconds before the quick tip hides when autoHide = true (defaults to 200)",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "hideOnClick",
+ "type" : "Boolean",
+ "desc" : "True to hide the quick tip if the user clicks anywhere in the document (defaults to true)",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "interceptTitles",
+ "type" : "Boolean",
+ "desc" : "True to automatically use the element's DOM title value if available (defaults to false)",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "maxWidth",
+ "type" : "Number",
+ "desc" : "The maximum width of the quick tip (defaults to 300)",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "minWidth",
+ "type" : "Number",
+ "desc" : "The minimum width of the quick tip (defaults to 40)",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "showDelay",
+ "type" : "Number",
+ "desc" : "Delay in milliseconds before the quick tip displays after the mouse enters the target element (defaults to 500)",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "text",
+ "type" : "String",
+ "desc" : "Body text to display (defaults to ''). This can be any valid HTML markup.",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "title",
+ "type" : "String",
+ "desc" : "Title text to display (defaults to ''). This can be any valid HTML markup.",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "trackMouse",
+ "type" : "Boolean",
+ "desc" : "True to have the quick tip follow the mouse as it moves over the target element (defaults to false)",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "width",
+ "type" : "Number",
+ "desc" : "Width in pixels of the quick tip (defaults to auto). Width will be ignored if it exceeds the bounds of\nminWidth or maxWidth.",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ }
+ ],
"events" : [],
"methods" : [
{
],
"isAbstract" : false,
"isBuilderTop" : false,
- "childClasses" : { },
+ "implementations" : [],
"tree_children" : [],
"tree_parent" : []
},
"name" : "center",
"type" : "Roo.LayoutRegion",
"desc" : "",
- "memberOf" : "Roo.BorderLayout"
+ "memberOf" : "Roo.BorderLayout",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "east",
"type" : "Roo.LayoutRegion",
"desc" : "",
- "memberOf" : "Roo.BorderLayout"
+ "memberOf" : "Roo.BorderLayout",
+ "isOptional" : false,
+ "optvals" : []
},
{
"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"
+ "memberOf" : "Roo.util.Observable",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "north",
"type" : "Roo.LayoutRegion",
"desc" : "",
- "memberOf" : "Roo.BorderLayout"
+ "memberOf" : "Roo.BorderLayout",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "south",
"type" : "Roo.LayoutRegion",
"desc" : "",
- "memberOf" : "Roo.BorderLayout"
+ "memberOf" : "Roo.BorderLayout",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "west",
"type" : "Roo.LayoutRegion",
"desc" : "",
- "memberOf" : "Roo.BorderLayout"
+ "memberOf" : "Roo.BorderLayout",
+ "isOptional" : false,
+ "optvals" : []
}
],
"events" : [
],
"isAbstract" : false,
"isBuilderTop" : false,
- "childClasses" : { },
+ "implementations" : [],
"tree_children" : [],
"tree_parent" : []
},
"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" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "animate",
"type" : "Boolean",
"desc" : "True to animate the resize (not compatible with dynamic sizing, defaults to false)",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "constrainTo",
"type" : "String/HTMLElement/Element",
"desc" : "Constrain the resize to a particular element",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "disableTrackOver",
"type" : "Boolean",
"desc" : "True to disable mouse tracking. This is only applied at config time. (defaults to false)",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "draggable",
"type" : "Boolean",
"desc" : "Convenience to initialize drag drop (defaults to false)",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "duration",
"type" : "Number",
"desc" : "Animation duration if animate = true (defaults to .35)",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "dynamic",
"type" : "Boolean",
"desc" : "True to resize the element while dragging instead of using a proxy (defaults to false)",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "easing",
"type" : "String",
"desc" : "Animation easing if animate = true (defaults to 'easingOutStrong')",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "enabled",
"type" : "Boolean",
"desc" : "False to disable resizing (defaults to true)",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "handles",
"type" : "String",
"desc" : "String consisting of the resize handles to display (defaults to undefined)",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "height",
"type" : "Number",
"desc" : "The height of the element in pixels (defaults to null)",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "heightIncrement",
"type" : "Number",
"desc" : "The increment to snap the height resize in pixels (dynamic must be true, defaults to 0)",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"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"
+ "memberOf" : "Roo.util.Observable",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "maxHeight",
"type" : "Number",
"desc" : "The maximum height for the element (defaults to 10000)",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "maxWidth",
"type" : "Number",
"desc" : "The maximum width for the element (defaults to 10000)",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "minHeight",
"type" : "Number",
"desc" : "The minimum height for the element (defaults to 5)",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "minWidth",
"type" : "Number",
"desc" : "The minimum width for the element (defaults to 5)",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "minX",
"type" : "Number",
"desc" : "The minimum allowed page X for the element (only used for west resizing, defaults to 0)",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "minY",
"type" : "Number",
"desc" : "The minimum allowed page Y for the element (only used for north resizing, defaults to 0)",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"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" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"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" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "preserveRatio",
"type" : "Boolean",
"desc" : "True to preserve the original ratio between height and width during resize (defaults to false)",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "resizeChild",
"type" : "Boolean/String/Element",
"desc" : "True to resize the first child, or id/element to resize (defaults to false)",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "resizeRegion",
"type" : "Roo.lib.Region",
"desc" : "Constrain the resize to a particular region",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "transparent",
"type" : "Boolean",
"desc" : "True for transparent handles. This is only applied at config time. (defaults to false)",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "width",
"type" : "Number",
"desc" : "The width of the element in pixels (defaults to null)",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "widthIncrement",
"type" : "Number",
"desc" : "The increment to snap the width resize in pixels (dynamic must be true, defaults to 0)",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "wrap",
"type" : "Boolean",
"desc" : "True to wrap an element with a div if needed (required for textareas and images, defaults to false)",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
}
],
"events" : [
],
"isAbstract" : false,
"isBuilderTop" : false,
- "childClasses" : { },
+ "implementations" : [],
"tree_children" : [],
"tree_parent" : []
},
"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" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "offset",
"type" : "String",
"desc" : "The number of pixels to offset the shadow from the element (defaults to 4)",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
}
],
"events" : [],
],
"isAbstract" : false,
"isBuilderTop" : false,
- "childClasses" : { },
+ "implementations" : [],
"tree_children" : [],
"tree_parent" : []
},
"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"
+ "memberOf" : "Roo.util.Observable",
+ "isOptional" : false,
+ "optvals" : []
}
],
"events" : [
],
"isAbstract" : false,
"isBuilderTop" : false,
- "childClasses" : { },
+ "implementations" : [],
"tree_children" : [],
"tree_parent" : []
},
],
"isAbstract" : false,
"isBuilderTop" : false,
- "childClasses" : { },
+ "implementations" : [],
"tree_children" : [],
"tree_parent" : []
},
],
"isAbstract" : false,
"isBuilderTop" : false,
- "childClasses" : {
- "Roo.SplitBar.BasicLayoutAdapter" : [
- "Roo.SplitBar.AbsoluteLayoutAdapter"
- ]
- },
+ "implementations" : [
+ "Roo.SplitBar.AbsoluteLayoutAdapter"
+ ],
"tree_children" : [],
"tree_parent" : []
},
"name" : "arrowHandler",
"type" : "Function",
"desc" : "A function called when the arrow button is clicked (can be used instead of click event)",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "arrowTooltip",
"type" : "String",
"desc" : "The title attribute of the arrow",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "clickEvent",
"type" : "String",
"desc" : "The type of event to map to the button's event handler (defaults to 'click')",
- "memberOf" : "Roo.Button"
+ "memberOf" : "Roo.Button",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "cls",
"type" : "String",
"desc" : "A CSS class to apply to the button's main element.",
- "memberOf" : "Roo.Button"
+ "memberOf" : "Roo.Button",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "disabled",
"type" : "Boolean",
"desc" : "True to start disabled (defaults to false)",
- "memberOf" : "Roo.Button"
+ "memberOf" : "Roo.Button",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "enableToggle",
"type" : "Boolean",
"desc" : "True to enable pressed/not pressed toggling (defaults to false)",
- "memberOf" : "Roo.Button"
+ "memberOf" : "Roo.Button",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "handleMouseEvents",
"type" : "Boolean",
"desc" : "False to disable visual cues on mouseover, mouseout and mousedown (defaults to true)",
- "memberOf" : "Roo.Button"
+ "memberOf" : "Roo.Button",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "handler",
"type" : "Function",
"desc" : "A function called when the button is clicked (can be used instead of click event)",
- "memberOf" : "Roo.Button"
+ "memberOf" : "Roo.Button",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "hidden",
"type" : "Boolean",
"desc" : "True to start hidden (defaults to false)",
- "memberOf" : "Roo.Button"
+ "memberOf" : "Roo.Button",
+ "isOptional" : false,
+ "optvals" : []
},
{
"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"
+ "memberOf" : "Roo.Button",
+ "isOptional" : false,
+ "optvals" : []
},
{
"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"
+ "memberOf" : "Roo.Button",
+ "isOptional" : false,
+ "optvals" : []
},
{
"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"
+ "memberOf" : "Roo.util.Observable",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "menu",
"type" : "Roo.menu.Menu",
"desc" : "Standard menu attribute consisting of a reference to a menu object, a menu id or a menu config blob (defaults to undefined).",
- "memberOf" : "Roo.Button"
+ "memberOf" : "Roo.Button",
+ "isOptional" : false,
+ "optvals" : []
},
{
"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"
+ "memberOf" : "Roo.Button",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "minWidth",
"type" : "Number",
"desc" : "The minimum width for this button (used to give a set of buttons a common width)",
- "memberOf" : "Roo.Button"
+ "memberOf" : "Roo.Button",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "pressed",
"type" : "Boolean",
"desc" : "True to start pressed (only if enableToggle = true)",
- "memberOf" : "Roo.Button"
+ "memberOf" : "Roo.Button",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "renderTo",
"type" : "String/HTMLElement/Element",
"desc" : "The element to append the button to",
- "memberOf" : "Roo.Button"
+ "memberOf" : "Roo.Button",
+ "isOptional" : false,
+ "optvals" : []
},
{
"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"
+ "memberOf" : "Roo.Button",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "scope",
"type" : "Object",
"desc" : "The scope of the handler",
- "memberOf" : "Roo.Button"
+ "memberOf" : "Roo.Button",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "tabIndex",
"type" : "Number",
"desc" : "The DOM tabIndex for this button (defaults to undefined)",
- "memberOf" : "Roo.Button"
+ "memberOf" : "Roo.Button",
+ "isOptional" : false,
+ "optvals" : []
},
{
"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"
+ "desc" : "An {@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",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "text",
"type" : "String",
"desc" : "The button text",
- "memberOf" : "Roo.Button"
+ "memberOf" : "Roo.Button",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "toggleGroup",
"type" : "String",
"desc" : "The group this toggle button is a member of (only 1 per group can be pressed, only\n applies if enableToggle = true)",
- "memberOf" : "Roo.Button"
+ "memberOf" : "Roo.Button",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "tooltip",
"type" : "String/Object",
"desc" : "The tooltip for the button - can be a string or QuickTips config object",
- "memberOf" : "Roo.Button"
+ "memberOf" : "Roo.Button",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "tooltipType",
"type" : "String",
"desc" : "The type of tooltip to use. Either \"qtip\" (default) for QuickTips or \"title\" for title attribute.",
- "memberOf" : "Roo.Button"
+ "memberOf" : "Roo.Button",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "type",
"type" : "String",
"desc" : "The button's type, corresponding to the DOM input element type attribute. Either \"submit,\" \"reset\" or \"button\" (default).",
- "memberOf" : "Roo.Button"
+ "memberOf" : "Roo.Button",
+ "isOptional" : false,
+ "optvals" : []
}
],
"events" : [
],
"returns" : []
},
+ {
+ "name" : "setPressed",
+ "type" : "function",
+ "desc" : "Similar to toggle, but does not trigger event.",
+ "sig" : "(state)",
+ "static" : false,
+ "memberOf" : "Roo.Button",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "state",
+ "type" : "Boolean",
+ "desc" : "[required] Force a particular state",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
{
"name" : "setText",
"type" : "function",
],
"isAbstract" : false,
"isBuilderTop" : false,
- "childClasses" : {
- "Roo.SplitButton" : [
- "Roo.Toolbar.SplitButton"
- ]
- },
+ "implementations" : [
+ "Roo.Toolbar.SplitButton"
+ ],
"tree_children" : [],
"tree_parent" : []
},
"name" : "alwaysShowTabs",
"type" : "Boolean",
"desc" : "True to always display tabs even when there is only 1 panel (defaults to false)",
- "memberOf" : "Roo.LayoutRegion"
+ "memberOf" : "Roo.LayoutRegion",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "animate",
"type" : "Boolean",
"desc" : "True to animate expand/collapse (defaults to false)",
- "memberOf" : "Roo.LayoutRegion"
+ "memberOf" : "Roo.LayoutRegion",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "autoHide",
"type" : "Boolean",
"desc" : "False to disable auto hiding when the mouse leaves the \"floated\" region (defaults to true)",
- "memberOf" : "Roo.LayoutRegion"
+ "memberOf" : "Roo.LayoutRegion",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "autoScroll",
"type" : "Boolean",
"desc" : "True to enable overflow scrolling (defaults to false)",
- "memberOf" : "Roo.LayoutRegion"
+ "memberOf" : "Roo.LayoutRegion",
+ "isOptional" : false,
+ "optvals" : []
},
{
"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"
+ "memberOf" : "Roo.LayoutRegion",
+ "isOptional" : false,
+ "optvals" : []
},
{
"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"
+ "memberOf" : "Roo.LayoutRegion",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "collapsed",
"type" : "Boolean",
"desc" : "True to set the initial display to collapsed (defaults to false)",
- "memberOf" : "Roo.LayoutRegion"
+ "memberOf" : "Roo.LayoutRegion",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "collapsedTitle",
"type" : "String",
"desc" : "Optional string message to display in the collapsed block of a north or south region",
- "memberOf" : "Roo.LayoutRegion"
+ "memberOf" : "Roo.LayoutRegion",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "collapsible",
"type" : "Boolean",
"desc" : "False to disable collapsing (defaults to true)",
- "memberOf" : "Roo.LayoutRegion"
+ "memberOf" : "Roo.LayoutRegion",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "disableTabTips",
"type" : "Boolean",
"desc" : "True to disable tab tooltips",
- "memberOf" : "Roo.LayoutRegion"
+ "memberOf" : "Roo.LayoutRegion",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "floatable",
"type" : "Boolean",
"desc" : "False to disable floating (defaults to true)",
- "memberOf" : "Roo.LayoutRegion"
+ "memberOf" : "Roo.LayoutRegion",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "height",
"type" : "Number",
"desc" : "For North/South panels",
- "memberOf" : "Roo.LayoutRegion"
+ "memberOf" : "Roo.LayoutRegion",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "hidden",
"type" : "Boolean",
"desc" : "True to start the region hidden (defaults to false)",
- "memberOf" : "Roo.LayoutRegion"
+ "memberOf" : "Roo.LayoutRegion",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "hideTabs",
"type" : "Boolean",
"desc" : "True to hide the tab strip (defaults to false)",
- "memberOf" : "Roo.LayoutRegion"
+ "memberOf" : "Roo.LayoutRegion",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "hideWhenEmpty",
"type" : "Boolean",
"desc" : "True to hide the region when it has no panels",
- "memberOf" : "Roo.LayoutRegion"
+ "memberOf" : "Roo.LayoutRegion",
+ "isOptional" : false,
+ "optvals" : []
},
{
"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"
+ "memberOf" : "Roo.util.Observable",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "margins",
"type" : "Object",
"desc" : "Margins for the element (defaults to {top: 0, left: 0, right:0, bottom: 0})",
- "memberOf" : "Roo.LayoutRegion"
+ "memberOf" : "Roo.LayoutRegion",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "minTabWidth",
"type" : "Number",
"desc" : "The minimum tab width (defaults to 40)",
- "memberOf" : "Roo.LayoutRegion"
+ "memberOf" : "Roo.LayoutRegion",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "preferredTabWidth",
"type" : "Number",
"desc" : "The preferred tab width (defaults to 150)",
- "memberOf" : "Roo.LayoutRegion"
+ "memberOf" : "Roo.LayoutRegion",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "preservePanels",
"type" : "Boolean",
"desc" : "True to preserve removed panels so they can be readded later (defaults to false)",
- "memberOf" : "Roo.LayoutRegion"
+ "memberOf" : "Roo.LayoutRegion",
+ "isOptional" : false,
+ "optvals" : []
},
{
"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"
+ "memberOf" : "Roo.LayoutRegion",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "showPin",
"type" : "Boolean",
"desc" : "True to show a pin button",
- "memberOf" : "Roo.LayoutRegion"
+ "memberOf" : "Roo.LayoutRegion",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "split",
"type" : "Boolean",
"desc" : "To show the splitter",
- "memberOf" : "Roo.LayoutRegion"
+ "memberOf" : "Roo.LayoutRegion",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "tabPosition",
"type" : "String",
- "desc" : "m) \"top\" or \"bottom\" (defaults to \"bottom\")",
- "memberOf" : "Roo.LayoutRegion"
+ "desc" : "m) \"top\" or \"bottom\" (defaults to \"bottom",
+ "memberOf" : "Roo.LayoutRegion",
+ "isOptional" : false,
+ "optvals" : [
+ "top",
+ "bottom"
+ ]
},
{
"name" : "title",
"type" : "String",
"desc" : "The title for the region (overrides panel titles)",
- "memberOf" : "Roo.LayoutRegion"
+ "memberOf" : "Roo.LayoutRegion",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "titlebar",
"type" : "Boolean",
"desc" : "True to display a title bar (defaults to true)",
- "memberOf" : "Roo.LayoutRegion"
+ "memberOf" : "Roo.LayoutRegion",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "toolbar",
"type" : "Boolean",
"desc" : "xtype configuration for a toolbar - shows on right of tabbar",
- "memberOf" : "Roo.LayoutRegion"
+ "memberOf" : "Roo.LayoutRegion",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "width",
"type" : "Number",
"desc" : "For East/West panels",
- "memberOf" : "Roo.LayoutRegion"
+ "memberOf" : "Roo.LayoutRegion",
+ "isOptional" : false,
+ "optvals" : []
}
],
"events" : [
],
"isAbstract" : false,
"isBuilderTop" : false,
- "childClasses" : { },
+ "implementations" : [],
"tree_children" : [],
"tree_parent" : []
},
"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"
+ "memberOf" : "Roo.util.Observable",
+ "isOptional" : false,
+ "optvals" : []
}
],
"events" : [
],
"isAbstract" : false,
"isBuilderTop" : false,
- "childClasses" : { },
+ "implementations" : [],
"tree_children" : [],
"tree_parent" : []
},
"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"
+ "memberOf" : "Roo.util.Observable",
+ "isOptional" : false,
+ "optvals" : []
}
],
"events" : [
],
"isAbstract" : false,
"isBuilderTop" : false,
- "childClasses" : { },
+ "implementations" : [],
"tree_children" : [],
"tree_parent" : []
},
"name" : "html",
"type" : "String",
"desc" : "The HTML fragment or an array of fragments to join(\"\") or multiple arguments to join(\"\")",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "onLoad",
"type" : "Function",
"desc" : "Called after the template has been loaded and complied (usually from a remove source)",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "url",
"type" : "String",
"desc" : "The Url to load the template from. beware if you are loading from a url, the data may not be ready if you use it instantly..\n it should be fixed so that template is observable...",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
}
],
"events" : [],
],
"isAbstract" : false,
"isBuilderTop" : false,
- "childClasses" : {
- "Roo.Template" : [
- "Roo.DomTemplate",
- "Roo.MasterTemplate",
- "Roo.XTemplate"
- ]
- },
+ "implementations" : [
+ "Roo.DomTemplate",
+ "Roo.MasterTemplate",
+ "Roo.XTemplate"
+ ],
"tree_children" : [],
"tree_parent" : []
},
"name" : "container",
"type" : "String/HTMLElement/Element",
"desc" : "The id or element that will contain the toolbar",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "items",
"type" : "Array",
"desc" : "array of button configs or elements to add (will be converted to a MixedCollection)",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "text",
"type" : "string",
"desc" : "",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
}
],
"events" : [],
],
"isAbstract" : false,
"isBuilderTop" : false,
- "childClasses" : {
- "Roo.Toolbar" : [
- "Roo.PagingToolbar"
- ]
- },
+ "implementations" : [
+ "Roo.PagingToolbar"
+ ],
"tree_children" : [
"Roo.Toolbar.Item",
"Roo.Toolbar.Fill",
"Roo.Toolbar.Separator",
"Roo.Toolbar.Spacer",
"Roo.Toolbar.TextItem",
+ "Roo.Toolbar.Button",
+ "Roo.Toolbar.SplitButton",
"Roo.form.Field",
"Roo.form.Checkbox",
"Roo.form.ComboBox",
"name" : "clickEvent",
"type" : "String",
"desc" : "The type of event to map to the button's event handler (defaults to 'click')",
- "memberOf" : "Roo.Button"
+ "memberOf" : "Roo.Button",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "cls",
"type" : "String",
"desc" : "A CSS class to apply to the button's main element.",
- "memberOf" : "Roo.Button"
+ "memberOf" : "Roo.Button",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "disabled",
"type" : "Boolean",
"desc" : "True to start disabled (defaults to false)",
- "memberOf" : "Roo.Button"
+ "memberOf" : "Roo.Button",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "enableToggle",
"type" : "Boolean",
"desc" : "True to enable pressed/not pressed toggling (defaults to false)",
- "memberOf" : "Roo.Button"
+ "memberOf" : "Roo.Button",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "handleMouseEvents",
"type" : "Boolean",
"desc" : "False to disable visual cues on mouseover, mouseout and mousedown (defaults to true)",
- "memberOf" : "Roo.Button"
+ "memberOf" : "Roo.Button",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "handler",
"type" : "Function",
"desc" : "A function called when the button is clicked (can be used instead of click event)",
- "memberOf" : "Roo.Button"
+ "memberOf" : "Roo.Button",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "hidden",
"type" : "Boolean",
"desc" : "True to start hidden (defaults to false)",
- "memberOf" : "Roo.Button"
+ "memberOf" : "Roo.Button",
+ "isOptional" : false,
+ "optvals" : []
},
{
"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"
+ "memberOf" : "Roo.Button",
+ "isOptional" : false,
+ "optvals" : []
},
{
"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"
+ "memberOf" : "Roo.Button",
+ "isOptional" : false,
+ "optvals" : []
},
{
"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"
+ "memberOf" : "Roo.util.Observable",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "menu",
"type" : "Roo.menu.Menu",
"desc" : "Standard menu attribute consisting of a reference to a menu object, a menu id or a menu config blob (defaults to undefined).",
- "memberOf" : "Roo.Button"
+ "memberOf" : "Roo.Button",
+ "isOptional" : false,
+ "optvals" : []
},
{
"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"
+ "memberOf" : "Roo.Button",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "minWidth",
"type" : "Number",
"desc" : "The minimum width for this button (used to give a set of buttons a common width)",
- "memberOf" : "Roo.Button"
+ "memberOf" : "Roo.Button",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "pressed",
"type" : "Boolean",
"desc" : "True to start pressed (only if enableToggle = true)",
- "memberOf" : "Roo.Button"
+ "memberOf" : "Roo.Button",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "renderTo",
"type" : "String/HTMLElement/Element",
"desc" : "The element to append the button to",
- "memberOf" : "Roo.Button"
+ "memberOf" : "Roo.Button",
+ "isOptional" : false,
+ "optvals" : []
},
{
"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"
+ "memberOf" : "Roo.Button",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "scope",
"type" : "Object",
"desc" : "The scope of the handler",
- "memberOf" : "Roo.Button"
+ "memberOf" : "Roo.Button",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "tabIndex",
"type" : "Number",
"desc" : "The DOM tabIndex for this button (defaults to undefined)",
- "memberOf" : "Roo.Button"
+ "memberOf" : "Roo.Button",
+ "isOptional" : false,
+ "optvals" : []
},
{
"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"
+ "desc" : "An {@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",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "text",
"type" : "String",
"desc" : "The button text",
- "memberOf" : "Roo.Button"
+ "memberOf" : "Roo.Button",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "toggleGroup",
"type" : "String",
"desc" : "The group this toggle button is a member of (only 1 per group can be pressed, only\n applies if enableToggle = true)",
- "memberOf" : "Roo.Button"
+ "memberOf" : "Roo.Button",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "tooltip",
"type" : "String/Object",
"desc" : "The tooltip for the button - can be a string or QuickTips config object",
- "memberOf" : "Roo.Button"
+ "memberOf" : "Roo.Button",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "tooltipType",
"type" : "String",
"desc" : "The type of tooltip to use. Either \"qtip\" (default) for QuickTips or \"title\" for title attribute.",
- "memberOf" : "Roo.Button"
+ "memberOf" : "Roo.Button",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "type",
"type" : "String",
"desc" : "The button's type, corresponding to the DOM input element type attribute. Either \"submit,\" \"reset\" or \"button\" (default).",
- "memberOf" : "Roo.Button"
+ "memberOf" : "Roo.Button",
+ "isOptional" : false,
+ "optvals" : []
}
],
"events" : [
],
"returns" : []
},
+ {
+ "name" : "setPressed",
+ "type" : "function",
+ "desc" : "Similar to toggle, but does not trigger event.",
+ "sig" : "(state)",
+ "static" : false,
+ "memberOf" : "Roo.Button",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "state",
+ "type" : "Boolean",
+ "desc" : "[required] Force a particular state",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
{
"name" : "setText",
"type" : "function",
],
"isAbstract" : false,
"isBuilderTop" : false,
- "childClasses" : { },
+ "implementations" : [],
"tree_children" : [],
"tree_parent" : []
},
],
"isAbstract" : false,
"isBuilderTop" : false,
- "childClasses" : { },
+ "implementations" : [],
"tree_children" : [],
"tree_parent" : []
},
],
"isAbstract" : false,
"isBuilderTop" : false,
- "childClasses" : {
- "Roo.Toolbar.Spacer" : [
- "Roo.Toolbar.Fill"
- ],
- "Roo.Toolbar.Item" : [
- "Roo.Toolbar.Separator",
- "Roo.Toolbar.Spacer",
- "Roo.Toolbar.TextItem"
- ]
- },
+ "implementations" : [
+ "Roo.Toolbar.Fill",
+ "Roo.Toolbar.Separator",
+ "Roo.Toolbar.Spacer",
+ "Roo.Toolbar.TextItem"
+ ],
"tree_children" : [],
"tree_parent" : []
},
],
"isAbstract" : false,
"isBuilderTop" : false,
- "childClasses" : { },
+ "implementations" : [],
"tree_children" : [],
"tree_parent" : []
},
],
"isAbstract" : false,
"isBuilderTop" : false,
- "childClasses" : {
- "Roo.Toolbar.Spacer" : [
- "Roo.Toolbar.Fill"
- ]
- },
+ "implementations" : [
+ "Roo.Toolbar.Fill"
+ ],
"tree_children" : [],
"tree_parent" : []
},
"name" : "arrowHandler",
"type" : "Function",
"desc" : "A function called when the arrow button is clicked (can be used instead of click event)",
- "memberOf" : "Roo.SplitButton"
+ "memberOf" : "Roo.SplitButton",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "arrowTooltip",
"type" : "String",
"desc" : "The title attribute of the arrow",
- "memberOf" : "Roo.SplitButton"
+ "memberOf" : "Roo.SplitButton",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "clickEvent",
"type" : "String",
"desc" : "The type of event to map to the button's event handler (defaults to 'click')",
- "memberOf" : "Roo.Button"
+ "memberOf" : "Roo.Button",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "cls",
"type" : "String",
"desc" : "A CSS class to apply to the button's main element.",
- "memberOf" : "Roo.Button"
+ "memberOf" : "Roo.Button",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "disabled",
"type" : "Boolean",
"desc" : "True to start disabled (defaults to false)",
- "memberOf" : "Roo.Button"
+ "memberOf" : "Roo.Button",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "enableToggle",
"type" : "Boolean",
"desc" : "True to enable pressed/not pressed toggling (defaults to false)",
- "memberOf" : "Roo.Button"
+ "memberOf" : "Roo.Button",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "handleMouseEvents",
"type" : "Boolean",
"desc" : "False to disable visual cues on mouseover, mouseout and mousedown (defaults to true)",
- "memberOf" : "Roo.Button"
+ "memberOf" : "Roo.Button",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "handler",
"type" : "Function",
"desc" : "A function called when the button is clicked (can be used instead of click event)",
- "memberOf" : "Roo.Button"
+ "memberOf" : "Roo.Button",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "hidden",
"type" : "Boolean",
"desc" : "True to start hidden (defaults to false)",
- "memberOf" : "Roo.Button"
+ "memberOf" : "Roo.Button",
+ "isOptional" : false,
+ "optvals" : []
},
{
"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"
+ "memberOf" : "Roo.Button",
+ "isOptional" : false,
+ "optvals" : []
},
{
"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"
+ "memberOf" : "Roo.Button",
+ "isOptional" : false,
+ "optvals" : []
},
{
"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"
+ "memberOf" : "Roo.util.Observable",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "menu",
"type" : "Roo.menu.Menu",
"desc" : "Standard menu attribute consisting of a reference to a menu object, a menu id or a menu config blob (defaults to undefined).",
- "memberOf" : "Roo.Button"
+ "memberOf" : "Roo.Button",
+ "isOptional" : false,
+ "optvals" : []
},
{
"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"
+ "memberOf" : "Roo.Button",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "minWidth",
"type" : "Number",
"desc" : "The minimum width for this button (used to give a set of buttons a common width)",
- "memberOf" : "Roo.Button"
+ "memberOf" : "Roo.Button",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "pressed",
"type" : "Boolean",
"desc" : "True to start pressed (only if enableToggle = true)",
- "memberOf" : "Roo.Button"
+ "memberOf" : "Roo.Button",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "renderTo",
"type" : "String/HTMLElement/Element",
"desc" : "The element to append the button to",
- "memberOf" : "Roo.Button"
+ "memberOf" : "Roo.Button",
+ "isOptional" : false,
+ "optvals" : []
},
{
"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"
+ "memberOf" : "Roo.Button",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "scope",
"type" : "Object",
"desc" : "The scope of the handler",
- "memberOf" : "Roo.Button"
+ "memberOf" : "Roo.Button",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "tabIndex",
"type" : "Number",
"desc" : "The DOM tabIndex for this button (defaults to undefined)",
- "memberOf" : "Roo.Button"
+ "memberOf" : "Roo.Button",
+ "isOptional" : false,
+ "optvals" : []
},
{
"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"
+ "desc" : "An {@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",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "text",
"type" : "String",
"desc" : "The button text",
- "memberOf" : "Roo.Button"
+ "memberOf" : "Roo.Button",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "toggleGroup",
"type" : "String",
"desc" : "The group this toggle button is a member of (only 1 per group can be pressed, only\n applies if enableToggle = true)",
- "memberOf" : "Roo.Button"
+ "memberOf" : "Roo.Button",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "tooltip",
"type" : "String/Object",
"desc" : "The tooltip for the button - can be a string or QuickTips config object",
- "memberOf" : "Roo.Button"
+ "memberOf" : "Roo.Button",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "tooltipType",
"type" : "String",
"desc" : "The type of tooltip to use. Either \"qtip\" (default) for QuickTips or \"title\" for title attribute.",
- "memberOf" : "Roo.Button"
+ "memberOf" : "Roo.Button",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "type",
"type" : "String",
"desc" : "The button's type, corresponding to the DOM input element type attribute. Either \"submit,\" \"reset\" or \"button\" (default).",
- "memberOf" : "Roo.Button"
+ "memberOf" : "Roo.Button",
+ "isOptional" : false,
+ "optvals" : []
}
],
"events" : [
],
"returns" : []
},
+ {
+ "name" : "setPressed",
+ "type" : "function",
+ "desc" : "Similar to toggle, but does not trigger event.",
+ "sig" : "(state)",
+ "static" : false,
+ "memberOf" : "Roo.Button",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "state",
+ "type" : "Boolean",
+ "desc" : "[required] Force a particular state",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
{
"name" : "setText",
"type" : "function",
],
"isAbstract" : false,
"isBuilderTop" : false,
- "childClasses" : { },
+ "implementations" : [],
"tree_children" : [],
"tree_parent" : []
},
"name" : "text",
"type" : "string",
"desc" : "",
- "memberOf" : "Roo.Toolbar"
+ "memberOf" : "Roo.Toolbar",
+ "isOptional" : false,
+ "optvals" : []
}
],
"events" : [
{
"name" : "hide",
"type" : "function",
- "desc" : "Hides this item.",
+ "desc" : "Hides this button",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.Toolbar.Item",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
{
"name" : "show",
"type" : "function",
- "desc" : "Shows this item.",
+ "desc" : "Shows this button",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.Toolbar.Item",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
],
"isAbstract" : false,
"isBuilderTop" : false,
- "childClasses" : { },
+ "implementations" : [],
"tree_children" : [],
"tree_parent" : []
},
"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"
+ "memberOf" : "Roo.ContentPanel",
+ "isOptional" : false,
+ "optvals" : []
},
{
"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"
+ "memberOf" : "Roo.ContentPanel",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "autoScroll",
"type" : "Boolean",
"desc" : "True to scroll overflow in this panel (use with {@link #fitToFrame})",
- "memberOf" : "Roo.ContentPanel"
+ "memberOf" : "Roo.ContentPanel",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "background",
"type" : "Boolean",
"desc" : "True if the panel should not be activated when it is added (defaults to false)",
- "memberOf" : "Roo.ContentPanel"
+ "memberOf" : "Roo.ContentPanel",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "closable",
"type" : "Boolean",
"desc" : "True if the panel can be closed/removed",
- "memberOf" : "Roo.ContentPanel"
+ "memberOf" : "Roo.ContentPanel",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "content",
"type" : "String",
"desc" : "Raw content to fill content panel with (uses setContent on construction.)",
- "memberOf" : "Roo.ContentPanel"
+ "memberOf" : "Roo.ContentPanel",
+ "isOptional" : false,
+ "optvals" : []
},
{
"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"
+ "memberOf" : "Roo.ContentPanel",
+ "isOptional" : false,
+ "optvals" : []
},
{
"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"
+ "memberOf" : "Roo.ContentPanel",
+ "isOptional" : false,
+ "optvals" : []
},
{
"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"
+ "memberOf" : "Roo.util.Observable",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "loadOnce",
"type" : "Boolean",
"desc" : "When used with {@link #url}, calls {@link #setUrl} with this value",
- "memberOf" : "Roo.ContentPanel"
+ "memberOf" : "Roo.ContentPanel",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "menu",
"type" : "Roo.menu.Menu",
"desc" : "popup menu",
- "memberOf" : "Roo.ContentPanel"
+ "memberOf" : "Roo.ContentPanel",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "params",
"type" : "String|Object",
"desc" : "When used with {@link #url}, calls {@link #setUrl} with this value",
- "memberOf" : "Roo.ContentPanel"
+ "memberOf" : "Roo.ContentPanel",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "region",
"type" : "String",
- "desc" : "[required] (center|north|south|east|west) which region to put this panel on (when used with xtype constructors)",
- "memberOf" : "Roo.ContentPanel"
+ "desc" : "t) which region to put this panel on (when used with xtype constructor",
+ "memberOf" : "Roo.ContentPanel",
+ "isOptional" : false,
+ "optvals" : [
+ "center",
+ "north",
+ "south",
+ "east",
+ "west"
+ ]
},
{
"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"
+ "memberOf" : "Roo.ContentPanel",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "style",
"type" : "String",
"desc" : "Extra style to add to the content panel",
- "memberOf" : "Roo.ContentPanel"
+ "memberOf" : "Roo.ContentPanel",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "title",
"type" : "String",
"desc" : "The title for this panel",
- "memberOf" : "Roo.ContentPanel"
+ "memberOf" : "Roo.ContentPanel",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "toolbar",
"type" : "Roo.Toolbar",
"desc" : "A toolbar for this panel",
- "memberOf" : "Roo.ContentPanel"
+ "memberOf" : "Roo.ContentPanel",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "url",
"type" : "String",
"desc" : "Calls {@link #setUrl} with this value",
- "memberOf" : "Roo.ContentPanel"
+ "memberOf" : "Roo.ContentPanel",
+ "isOptional" : false,
+ "optvals" : []
}
],
"events" : [
],
"isAbstract" : false,
"isBuilderTop" : false,
- "childClasses" : { },
+ "implementations" : [],
"tree_children" : [],
- "tree_parent" : []
+ "tree_parent" : [
+ "Roo.BorderLayout",
+ "Roo.LayoutDialog",
+ "builder"
+ ]
},
"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"
+ "memberOf" : "Roo.util.Observable",
+ "isOptional" : false,
+ "optvals" : []
}
],
"events" : [
],
"isAbstract" : false,
"isBuilderTop" : false,
- "childClasses" : { },
+ "implementations" : [],
"tree_children" : [],
"tree_parent" : []
},
],
"isAbstract" : false,
"isBuilderTop" : false,
- "childClasses" : { },
+ "implementations" : [],
"tree_children" : [],
"tree_parent" : []
},
"methods" : [],
"isAbstract" : false,
"isBuilderTop" : false,
- "childClasses" : { },
+ "implementations" : [],
"tree_children" : [],
"tree_parent" : []
},
"name" : "dataName",
"type" : "String",
"desc" : "the named area of the template to use as the data area\n Works with domtemplates roo-name=\"name\"",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "el",
"type" : "String|Roo.Element",
"desc" : "The container element.",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "emptyText",
"type" : "String",
"desc" : "The empty text to show when nothing is loaded.",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"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"
+ "memberOf" : "Roo.util.Observable",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "multiSelect",
"type" : "Boolean",
"desc" : "Allow multiple selection",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "selectedClass",
"type" : "String",
"desc" : "The css class to add to selected nodes",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "singleSelect",
"type" : "Boolean",
"desc" : "Allow single selection",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "store",
"type" : "Roo.data.Store",
"desc" : "Data store to load data from.",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "text",
"type" : "String",
"desc" : "to display on mask (default Loading)",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "tickable",
"type" : "Boolean",
"desc" : "- selecting",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "toggleSelect",
"type" : "Boolean",
"desc" : "- selecting",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "tpl",
"type" : "String|Roo.Template",
"desc" : "The template used by this View",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
}
],
"events" : [
],
"isAbstract" : false,
"isBuilderTop" : false,
- "childClasses" : {
- "Roo.View" : [
- "Roo.JsonView"
- ]
- },
+ "implementations" : [
+ "Roo.JsonView"
+ ],
"tree_children" : [],
"tree_parent" : []
},
"name" : "disabled",
"type" : "Function|boolean",
"desc" : "If this module is disabled by some rule, return true from the funtion",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"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" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"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"
+ "memberOf" : "Roo.util.Observable",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "name",
"type" : "String",
"desc" : "String to display while loading.",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "order",
"type" : "String",
"desc" : "Used to set the order in which elements are created (usefull for multiple tabs)",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "parent",
"type" : "String",
"desc" : "Name of parent element which it get xtype added to..",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "region",
"type" : "String",
"desc" : "Region to render component to (defaults to center)",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
}
],
"events" : [
],
"isAbstract" : false,
"isBuilderTop" : false,
- "childClasses" : { },
+ "implementations" : [],
"tree_children" : [],
"tree_parent" : []
},
"methods" : [],
"isAbstract" : false,
"isBuilderTop" : false,
- "childClasses" : { },
+ "implementations" : [],
"tree_children" : [],
"tree_parent" : []
},
"name" : "html",
"type" : "String",
"desc" : "The HTML fragment or an array of fragments to join(\"\") or multiple arguments to join(\"\")",
- "memberOf" : "Roo.Template"
+ "memberOf" : "Roo.Template",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "onLoad",
"type" : "Function",
"desc" : "Called after the template has been loaded and complied (usually from a remove source)",
- "memberOf" : "Roo.Template"
+ "memberOf" : "Roo.Template",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "url",
"type" : "String",
"desc" : "The Url to load the template from. beware if you are loading from a url, the data may not be ready if you use it instantly..\n it should be fixed so that template is observable...",
- "memberOf" : "Roo.Template"
+ "memberOf" : "Roo.Template",
+ "isOptional" : false,
+ "optvals" : []
}
],
"events" : [],
],
"isAbstract" : false,
"isBuilderTop" : false,
- "childClasses" : { },
+ "implementations" : [],
"tree_children" : [],
"tree_parent" : []
},
"methods" : [],
"isAbstract" : false,
"isBuilderTop" : false,
- "childClasses" : { },
+ "implementations" : [],
"tree_children" : [],
"tree_parent" : []
},
"name" : "actionMode",
"type" : "String",
"desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el' for forms you probably want to set this to fieldEl",
- "memberOf" : "Roo.Component"
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "allowDomMove",
"type" : "Boolean",
"desc" : "Whether the component can move the Dom node when rendering (defaults to true).",
- "memberOf" : "Roo.Component"
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "can_build_overlaid",
"type" : "Boolean",
"desc" : "True if element can be rebuild from a HTML page",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "close",
"type" : "Boolean",
"desc" : "true to show a x closer",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "cls",
"type" : "String",
"desc" : "css class",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "container_method",
"type" : "string",
"desc" : "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "dataId",
"type" : "string",
"desc" : "cutomer id",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "disableClass",
"type" : "String",
"desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").",
- "memberOf" : "Roo.Component"
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "fa",
"type" : "String",
"desc" : "font-awesomeicon",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "hideMode",
"type" : "String",
- "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".",
- "memberOf" : "Roo.Component"
+ "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display",
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : [
+ "display",
+ "visibility"
+ ]
},
{
"name" : "html",
"type" : "String",
"desc" : "The content of alert",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"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"
+ "memberOf" : "Roo.util.Observable",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "name",
"type" : "string",
"desc" : "Specifies name attribute",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "seconds",
"type" : "Number",
"desc" : "default:-1 Number of seconds until it disapears (-1 means never.)",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "style",
"type" : "String",
"desc" : "any extra css",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "title",
"type" : "String",
"desc" : "The title of alert",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "tooltip",
"type" : "string",
"desc" : "Text for the tooltip",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "visibilityEl",
"type" : "string|object",
- "desc" : "t) What element to use for visibility (@see getVisibilityEl())",
- "memberOf" : "Roo.bootstrap.Component"
+ "desc" : "t) What element to use for visibility (@see getVisibilityEl(",
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : [
+ "el",
+ "parent"
+ ]
},
{
"name" : "weight",
"type" : "String",
- "desc" : "r) Weight of the message",
- "memberOf" : ""
+ "desc" : "r) Weight of the messa",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : [
+ "success",
+ "info",
+ "warning",
+ "danger"
+ ]
},
{
"name" : "xattr",
"type" : "Object",
"desc" : "extra attributes to add to 'element' (used by builder to store stuff.)",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
}
],
"events" : [
],
"isAbstract" : false,
"isBuilderTop" : false,
- "childClasses" : { },
+ "implementations" : [],
"tree_children" : [],
"tree_parent" : []
},
"name" : "Add",
"type" : "integer",
"desc" : "the next point only if the previous one is farther than x pixels. Defaults to 5.",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "Callback",
"type" : "function",
"desc" : "when stroke begin.",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "Color",
"type" : "string",
"desc" : "used to draw the lines. Can be any color format accepted by context.fillStyle. Defaults to \"black\".",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "Draw",
"type" : "integer",
"desc" : "the next point at most once per every x milliseconds. Set it to 0 to turn off throttling. Defaults to 16.",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "Maximum",
"type" : "float",
"desc" : "width of a line. Defaults to 2.5.",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "Minimum",
"type" : "float",
"desc" : "width of a line. Defaults to 0.5.",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "Radius",
"type" : "float|function",
"desc" : "of a single dot.",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "Weight",
"type" : "float",
"desc" : "used to modify new velocity based on the previous velocity. Defaults to 0.7.",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "actionMode",
"type" : "String",
"desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el' for forms you probably want to set this to fieldEl",
- "memberOf" : "Roo.Component"
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "allowDomMove",
"type" : "Boolean",
"desc" : "Whether the component can move the Dom node when rendering (defaults to true).",
- "memberOf" : "Roo.Component"
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "can_build_overlaid",
"type" : "Boolean",
"desc" : "True if element can be rebuild from a HTML page",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "canvas",
"type" : "int",
"desc" : "height",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "cls",
"type" : "String",
"desc" : "css class",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "container_method",
"type" : "string",
"desc" : "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "dataId",
"type" : "string",
"desc" : "cutomer id",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "disableClass",
"type" : "String",
"desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").",
- "memberOf" : "Roo.Component"
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "hideMode",
"type" : "String",
- "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".",
- "memberOf" : "Roo.Component"
+ "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display",
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : [
+ "display",
+ "visibility"
+ ]
},
{
"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"
+ "memberOf" : "Roo.util.Observable",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "name",
"type" : "string",
"desc" : "Specifies name attribute",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "style",
"type" : "String",
"desc" : "any extra css",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "tooltip",
"type" : "string",
"desc" : "Text for the tooltip",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "visibilityEl",
"type" : "string|object",
- "desc" : "t) What element to use for visibility (@see getVisibilityEl())",
- "memberOf" : "Roo.bootstrap.Component"
+ "desc" : "t) What element to use for visibility (@see getVisibilityEl(",
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : [
+ "el",
+ "parent"
+ ]
},
{
"name" : "xattr",
"type" : "Object",
"desc" : "extra attributes to add to 'element' (used by builder to store stuff.)",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
}
],
"events" : [
],
"isAbstract" : false,
"isBuilderTop" : false,
- "childClasses" : { },
+ "implementations" : [],
"tree_children" : [],
"tree_parent" : []
},
"name" : "actionMode",
"type" : "String",
"desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el' for forms you probably want to set this to fieldEl",
- "memberOf" : "Roo.Component"
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "allowDomMove",
"type" : "Boolean",
"desc" : "Whether the component can move the Dom node when rendering (defaults to true).",
- "memberOf" : "Roo.Component"
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "can_build_overlaid",
"type" : "Boolean",
"desc" : "True if element can be rebuild from a HTML page",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "cls",
"type" : "String",
"desc" : "css class",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "container_method",
"type" : "string",
"desc" : "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "dataId",
"type" : "string",
"desc" : "cutomer id",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "disableClass",
"type" : "String",
"desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").",
- "memberOf" : "Roo.Component"
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "hideMode",
"type" : "String",
- "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".",
- "memberOf" : "Roo.Component"
+ "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display",
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : [
+ "display",
+ "visibility"
+ ]
},
{
"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"
+ "memberOf" : "Roo.util.Observable",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "name",
"type" : "string",
"desc" : "Specifies name attribute",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "style",
"type" : "String",
"desc" : "any extra css",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "tooltip",
"type" : "string",
"desc" : "Text for the tooltip",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "visibilityEl",
"type" : "string|object",
- "desc" : "t) What element to use for visibility (@see getVisibilityEl())",
- "memberOf" : "Roo.bootstrap.Component"
+ "desc" : "t) What element to use for visibility (@see getVisibilityEl(",
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : [
+ "el",
+ "parent"
+ ]
},
{
"name" : "xattr",
"type" : "Object",
"desc" : "extra attributes to add to 'element' (used by builder to store stuff.)",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
}
],
"events" : [
}
],
"isAbstract" : false,
- "isBuilderTop" : true,
- "childClasses" : { },
+ "isBuilderTop" : false,
+ "implementations" : [],
"tree_children" : [
"Roo.bootstrap.Alert",
"Roo.bootstrap.BezierSignature",
"Roo.bootstrap.Calendar",
"Roo.bootstrap.Card",
"Roo.bootstrap.Column",
- "Roo.bootstrap.Container",
"Roo.bootstrap.DocumentManager",
"Roo.bootstrap.DocumentSlider",
"Roo.bootstrap.DocumentViewer",
"Roo.bootstrap.form.TextArea",
"Roo.bootstrap.form.TimeField",
"Roo.bootstrap.form.TriggerField",
- "Roo.bootstrap.layout.Border",
"Roo.bootstrap.nav.Group",
"Roo.bootstrap.nav.Headerbar",
"Roo.bootstrap.nav.ProgressBar",
"Roo.bootstrap.nav.Simplebar"
],
"tree_parent" : [
- "none"
+ "none",
+ "builder"
]
},
"Roo.bootstrap.Brick" : {
"name" : "actionMode",
"type" : "String",
"desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el' for forms you probably want to set this to fieldEl",
- "memberOf" : "Roo.Component"
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "allowDomMove",
"type" : "Boolean",
"desc" : "Whether the component can move the Dom node when rendering (defaults to true).",
- "memberOf" : "Roo.Component"
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "bgimage",
"type" : "String",
"desc" : "",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "can_build_overlaid",
"type" : "Boolean",
"desc" : "True if element can be rebuild from a HTML page",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "cls",
"type" : "String",
"desc" : "",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "container_method",
"type" : "string",
"desc" : "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "dataId",
"type" : "string",
"desc" : "cutomer id",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "disableClass",
"type" : "String",
"desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").",
- "memberOf" : "Roo.Component"
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "hideMode",
"type" : "String",
- "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".",
- "memberOf" : "Roo.Component"
+ "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display",
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : [
+ "display",
+ "visibility"
+ ]
},
{
"name" : "href",
"type" : "String",
"desc" : "",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "html",
"type" : "String",
"desc" : "",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"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"
+ "memberOf" : "Roo.util.Observable",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "name",
"type" : "string",
"desc" : "Specifies name attribute",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "square",
"type" : "Boolean",
"desc" : "",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "style",
"type" : "String",
"desc" : "any extra css",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "title",
"type" : "String",
"desc" : "",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "tooltip",
"type" : "string",
"desc" : "Text for the tooltip",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "video",
"type" : "String",
"desc" : "",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "visibilityEl",
"type" : "string|object",
- "desc" : "t) What element to use for visibility (@see getVisibilityEl())",
- "memberOf" : "Roo.bootstrap.Component"
+ "desc" : "t) What element to use for visibility (@see getVisibilityEl(",
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : [
+ "el",
+ "parent"
+ ]
},
{
"name" : "xattr",
"type" : "Object",
"desc" : "extra attributes to add to 'element' (used by builder to store stuff.)",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
}
],
"events" : [
],
"isAbstract" : false,
"isBuilderTop" : false,
- "childClasses" : { },
+ "implementations" : [],
"tree_children" : [],
"tree_parent" : []
},
"name" : "actionMode",
"type" : "String",
"desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el' for forms you probably want to set this to fieldEl",
- "memberOf" : "Roo.Component"
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "allowDomMove",
"type" : "Boolean",
"desc" : "Whether the component can move the Dom node when rendering (defaults to true).",
- "memberOf" : "Roo.Component"
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "badge",
"type" : "String",
"desc" : "text for badge",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "badge_weight",
"type" : "String",
- "desc" : "k) default (same as button)",
- "memberOf" : ""
+ "desc" : "k) default (same as butto",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : [
+ "default",
+ "primary",
+ "secondary",
+ "success",
+ "info",
+ "warning",
+ "danger",
+ "link",
+ "light",
+ "dark"
+ ]
},
{
"name" : "can_build_overlaid",
"type" : "Boolean",
"desc" : "True if element can be rebuild from a HTML page",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "cls",
"type" : "String",
"desc" : "css class",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "container_method",
"type" : "string",
"desc" : "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "dataId",
"type" : "string",
"desc" : "cutomer id",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "disableClass",
"type" : "String",
"desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").",
- "memberOf" : "Roo.Component"
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "disabled",
"type" : "Boolean",
"desc" : "default false;",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "fa",
"type" : "String",
"desc" : "fontawesome icon - eg. 'comment' - without the fa/fas etc..",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "glyphicon",
"type" : "String",
"desc" : "depricated - use fa",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "grpup",
"type" : "Boolean",
"desc" : "if parent is a btn group - then it turns it into a toogleGroup.",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "hideMode",
"type" : "String",
- "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".",
- "memberOf" : "Roo.Component"
+ "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display",
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : [
+ "display",
+ "visibility"
+ ]
},
{
"name" : "href",
"type" : "String",
"desc" : "empty or href",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "html",
"type" : "String",
"desc" : "The button content",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "inverse",
"type" : "Boolean",
"desc" : "dark themed version",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "isClose",
"type" : "Boolean",
"desc" : "default false;",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"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"
+ "memberOf" : "Roo.util.Observable",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "menu",
"type" : "Roo.bootstrap.menu.Menu",
"desc" : "a Menu",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "name",
"type" : "string",
"desc" : "Specifies name attribute",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "offtext",
"type" : "String",
"desc" : "text for off slidy toggle state",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "ontext",
"type" : "String",
"desc" : "text for on slidy toggle state",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "outline",
"type" : "Boolean",
"desc" : "default false (except for weight=default which emulates old behaveiour with an outline)",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "pressed",
"type" : "Boolean",
"desc" : "default null - if the button ahs active state",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "preventDefault",
"type" : "Boolean",
"desc" : "default true (stop click event triggering the URL if it's a link.)",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "removeClass",
"type" : "Boolean",
"desc" : "remove the standard class..",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "size",
"type" : "String",
- "desc" : "s)",
- "memberOf" : ""
+ "desc" : "",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : [
+ "lg",
+ "sm",
+ "xs"
+ ]
},
{
"name" : "style",
"type" : "String",
"desc" : "any extra css",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "tag",
"type" : "String",
- "desc" : "t)",
- "memberOf" : ""
+ "desc" : "",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : [
+ "a",
+ "input",
+ "submit"
+ ]
},
{
"name" : "target",
"type" : "String",
- "desc" : "r) target for a href.",
- "memberOf" : ""
+ "desc" : "r) target for a hre",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : [
+ "_self",
+ "_blank",
+ "_parent",
+ "_top",
+ "other"
+ ]
},
{
"name" : "theme",
"type" : "String",
- "desc" : "w)",
- "memberOf" : ""
+ "desc" : "",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : [
+ "default",
+ "glow"
+ ]
},
{
"name" : "toggle",
"type" : "Boolean",
"desc" : "is it a slidy toggle button",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "tooltip",
"type" : "string",
"desc" : "Text for the tooltip",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "visibilityEl",
"type" : "string|object",
- "desc" : "t) What element to use for visibility (@see getVisibilityEl())",
- "memberOf" : "Roo.bootstrap.Component"
+ "desc" : "t) What element to use for visibility (@see getVisibilityEl(",
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : [
+ "el",
+ "parent"
+ ]
},
{
"name" : "weight",
"type" : "String",
- "desc" : "k) default",
- "memberOf" : ""
+ "desc" : "k) defau",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : [
+ "default",
+ "primary",
+ "secondary",
+ "success",
+ "info",
+ "warning",
+ "danger",
+ "link",
+ "light",
+ "dark"
+ ]
},
{
"name" : "xattr",
"type" : "Object",
"desc" : "extra attributes to add to 'element' (used by builder to store stuff.)",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
}
],
"events" : [
],
"isAbstract" : false,
"isBuilderTop" : false,
- "childClasses" : {
- "Roo.bootstrap.Button" : [
- "Roo.bootstrap.ButtonUploader",
- "Roo.bootstrap.form.CardUploader"
- ]
- },
+ "implementations" : [
+ "Roo.bootstrap.ButtonUploader",
+ "Roo.bootstrap.form.CardUploader"
+ ],
"tree_children" : [],
"tree_parent" : []
},
"name" : "actionMode",
"type" : "String",
"desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el' for forms you probably want to set this to fieldEl",
- "memberOf" : "Roo.Component"
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "align",
"type" : "String",
"desc" : "vertical | justified (default none)",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "allowDomMove",
"type" : "Boolean",
"desc" : "Whether the component can move the Dom node when rendering (defaults to true).",
- "memberOf" : "Roo.Component"
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "btn",
"type" : "Boolean",
"desc" : "true | false",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "can_build_overlaid",
"type" : "Boolean",
"desc" : "True if element can be rebuild from a HTML page",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "cls",
"type" : "String",
"desc" : "css class",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "container_method",
"type" : "string",
"desc" : "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "dataId",
"type" : "string",
"desc" : "cutomer id",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "direction",
"type" : "String",
"desc" : "up | down (default down)",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "disableClass",
"type" : "String",
"desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").",
- "memberOf" : "Roo.Component"
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "hideMode",
"type" : "String",
- "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".",
- "memberOf" : "Roo.Component"
+ "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display",
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : [
+ "display",
+ "visibility"
+ ]
},
{
"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"
+ "memberOf" : "Roo.util.Observable",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "name",
"type" : "string",
"desc" : "Specifies name attribute",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "size",
"type" : "String",
"desc" : "lg | sm | xs (default empty normal)",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "style",
"type" : "String",
"desc" : "any extra css",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "toolbar",
"type" : "Boolean",
"desc" : "false | true",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "tooltip",
"type" : "string",
"desc" : "Text for the tooltip",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "visibilityEl",
"type" : "string|object",
- "desc" : "t) What element to use for visibility (@see getVisibilityEl())",
- "memberOf" : "Roo.bootstrap.Component"
+ "desc" : "t) What element to use for visibility (@see getVisibilityEl(",
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : [
+ "el",
+ "parent"
+ ]
},
{
"name" : "xattr",
"type" : "Object",
"desc" : "extra attributes to add to 'element' (used by builder to store stuff.)",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
}
],
"events" : [
],
"isAbstract" : false,
"isBuilderTop" : false,
- "childClasses" : { },
+ "implementations" : [],
"tree_children" : [
"Roo.bootstrap.Button",
"Roo.bootstrap.ButtonUploader",
"name" : "actionMode",
"type" : "String",
"desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el' for forms you probably want to set this to fieldEl",
- "memberOf" : "Roo.Component"
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "allowDomMove",
"type" : "Boolean",
"desc" : "Whether the component can move the Dom node when rendering (defaults to true).",
- "memberOf" : "Roo.Component"
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "badge",
"type" : "String",
"desc" : "text for badge",
- "memberOf" : "Roo.bootstrap.Button"
+ "memberOf" : "Roo.bootstrap.Button",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "badge_weight",
"type" : "String",
- "desc" : "k) default (same as button)",
- "memberOf" : "Roo.bootstrap.Button"
+ "desc" : "k) default (same as butto",
+ "memberOf" : "Roo.bootstrap.Button",
+ "isOptional" : false,
+ "optvals" : [
+ "default",
+ "primary",
+ "secondary",
+ "success",
+ "info",
+ "warning",
+ "danger",
+ "link",
+ "light",
+ "dark"
+ ]
},
{
"name" : "can_build_overlaid",
"type" : "Boolean",
"desc" : "True if element can be rebuild from a HTML page",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "cls",
"type" : "String",
"desc" : "css class",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "container_method",
"type" : "string",
"desc" : "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "dataId",
"type" : "string",
"desc" : "cutomer id",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "disableClass",
"type" : "String",
"desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").",
- "memberOf" : "Roo.Component"
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "disabled",
"type" : "Boolean",
"desc" : "default false;",
- "memberOf" : "Roo.bootstrap.Button"
+ "memberOf" : "Roo.bootstrap.Button",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "errorTimeout",
"type" : "Number",
"desc" : "default 3000",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "fa",
"type" : "String",
"desc" : "fontawesome icon - eg. 'comment' - without the fa/fas etc..",
- "memberOf" : "Roo.bootstrap.Button"
+ "memberOf" : "Roo.bootstrap.Button",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "glyphicon",
"type" : "String",
"desc" : "depricated - use fa",
- "memberOf" : "Roo.bootstrap.Button"
+ "memberOf" : "Roo.bootstrap.Button",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "grpup",
"type" : "Boolean",
"desc" : "if parent is a btn group - then it turns it into a toogleGroup.",
- "memberOf" : "Roo.bootstrap.Button"
+ "memberOf" : "Roo.bootstrap.Button",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "hideMode",
"type" : "String",
- "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".",
- "memberOf" : "Roo.Component"
+ "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display",
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : [
+ "display",
+ "visibility"
+ ]
},
{
"name" : "href",
"type" : "String",
"desc" : "empty or href",
- "memberOf" : "Roo.bootstrap.Button"
+ "memberOf" : "Roo.bootstrap.Button",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "html",
"type" : "Array",
"desc" : "The button text.",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "images",
"type" : "Array",
"desc" : "an array of ?? Img objects ??? when loading existing files..",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "inverse",
"type" : "Boolean",
"desc" : "dark themed version",
- "memberOf" : "Roo.bootstrap.Button"
+ "memberOf" : "Roo.bootstrap.Button",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "isClose",
"type" : "Boolean",
"desc" : "default false;",
- "memberOf" : "Roo.bootstrap.Button"
+ "memberOf" : "Roo.bootstrap.Button",
+ "isOptional" : false,
+ "optvals" : []
},
{
"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"
+ "memberOf" : "Roo.util.Observable",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "menu",
"type" : "Roo.bootstrap.menu.Menu",
"desc" : "a Menu",
- "memberOf" : "Roo.bootstrap.Button"
+ "memberOf" : "Roo.bootstrap.Button",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "multiple",
"type" : "Boolean",
"desc" : "(default true) Should the upload allow multiple files to be uploaded.",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "name",
"type" : "string",
"desc" : "Specifies name attribute",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "offtext",
"type" : "String",
"desc" : "text for off slidy toggle state",
- "memberOf" : "Roo.bootstrap.Button"
+ "memberOf" : "Roo.bootstrap.Button",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "ontext",
"type" : "String",
"desc" : "text for on slidy toggle state",
- "memberOf" : "Roo.bootstrap.Button"
+ "memberOf" : "Roo.bootstrap.Button",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "outline",
"type" : "Boolean",
"desc" : "default false (except for weight=default which emulates old behaveiour with an outline)",
- "memberOf" : "Roo.bootstrap.Button"
+ "memberOf" : "Roo.bootstrap.Button",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "pressed",
"type" : "Boolean",
"desc" : "default null - if the button ahs active state",
- "memberOf" : "Roo.bootstrap.Button"
+ "memberOf" : "Roo.bootstrap.Button",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "preventDefault",
"type" : "Boolean",
"desc" : "default true (stop click event triggering the URL if it's a link.)",
- "memberOf" : "Roo.bootstrap.Button"
+ "memberOf" : "Roo.bootstrap.Button",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "removeClass",
"type" : "Boolean",
"desc" : "remove the standard class..",
- "memberOf" : "Roo.bootstrap.Button"
+ "memberOf" : "Roo.bootstrap.Button",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "size",
"type" : "String",
- "desc" : "s)",
- "memberOf" : "Roo.bootstrap.Button"
+ "desc" : "",
+ "memberOf" : "Roo.bootstrap.Button",
+ "isOptional" : false,
+ "optvals" : [
+ "lg",
+ "sm",
+ "xs"
+ ]
},
{
"name" : "style",
"type" : "String",
"desc" : "any extra css",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "tag",
"type" : "String",
- "desc" : "t)",
- "memberOf" : "Roo.bootstrap.Button"
+ "desc" : "",
+ "memberOf" : "Roo.bootstrap.Button",
+ "isOptional" : false,
+ "optvals" : [
+ "a",
+ "input",
+ "submit"
+ ]
},
{
"name" : "target",
"type" : "String",
- "desc" : "r) target for a href.",
- "memberOf" : "Roo.bootstrap.Button"
+ "desc" : "r) target for a hre",
+ "memberOf" : "Roo.bootstrap.Button",
+ "isOptional" : false,
+ "optvals" : [
+ "_self",
+ "_blank",
+ "_parent",
+ "_top",
+ "other"
+ ]
},
{
"name" : "theme",
"type" : "String",
- "desc" : "w)",
- "memberOf" : "Roo.bootstrap.Button"
+ "desc" : "",
+ "memberOf" : "Roo.bootstrap.Button",
+ "isOptional" : false,
+ "optvals" : [
+ "default",
+ "glow"
+ ]
},
{
"name" : "toggle",
"type" : "Boolean",
"desc" : "is it a slidy toggle button",
- "memberOf" : "Roo.bootstrap.Button"
+ "memberOf" : "Roo.bootstrap.Button",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "tooltip",
"type" : "string",
"desc" : "Text for the tooltip",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "visibilityEl",
"type" : "string|object",
- "desc" : "t) What element to use for visibility (@see getVisibilityEl())",
- "memberOf" : "Roo.bootstrap.Component"
+ "desc" : "t) What element to use for visibility (@see getVisibilityEl(",
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : [
+ "el",
+ "parent"
+ ]
},
{
"name" : "weight",
"type" : "String",
- "desc" : "k) default",
- "memberOf" : "Roo.bootstrap.Button"
+ "desc" : "k) defau",
+ "memberOf" : "Roo.bootstrap.Button",
+ "isOptional" : false,
+ "optvals" : [
+ "default",
+ "primary",
+ "secondary",
+ "success",
+ "info",
+ "warning",
+ "danger",
+ "link",
+ "light",
+ "dark"
+ ]
},
{
"name" : "xattr",
"type" : "Object",
"desc" : "extra attributes to add to 'element' (used by builder to store stuff.)",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
}
],
"events" : [
],
"isAbstract" : false,
"isBuilderTop" : false,
- "childClasses" : { },
+ "implementations" : [],
"tree_children" : [],
"tree_parent" : []
},
"name" : "actionMode",
"type" : "String",
"desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el' for forms you probably want to set this to fieldEl",
- "memberOf" : "Roo.Component"
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "allowDomMove",
"type" : "Boolean",
"desc" : "Whether the component can move the Dom node when rendering (defaults to true).",
- "memberOf" : "Roo.Component"
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "can_build_overlaid",
"type" : "Boolean",
"desc" : "True if element can be rebuild from a HTML page",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "cls",
"type" : "String",
"desc" : "css class",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "container_method",
"type" : "string",
"desc" : "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "dataId",
"type" : "string",
"desc" : "cutomer id",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "disableClass",
"type" : "String",
"desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").",
- "memberOf" : "Roo.Component"
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "header",
"type" : "Object",
"desc" : "generate the user specific header of the calendar, default false",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "hideMode",
"type" : "String",
- "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".",
- "memberOf" : "Roo.Component"
+ "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display",
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : [
+ "display",
+ "visibility"
+ ]
},
{
"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"
+ "memberOf" : "Roo.util.Observable",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "loadMask",
"type" : "Boolean",
- "desc" : "e) default false",
- "memberOf" : ""
+ "desc" : "e) default fal",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : [
+ "true",
+ "false"
+ ]
},
{
"name" : "name",
"type" : "string",
"desc" : "Specifies name attribute",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "startDay",
"type" : "Number",
"desc" : "Day index at which the week should begin, 0-based (defaults to 0, which is Sunday)",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "store",
"type" : "Roo.data.Store",
"desc" : "The data source for the calendar",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "style",
"type" : "String",
"desc" : "any extra css",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "tooltip",
"type" : "string",
"desc" : "Text for the tooltip",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "visibilityEl",
"type" : "string|object",
- "desc" : "t) What element to use for visibility (@see getVisibilityEl())",
- "memberOf" : "Roo.bootstrap.Component"
+ "desc" : "t) What element to use for visibility (@see getVisibilityEl(",
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : [
+ "el",
+ "parent"
+ ]
},
{
"name" : "xattr",
"type" : "Object",
"desc" : "extra attributes to add to 'element' (used by builder to store stuff.)",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
}
],
"events" : [
],
"isAbstract" : false,
"isBuilderTop" : false,
- "childClasses" : { },
+ "implementations" : [],
"tree_children" : [],
"tree_parent" : []
},
"name" : "actionMode",
"type" : "String",
"desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el' for forms you probably want to set this to fieldEl",
- "memberOf" : "Roo.Component"
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "allowDomMove",
"type" : "Boolean",
"desc" : "Whether the component can move the Dom node when rendering (defaults to true).",
- "memberOf" : "Roo.Component"
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "can_build_overlaid",
"type" : "Boolean",
"desc" : "True if element can be rebuild from a HTML page",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "cls",
"type" : "String",
"desc" : "css class",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "container_method",
"type" : "string",
"desc" : "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "dataId",
"type" : "string",
"desc" : "cutomer id",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "disableClass",
"type" : "String",
"desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").",
- "memberOf" : "Roo.Component"
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "display",
"type" : "String",
- "desc" : "x)",
- "memberOf" : ""
+ "desc" : "",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : [
+ "none",
+ "inline",
+ "inline-block",
+ "block",
+ "table",
+ "table-cell",
+ "table-row",
+ "flex",
+ "inline-flex"
+ ]
},
{
"name" : "display_lg",
"type" : "String",
- "desc" : "x)",
- "memberOf" : ""
+ "desc" : "",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : [
+ "none",
+ "inline",
+ "inline-block",
+ "block",
+ "table",
+ "table-cell",
+ "table-row",
+ "flex",
+ "inline-flex"
+ ]
},
{
"name" : "display_sm",
"type" : "String",
- "desc" : "x)",
- "memberOf" : ""
+ "desc" : "",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : [
+ "none",
+ "inline",
+ "inline-block",
+ "block",
+ "table",
+ "table-cell",
+ "table-row",
+ "flex",
+ "inline-flex"
+ ]
},
{
"name" : "display_xl",
"type" : "String",
- "desc" : "x)",
- "memberOf" : ""
+ "desc" : "",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : [
+ "none",
+ "inline",
+ "inline-block",
+ "block",
+ "table",
+ "table-cell",
+ "table-row",
+ "flex",
+ "inline-flex"
+ ]
},
{
"name" : "display_xs",
"type" : "String",
- "desc" : "x)",
- "memberOf" : ""
+ "desc" : "",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : [
+ "none",
+ "inline",
+ "inline-block",
+ "block",
+ "table",
+ "table-cell",
+ "table-row",
+ "flex",
+ "inline-flex"
+ ]
},
{
"name" : "footer",
"type" : "String",
"desc" : "",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "header",
"type" : "String|Object",
"desc" : "",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "header_image",
"type" : "String",
"desc" : "src url of image.",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "header_size",
"type" : "Number",
- "desc" : "5) H1 or H2 etc.. 0 indicates default",
- "memberOf" : ""
+ "desc" : "5) H1 or H2 etc.. 0 indicates defau",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : [
+ "0",
+ "1",
+ "2",
+ "3",
+ "4",
+ "5"
+ ]
},
{
"name" : "header_weight",
"type" : "Number",
- "desc" : "k)",
- "memberOf" : ""
+ "desc" : "",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : [
+ "primary",
+ "secondary",
+ "success",
+ "info",
+ "warning",
+ "danger",
+ "light",
+ "dark"
+ ]
},
{
"name" : "hideMode",
"type" : "String",
- "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".",
- "memberOf" : "Roo.Component"
+ "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display",
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : [
+ "display",
+ "visibility"
+ ]
},
{
"name" : "html",
"type" : "String|Boolean",
"desc" : "-- html contents - or just use children.. use false to hide it..",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"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"
+ "memberOf" : "Roo.util.Observable",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "margin",
"type" : "String",
- "desc" : "o)",
- "memberOf" : ""
+ "desc" : "",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : [
+ "0",
+ "1",
+ "2",
+ "3",
+ "4",
+ "5",
+ "auto"
+ ]
},
{
"name" : "margin_bottom",
"type" : "String",
- "desc" : "o)",
- "memberOf" : ""
+ "desc" : "",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : [
+ "0",
+ "1",
+ "2",
+ "3",
+ "4",
+ "5",
+ "auto"
+ ]
},
{
"name" : "margin_left",
"type" : "String",
- "desc" : "o)",
- "memberOf" : ""
+ "desc" : "",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : [
+ "0",
+ "1",
+ "2",
+ "3",
+ "4",
+ "5",
+ "auto"
+ ]
},
{
"name" : "margin_right",
"type" : "String",
- "desc" : "o)",
- "memberOf" : ""
+ "desc" : "",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : [
+ "0",
+ "1",
+ "2",
+ "3",
+ "4",
+ "5",
+ "auto"
+ ]
},
{
"name" : "margin_top",
"type" : "String",
- "desc" : "o)",
- "memberOf" : ""
+ "desc" : "",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : [
+ "0",
+ "1",
+ "2",
+ "3",
+ "4",
+ "5",
+ "auto"
+ ]
},
{
"name" : "margin_x",
"type" : "String",
- "desc" : "o)",
- "memberOf" : ""
+ "desc" : "",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : [
+ "0",
+ "1",
+ "2",
+ "3",
+ "4",
+ "5",
+ "auto"
+ ]
},
{
"name" : "margin_y",
"type" : "String",
- "desc" : "o)",
- "memberOf" : ""
+ "desc" : "",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : [
+ "0",
+ "1",
+ "2",
+ "3",
+ "4",
+ "5",
+ "auto"
+ ]
},
{
"name" : "name",
"type" : "string",
"desc" : "Specifies name attribute",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "padding",
"type" : "String",
- "desc" : "5)",
- "memberOf" : ""
+ "desc" : "",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : [
+ "0",
+ "1",
+ "2",
+ "3",
+ "4",
+ "5"
+ ]
},
{
"name" : "padding_bottom",
"type" : "String",
- "desc" : "5)",
- "memberOf" : ""
+ "desc" : "",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : [
+ "0",
+ "1",
+ "2",
+ "3",
+ "4",
+ "5"
+ ]
},
{
"name" : "padding_left",
"type" : "String",
- "desc" : "5)",
- "memberOf" : ""
+ "desc" : "",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : [
+ "0",
+ "1",
+ "2",
+ "3",
+ "4",
+ "5"
+ ]
},
{
"name" : "padding_right",
"type" : "String",
- "desc" : "5)",
- "memberOf" : ""
+ "desc" : "",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : [
+ "0",
+ "1",
+ "2",
+ "3",
+ "4",
+ "5"
+ ]
},
{
"name" : "padding_top",
"type" : "String",
- "desc" : "5)next_to_card",
- "memberOf" : ""
+ "desc" : "5)next_to_ca",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : [
+ "0",
+ "1",
+ "2",
+ "3",
+ "4",
+ "5"
+ ]
},
{
"name" : "padding_x",
"type" : "String",
- "desc" : "5)",
- "memberOf" : ""
+ "desc" : "",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : [
+ "0",
+ "1",
+ "2",
+ "3",
+ "4",
+ "5"
+ ]
},
{
"name" : "padding_y",
"type" : "String",
- "desc" : "5)",
- "memberOf" : ""
+ "desc" : "",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : [
+ "0",
+ "1",
+ "2",
+ "3",
+ "4",
+ "5"
+ ]
},
{
"name" : "style",
"type" : "String",
"desc" : "any extra css",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "subtitle",
"type" : "String",
"desc" : "",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "title",
"type" : "String",
"desc" : "",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "tooltip",
"type" : "string",
"desc" : "Text for the tooltip",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "visibilityEl",
"type" : "string|object",
- "desc" : "t) What element to use for visibility (@see getVisibilityEl())",
- "memberOf" : "Roo.bootstrap.Component"
+ "desc" : "t) What element to use for visibility (@see getVisibilityEl(",
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : [
+ "el",
+ "parent"
+ ]
},
{
"name" : "weight",
"type" : "String",
- "desc" : "k)",
- "memberOf" : ""
+ "desc" : "",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : [
+ "primary",
+ "warning",
+ "info",
+ "danger",
+ "secondary",
+ "success",
+ "light",
+ "dark"
+ ]
},
{
"name" : "xattr",
"type" : "Object",
"desc" : "extra attributes to add to 'element' (used by builder to store stuff.)",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
}
],
"events" : [
],
"isAbstract" : false,
"isBuilderTop" : false,
- "childClasses" : { },
+ "implementations" : [],
"tree_children" : [
"Roo.bootstrap.Alert",
"Roo.bootstrap.BezierSignature",
"Roo.bootstrap.CardHeader",
"Roo.bootstrap.CardImageTop",
"Roo.bootstrap.Column",
- "Roo.bootstrap.Container",
"Roo.bootstrap.DocumentManager",
"Roo.bootstrap.DocumentSlider",
"Roo.bootstrap.DocumentViewer",
"Roo.bootstrap.form.TextArea",
"Roo.bootstrap.form.TimeField",
"Roo.bootstrap.form.TriggerField",
- "Roo.bootstrap.layout.Border",
"Roo.bootstrap.nav.Group",
"Roo.bootstrap.nav.Headerbar",
"Roo.bootstrap.nav.ProgressBar",
"name" : "actionMode",
"type" : "String",
"desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el' for forms you probably want to set this to fieldEl",
- "memberOf" : "Roo.Component"
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "allowDomMove",
"type" : "Boolean",
"desc" : "Whether the component can move the Dom node when rendering (defaults to true).",
- "memberOf" : "Roo.Component"
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "can_build_overlaid",
"type" : "Boolean",
"desc" : "True if element can be rebuild from a HTML page",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "clickable",
"type" : "Boolean",
- "desc" : "e) default false",
- "memberOf" : "Roo.bootstrap.Element"
+ "desc" : "e) default fal",
+ "memberOf" : "Roo.bootstrap.Element",
+ "isOptional" : false,
+ "optvals" : [
+ "true",
+ "false"
+ ]
},
{
"name" : "cls",
"type" : "String",
"desc" : "class of the element",
- "memberOf" : "Roo.bootstrap.Element"
+ "memberOf" : "Roo.bootstrap.Element",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "container_method",
"type" : "string",
"desc" : "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "dataId",
"type" : "string",
"desc" : "cutomer id",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "disableClass",
"type" : "String",
"desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").",
- "memberOf" : "Roo.Component"
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "hideMode",
"type" : "String",
- "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".",
- "memberOf" : "Roo.Component"
+ "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display",
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : [
+ "display",
+ "visibility"
+ ]
},
{
"name" : "html",
"type" : "String",
"desc" : "contents of the element",
- "memberOf" : "Roo.bootstrap.Element"
+ "memberOf" : "Roo.bootstrap.Element",
+ "isOptional" : false,
+ "optvals" : []
},
{
"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"
+ "memberOf" : "Roo.util.Observable",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "name",
"type" : "string",
"desc" : "Specifies name attribute",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "preventDefault",
"type" : "Boolean",
- "desc" : "e) default false",
- "memberOf" : "Roo.bootstrap.Element"
+ "desc" : "e) default fal",
+ "memberOf" : "Roo.bootstrap.Element",
+ "isOptional" : false,
+ "optvals" : [
+ "true",
+ "false"
+ ]
},
{
"name" : "role",
"type" : "String",
"desc" : "default blank - set to button to force cursor pointer",
- "memberOf" : "Roo.bootstrap.Element"
+ "memberOf" : "Roo.bootstrap.Element",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "style",
"type" : "String",
"desc" : "any extra css",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "tag",
"type" : "String",
"desc" : "tag of the element",
- "memberOf" : "Roo.bootstrap.Element"
+ "memberOf" : "Roo.bootstrap.Element",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "tooltip",
"type" : "string",
"desc" : "Text for the tooltip",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "visibilityEl",
"type" : "string|object",
- "desc" : "t) What element to use for visibility (@see getVisibilityEl())",
- "memberOf" : "Roo.bootstrap.Component"
+ "desc" : "t) What element to use for visibility (@see getVisibilityEl(",
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : [
+ "el",
+ "parent"
+ ]
},
{
"name" : "xattr",
"type" : "Object",
"desc" : "extra attributes to add to 'element' (used by builder to store stuff.)",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
}
],
"events" : [
],
"isAbstract" : false,
"isBuilderTop" : false,
- "childClasses" : { },
+ "implementations" : [],
"tree_children" : [
"Roo.bootstrap.Alert",
"Roo.bootstrap.BezierSignature",
"Roo.bootstrap.Calendar",
"Roo.bootstrap.Card",
"Roo.bootstrap.Column",
- "Roo.bootstrap.Container",
"Roo.bootstrap.DocumentManager",
"Roo.bootstrap.DocumentSlider",
"Roo.bootstrap.DocumentViewer",
"Roo.bootstrap.form.TextArea",
"Roo.bootstrap.form.TimeField",
"Roo.bootstrap.form.TriggerField",
- "Roo.bootstrap.layout.Border",
"Roo.bootstrap.nav.Group",
"Roo.bootstrap.nav.Headerbar",
"Roo.bootstrap.nav.ProgressBar",
"name" : "actionMode",
"type" : "String",
"desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el' for forms you probably want to set this to fieldEl",
- "memberOf" : "Roo.Component"
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "allowDomMove",
"type" : "Boolean",
"desc" : "Whether the component can move the Dom node when rendering (defaults to true).",
- "memberOf" : "Roo.Component"
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "can_build_overlaid",
"type" : "Boolean",
"desc" : "True if element can be rebuild from a HTML page",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "clickable",
"type" : "Boolean",
- "desc" : "e) default false",
- "memberOf" : "Roo.bootstrap.Element"
+ "desc" : "e) default fal",
+ "memberOf" : "Roo.bootstrap.Element",
+ "isOptional" : false,
+ "optvals" : [
+ "true",
+ "false"
+ ]
},
{
"name" : "cls",
"type" : "String",
"desc" : "class of the element",
- "memberOf" : "Roo.bootstrap.Element"
+ "memberOf" : "Roo.bootstrap.Element",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "container_method",
"type" : "string",
"desc" : "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "dataId",
"type" : "string",
"desc" : "cutomer id",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "disableClass",
"type" : "String",
"desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").",
- "memberOf" : "Roo.Component"
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "hideMode",
"type" : "String",
- "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".",
- "memberOf" : "Roo.Component"
+ "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display",
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : [
+ "display",
+ "visibility"
+ ]
},
{
"name" : "html",
"type" : "String",
"desc" : "contents of the element",
- "memberOf" : "Roo.bootstrap.Element"
+ "memberOf" : "Roo.bootstrap.Element",
+ "isOptional" : false,
+ "optvals" : []
},
{
"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"
+ "memberOf" : "Roo.util.Observable",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "name",
"type" : "string",
"desc" : "Specifies name attribute",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "preventDefault",
"type" : "Boolean",
- "desc" : "e) default false",
- "memberOf" : "Roo.bootstrap.Element"
+ "desc" : "e) default fal",
+ "memberOf" : "Roo.bootstrap.Element",
+ "isOptional" : false,
+ "optvals" : [
+ "true",
+ "false"
+ ]
},
{
"name" : "role",
"type" : "String",
"desc" : "default blank - set to button to force cursor pointer",
- "memberOf" : "Roo.bootstrap.Element"
+ "memberOf" : "Roo.bootstrap.Element",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "style",
"type" : "String",
"desc" : "any extra css",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "tag",
"type" : "String",
"desc" : "tag of the element",
- "memberOf" : "Roo.bootstrap.Element"
+ "memberOf" : "Roo.bootstrap.Element",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "tooltip",
"type" : "string",
"desc" : "Text for the tooltip",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "visibilityEl",
"type" : "string|object",
- "desc" : "t) What element to use for visibility (@see getVisibilityEl())",
- "memberOf" : "Roo.bootstrap.Component"
+ "desc" : "t) What element to use for visibility (@see getVisibilityEl(",
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : [
+ "el",
+ "parent"
+ ]
},
{
"name" : "xattr",
"type" : "Object",
"desc" : "extra attributes to add to 'element' (used by builder to store stuff.)",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
}
],
"events" : [
],
"isAbstract" : false,
"isBuilderTop" : false,
- "childClasses" : { },
+ "implementations" : [],
"tree_children" : [
"Roo.bootstrap.Alert",
"Roo.bootstrap.BezierSignature",
"Roo.bootstrap.Calendar",
"Roo.bootstrap.Card",
"Roo.bootstrap.Column",
- "Roo.bootstrap.Container",
"Roo.bootstrap.DocumentManager",
"Roo.bootstrap.DocumentSlider",
"Roo.bootstrap.DocumentViewer",
"Roo.bootstrap.form.TextArea",
"Roo.bootstrap.form.TimeField",
"Roo.bootstrap.form.TriggerField",
- "Roo.bootstrap.layout.Border",
"Roo.bootstrap.nav.Group",
"Roo.bootstrap.nav.Headerbar",
"Roo.bootstrap.nav.ProgressBar",
"name" : "actionMode",
"type" : "String",
"desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el' for forms you probably want to set this to fieldEl",
- "memberOf" : "Roo.Component"
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "allowDomMove",
"type" : "Boolean",
"desc" : "Whether the component can move the Dom node when rendering (defaults to true).",
- "memberOf" : "Roo.Component"
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "can_build_overlaid",
"type" : "Boolean",
"desc" : "True if element can be rebuild from a HTML page",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "clickable",
"type" : "Boolean",
- "desc" : "e) default false",
- "memberOf" : "Roo.bootstrap.Element"
+ "desc" : "e) default fal",
+ "memberOf" : "Roo.bootstrap.Element",
+ "isOptional" : false,
+ "optvals" : [
+ "true",
+ "false"
+ ]
},
{
"name" : "cls",
"type" : "String",
"desc" : "class of the element",
- "memberOf" : "Roo.bootstrap.Element"
+ "memberOf" : "Roo.bootstrap.Element",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "container_method",
"type" : "string",
"desc" : "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "dataId",
"type" : "string",
"desc" : "cutomer id",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "disableClass",
"type" : "String",
"desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").",
- "memberOf" : "Roo.Component"
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "hideMode",
"type" : "String",
- "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".",
- "memberOf" : "Roo.Component"
+ "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display",
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : [
+ "display",
+ "visibility"
+ ]
},
{
"name" : "html",
"type" : "String",
"desc" : "contents of the element",
- "memberOf" : "Roo.bootstrap.Element"
+ "memberOf" : "Roo.bootstrap.Element",
+ "isOptional" : false,
+ "optvals" : []
},
{
"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"
+ "memberOf" : "Roo.util.Observable",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "name",
"type" : "string",
"desc" : "Specifies name attribute",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "preventDefault",
"type" : "Boolean",
- "desc" : "e) default false",
- "memberOf" : "Roo.bootstrap.Element"
+ "desc" : "e) default fal",
+ "memberOf" : "Roo.bootstrap.Element",
+ "isOptional" : false,
+ "optvals" : [
+ "true",
+ "false"
+ ]
},
{
"name" : "role",
"type" : "String",
"desc" : "default blank - set to button to force cursor pointer",
- "memberOf" : "Roo.bootstrap.Element"
+ "memberOf" : "Roo.bootstrap.Element",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "style",
"type" : "String",
"desc" : "any extra css",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "tag",
"type" : "String",
"desc" : "tag of the element",
- "memberOf" : "Roo.bootstrap.Element"
+ "memberOf" : "Roo.bootstrap.Element",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "tooltip",
"type" : "string",
"desc" : "Text for the tooltip",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "visibilityEl",
"type" : "string|object",
- "desc" : "t) What element to use for visibility (@see getVisibilityEl())",
- "memberOf" : "Roo.bootstrap.Component"
+ "desc" : "t) What element to use for visibility (@see getVisibilityEl(",
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : [
+ "el",
+ "parent"
+ ]
},
{
"name" : "xattr",
"type" : "Object",
"desc" : "extra attributes to add to 'element' (used by builder to store stuff.)",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
}
],
"events" : [
],
"isAbstract" : false,
"isBuilderTop" : false,
- "childClasses" : { },
+ "implementations" : [],
"tree_children" : [
"Roo.bootstrap.Alert",
"Roo.bootstrap.BezierSignature",
"Roo.bootstrap.Calendar",
"Roo.bootstrap.Card",
"Roo.bootstrap.Column",
- "Roo.bootstrap.Container",
"Roo.bootstrap.DocumentManager",
"Roo.bootstrap.DocumentSlider",
"Roo.bootstrap.DocumentViewer",
"Roo.bootstrap.form.TextArea",
"Roo.bootstrap.form.TimeField",
"Roo.bootstrap.form.TriggerField",
- "Roo.bootstrap.layout.Border",
"Roo.bootstrap.nav.Group",
"Roo.bootstrap.nav.Headerbar",
"Roo.bootstrap.nav.ProgressBar",
"name" : "actionMode",
"type" : "String",
"desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el' for forms you probably want to set this to fieldEl",
- "memberOf" : "Roo.Component"
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "alert",
"type" : "String",
- "desc" : "r) type alert (changes background / border...)",
- "memberOf" : ""
+ "desc" : "r) type alert (changes background / border..",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : [
+ "success",
+ "info",
+ "warning",
+ "danger"
+ ]
},
{
"name" : "allowDomMove",
"type" : "Boolean",
"desc" : "Whether the component can move the Dom node when rendering (defaults to true).",
- "memberOf" : "Roo.Component"
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "can_build_overlaid",
"type" : "Boolean",
"desc" : "True if element can be rebuild from a HTML page",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "cls",
"type" : "String",
"desc" : "css class",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "container_method",
"type" : "string",
"desc" : "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "dataId",
"type" : "string",
"desc" : "cutomer id",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "disableClass",
"type" : "String",
"desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").",
- "memberOf" : "Roo.Component"
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "fa",
"type" : "String",
- "desc" : ".) font awesome icon",
- "memberOf" : ""
+ "desc" : ".) font awesome ic",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : [
+ "ban",
+ "check",
+ "..."
+ ]
},
{
"name" : "fasize",
"type" : "Number",
- "desc" : ".) font awsome size",
- "memberOf" : ""
+ "desc" : ".) font awsome si",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : [
+ "1",
+ "2",
+ "...."
+ ]
},
{
"name" : "hidden",
"type" : "Boolean",
- "desc" : "e) hide the element",
- "memberOf" : ""
+ "desc" : "e) hide the eleme",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : [
+ "true",
+ "false"
+ ]
},
{
"name" : "hideMode",
"type" : "String",
- "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".",
- "memberOf" : "Roo.Component"
+ "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display",
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : [
+ "display",
+ "visibility"
+ ]
},
{
"name" : "html",
"type" : "String",
"desc" : "content of column.",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "icon",
"type" : "String",
- "desc" : ".) glyphicon name",
- "memberOf" : ""
+ "desc" : ".) glyphicon na",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : [
+ "info-sign",
+ "check",
+ "..."
+ ]
},
{
"name" : "lg",
"type" : "Number",
"desc" : "colspan out of 12 for large computer-sized screens or 0 for hidden",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "lgoff",
"type" : "Number",
"desc" : "colspan offset out of 12 for large computer-sized screens or 0 for hidden",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"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"
+ "memberOf" : "Roo.util.Observable",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "md",
"type" : "Number",
"desc" : "colspan out of 12 for computer-sized screens or 0 for hidden",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "mdoff",
"type" : "Number",
"desc" : "colspan offset out of 12 for computer-sized screens or 0 for hidden",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "name",
"type" : "string",
"desc" : "Specifies name attribute",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "sm",
"type" : "Number",
"desc" : "colspan out of 12 for tablet-sized screens or 0 for hidden",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "smoff",
"type" : "Number",
"desc" : "colspan offset out of 12 for tablet-sized screens or 0 for hidden",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "style",
"type" : "String",
"desc" : "any extra css",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "tooltip",
"type" : "string",
"desc" : "Text for the tooltip",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "visibilityEl",
"type" : "string|object",
- "desc" : "t) What element to use for visibility (@see getVisibilityEl())",
- "memberOf" : "Roo.bootstrap.Component"
+ "desc" : "t) What element to use for visibility (@see getVisibilityEl(",
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : [
+ "el",
+ "parent"
+ ]
},
{
"name" : "xattr",
"type" : "Object",
"desc" : "extra attributes to add to 'element' (used by builder to store stuff.)",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "xs",
"type" : "Number",
"desc" : "colspan out of 12 for mobile-sized screens or 0 for hidden",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "xsoff",
"type" : "Number",
"desc" : "colspan offset out of 12 for mobile-sized screens or 0 for hidden",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
}
],
"events" : [
],
"isAbstract" : false,
"isBuilderTop" : false,
- "childClasses" : {
- "Roo.bootstrap.Column" : [
- "Roo.bootstrap.TabGroup"
- ]
- },
+ "implementations" : [
+ "Roo.bootstrap.TabGroup"
+ ],
"tree_children" : [
"Roo.bootstrap.Alert",
"Roo.bootstrap.BezierSignature",
"Roo.bootstrap.Calendar",
"Roo.bootstrap.Card",
"Roo.bootstrap.Column",
- "Roo.bootstrap.Container",
"Roo.bootstrap.DocumentManager",
"Roo.bootstrap.DocumentSlider",
"Roo.bootstrap.DocumentViewer",
"Roo.bootstrap.form.TextArea",
"Roo.bootstrap.form.TimeField",
"Roo.bootstrap.form.TriggerField",
- "Roo.bootstrap.layout.Border",
"Roo.bootstrap.nav.Group",
"Roo.bootstrap.nav.Headerbar",
"Roo.bootstrap.nav.ProgressBar",
"name" : "actionMode",
"type" : "String",
"desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el' for forms you probably want to set this to fieldEl",
- "memberOf" : "Roo.Component"
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "allowDomMove",
"type" : "Boolean",
"desc" : "Whether the component can move the Dom node when rendering (defaults to true).",
- "memberOf" : "Roo.Component"
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "can_build_overlaid",
"type" : "Boolean",
"desc" : "True if element can be rebuild from a HTML page",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "cls",
"type" : "String",
"desc" : "css class",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "container_method",
"type" : "string",
"desc" : "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "dataId",
"type" : "string",
"desc" : "cutomer id",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "disableClass",
"type" : "String",
"desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").",
- "memberOf" : "Roo.Component"
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "hideMode",
"type" : "String",
- "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".",
- "memberOf" : "Roo.Component"
+ "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display",
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : [
+ "display",
+ "visibility"
+ ]
},
{
"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"
+ "memberOf" : "Roo.util.Observable",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "name",
"type" : "string",
"desc" : "Specifies name attribute",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "style",
"type" : "String",
"desc" : "any extra css",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "tooltip",
"type" : "string",
"desc" : "Text for the tooltip",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "visibilityEl",
"type" : "string|object",
- "desc" : "t) What element to use for visibility (@see getVisibilityEl())",
- "memberOf" : ""
+ "desc" : "t) What element to use for visibility (@see getVisibilityEl(",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : [
+ "el",
+ "parent"
+ ]
},
{
"name" : "xattr",
"type" : "Object",
"desc" : "extra attributes to add to 'element' (used by builder to store stuff.)",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
}
],
"events" : [
],
"isAbstract" : true,
"isBuilderTop" : false,
- "childClasses" : {
- "Roo.bootstrap.nav.Bar" : [
- "Roo.bootstrap.nav.Sidebar",
- "Roo.bootstrap.nav.Simplebar"
- ],
- "Roo.bootstrap.nav.Simplebar" : [
- "Roo.bootstrap.PagingToolbar",
- "Roo.bootstrap.PopoverNav",
- "Roo.bootstrap.form.HtmlEditorToolbarStandard",
- "Roo.bootstrap.nav.Headerbar"
- ],
- "Roo.bootstrap.Button" : [
- "Roo.bootstrap.ButtonUploader",
- "Roo.bootstrap.form.CardUploader"
- ],
- "Roo.bootstrap.Column" : [
- "Roo.bootstrap.TabGroup"
- ],
- "Roo.bootstrap.form.TriggerField" : [
- "Roo.bootstrap.form.ComboBox",
- "Roo.bootstrap.form.PhoneInput"
- ],
- "Roo.bootstrap.form.TextArea" : [
- "Roo.bootstrap.form.HtmlEditor",
- "Roo.bootstrap.form.Markdown"
- ],
- "Roo.bootstrap.layout.Manager" : [
- "Roo.bootstrap.layout.Border"
- ],
- "Roo.bootstrap.Element" : [
- "Roo.bootstrap.CardFooter",
- "Roo.bootstrap.CardHeader",
- "Roo.bootstrap.CardImageTop",
- "Roo.bootstrap.DropTarget"
- ],
- "Roo.bootstrap.nav.Item" : [
- "Roo.bootstrap.nav.SidebarItem"
- ],
- "Roo.bootstrap.Component" : [
- "Roo.bootstrap.Alert",
- "Roo.bootstrap.BezierSignature",
- "Roo.bootstrap.Body",
- "Roo.bootstrap.Brick",
- "Roo.bootstrap.Button",
- "Roo.bootstrap.ButtonGroup",
- "Roo.bootstrap.Calendar",
- "Roo.bootstrap.Card",
- "Roo.bootstrap.Column",
- "Roo.bootstrap.Container",
- "Roo.bootstrap.DocumentManager",
- "Roo.bootstrap.DocumentSlider",
- "Roo.bootstrap.DocumentViewer",
- "Roo.bootstrap.Element",
- "Roo.bootstrap.Graph",
- "Roo.bootstrap.Header",
- "Roo.bootstrap.Img",
- "Roo.bootstrap.LayoutMasonry",
- "Roo.bootstrap.LayoutMasonryAuto",
- "Roo.bootstrap.Link",
- "Roo.bootstrap.LocationPicker",
- "Roo.bootstrap.MasonryBrick",
- "Roo.bootstrap.MessageBar",
- "Roo.bootstrap.Modal",
- "Roo.bootstrap.Pagination",
- "Roo.bootstrap.PaginationItem",
- "Roo.bootstrap.Popover",
- "Roo.bootstrap.Progress",
- "Roo.bootstrap.ProgressBar",
- "Roo.bootstrap.Row",
- "Roo.bootstrap.Slider",
- "Roo.bootstrap.TabPanel",
- "Roo.bootstrap.Table",
- "Roo.bootstrap.TableBody",
- "Roo.bootstrap.TableCell",
- "Roo.bootstrap.TableRow",
- "Roo.bootstrap.UploadCropbox",
- "Roo.bootstrap.breadcrumb.Item",
- "Roo.bootstrap.breadcrumb.Nav",
- "Roo.bootstrap.dash.NumberBox",
- "Roo.bootstrap.dash.TabBox",
- "Roo.bootstrap.dash.TabPane",
- "Roo.bootstrap.form.DateSplitField",
- "Roo.bootstrap.form.FieldLabel",
- "Roo.bootstrap.form.Form",
- "Roo.bootstrap.form.Input",
- "Roo.bootstrap.form.Radio",
- "Roo.bootstrap.layout.Manager",
- "Roo.bootstrap.menu.Item",
- "Roo.bootstrap.menu.Menu",
- "Roo.bootstrap.menu.Separator",
- "Roo.bootstrap.nav.Bar",
- "Roo.bootstrap.nav.Group",
- "Roo.bootstrap.nav.Item",
- "Roo.bootstrap.nav.ProgressBar",
- "Roo.bootstrap.nav.ProgressBarItem"
- ],
- "Roo.bootstrap.form.ComboBox" : [
- "Roo.bootstrap.form.MoneyField"
- ],
- "Roo.bootstrap.form.Input" : [
- "Roo.bootstrap.form.CheckBox",
- "Roo.bootstrap.form.DateField",
- "Roo.bootstrap.form.MonthField",
- "Roo.bootstrap.form.NumberField",
- "Roo.bootstrap.form.RadioSet",
- "Roo.bootstrap.form.SecurePass",
- "Roo.bootstrap.form.TextArea",
- "Roo.bootstrap.form.TimeField",
- "Roo.bootstrap.form.TriggerField"
- ]
- },
- "tree_children" : [
+ "implementations" : [
"Roo.bootstrap.Alert",
"Roo.bootstrap.BezierSignature",
+ "Roo.bootstrap.Body",
"Roo.bootstrap.Brick",
"Roo.bootstrap.Button",
"Roo.bootstrap.ButtonGroup",
"Roo.bootstrap.ButtonUploader",
"Roo.bootstrap.Calendar",
"Roo.bootstrap.Card",
+ "Roo.bootstrap.CardFooter",
+ "Roo.bootstrap.CardHeader",
+ "Roo.bootstrap.CardImageTop",
"Roo.bootstrap.Column",
"Roo.bootstrap.Container",
"Roo.bootstrap.DocumentManager",
"Roo.bootstrap.LocationPicker",
"Roo.bootstrap.MasonryBrick",
"Roo.bootstrap.MessageBar",
+ "Roo.bootstrap.Modal",
"Roo.bootstrap.Pagination",
"Roo.bootstrap.PaginationItem",
"Roo.bootstrap.PagingToolbar",
+ "Roo.bootstrap.Popover",
+ "Roo.bootstrap.PopoverNav",
"Roo.bootstrap.Progress",
"Roo.bootstrap.ProgressBar",
"Roo.bootstrap.Row",
"Roo.bootstrap.TabGroup",
"Roo.bootstrap.TabPanel",
"Roo.bootstrap.Table",
+ "Roo.bootstrap.TableBody",
+ "Roo.bootstrap.TableCell",
+ "Roo.bootstrap.TableRow",
"Roo.bootstrap.UploadCropbox",
+ "Roo.bootstrap.breadcrumb.Item",
"Roo.bootstrap.breadcrumb.Nav",
"Roo.bootstrap.dash.NumberBox",
"Roo.bootstrap.dash.TabBox",
"Roo.bootstrap.form.FieldLabel",
"Roo.bootstrap.form.Form",
"Roo.bootstrap.form.HtmlEditor",
+ "Roo.bootstrap.form.HtmlEditorToolbarStandard",
"Roo.bootstrap.form.Input",
"Roo.bootstrap.form.Markdown",
"Roo.bootstrap.form.MoneyField",
"Roo.bootstrap.form.TimeField",
"Roo.bootstrap.form.TriggerField",
"Roo.bootstrap.layout.Border",
+ "Roo.bootstrap.layout.Manager",
+ "Roo.bootstrap.menu.Item",
+ "Roo.bootstrap.menu.Menu",
+ "Roo.bootstrap.menu.Separator",
+ "Roo.bootstrap.nav.Bar",
+ "Roo.bootstrap.nav.Group",
+ "Roo.bootstrap.nav.Headerbar",
+ "Roo.bootstrap.nav.Item",
+ "Roo.bootstrap.nav.ProgressBar",
+ "Roo.bootstrap.nav.ProgressBarItem",
+ "Roo.bootstrap.nav.Sidebar",
+ "Roo.bootstrap.nav.SidebarItem",
+ "Roo.bootstrap.nav.Simplebar"
+ ],
+ "tree_children" : [
+ "Roo.bootstrap.Alert",
+ "Roo.bootstrap.BezierSignature",
+ "Roo.bootstrap.Brick",
+ "Roo.bootstrap.Button",
+ "Roo.bootstrap.ButtonGroup",
+ "Roo.bootstrap.ButtonUploader",
+ "Roo.bootstrap.Calendar",
+ "Roo.bootstrap.Card",
+ "Roo.bootstrap.Column",
+ "Roo.bootstrap.DocumentManager",
+ "Roo.bootstrap.DocumentSlider",
+ "Roo.bootstrap.DocumentViewer",
+ "Roo.bootstrap.DropTarget",
+ "Roo.bootstrap.Element",
+ "Roo.bootstrap.Graph",
+ "Roo.bootstrap.Header",
+ "Roo.bootstrap.Img",
+ "Roo.bootstrap.LayoutMasonry",
+ "Roo.bootstrap.LayoutMasonryAuto",
+ "Roo.bootstrap.Link",
+ "Roo.bootstrap.LocationPicker",
+ "Roo.bootstrap.MasonryBrick",
+ "Roo.bootstrap.MessageBar",
+ "Roo.bootstrap.Pagination",
+ "Roo.bootstrap.PaginationItem",
+ "Roo.bootstrap.PagingToolbar",
+ "Roo.bootstrap.Progress",
+ "Roo.bootstrap.ProgressBar",
+ "Roo.bootstrap.Row",
+ "Roo.bootstrap.Slider",
+ "Roo.bootstrap.TabGroup",
+ "Roo.bootstrap.TabPanel",
+ "Roo.bootstrap.Table",
+ "Roo.bootstrap.UploadCropbox",
+ "Roo.bootstrap.breadcrumb.Nav",
+ "Roo.bootstrap.dash.NumberBox",
+ "Roo.bootstrap.dash.TabBox",
+ "Roo.bootstrap.dash.TabPane",
+ "Roo.bootstrap.form.CardUploader",
+ "Roo.bootstrap.form.CheckBox",
+ "Roo.bootstrap.form.ComboBox",
+ "Roo.bootstrap.form.DateField",
+ "Roo.bootstrap.form.DateSplitField",
+ "Roo.bootstrap.form.FieldLabel",
+ "Roo.bootstrap.form.Form",
+ "Roo.bootstrap.form.HtmlEditor",
+ "Roo.bootstrap.form.Input",
+ "Roo.bootstrap.form.Markdown",
+ "Roo.bootstrap.form.MoneyField",
+ "Roo.bootstrap.form.MonthField",
+ "Roo.bootstrap.form.NumberField",
+ "Roo.bootstrap.form.PhoneInput",
+ "Roo.bootstrap.form.Radio",
+ "Roo.bootstrap.form.RadioSet",
+ "Roo.bootstrap.form.SecurePass",
+ "Roo.bootstrap.form.TextArea",
+ "Roo.bootstrap.form.TimeField",
+ "Roo.bootstrap.form.TriggerField",
"Roo.bootstrap.nav.Group",
"Roo.bootstrap.nav.Headerbar",
"Roo.bootstrap.nav.ProgressBar",
"name" : "actionMode",
"type" : "String",
"desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el' for forms you probably want to set this to fieldEl",
- "memberOf" : "Roo.Component"
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "alert",
"type" : "String",
- "desc" : "r) type alert (changes background / border...)",
- "memberOf" : ""
+ "desc" : "r) type alert (changes background / border..",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : [
+ "success",
+ "info",
+ "warning",
+ "danger"
+ ]
},
{
"name" : "allowDomMove",
"type" : "Boolean",
"desc" : "Whether the component can move the Dom node when rendering (defaults to true).",
- "memberOf" : "Roo.Component"
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "can_build_overlaid",
"type" : "Boolean",
"desc" : "True if element can be rebuild from a HTML page",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "clickable",
"type" : "Boolean",
- "desc" : "e) default false",
- "memberOf" : ""
+ "desc" : "e) default fal",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : [
+ "true",
+ "false"
+ ]
},
{
"name" : "cls",
"type" : "String",
"desc" : "css class",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "container_method",
"type" : "string",
"desc" : "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "dataId",
"type" : "string",
"desc" : "cutomer id",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "disableClass",
"type" : "String",
"desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").",
- "memberOf" : "Roo.Component"
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "expandable",
"type" : "Boolean",
- "desc" : "e) default false",
- "memberOf" : ""
+ "desc" : "e) default fal",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : [
+ "true",
+ "false"
+ ]
},
{
"name" : "expanded",
"type" : "Boolean",
- "desc" : "e) default true",
- "memberOf" : ""
+ "desc" : "e) default tr",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : [
+ "true",
+ "false"
+ ]
},
{
"name" : "fa",
"type" : "String",
"desc" : "font awesome icon",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "footer",
"type" : "String",
"desc" : "content of footer (for panel)",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "header",
"type" : "String",
"desc" : "content of header (for panel)",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "hidden",
"type" : "Boolean",
- "desc" : "e) hide the element",
- "memberOf" : ""
+ "desc" : "e) hide the eleme",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : [
+ "true",
+ "false"
+ ]
},
{
"name" : "hideMode",
"type" : "String",
- "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".",
- "memberOf" : "Roo.Component"
+ "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display",
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : [
+ "display",
+ "visibility"
+ ]
},
{
"name" : "html",
"type" : "String",
"desc" : "content of element",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "icon",
"type" : "String",
- "desc" : ".) glyphicon name",
- "memberOf" : ""
+ "desc" : ".) glyphicon na",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : [
+ "info-sign",
+ "check",
+ "..."
+ ]
},
{
"name" : "jumbotron",
"type" : "Boolean",
"desc" : "is it a jumbotron element",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"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"
+ "memberOf" : "Roo.util.Observable",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "name",
"type" : "string",
"desc" : "Specifies name attribute",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "panel",
"type" : "String",
- "desc" : "r) render as panel - type - primary/success.....",
- "memberOf" : ""
+ "desc" : "r) render as panel - type - primary/success...",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : [
+ "default",
+ "primary",
+ "success",
+ "info",
+ "warning",
+ "danger"
+ ]
},
{
"name" : "rheader",
"type" : "String",
"desc" : "contet on the right of header",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "sticky",
"type" : "String",
- "desc" : "h) block to use as footer or body- needs css-bootstrap/sticky-footer.css",
- "memberOf" : ""
+ "desc" : "h) block to use as footer or body- needs css-bootstrap/sticky-footer.c",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : [
+ "footer",
+ "wrap",
+ "push"
+ ]
},
{
"name" : "style",
"type" : "String",
"desc" : "any extra css",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "tag",
"type" : "String",
- "desc" : "n) type of HTML tag.",
- "memberOf" : ""
+ "desc" : "n) type of HTML ta",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : [
+ "header",
+ "aside",
+ "section"
+ ]
},
{
"name" : "tooltip",
"type" : "string",
"desc" : "Text for the tooltip",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "visibilityEl",
"type" : "string|object",
- "desc" : "t) What element to use for visibility (@see getVisibilityEl())",
- "memberOf" : "Roo.bootstrap.Component"
+ "desc" : "t) What element to use for visibility (@see getVisibilityEl(",
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : [
+ "el",
+ "parent"
+ ]
},
{
"name" : "well",
"type" : "String",
- "desc" : "d) a well, large, small or medium.",
- "memberOf" : ""
+ "desc" : "d) a well, large, small or mediu",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : [
+ "lg",
+ "sm",
+ "md"
+ ]
},
{
"name" : "xattr",
"type" : "Object",
"desc" : "extra attributes to add to 'element' (used by builder to store stuff.)",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
}
],
"events" : [
}
],
"isAbstract" : false,
- "isBuilderTop" : true,
- "childClasses" : { },
+ "isBuilderTop" : false,
+ "implementations" : [],
"tree_children" : [
"Roo.bootstrap.Alert",
"Roo.bootstrap.BezierSignature",
"Roo.bootstrap.Calendar",
"Roo.bootstrap.Card",
"Roo.bootstrap.Column",
- "Roo.bootstrap.Container",
"Roo.bootstrap.DocumentManager",
"Roo.bootstrap.DocumentSlider",
"Roo.bootstrap.DocumentViewer",
"Roo.bootstrap.form.TextArea",
"Roo.bootstrap.form.TimeField",
"Roo.bootstrap.form.TriggerField",
- "Roo.bootstrap.layout.Border",
"Roo.bootstrap.nav.Group",
"Roo.bootstrap.nav.Headerbar",
"Roo.bootstrap.nav.ProgressBar",
"Roo.bootstrap.nav.SidebarItem",
"Roo.bootstrap.nav.Simplebar"
],
- "tree_parent" : []
+ "tree_parent" : [
+ "builder"
+ ]
},
"Roo.bootstrap.DocumentManager" : {
"props" : [
"name" : "actionMode",
"type" : "String",
"desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el' for forms you probably want to set this to fieldEl",
- "memberOf" : "Roo.Component"
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "allowDomMove",
"type" : "Boolean",
"desc" : "Whether the component can move the Dom node when rendering (defaults to true).",
- "memberOf" : "Roo.Component"
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "boxes",
"type" : "Number",
"desc" : "number of boxes, 0 is no limit.. default 0",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "can_build_overlaid",
"type" : "Boolean",
"desc" : "True if element can be rebuild from a HTML page",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "cls",
"type" : "String",
"desc" : "css class",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "container_method",
"type" : "string",
"desc" : "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "dataId",
"type" : "string",
"desc" : "cutomer id",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "disableClass",
"type" : "String",
"desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").",
- "memberOf" : "Roo.Component"
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "editable",
"type" : "Boolean",
- "desc" : "e) allow edit when upload a image default true",
- "memberOf" : ""
+ "desc" : "e) allow edit when upload a image default tr",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : [
+ "true",
+ "false"
+ ]
},
{
"name" : "fieldLabel",
"type" : "String",
"desc" : "",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "hideMode",
"type" : "String",
- "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".",
- "memberOf" : "Roo.Component"
+ "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display",
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : [
+ "display",
+ "visibility"
+ ]
},
{
"name" : "labelAlign",
"type" : "String",
- "desc" : "p) default left",
- "memberOf" : ""
+ "desc" : "p) default le",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : [
+ "left",
+ "top"
+ ]
},
{
"name" : "labelWidth",
"type" : "Number",
"desc" : "default 4",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "labellg",
"type" : "Number",
"desc" : "set the width of label (1-12)",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "labelmd",
"type" : "Number",
"desc" : "set the width of label (1-12)",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "labelsm",
"type" : "Number",
"desc" : "set the width of label (1-12)",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "labelxs",
"type" : "Number",
"desc" : "set the width of label (1-12)",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"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"
+ "memberOf" : "Roo.util.Observable",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "method",
"type" : "String",
"desc" : "default POST",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "multiple",
"type" : "Boolean",
"desc" : "multiple upload default true",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "name",
"type" : "string",
"desc" : "Specifies name attribute",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "paramName",
"type" : "String",
"desc" : "default 'imageUpload'",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "style",
"type" : "String",
"desc" : "any extra css",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "thumbSize",
"type" : "Number",
"desc" : "default 300",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "toolTipName",
"type" : "String",
"desc" : "default 'filename'",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "tooltip",
"type" : "string",
"desc" : "Text for the tooltip",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "url",
"type" : "String",
"desc" : "action url",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "visibilityEl",
"type" : "string|object",
- "desc" : "t) What element to use for visibility (@see getVisibilityEl())",
- "memberOf" : "Roo.bootstrap.Component"
+ "desc" : "t) What element to use for visibility (@see getVisibilityEl(",
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : [
+ "el",
+ "parent"
+ ]
},
{
"name" : "xattr",
"type" : "Object",
"desc" : "extra attributes to add to 'element' (used by builder to store stuff.)",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
}
],
"events" : [
],
"isAbstract" : false,
"isBuilderTop" : false,
- "childClasses" : { },
+ "implementations" : [],
"tree_children" : [],
"tree_parent" : []
},
"name" : "actionMode",
"type" : "String",
"desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el' for forms you probably want to set this to fieldEl",
- "memberOf" : "Roo.Component"
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "allowDomMove",
"type" : "Boolean",
"desc" : "Whether the component can move the Dom node when rendering (defaults to true).",
- "memberOf" : "Roo.Component"
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "can_build_overlaid",
"type" : "Boolean",
"desc" : "True if element can be rebuild from a HTML page",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "cls",
"type" : "String",
"desc" : "css class",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "container_method",
"type" : "string",
"desc" : "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "dataId",
"type" : "string",
"desc" : "cutomer id",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "disableClass",
"type" : "String",
"desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").",
- "memberOf" : "Roo.Component"
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "hideMode",
"type" : "String",
- "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".",
- "memberOf" : "Roo.Component"
+ "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display",
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : [
+ "display",
+ "visibility"
+ ]
},
{
"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"
+ "memberOf" : "Roo.util.Observable",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "name",
"type" : "string",
"desc" : "Specifies name attribute",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "style",
"type" : "String",
"desc" : "any extra css",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "tooltip",
"type" : "string",
"desc" : "Text for the tooltip",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "visibilityEl",
"type" : "string|object",
- "desc" : "t) What element to use for visibility (@see getVisibilityEl())",
- "memberOf" : "Roo.bootstrap.Component"
+ "desc" : "t) What element to use for visibility (@see getVisibilityEl(",
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : [
+ "el",
+ "parent"
+ ]
},
{
"name" : "xattr",
"type" : "Object",
"desc" : "extra attributes to add to 'element' (used by builder to store stuff.)",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
}
],
"events" : [
],
"isAbstract" : false,
"isBuilderTop" : false,
- "childClasses" : { },
+ "implementations" : [],
"tree_children" : [],
"tree_parent" : []
},
"name" : "actionMode",
"type" : "String",
"desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el' for forms you probably want to set this to fieldEl",
- "memberOf" : "Roo.Component"
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "allowDomMove",
"type" : "Boolean",
"desc" : "Whether the component can move the Dom node when rendering (defaults to true).",
- "memberOf" : "Roo.Component"
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "can_build_overlaid",
"type" : "Boolean",
"desc" : "True if element can be rebuild from a HTML page",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "cls",
"type" : "String",
"desc" : "css class",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "container_method",
"type" : "string",
"desc" : "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "dataId",
"type" : "string",
"desc" : "cutomer id",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "disableClass",
"type" : "String",
"desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").",
- "memberOf" : "Roo.Component"
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "hideMode",
"type" : "String",
- "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".",
- "memberOf" : "Roo.Component"
+ "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display",
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : [
+ "display",
+ "visibility"
+ ]
},
{
"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"
+ "memberOf" : "Roo.util.Observable",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "name",
"type" : "string",
"desc" : "Specifies name attribute",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "showDownload",
"type" : "Boolean",
- "desc" : "e) show download button (default true)",
- "memberOf" : ""
+ "desc" : "e) show download button (default tru",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : [
+ "true",
+ "false"
+ ]
},
{
"name" : "showTrash",
"type" : "Boolean",
- "desc" : "e) show trash button (default true)",
- "memberOf" : ""
+ "desc" : "e) show trash button (default tru",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : [
+ "true",
+ "false"
+ ]
},
{
"name" : "style",
"type" : "String",
"desc" : "any extra css",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "tooltip",
"type" : "string",
"desc" : "Text for the tooltip",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "visibilityEl",
"type" : "string|object",
- "desc" : "t) What element to use for visibility (@see getVisibilityEl())",
- "memberOf" : "Roo.bootstrap.Component"
+ "desc" : "t) What element to use for visibility (@see getVisibilityEl(",
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : [
+ "el",
+ "parent"
+ ]
},
{
"name" : "xattr",
"type" : "Object",
"desc" : "extra attributes to add to 'element' (used by builder to store stuff.)",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
}
],
"events" : [
],
"isAbstract" : false,
"isBuilderTop" : false,
- "childClasses" : { },
+ "implementations" : [],
"tree_children" : [],
"tree_parent" : []
},
"name" : "actionMode",
"type" : "String",
"desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el' for forms you probably want to set this to fieldEl",
- "memberOf" : "Roo.Component"
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "allowDomMove",
"type" : "Boolean",
"desc" : "Whether the component can move the Dom node when rendering (defaults to true).",
- "memberOf" : "Roo.Component"
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "can_build_overlaid",
"type" : "Boolean",
"desc" : "True if element can be rebuild from a HTML page",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "clickable",
"type" : "Boolean",
- "desc" : "e) default false",
- "memberOf" : "Roo.bootstrap.Element"
+ "desc" : "e) default fal",
+ "memberOf" : "Roo.bootstrap.Element",
+ "isOptional" : false,
+ "optvals" : [
+ "true",
+ "false"
+ ]
},
{
"name" : "cls",
"type" : "String",
"desc" : "class of the element",
- "memberOf" : "Roo.bootstrap.Element"
+ "memberOf" : "Roo.bootstrap.Element",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "container_method",
"type" : "string",
"desc" : "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "dataId",
"type" : "string",
"desc" : "cutomer id",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "disableClass",
"type" : "String",
"desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").",
- "memberOf" : "Roo.Component"
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "hideMode",
"type" : "String",
- "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".",
- "memberOf" : "Roo.Component"
+ "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display",
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : [
+ "display",
+ "visibility"
+ ]
},
{
"name" : "html",
"type" : "String",
"desc" : "contents of the element",
- "memberOf" : "Roo.bootstrap.Element"
+ "memberOf" : "Roo.bootstrap.Element",
+ "isOptional" : false,
+ "optvals" : []
},
{
"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"
+ "memberOf" : "Roo.util.Observable",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "name",
"type" : "string",
"desc" : "dropable name",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "preventDefault",
"type" : "Boolean",
- "desc" : "e) default false",
- "memberOf" : "Roo.bootstrap.Element"
+ "desc" : "e) default fal",
+ "memberOf" : "Roo.bootstrap.Element",
+ "isOptional" : false,
+ "optvals" : [
+ "true",
+ "false"
+ ]
},
{
"name" : "role",
"type" : "String",
"desc" : "default blank - set to button to force cursor pointer",
- "memberOf" : "Roo.bootstrap.Element"
+ "memberOf" : "Roo.bootstrap.Element",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "style",
"type" : "String",
"desc" : "any extra css",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "tag",
"type" : "String",
"desc" : "tag of the element",
- "memberOf" : "Roo.bootstrap.Element"
+ "memberOf" : "Roo.bootstrap.Element",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "tooltip",
"type" : "string",
"desc" : "Text for the tooltip",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "visibilityEl",
"type" : "string|object",
- "desc" : "t) What element to use for visibility (@see getVisibilityEl())",
- "memberOf" : "Roo.bootstrap.Component"
+ "desc" : "t) What element to use for visibility (@see getVisibilityEl(",
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : [
+ "el",
+ "parent"
+ ]
},
{
"name" : "xattr",
"type" : "Object",
"desc" : "extra attributes to add to 'element' (used by builder to store stuff.)",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
}
],
"events" : [
],
"isAbstract" : false,
"isBuilderTop" : false,
- "childClasses" : { },
+ "implementations" : [],
"tree_children" : [],
"tree_parent" : []
},
"name" : "actionMode",
"type" : "String",
"desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el' for forms you probably want to set this to fieldEl",
- "memberOf" : "Roo.Component"
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "allowDomMove",
"type" : "Boolean",
"desc" : "Whether the component can move the Dom node when rendering (defaults to true).",
- "memberOf" : "Roo.Component"
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "can_build_overlaid",
"type" : "Boolean",
"desc" : "True if element can be rebuild from a HTML page",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "clickable",
"type" : "Boolean",
- "desc" : "e) default false",
- "memberOf" : ""
+ "desc" : "e) default fal",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : [
+ "true",
+ "false"
+ ]
},
{
"name" : "cls",
"type" : "String",
"desc" : "class of the element",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "container_method",
"type" : "string",
"desc" : "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "dataId",
"type" : "string",
"desc" : "cutomer id",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "disableClass",
"type" : "String",
"desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").",
- "memberOf" : "Roo.Component"
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "hideMode",
"type" : "String",
- "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".",
- "memberOf" : "Roo.Component"
+ "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display",
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : [
+ "display",
+ "visibility"
+ ]
},
{
"name" : "html",
"type" : "String",
"desc" : "contents of the element",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"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"
+ "memberOf" : "Roo.util.Observable",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "name",
"type" : "string",
"desc" : "Specifies name attribute",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "preventDefault",
"type" : "Boolean",
- "desc" : "e) default false",
- "memberOf" : ""
+ "desc" : "e) default fal",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : [
+ "true",
+ "false"
+ ]
},
{
"name" : "role",
"type" : "String",
"desc" : "default blank - set to button to force cursor pointer",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "style",
"type" : "String",
"desc" : "any extra css",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "tag",
"type" : "String",
"desc" : "tag of the element",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "tooltip",
"type" : "string",
"desc" : "Text for the tooltip",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "visibilityEl",
"type" : "string|object",
- "desc" : "t) What element to use for visibility (@see getVisibilityEl())",
- "memberOf" : "Roo.bootstrap.Component"
+ "desc" : "t) What element to use for visibility (@see getVisibilityEl(",
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : [
+ "el",
+ "parent"
+ ]
},
{
"name" : "xattr",
"type" : "Object",
"desc" : "extra attributes to add to 'element' (used by builder to store stuff.)",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
}
],
"events" : [
],
"isAbstract" : false,
"isBuilderTop" : false,
- "childClasses" : {
- "Roo.bootstrap.Element" : [
- "Roo.bootstrap.CardFooter",
- "Roo.bootstrap.CardHeader",
- "Roo.bootstrap.CardImageTop",
- "Roo.bootstrap.DropTarget"
- ]
- },
+ "implementations" : [
+ "Roo.bootstrap.CardFooter",
+ "Roo.bootstrap.CardHeader",
+ "Roo.bootstrap.CardImageTop",
+ "Roo.bootstrap.DropTarget"
+ ],
"tree_children" : [
"Roo.bootstrap.Alert",
"Roo.bootstrap.BezierSignature",
"Roo.bootstrap.Calendar",
"Roo.bootstrap.Card",
"Roo.bootstrap.Column",
- "Roo.bootstrap.Container",
"Roo.bootstrap.DocumentManager",
"Roo.bootstrap.DocumentSlider",
"Roo.bootstrap.DocumentViewer",
"Roo.bootstrap.form.TextArea",
"Roo.bootstrap.form.TimeField",
"Roo.bootstrap.form.TriggerField",
- "Roo.bootstrap.layout.Border",
"Roo.bootstrap.nav.Group",
"Roo.bootstrap.nav.Headerbar",
"Roo.bootstrap.nav.ProgressBar",
"name" : "actionMode",
"type" : "String",
"desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el' for forms you probably want to set this to fieldEl",
- "memberOf" : "Roo.Component"
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "allowDomMove",
"type" : "Boolean",
"desc" : "Whether the component can move the Dom node when rendering (defaults to true).",
- "memberOf" : "Roo.Component"
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "can_build_overlaid",
"type" : "Boolean",
"desc" : "True if element can be rebuild from a HTML page",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "cls",
"type" : "String",
"desc" : "css class",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "container_method",
"type" : "string",
"desc" : "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "dataId",
"type" : "string",
"desc" : "cutomer id",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "disableClass",
"type" : "String",
"desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").",
- "memberOf" : "Roo.Component"
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "g_height",
"type" : "number",
"desc" : "height of the chart (respected by all elements in the set)",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "g_r",
"type" : "number",
"desc" : "radius (pie)",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "g_width",
"type" : "number",
"desc" : "width of the chart (respected by all elements in the set)",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "g_x",
"type" : "number",
"desc" : "coodinator | centre x (pie)",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "g_y",
"type" : "number",
"desc" : "coodinator | centre y (pie)",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "graphtype",
"type" : "String",
"desc" : "bar | vbar | pie",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "hideMode",
"type" : "String",
- "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".",
- "memberOf" : "Roo.Component"
+ "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display",
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : [
+ "display",
+ "visibility"
+ ]
},
{
"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"
+ "memberOf" : "Roo.util.Observable",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "name",
"type" : "string",
"desc" : "Specifies name attribute",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "style",
"type" : "String",
"desc" : "any extra css",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "title",
"type" : "Object",
"desc" : "The title of the chart\n \n -{Array} values\n -opts (object) options for the chart \n o {\n o type (string) type of endings of the bar. Default: 'square'. Other options are: 'round', 'sharp', 'soft'.\n o gutter (number)(string) default '20%' (WHAT DOES IT DO?)\n o vgutter (number)\n o colors (array) colors be used repeatedly to plot the bars. If multicolumn bar is used each sequence of bars with use a different color.\n o stacked (boolean) whether or not to tread values as in a stacked bar chart\n o to\n o stretch (boolean)\n o }\n -opts (object) options for the pie\n o{\n o cut\n o startAngle (number)\n o endAngle (number)\n }",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "tooltip",
"type" : "string",
"desc" : "Text for the tooltip",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "visibilityEl",
"type" : "string|object",
- "desc" : "t) What element to use for visibility (@see getVisibilityEl())",
- "memberOf" : "Roo.bootstrap.Component"
+ "desc" : "t) What element to use for visibility (@see getVisibilityEl(",
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : [
+ "el",
+ "parent"
+ ]
},
{
"name" : "xattr",
"type" : "Object",
"desc" : "extra attributes to add to 'element' (used by builder to store stuff.)",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
}
],
"events" : [
],
"isAbstract" : false,
"isBuilderTop" : false,
- "childClasses" : { },
+ "implementations" : [],
"tree_children" : [],
"tree_parent" : []
},
"name" : "actionMode",
"type" : "String",
"desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el' for forms you probably want to set this to fieldEl",
- "memberOf" : "Roo.Component"
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "allowDomMove",
"type" : "Boolean",
"desc" : "Whether the component can move the Dom node when rendering (defaults to true).",
- "memberOf" : "Roo.Component"
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "can_build_overlaid",
"type" : "Boolean",
"desc" : "True if element can be rebuild from a HTML page",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "cls",
"type" : "String",
"desc" : "css class",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "container_method",
"type" : "string",
"desc" : "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "dataId",
"type" : "string",
"desc" : "cutomer id",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "disableClass",
"type" : "String",
"desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").",
- "memberOf" : "Roo.Component"
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "hideMode",
"type" : "String",
- "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".",
- "memberOf" : "Roo.Component"
+ "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display",
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : [
+ "display",
+ "visibility"
+ ]
},
{
"name" : "html",
"type" : "String",
"desc" : "content of header",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "level",
"type" : "Number",
- "desc" : "6) default 1",
- "memberOf" : ""
+ "desc" : "6) default",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : [
+ "1",
+ "2",
+ "3",
+ "4",
+ "5",
+ "6"
+ ]
},
{
"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"
+ "memberOf" : "Roo.util.Observable",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "name",
"type" : "string",
"desc" : "Specifies name attribute",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "style",
"type" : "String",
"desc" : "any extra css",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "tooltip",
"type" : "string",
"desc" : "Text for the tooltip",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "visibilityEl",
"type" : "string|object",
- "desc" : "t) What element to use for visibility (@see getVisibilityEl())",
- "memberOf" : "Roo.bootstrap.Component"
+ "desc" : "t) What element to use for visibility (@see getVisibilityEl(",
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : [
+ "el",
+ "parent"
+ ]
},
{
"name" : "xattr",
"type" : "Object",
"desc" : "extra attributes to add to 'element' (used by builder to store stuff.)",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
}
],
"events" : [
],
"isAbstract" : false,
"isBuilderTop" : false,
- "childClasses" : { },
+ "implementations" : [],
"tree_children" : [
"Roo.bootstrap.Alert",
"Roo.bootstrap.BezierSignature",
"Roo.bootstrap.Calendar",
"Roo.bootstrap.Card",
"Roo.bootstrap.Column",
- "Roo.bootstrap.Container",
"Roo.bootstrap.DocumentManager",
"Roo.bootstrap.DocumentSlider",
"Roo.bootstrap.DocumentViewer",
"Roo.bootstrap.form.TextArea",
"Roo.bootstrap.form.TimeField",
"Roo.bootstrap.form.TriggerField",
- "Roo.bootstrap.layout.Border",
"Roo.bootstrap.nav.Group",
"Roo.bootstrap.nav.Headerbar",
"Roo.bootstrap.nav.ProgressBar",
"name" : "actionMode",
"type" : "String",
"desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el' for forms you probably want to set this to fieldEl",
- "memberOf" : "Roo.Component"
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "allowDomMove",
"type" : "Boolean",
"desc" : "Whether the component can move the Dom node when rendering (defaults to true).",
- "memberOf" : "Roo.Component"
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "alt",
"type" : "String",
"desc" : "image alternative text",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "backgroundContain",
"type" : "Boolean",
"desc" : "(use style background and contain image in content)",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "border",
"type" : "String",
"desc" : "rounded | circle | thumbnail",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "can_build_overlaid",
"type" : "Boolean",
"desc" : "True if element can be rebuild from a HTML page",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "cls",
"type" : "String",
"desc" : "css class",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "container_method",
"type" : "string",
"desc" : "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "dataId",
"type" : "string",
"desc" : "cutomer id",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "disableClass",
"type" : "String",
"desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").",
- "memberOf" : "Roo.Component"
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "hideMode",
"type" : "String",
- "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".",
- "memberOf" : "Roo.Component"
+ "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display",
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : [
+ "display",
+ "visibility"
+ ]
},
{
"name" : "href",
"type" : "String",
"desc" : "a tag href",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "imgResponsive",
"type" : "Boolean",
"desc" : "false | true",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "lgUrl",
"type" : "String",
"desc" : "lg image source",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"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"
+ "memberOf" : "Roo.util.Observable",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "mdUrl",
"type" : "String",
"desc" : "md image source",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "name",
"type" : "string",
"desc" : "Specifies name attribute",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "smUrl",
"type" : "String",
"desc" : "sm image source",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "src",
"type" : "String",
"desc" : "image source",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "style",
"type" : "String",
"desc" : "any extra css",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "target",
"type" : "String",
- "desc" : "p)target for a href.",
- "memberOf" : ""
+ "desc" : "p)target for a hre",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : [
+ "_self",
+ "_blank",
+ "_parent",
+ "_top"
+ ]
},
{
"name" : "tooltip",
"type" : "string",
"desc" : "Text for the tooltip",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "visibilityEl",
"type" : "string|object",
- "desc" : "t) What element to use for visibility (@see getVisibilityEl())",
- "memberOf" : "Roo.bootstrap.Component"
+ "desc" : "t) What element to use for visibility (@see getVisibilityEl(",
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : [
+ "el",
+ "parent"
+ ]
},
{
"name" : "xattr",
"type" : "Object",
"desc" : "extra attributes to add to 'element' (used by builder to store stuff.)",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "xsUrl",
"type" : "String",
"desc" : "xs image source",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
}
],
"events" : [
],
"isAbstract" : false,
"isBuilderTop" : false,
- "childClasses" : { },
+ "implementations" : [],
"tree_children" : [],
"tree_parent" : []
},
"name" : "actionMode",
"type" : "String",
"desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el' for forms you probably want to set this to fieldEl",
- "memberOf" : "Roo.Component"
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "allowDomMove",
"type" : "Boolean",
"desc" : "Whether the component can move the Dom node when rendering (defaults to true).",
- "memberOf" : "Roo.Component"
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "alternativePadWidth",
"type" : "Number",
"desc" : "padding below box..",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "boxHeight",
"type" : "Number",
"desc" : "- 0 for square, or fix it at a certian height",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "boxWidth",
"type" : "Number",
"desc" : "width of the columns",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "can_build_overlaid",
"type" : "Boolean",
"desc" : "True if element can be rebuild from a HTML page",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "cls",
"type" : "String",
"desc" : "css class",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "container_method",
"type" : "string",
"desc" : "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "dataId",
"type" : "string",
"desc" : "cutomer id",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "disableClass",
"type" : "String",
"desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").",
- "memberOf" : "Roo.Component"
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "gutter",
"type" : "Number",
"desc" : "gutter width..",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "hideMode",
"type" : "String",
- "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".",
- "memberOf" : "Roo.Component"
+ "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display",
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : [
+ "display",
+ "visibility"
+ ]
},
{
"name" : "isAutoInitial",
"type" : "Boolean",
"desc" : "defalut true",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "isHorizontal",
"type" : "Boolean",
"desc" : "defalut false",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "isLayoutInstant",
"type" : "Boolean",
"desc" : "= no animation?",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"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"
+ "memberOf" : "Roo.util.Observable",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "maxCols",
"type" : "Number",
"desc" : "maximum number of columns",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "name",
"type" : "string",
"desc" : "Specifies name attribute",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "padWidth",
"type" : "Number",
"desc" : "padding below box..",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "style",
"type" : "String",
"desc" : "any extra css",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "tooltip",
"type" : "string",
"desc" : "Text for the tooltip",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "visibilityEl",
"type" : "string|object",
- "desc" : "t) What element to use for visibility (@see getVisibilityEl())",
- "memberOf" : "Roo.bootstrap.Component"
+ "desc" : "t) What element to use for visibility (@see getVisibilityEl(",
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : [
+ "el",
+ "parent"
+ ]
},
{
"name" : "xattr",
"type" : "Object",
"desc" : "extra attributes to add to 'element' (used by builder to store stuff.)",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
}
],
"events" : [
],
"isAbstract" : false,
"isBuilderTop" : false,
- "childClasses" : { },
+ "implementations" : [],
"tree_children" : [
"Roo.bootstrap.Element",
"Roo.bootstrap.DropTarget",
"name" : "actionMode",
"type" : "String",
"desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el' for forms you probably want to set this to fieldEl",
- "memberOf" : "Roo.Component"
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "allowDomMove",
"type" : "Boolean",
"desc" : "Whether the component can move the Dom node when rendering (defaults to true).",
- "memberOf" : "Roo.Component"
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "can_build_overlaid",
"type" : "Boolean",
"desc" : "True if element can be rebuild from a HTML page",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "cls",
"type" : "String",
"desc" : "css class",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "columnWidth",
"type" : "Number",
"desc" : "width of the columns",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "container_method",
"type" : "string",
"desc" : "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "dataId",
"type" : "string",
"desc" : "cutomer id",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "disableClass",
"type" : "String",
"desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").",
- "memberOf" : "Roo.Component"
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "hideMode",
"type" : "String",
- "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".",
- "memberOf" : "Roo.Component"
+ "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display",
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : [
+ "display",
+ "visibility"
+ ]
},
{
"name" : "isAutoInitial",
"type" : "Boolean",
"desc" : "defalut true",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "isFitWidth",
"type" : "Boolean",
"desc" : "- resize the width..",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "isLayoutInstant",
"type" : "Boolean",
"desc" : "= no animation?",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "isOriginLeft",
"type" : "Boolean",
"desc" : "= left align?",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "isOriginTop",
"type" : "Boolean",
"desc" : "= top align?",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "isResizingContainer",
"type" : "Boolean",
"desc" : "= not sure if this is used..",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"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"
+ "memberOf" : "Roo.util.Observable",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "maxCols",
"type" : "Number",
"desc" : "maximum number of columns",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "name",
"type" : "string",
"desc" : "Specifies name attribute",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "padHeight",
"type" : "Number",
"desc" : "padding below box..",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "style",
"type" : "String",
"desc" : "any extra css",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "tooltip",
"type" : "string",
"desc" : "Text for the tooltip",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "visibilityEl",
"type" : "string|object",
- "desc" : "t) What element to use for visibility (@see getVisibilityEl())",
- "memberOf" : "Roo.bootstrap.Component"
+ "desc" : "t) What element to use for visibility (@see getVisibilityEl(",
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : [
+ "el",
+ "parent"
+ ]
},
{
"name" : "xattr",
"type" : "Object",
"desc" : "extra attributes to add to 'element' (used by builder to store stuff.)",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
}
],
"events" : [
],
"isAbstract" : false,
"isBuilderTop" : false,
- "childClasses" : { },
+ "implementations" : [],
"tree_children" : [],
"tree_parent" : []
},
"name" : "actionMode",
"type" : "String",
"desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el' for forms you probably want to set this to fieldEl",
- "memberOf" : "Roo.Component"
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "allowDomMove",
"type" : "Boolean",
"desc" : "Whether the component can move the Dom node when rendering (defaults to true).",
- "memberOf" : "Roo.Component"
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "alt",
"type" : "String",
"desc" : "image alternative text",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "anchor",
"type" : "String",
"desc" : "name for the anchor link",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "can_build_overlaid",
"type" : "Boolean",
"desc" : "True if element can be rebuild from a HTML page",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "cls",
"type" : "String",
"desc" : "css class",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "container_method",
"type" : "string",
"desc" : "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "dataId",
"type" : "string",
"desc" : "cutomer id",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "disableClass",
"type" : "String",
"desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").",
- "memberOf" : "Roo.Component"
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "fa",
"type" : "String",
"desc" : "- favicon",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "hideMode",
"type" : "String",
- "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".",
- "memberOf" : "Roo.Component"
+ "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display",
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : [
+ "display",
+ "visibility"
+ ]
},
{
"name" : "href",
"type" : "String",
"desc" : "a tag href",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "html",
"type" : "String",
"desc" : "the content of the link.",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"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"
+ "memberOf" : "Roo.util.Observable",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "name",
"type" : "string",
"desc" : "Specifies name attribute",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "preventDefault",
"type" : "Boolean",
- "desc" : "e) default false",
- "memberOf" : ""
+ "desc" : "e) default fal",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : [
+ "true",
+ "false"
+ ]
},
{
"name" : "style",
"type" : "String",
"desc" : "any extra css",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "target",
"type" : "String",
- "desc" : "p) target for a href.",
- "memberOf" : ""
+ "desc" : "p) target for a hre",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : [
+ "_self",
+ "_blank",
+ "_parent",
+ "_top"
+ ]
},
{
"name" : "tooltip",
"type" : "string",
"desc" : "Text for the tooltip",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "visibilityEl",
"type" : "string|object",
- "desc" : "t) What element to use for visibility (@see getVisibilityEl())",
- "memberOf" : "Roo.bootstrap.Component"
+ "desc" : "t) What element to use for visibility (@see getVisibilityEl(",
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : [
+ "el",
+ "parent"
+ ]
},
{
"name" : "xattr",
"type" : "Object",
"desc" : "extra attributes to add to 'element' (used by builder to store stuff.)",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
}
],
"events" : [
],
"isAbstract" : false,
"isBuilderTop" : false,
- "childClasses" : { },
+ "implementations" : [],
"tree_children" : [
"Roo.bootstrap.Alert",
"Roo.bootstrap.BezierSignature",
"Roo.bootstrap.Calendar",
"Roo.bootstrap.Card",
"Roo.bootstrap.Column",
- "Roo.bootstrap.Container",
"Roo.bootstrap.DocumentManager",
"Roo.bootstrap.DocumentSlider",
"Roo.bootstrap.DocumentViewer",
"Roo.bootstrap.form.TextArea",
"Roo.bootstrap.form.TimeField",
"Roo.bootstrap.form.TriggerField",
- "Roo.bootstrap.layout.Border",
"Roo.bootstrap.nav.Group",
"Roo.bootstrap.nav.Headerbar",
"Roo.bootstrap.nav.ProgressBar",
"name" : "actionMode",
"type" : "String",
"desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el' for forms you probably want to set this to fieldEl",
- "memberOf" : "Roo.Component"
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "allowDomMove",
"type" : "Boolean",
"desc" : "Whether the component can move the Dom node when rendering (defaults to true).",
- "memberOf" : "Roo.Component"
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "can_build_overlaid",
"type" : "Boolean",
"desc" : "True if element can be rebuild from a HTML page",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "cls",
"type" : "String",
"desc" : "css class",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "container_method",
"type" : "string",
"desc" : "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "dataId",
"type" : "string",
"desc" : "cutomer id",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "disableClass",
"type" : "String",
"desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").",
- "memberOf" : "Roo.Component"
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "disableDoubleClickZoom",
"type" : "Boolean",
"desc" : "default false",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "draggable",
"type" : "Boolean",
"desc" : "default true",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "enableAutocomplete",
"type" : "Boolean",
"desc" : "default false",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "enableReverseGeocode",
"type" : "Boolean",
"desc" : "default true",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "hideMode",
"type" : "String",
- "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".",
- "memberOf" : "Roo.Component"
+ "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display",
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : [
+ "display",
+ "visibility"
+ ]
},
{
"name" : "latitude",
"type" : "Number",
"desc" : "Position when init default 0",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"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"
+ "memberOf" : "Roo.util.Observable",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "locationName",
"type" : "String",
"desc" : "",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "longitude",
"type" : "Number",
"desc" : "Position when init default 0",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "mapTypeControl",
"type" : "Boolean",
"desc" : "default false",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "mapTypeId",
"type" : "String",
"desc" : "default google.maps.MapTypeId.ROADMAP",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "markerTitle",
"type" : "String",
"desc" : "",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "name",
"type" : "string",
"desc" : "Specifies name attribute",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "radius",
"type" : "Number",
"desc" : "default 0",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "scrollwheel",
"type" : "Boolean",
"desc" : "default true",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "streetViewControl",
"type" : "Boolean",
"desc" : "default false",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "style",
"type" : "String",
"desc" : "any extra css",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "tooltip",
"type" : "string",
"desc" : "Text for the tooltip",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "visibilityEl",
"type" : "string|object",
- "desc" : "t) What element to use for visibility (@see getVisibilityEl())",
- "memberOf" : "Roo.bootstrap.Component"
+ "desc" : "t) What element to use for visibility (@see getVisibilityEl(",
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : [
+ "el",
+ "parent"
+ ]
},
{
"name" : "xattr",
"type" : "Object",
"desc" : "extra attributes to add to 'element' (used by builder to store stuff.)",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "zoom",
"type" : "Number",
"desc" : "default 15",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
}
],
"events" : [
],
"isAbstract" : false,
"isBuilderTop" : false,
- "childClasses" : { },
+ "implementations" : [],
"tree_children" : [],
"tree_parent" : []
},
"name" : "actionMode",
"type" : "String",
"desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el' for forms you probably want to set this to fieldEl",
- "memberOf" : "Roo.Component"
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "allowDomMove",
"type" : "Boolean",
"desc" : "Whether the component can move the Dom node when rendering (defaults to true).",
- "memberOf" : "Roo.Component"
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "bgimage",
"type" : "String",
"desc" : "",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "can_build_overlaid",
"type" : "Boolean",
"desc" : "True if element can be rebuild from a HTML page",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "cls",
"type" : "String",
"desc" : "",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "container_method",
"type" : "string",
"desc" : "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "dataId",
"type" : "string",
"desc" : "cutomer id",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "disableClass",
"type" : "String",
"desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").",
- "memberOf" : "Roo.Component"
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "hideMode",
"type" : "String",
- "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".",
- "memberOf" : "Roo.Component"
+ "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display",
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : [
+ "display",
+ "visibility"
+ ]
},
{
"name" : "href",
"type" : "String",
"desc" : "",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "html",
"type" : "String",
"desc" : "",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "inverse",
"type" : "Boolean",
"desc" : "defalut false",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "isFitContainer",
"type" : "Boolean",
"desc" : "defalut true",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"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"
+ "memberOf" : "Roo.util.Observable",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "name",
"type" : "string",
"desc" : "Specifies name attribute",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "placetitle",
"type" : "String",
- "desc" : "m)",
- "memberOf" : ""
+ "desc" : "",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : [
+ "center",
+ "bottom"
+ ]
},
{
"name" : "preventDefault",
"type" : "Boolean",
"desc" : "defalut false",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "size",
"type" : "String",
- "desc" : "e)",
- "memberOf" : ""
+ "desc" : "",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : [
+ "xs",
+ "sm",
+ "md",
+ "md-left",
+ "md-right",
+ "tall",
+ "wide"
+ ]
},
{
"name" : "style",
"type" : "String",
"desc" : "any extra css",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "title",
"type" : "String",
"desc" : "",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "tooltip",
"type" : "string",
"desc" : "Text for the tooltip",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "videourl",
"type" : "String",
"desc" : "",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "visibilityEl",
"type" : "string|object",
- "desc" : "t) What element to use for visibility (@see getVisibilityEl())",
- "memberOf" : "Roo.bootstrap.Component"
+ "desc" : "t) What element to use for visibility (@see getVisibilityEl(",
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : [
+ "el",
+ "parent"
+ ]
},
{
"name" : "xattr",
"type" : "Object",
"desc" : "extra attributes to add to 'element' (used by builder to store stuff.)",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
}
],
"events" : [
],
"isAbstract" : false,
"isBuilderTop" : false,
- "childClasses" : { },
+ "implementations" : [],
"tree_children" : [],
"tree_parent" : []
},
"name" : "actionMode",
"type" : "String",
"desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el' for forms you probably want to set this to fieldEl",
- "memberOf" : "Roo.Component"
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "allowDomMove",
"type" : "Boolean",
"desc" : "Whether the component can move the Dom node when rendering (defaults to true).",
- "memberOf" : "Roo.Component"
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "beforeClass",
"type" : "String",
"desc" : "insert the bar before the given class",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "can_build_overlaid",
"type" : "Boolean",
"desc" : "True if element can be rebuild from a HTML page",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "closable",
"type" : "Boolean",
- "desc" : "e) default false",
- "memberOf" : ""
+ "desc" : "e) default fal",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : [
+ "true",
+ "false"
+ ]
},
{
"name" : "cls",
"type" : "String",
"desc" : "css class",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "container_method",
"type" : "string",
"desc" : "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "dataId",
"type" : "string",
"desc" : "cutomer id",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "disableClass",
"type" : "String",
"desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").",
- "memberOf" : "Roo.Component"
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "fixed",
"type" : "Boolean",
- "desc" : "e) default false, fix the bar at the top",
- "memberOf" : ""
+ "desc" : "e) default false, fix the bar at the t",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : [
+ "true",
+ "false"
+ ]
},
{
"name" : "hideMode",
"type" : "String",
- "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".",
- "memberOf" : "Roo.Component"
+ "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display",
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : [
+ "display",
+ "visibility"
+ ]
},
{
"name" : "html",
"type" : "String",
"desc" : "contents of the MessageBar",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"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"
+ "memberOf" : "Roo.util.Observable",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "name",
"type" : "string",
"desc" : "Specifies name attribute",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "style",
"type" : "String",
"desc" : "any extra css",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "tooltip",
"type" : "string",
"desc" : "Text for the tooltip",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "visibilityEl",
"type" : "string|object",
- "desc" : "t) What element to use for visibility (@see getVisibilityEl())",
- "memberOf" : "Roo.bootstrap.Component"
+ "desc" : "t) What element to use for visibility (@see getVisibilityEl(",
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : [
+ "el",
+ "parent"
+ ]
},
{
"name" : "weight",
"type" : "String",
- "desc" : "r) default info",
- "memberOf" : ""
+ "desc" : "r) default in",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : [
+ "info",
+ "success",
+ "warning",
+ "danger"
+ ]
},
{
"name" : "xattr",
"type" : "Object",
"desc" : "extra attributes to add to 'element' (used by builder to store stuff.)",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
}
],
"events" : [
],
"isAbstract" : false,
"isBuilderTop" : false,
- "childClasses" : { },
+ "implementations" : [],
"tree_children" : [],
"tree_parent" : []
},
],
"isAbstract" : false,
"isBuilderTop" : false,
- "childClasses" : { },
+ "implementations" : [],
"tree_children" : [],
"tree_parent" : []
},
"name" : "actionMode",
"type" : "String",
"desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el' for forms you probably want to set this to fieldEl",
- "memberOf" : "Roo.Component"
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "allowDomMove",
"type" : "Boolean",
"desc" : "Whether the component can move the Dom node when rendering (defaults to true).",
- "memberOf" : "Roo.Component"
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "allow_close",
"type" : "Boolean",
"desc" : "default true",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "animate",
"type" : "Boolean",
"desc" : "default true",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "bodyOverflow",
"type" : "Boolean",
"desc" : "should the body element have overflow auto added default false",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "buttonPosition",
"type" : "String",
- "desc" : "r) default right (DEPRICATED) - use mr-auto on buttons to put them on the left",
- "memberOf" : ""
+ "desc" : "r) default right (DEPRICATED) - use mr-auto on buttons to put them on the le",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : [
+ "left",
+ "right",
+ "center"
+ ]
},
{
"name" : "buttons[]",
"type" : "Roo.bootstrap.Button",
"desc" : "Array of buttons or standard button set..",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "can_build_overlaid",
"type" : "Boolean",
"desc" : "True if element can be rebuild from a HTML page",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "cls",
"type" : "String",
"desc" : "css class",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "container_method",
"type" : "string",
"desc" : "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "dataId",
"type" : "string",
"desc" : "cutomer id",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "disableClass",
"type" : "String",
"desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").",
- "memberOf" : "Roo.Component"
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "editableTitle",
"type" : "Boolean",
"desc" : "can the title be edited",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "fitwindow",
"type" : "Boolean",
"desc" : "default false",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "height",
"type" : "Number",
"desc" : "fixed height - usefull for chrome extension only really.",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "hideMode",
"type" : "String",
- "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".",
- "memberOf" : "Roo.Component"
+ "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display",
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : [
+ "display",
+ "visibility"
+ ]
},
{
"name" : "html",
"type" : "String",
"desc" : "- the body of the dialog (for simple ones) - you can also use template..",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"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"
+ "memberOf" : "Roo.util.Observable",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "max_width",
"type" : "Number",
"desc" : "set the max width of modal",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "name",
"type" : "string",
"desc" : "Specifies name attribute",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "size",
"type" : "String",
- "desc" : "l) default empty",
- "memberOf" : ""
+ "desc" : "l) default emp",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : [
+ "sm",
+ "lg",
+ "xl"
+ ]
},
{
"name" : "specificTitle",
"type" : "Boolean",
"desc" : "default false",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "style",
"type" : "String",
"desc" : "any extra css",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "title",
"type" : "String",
"desc" : "Title of dialog",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "tmpl",
"type" : "Roo.Template",
"desc" : "- a template with variables. to use it, add a handler in show:method adn",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "tooltip",
"type" : "string",
"desc" : "Text for the tooltip",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "visibilityEl",
"type" : "string|object",
- "desc" : "t) What element to use for visibility (@see getVisibilityEl())",
- "memberOf" : "Roo.bootstrap.Component"
+ "desc" : "t) What element to use for visibility (@see getVisibilityEl(",
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : [
+ "el",
+ "parent"
+ ]
},
{
"name" : "width",
"type" : "Number",
"desc" : "fixed width - usefull for chrome extension only really.",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "xattr",
"type" : "Object",
"desc" : "extra attributes to add to 'element' (used by builder to store stuff.)",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
}
],
"events" : [
}
],
"isAbstract" : false,
- "isBuilderTop" : true,
- "childClasses" : { },
+ "isBuilderTop" : false,
+ "implementations" : [],
"tree_children" : [
"Roo.bootstrap.Alert",
"Roo.bootstrap.BezierSignature",
"Roo.bootstrap.Calendar",
"Roo.bootstrap.Card",
"Roo.bootstrap.Column",
- "Roo.bootstrap.Container",
"Roo.bootstrap.DocumentManager",
"Roo.bootstrap.DocumentSlider",
"Roo.bootstrap.DocumentViewer",
"Roo.bootstrap.nav.Simplebar"
],
"tree_parent" : [
- "none"
+ "none",
+ "builder"
]
},
"Roo.bootstrap.Pagination" : {
"name" : "actionMode",
"type" : "String",
"desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el' for forms you probably want to set this to fieldEl",
- "memberOf" : "Roo.Component"
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "allowDomMove",
"type" : "Boolean",
"desc" : "Whether the component can move the Dom node when rendering (defaults to true).",
- "memberOf" : "Roo.Component"
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "can_build_overlaid",
"type" : "Boolean",
"desc" : "True if element can be rebuild from a HTML page",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "cls",
"type" : "String",
"desc" : "css class",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "container_method",
"type" : "string",
"desc" : "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "dataId",
"type" : "string",
"desc" : "cutomer id",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "disableClass",
"type" : "String",
"desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").",
- "memberOf" : "Roo.Component"
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "hideMode",
"type" : "String",
- "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".",
- "memberOf" : "Roo.Component"
+ "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display",
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : [
+ "display",
+ "visibility"
+ ]
},
{
"name" : "inverse",
"type" : "Boolean",
"desc" : "",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"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"
+ "memberOf" : "Roo.util.Observable",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "name",
"type" : "string",
"desc" : "Specifies name attribute",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "size",
"type" : "String",
- "desc" : "l)",
- "memberOf" : ""
+ "desc" : "",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : [
+ "xs",
+ "sm",
+ "md",
+ "lg",
+ "xl"
+ ]
},
{
"name" : "style",
"type" : "String",
"desc" : "any extra css",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "tooltip",
"type" : "string",
"desc" : "Text for the tooltip",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "visibilityEl",
"type" : "string|object",
- "desc" : "t) What element to use for visibility (@see getVisibilityEl())",
- "memberOf" : "Roo.bootstrap.Component"
+ "desc" : "t) What element to use for visibility (@see getVisibilityEl(",
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : [
+ "el",
+ "parent"
+ ]
},
{
"name" : "xattr",
"type" : "Object",
"desc" : "extra attributes to add to 'element' (used by builder to store stuff.)",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
}
],
"events" : [
],
"isAbstract" : false,
"isBuilderTop" : false,
- "childClasses" : { },
+ "implementations" : [],
"tree_children" : [
"Roo.bootstrap.Pagination"
],
"name" : "actionMode",
"type" : "String",
"desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el' for forms you probably want to set this to fieldEl",
- "memberOf" : "Roo.Component"
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "active",
"type" : "Boolean",
- "desc" : "e) default false",
- "memberOf" : ""
+ "desc" : "e) default fal",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : [
+ "true",
+ "false"
+ ]
},
{
"name" : "allowDomMove",
"type" : "Boolean",
"desc" : "Whether the component can move the Dom node when rendering (defaults to true).",
- "memberOf" : "Roo.Component"
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "can_build_overlaid",
"type" : "Boolean",
"desc" : "True if element can be rebuild from a HTML page",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "cls",
"type" : "String",
"desc" : "css class",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "container_method",
"type" : "string",
"desc" : "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "dataId",
"type" : "string",
"desc" : "cutomer id",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "disableClass",
"type" : "String",
"desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").",
- "memberOf" : "Roo.Component"
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "disabled",
"type" : "Boolean",
"desc" : "default false",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "hideMode",
"type" : "String",
- "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".",
- "memberOf" : "Roo.Component"
+ "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display",
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : [
+ "display",
+ "visibility"
+ ]
},
{
"name" : "href",
"type" : "String",
"desc" : "the link",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "html",
"type" : "String",
"desc" : "text",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"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"
+ "memberOf" : "Roo.util.Observable",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "name",
"type" : "string",
"desc" : "Specifies name attribute",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "preventDefault",
"type" : "Boolean",
- "desc" : "e) default true",
- "memberOf" : ""
+ "desc" : "e) default tr",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : [
+ "true",
+ "false"
+ ]
},
{
"name" : "style",
"type" : "String",
"desc" : "any extra css",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "tooltip",
"type" : "string",
"desc" : "Text for the tooltip",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "visibilityEl",
"type" : "string|object",
- "desc" : "t) What element to use for visibility (@see getVisibilityEl())",
- "memberOf" : "Roo.bootstrap.Component"
+ "desc" : "t) What element to use for visibility (@see getVisibilityEl(",
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : [
+ "el",
+ "parent"
+ ]
},
{
"name" : "xattr",
"type" : "Object",
"desc" : "extra attributes to add to 'element' (used by builder to store stuff.)",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
}
],
"events" : [
],
"isAbstract" : false,
"isBuilderTop" : false,
- "childClasses" : { },
+ "implementations" : [],
"tree_children" : [],
"tree_parent" : []
},
"name" : "actionMode",
"type" : "String",
"desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el' for forms you probably want to set this to fieldEl",
- "memberOf" : "Roo.Component"
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "align",
"type" : "String",
- "desc" : "t) alignment",
- "memberOf" : "Roo.bootstrap.nav.Simplebar"
+ "desc" : "t) alignme",
+ "memberOf" : "Roo.bootstrap.nav.Simplebar",
+ "isOptional" : false,
+ "optvals" : [
+ "left",
+ "right"
+ ]
},
{
"name" : "allowDomMove",
"type" : "Boolean",
"desc" : "Whether the component can move the Dom node when rendering (defaults to true).",
- "memberOf" : "Roo.Component"
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "arrangement",
"type" : "Boolean",
"desc" : "stacked | justified",
- "memberOf" : "Roo.bootstrap.nav.Simplebar"
+ "memberOf" : "Roo.bootstrap.nav.Simplebar",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "buttons[]",
"type" : "Roo.bootstrap.Button",
"desc" : "Buttons for the toolbar",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "can_build_overlaid",
"type" : "Boolean",
"desc" : "True if element can be rebuild from a HTML page",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "cls",
"type" : "String",
"desc" : "css class",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "container",
"type" : "String/HTMLElement/Element",
"desc" : "container The id or element that will contain the toolbar",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "container_method",
"type" : "string",
"desc" : "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "dataId",
"type" : "string",
"desc" : "cutomer id",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "disableClass",
"type" : "String",
"desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").",
- "memberOf" : "Roo.Component"
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "displayInfo",
"type" : "Boolean",
"desc" : "True to display the displayMsg (defaults to false)",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "displayMsg",
"type" : "String",
"desc" : "The paging status message to display (defaults to \"Displaying {start} - {end} of {total}\")",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "emptyMsg",
"type" : "String",
"desc" : "The message to display when no records are found (defaults to \"No data to display\")",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "hideMode",
"type" : "String",
- "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".",
- "memberOf" : "Roo.Component"
+ "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display",
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : [
+ "display",
+ "visibility"
+ ]
},
{
"name" : "inverse",
"type" : "Boolean",
"desc" : "is inverted color",
- "memberOf" : "Roo.bootstrap.nav.Simplebar"
+ "memberOf" : "Roo.bootstrap.nav.Simplebar",
+ "isOptional" : false,
+ "optvals" : []
},
{
"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"
+ "memberOf" : "Roo.util.Observable",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "loadMask",
"type" : "Boolean",
- "desc" : "e) loadMask on the bar",
- "memberOf" : "Roo.bootstrap.nav.Simplebar"
+ "desc" : "e) loadMask on the b",
+ "memberOf" : "Roo.bootstrap.nav.Simplebar",
+ "isOptional" : false,
+ "optvals" : [
+ "true",
+ "false"
+ ]
},
{
"name" : "main",
"type" : "Boolean",
- "desc" : "e) main nav bar? default false",
- "memberOf" : "Roo.bootstrap.nav.Simplebar"
+ "desc" : "e) main nav bar? default fal",
+ "memberOf" : "Roo.bootstrap.nav.Simplebar",
+ "isOptional" : false,
+ "optvals" : [
+ "true",
+ "false"
+ ]
},
{
"name" : "name",
"type" : "string",
"desc" : "Specifies name attribute",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "pageSize",
"type" : "Number",
"desc" : "The number of records to display per page (defaults to 20)",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "store",
"type" : "Roo.data.Store",
"desc" : "The underlying data store providing the paged data",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "style",
"type" : "String",
"desc" : "any extra css",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "tag",
"type" : "String",
- "desc" : "v) default is nav",
- "memberOf" : "Roo.bootstrap.nav.Simplebar"
+ "desc" : "v) default is n",
+ "memberOf" : "Roo.bootstrap.nav.Simplebar",
+ "isOptional" : false,
+ "optvals" : [
+ "header",
+ "footer",
+ "nav",
+ "div"
+ ]
},
{
"name" : "tooltip",
"type" : "string",
"desc" : "Text for the tooltip",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "type",
"type" : "String",
- "desc" : "s)",
- "memberOf" : "Roo.bootstrap.nav.Simplebar"
+ "desc" : "",
+ "memberOf" : "Roo.bootstrap.nav.Simplebar",
+ "isOptional" : false,
+ "optvals" : [
+ "nav",
+ "pills",
+ "tabs"
+ ]
},
{
"name" : "visibilityEl",
"type" : "string|object",
- "desc" : "t) What element to use for visibility (@see getVisibilityEl())",
- "memberOf" : "Roo.bootstrap.Component"
+ "desc" : "t) What element to use for visibility (@see getVisibilityEl(",
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : [
+ "el",
+ "parent"
+ ]
},
{
"name" : "weight",
"type" : "String",
- "desc" : "e) default is light.",
- "memberOf" : "Roo.bootstrap.nav.Simplebar"
+ "desc" : "e) default is ligh",
+ "memberOf" : "Roo.bootstrap.nav.Simplebar",
+ "isOptional" : false,
+ "optvals" : [
+ "light",
+ "primary",
+ "secondary",
+ "success",
+ "danger",
+ "warning",
+ "info",
+ "dark",
+ "white"
+ ]
},
{
"name" : "xattr",
"type" : "Object",
"desc" : "extra attributes to add to 'element' (used by builder to store stuff.)",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
}
],
"events" : [
],
"isAbstract" : false,
"isBuilderTop" : false,
- "childClasses" : { },
+ "implementations" : [],
"tree_children" : [],
"tree_parent" : []
},
"name" : "(right|top|bottom|left|auto)",
"type" : "String|function",
"desc" : "placement how it is placed",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "actionMode",
"type" : "String",
"desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el' for forms you probably want to set this to fieldEl",
- "memberOf" : "Roo.Component"
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "add",
"type" : "String|Boolean|Roo.Element",
"desc" : "click hander to trigger show over what element\n - if false and it has a 'parent' then it will be automatically added to that element\n - if string - Roo.get will be called",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "allowDomMove",
"type" : "Boolean",
"desc" : "Whether the component can move the Dom node when rendering (defaults to true).",
- "memberOf" : "Roo.Component"
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "can_build_overlaid",
"type" : "Boolean",
"desc" : "True if element can be rebuild from a HTML page",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "cls",
"type" : "String",
"desc" : "css class",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "container_method",
"type" : "string",
"desc" : "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "dataId",
"type" : "string",
"desc" : "cutomer id",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "delay",
"type" : "Number",
"desc" : "- delay before showing",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "disableClass",
"type" : "String",
"desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").",
- "memberOf" : "Roo.Component"
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "hideMode",
"type" : "String",
- "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".",
- "memberOf" : "Roo.Component"
+ "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display",
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : [
+ "display",
+ "visibility"
+ ]
},
{
"name" : "html",
"type" : "String",
"desc" : "contents of the popover (or false to use children..)",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"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"
+ "memberOf" : "Roo.util.Observable",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "modal",
"type" : "Boolean",
"desc" : "- popovers that are modal will mask the screen, and must be closed with another event.",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "name",
"type" : "string",
"desc" : "Specifies name attribute",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "style",
"type" : "String",
"desc" : "any extra css",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "title",
"type" : "String",
"desc" : "of popover (or false to hide)",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "tooltip",
"type" : "string",
"desc" : "Text for the tooltip",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "trigger",
"type" : "String",
"desc" : "click || hover (or false to trigger manually)",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "visibilityEl",
"type" : "string|object",
- "desc" : "t) What element to use for visibility (@see getVisibilityEl())",
- "memberOf" : "Roo.bootstrap.Component"
+ "desc" : "t) What element to use for visibility (@see getVisibilityEl(",
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : [
+ "el",
+ "parent"
+ ]
},
{
"name" : "xattr",
"type" : "Object",
"desc" : "extra attributes to add to 'element' (used by builder to store stuff.)",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
}
],
"events" : [
}
]
},
+ {
+ "name" : "doAlign",
+ "type" : "function",
+ "desc" : "update the position of the dialog\nnormally this is needed if the popover get's bigger - due to a Table reload etc..",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
{
"name" : "enable",
"type" : "function",
}
],
"isAbstract" : false,
- "isBuilderTop" : true,
- "childClasses" : { },
+ "isBuilderTop" : false,
+ "implementations" : [],
"tree_children" : [
"Roo.bootstrap.Alert",
"Roo.bootstrap.BezierSignature",
"Roo.bootstrap.Calendar",
"Roo.bootstrap.Card",
"Roo.bootstrap.Column",
- "Roo.bootstrap.Container",
"Roo.bootstrap.DocumentManager",
"Roo.bootstrap.DocumentSlider",
"Roo.bootstrap.DocumentViewer",
"Roo.bootstrap.form.TextArea",
"Roo.bootstrap.form.TimeField",
"Roo.bootstrap.form.TriggerField",
- "Roo.bootstrap.layout.Border",
"Roo.bootstrap.nav.Group",
"Roo.bootstrap.nav.Headerbar",
"Roo.bootstrap.nav.ProgressBar",
"Roo.bootstrap.nav.Simplebar"
],
"tree_parent" : [
- "none"
+ "none",
+ "builder"
]
},
"Roo.bootstrap.PopoverNav" : {
"name" : "actionMode",
"type" : "String",
"desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el' for forms you probably want to set this to fieldEl",
- "memberOf" : "Roo.Component"
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "align",
"type" : "String",
- "desc" : "t) alignment",
- "memberOf" : "Roo.bootstrap.nav.Simplebar"
+ "desc" : "t) alignme",
+ "memberOf" : "Roo.bootstrap.nav.Simplebar",
+ "isOptional" : false,
+ "optvals" : [
+ "left",
+ "right"
+ ]
},
{
"name" : "allowDomMove",
"type" : "Boolean",
"desc" : "Whether the component can move the Dom node when rendering (defaults to true).",
- "memberOf" : "Roo.Component"
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "arrangement",
"type" : "Boolean",
"desc" : "stacked | justified",
- "memberOf" : "Roo.bootstrap.nav.Simplebar"
+ "memberOf" : "Roo.bootstrap.nav.Simplebar",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "can_build_overlaid",
"type" : "Boolean",
"desc" : "True if element can be rebuild from a HTML page",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "cls",
"type" : "String",
"desc" : "css class",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "container_method",
"type" : "string",
"desc" : "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "dataId",
"type" : "string",
"desc" : "cutomer id",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "disableClass",
"type" : "String",
"desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").",
- "memberOf" : "Roo.Component"
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "hideMode",
"type" : "String",
- "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".",
- "memberOf" : "Roo.Component"
+ "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display",
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : [
+ "display",
+ "visibility"
+ ]
},
{
"name" : "inverse",
"type" : "Boolean",
"desc" : "is inverted color",
- "memberOf" : "Roo.bootstrap.nav.Simplebar"
+ "memberOf" : "Roo.bootstrap.nav.Simplebar",
+ "isOptional" : false,
+ "optvals" : []
},
{
"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"
+ "memberOf" : "Roo.util.Observable",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "loadMask",
"type" : "Boolean",
- "desc" : "e) loadMask on the bar",
- "memberOf" : "Roo.bootstrap.nav.Simplebar"
+ "desc" : "e) loadMask on the b",
+ "memberOf" : "Roo.bootstrap.nav.Simplebar",
+ "isOptional" : false,
+ "optvals" : [
+ "true",
+ "false"
+ ]
},
{
"name" : "main",
"type" : "Boolean",
- "desc" : "e) main nav bar? default false",
- "memberOf" : "Roo.bootstrap.nav.Simplebar"
+ "desc" : "e) main nav bar? default fal",
+ "memberOf" : "Roo.bootstrap.nav.Simplebar",
+ "isOptional" : false,
+ "optvals" : [
+ "true",
+ "false"
+ ]
},
{
"name" : "name",
"type" : "string",
"desc" : "Specifies name attribute",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "style",
"type" : "String",
"desc" : "any extra css",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "tag",
"type" : "String",
- "desc" : "v) default is nav",
- "memberOf" : "Roo.bootstrap.nav.Simplebar"
+ "desc" : "v) default is n",
+ "memberOf" : "Roo.bootstrap.nav.Simplebar",
+ "isOptional" : false,
+ "optvals" : [
+ "header",
+ "footer",
+ "nav",
+ "div"
+ ]
},
{
"name" : "tooltip",
"type" : "string",
"desc" : "Text for the tooltip",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "type",
"type" : "String",
- "desc" : "s)",
- "memberOf" : "Roo.bootstrap.nav.Simplebar"
+ "desc" : "",
+ "memberOf" : "Roo.bootstrap.nav.Simplebar",
+ "isOptional" : false,
+ "optvals" : [
+ "nav",
+ "pills",
+ "tabs"
+ ]
},
{
"name" : "visibilityEl",
"type" : "string|object",
- "desc" : "t) What element to use for visibility (@see getVisibilityEl())",
- "memberOf" : "Roo.bootstrap.Component"
+ "desc" : "t) What element to use for visibility (@see getVisibilityEl(",
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : [
+ "el",
+ "parent"
+ ]
},
{
"name" : "weight",
"type" : "String",
- "desc" : "e) default is light.",
- "memberOf" : "Roo.bootstrap.nav.Simplebar"
+ "desc" : "e) default is ligh",
+ "memberOf" : "Roo.bootstrap.nav.Simplebar",
+ "isOptional" : false,
+ "optvals" : [
+ "light",
+ "primary",
+ "secondary",
+ "success",
+ "danger",
+ "warning",
+ "info",
+ "dark",
+ "white"
+ ]
},
{
"name" : "xattr",
"type" : "Object",
"desc" : "extra attributes to add to 'element' (used by builder to store stuff.)",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
}
],
"events" : [
],
"isAbstract" : false,
"isBuilderTop" : false,
- "childClasses" : { },
+ "implementations" : [],
"tree_children" : [
- "Roo.bootstrap.nav.Group",
- "Roo.bootstrap.Container"
+ "Roo.bootstrap.nav.Group"
],
"tree_parent" : [
"Roo.bootstrap.Popover"
"name" : "actionMode",
"type" : "String",
"desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el' for forms you probably want to set this to fieldEl",
- "memberOf" : "Roo.Component"
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "active",
"type" : "Boolean",
"desc" : "animated of the progress bar",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "allowDomMove",
"type" : "Boolean",
"desc" : "Whether the component can move the Dom node when rendering (defaults to true).",
- "memberOf" : "Roo.Component"
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "can_build_overlaid",
"type" : "Boolean",
"desc" : "True if element can be rebuild from a HTML page",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "cls",
"type" : "String",
"desc" : "css class",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "container_method",
"type" : "string",
"desc" : "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "dataId",
"type" : "string",
"desc" : "cutomer id",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "disableClass",
"type" : "String",
"desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").",
- "memberOf" : "Roo.Component"
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "hideMode",
"type" : "String",
- "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".",
- "memberOf" : "Roo.Component"
+ "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display",
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : [
+ "display",
+ "visibility"
+ ]
},
{
"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"
+ "memberOf" : "Roo.util.Observable",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "name",
"type" : "string",
"desc" : "Specifies name attribute",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "striped",
"type" : "Boolean",
"desc" : "striped of the progress bar",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "style",
"type" : "String",
"desc" : "any extra css",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "tooltip",
"type" : "string",
"desc" : "Text for the tooltip",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "visibilityEl",
"type" : "string|object",
- "desc" : "t) What element to use for visibility (@see getVisibilityEl())",
- "memberOf" : "Roo.bootstrap.Component"
+ "desc" : "t) What element to use for visibility (@see getVisibilityEl(",
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : [
+ "el",
+ "parent"
+ ]
},
{
"name" : "xattr",
"type" : "Object",
"desc" : "extra attributes to add to 'element' (used by builder to store stuff.)",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
}
],
"events" : [
],
"isAbstract" : false,
"isBuilderTop" : false,
- "childClasses" : { },
+ "implementations" : [],
"tree_children" : [
"Roo.bootstrap.ProgressBar"
],
"name" : "actionMode",
"type" : "String",
"desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el' for forms you probably want to set this to fieldEl",
- "memberOf" : "Roo.Component"
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "allowDomMove",
"type" : "Boolean",
"desc" : "Whether the component can move the Dom node when rendering (defaults to true).",
- "memberOf" : "Roo.Component"
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "aria_valuemax",
"type" : "Number",
"desc" : "aria-value max",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "aria_valuemin",
"type" : "Number",
"desc" : "aria-value min",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "aria_valuenow",
"type" : "Number",
"desc" : "aria-value now",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "can_build_overlaid",
"type" : "Boolean",
"desc" : "True if element can be rebuild from a HTML page",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "cls",
"type" : "String",
"desc" : "css class",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "container_method",
"type" : "string",
"desc" : "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "dataId",
"type" : "string",
"desc" : "cutomer id",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "disableClass",
"type" : "String",
"desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").",
- "memberOf" : "Roo.Component"
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "hideMode",
"type" : "String",
- "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".",
- "memberOf" : "Roo.Component"
+ "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display",
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : [
+ "display",
+ "visibility"
+ ]
},
{
"name" : "label",
"type" : "String",
"desc" : "label for the progress bar",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"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"
+ "memberOf" : "Roo.util.Observable",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "name",
"type" : "string",
"desc" : "Specifies name attribute",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "panel",
"type" : "String",
- "desc" : ")",
- "memberOf" : ""
+ "desc" : "",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : [
+ "success",
+ "info",
+ "warning",
+ "danger"
+ ]
},
{
"name" : "role",
"type" : "String",
"desc" : "role of the progress bar",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "sr_only",
"type" : "String",
"desc" : "text",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "style",
"type" : "String",
"desc" : "any extra css",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "tooltip",
"type" : "string",
"desc" : "Text for the tooltip",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "visibilityEl",
"type" : "string|object",
- "desc" : "t) What element to use for visibility (@see getVisibilityEl())",
- "memberOf" : "Roo.bootstrap.Component"
+ "desc" : "t) What element to use for visibility (@see getVisibilityEl(",
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : [
+ "el",
+ "parent"
+ ]
},
{
"name" : "xattr",
"type" : "Object",
"desc" : "extra attributes to add to 'element' (used by builder to store stuff.)",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
}
],
"events" : [
],
"isAbstract" : false,
"isBuilderTop" : false,
- "childClasses" : { },
+ "implementations" : [],
"tree_children" : [],
"tree_parent" : []
},
"name" : "actionMode",
"type" : "String",
"desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el' for forms you probably want to set this to fieldEl",
- "memberOf" : "Roo.Component"
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "allowDomMove",
"type" : "Boolean",
"desc" : "Whether the component can move the Dom node when rendering (defaults to true).",
- "memberOf" : "Roo.Component"
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "can_build_overlaid",
"type" : "Boolean",
"desc" : "True if element can be rebuild from a HTML page",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "cls",
"type" : "String",
"desc" : "css class",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "container_method",
"type" : "string",
"desc" : "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "dataId",
"type" : "string",
"desc" : "cutomer id",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "disableClass",
"type" : "String",
"desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").",
- "memberOf" : "Roo.Component"
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "hideMode",
"type" : "String",
- "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".",
- "memberOf" : "Roo.Component"
+ "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display",
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : [
+ "display",
+ "visibility"
+ ]
},
{
"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"
+ "memberOf" : "Roo.util.Observable",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "name",
"type" : "string",
"desc" : "Specifies name attribute",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "style",
"type" : "String",
"desc" : "any extra css",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "tooltip",
"type" : "string",
"desc" : "Text for the tooltip",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "visibilityEl",
"type" : "string|object",
- "desc" : "t) What element to use for visibility (@see getVisibilityEl())",
- "memberOf" : "Roo.bootstrap.Component"
+ "desc" : "t) What element to use for visibility (@see getVisibilityEl(",
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : [
+ "el",
+ "parent"
+ ]
},
{
"name" : "xattr",
"type" : "Object",
"desc" : "extra attributes to add to 'element' (used by builder to store stuff.)",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
}
],
"events" : [
],
"isAbstract" : false,
"isBuilderTop" : false,
- "childClasses" : { },
+ "implementations" : [],
"tree_children" : [
"Roo.bootstrap.Alert",
"Roo.bootstrap.BezierSignature",
"Roo.bootstrap.Calendar",
"Roo.bootstrap.Card",
"Roo.bootstrap.Column",
- "Roo.bootstrap.Container",
"Roo.bootstrap.DocumentManager",
"Roo.bootstrap.DocumentSlider",
"Roo.bootstrap.DocumentViewer",
"Roo.bootstrap.form.TextArea",
"Roo.bootstrap.form.TimeField",
"Roo.bootstrap.form.TriggerField",
- "Roo.bootstrap.layout.Border",
"Roo.bootstrap.nav.Group",
"Roo.bootstrap.nav.Headerbar",
"Roo.bootstrap.nav.ProgressBar",
"name" : "actionMode",
"type" : "String",
"desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el' for forms you probably want to set this to fieldEl",
- "memberOf" : "Roo.Component"
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "allowDomMove",
"type" : "Boolean",
"desc" : "Whether the component can move the Dom node when rendering (defaults to true).",
- "memberOf" : "Roo.Component"
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "can_build_overlaid",
"type" : "Boolean",
"desc" : "True if element can be rebuild from a HTML page",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "cls",
"type" : "String",
"desc" : "css class",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "container_method",
"type" : "string",
"desc" : "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "dataId",
"type" : "string",
"desc" : "cutomer id",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "disableClass",
"type" : "String",
"desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").",
- "memberOf" : "Roo.Component"
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "hideMode",
"type" : "String",
- "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".",
- "memberOf" : "Roo.Component"
+ "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display",
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : [
+ "display",
+ "visibility"
+ ]
},
{
"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"
+ "memberOf" : "Roo.util.Observable",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "name",
"type" : "string",
"desc" : "Specifies name attribute",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "style",
"type" : "String",
"desc" : "any extra css",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "tooltip",
"type" : "string",
"desc" : "Text for the tooltip",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "visibilityEl",
"type" : "string|object",
- "desc" : "t) What element to use for visibility (@see getVisibilityEl())",
- "memberOf" : "Roo.bootstrap.Component"
+ "desc" : "t) What element to use for visibility (@see getVisibilityEl(",
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : [
+ "el",
+ "parent"
+ ]
},
{
"name" : "xattr",
"type" : "Object",
"desc" : "extra attributes to add to 'element' (used by builder to store stuff.)",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
}
],
"events" : [
],
"isAbstract" : false,
"isBuilderTop" : false,
- "childClasses" : { },
+ "implementations" : [],
"tree_children" : [],
"tree_parent" : []
},
"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"
+ "memberOf" : "Roo.util.Observable",
+ "isOptional" : false,
+ "optvals" : []
}
],
"events" : [
],
"isAbstract" : false,
"isBuilderTop" : false,
- "childClasses" : { },
+ "implementations" : [],
"tree_children" : [],
"tree_parent" : []
},
],
"isAbstract" : false,
"isBuilderTop" : false,
- "childClasses" : { },
+ "implementations" : [],
"tree_children" : [],
"tree_parent" : []
},
],
"isAbstract" : false,
"isBuilderTop" : false,
- "childClasses" : {
- "Roo.bootstrap.SplitBar.BasicLayoutAdapter" : [
- "Roo.bootstrap.SplitBar.AbsoluteLayoutAdapter"
- ]
- },
+ "implementations" : [
+ "Roo.bootstrap.SplitBar.AbsoluteLayoutAdapter"
+ ],
"tree_children" : [],
"tree_parent" : []
},
"name" : "actionMode",
"type" : "String",
"desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el' for forms you probably want to set this to fieldEl",
- "memberOf" : "Roo.Component"
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "alert",
"type" : "String",
- "desc" : "r) type alert (changes background / border...)",
- "memberOf" : "Roo.bootstrap.Column"
+ "desc" : "r) type alert (changes background / border..",
+ "memberOf" : "Roo.bootstrap.Column",
+ "isOptional" : false,
+ "optvals" : [
+ "success",
+ "info",
+ "warning",
+ "danger"
+ ]
},
{
"name" : "allowDomMove",
"type" : "Boolean",
"desc" : "Whether the component can move the Dom node when rendering (defaults to true).",
- "memberOf" : "Roo.Component"
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "autoslide",
"type" : "Boolean",
- "desc" : "e) auto slide .. default false",
- "memberOf" : ""
+ "desc" : "e) auto slide .. default fal",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : [
+ "true",
+ "false"
+ ]
},
{
"name" : "bullets",
"type" : "Boolean",
"desc" : "show bullets for the panels",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "can_build_overlaid",
"type" : "Boolean",
"desc" : "True if element can be rebuild from a HTML page",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "carousel",
"type" : "Boolean",
"desc" : "true to make the group behave like a carousel",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "cls",
"type" : "String",
"desc" : "css class",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "container_method",
"type" : "string",
"desc" : "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "dataId",
"type" : "string",
"desc" : "cutomer id",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "disableClass",
"type" : "String",
"desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").",
- "memberOf" : "Roo.Component"
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "fa",
"type" : "String",
- "desc" : ".) font awesome icon",
- "memberOf" : "Roo.bootstrap.Column"
+ "desc" : ".) font awesome ic",
+ "memberOf" : "Roo.bootstrap.Column",
+ "isOptional" : false,
+ "optvals" : [
+ "ban",
+ "check",
+ "..."
+ ]
},
{
"name" : "fasize",
"type" : "Number",
- "desc" : ".) font awsome size",
- "memberOf" : "Roo.bootstrap.Column"
+ "desc" : ".) font awsome si",
+ "memberOf" : "Roo.bootstrap.Column",
+ "isOptional" : false,
+ "optvals" : [
+ "1",
+ "2",
+ "...."
+ ]
},
{
"name" : "hidden",
"type" : "Boolean",
- "desc" : "e) hide the element",
- "memberOf" : "Roo.bootstrap.Column"
+ "desc" : "e) hide the eleme",
+ "memberOf" : "Roo.bootstrap.Column",
+ "isOptional" : false,
+ "optvals" : [
+ "true",
+ "false"
+ ]
},
{
"name" : "hideMode",
"type" : "String",
- "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".",
- "memberOf" : "Roo.Component"
+ "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display",
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : [
+ "display",
+ "visibility"
+ ]
},
{
"name" : "html",
"type" : "String",
"desc" : "content of column.",
- "memberOf" : "Roo.bootstrap.Column"
+ "memberOf" : "Roo.bootstrap.Column",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "icon",
"type" : "String",
- "desc" : ".) glyphicon name",
- "memberOf" : "Roo.bootstrap.Column"
+ "desc" : ".) glyphicon na",
+ "memberOf" : "Roo.bootstrap.Column",
+ "isOptional" : false,
+ "optvals" : [
+ "info-sign",
+ "check",
+ "..."
+ ]
},
{
"name" : "lg",
"type" : "Number",
"desc" : "colspan out of 12 for large computer-sized screens or 0 for hidden",
- "memberOf" : "Roo.bootstrap.Column"
+ "memberOf" : "Roo.bootstrap.Column",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "lgoff",
"type" : "Number",
"desc" : "colspan offset out of 12 for large computer-sized screens or 0 for hidden",
- "memberOf" : "Roo.bootstrap.Column"
+ "memberOf" : "Roo.bootstrap.Column",
+ "isOptional" : false,
+ "optvals" : []
},
{
"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"
+ "memberOf" : "Roo.util.Observable",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "md",
"type" : "Number",
"desc" : "colspan out of 12 for computer-sized screens or 0 for hidden",
- "memberOf" : "Roo.bootstrap.Column"
+ "memberOf" : "Roo.bootstrap.Column",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "mdoff",
"type" : "Number",
"desc" : "colspan offset out of 12 for computer-sized screens or 0 for hidden",
- "memberOf" : "Roo.bootstrap.Column"
+ "memberOf" : "Roo.bootstrap.Column",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "name",
"type" : "string",
"desc" : "Specifies name attribute",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "navId",
"type" : "String",
"desc" : "the navigation id (for use with navbars) - will be auto generated if it does not exist..",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "showarrow",
"type" : "Boolean",
- "desc" : "e) show arrow default true",
- "memberOf" : ""
+ "desc" : "e) show arrow default tr",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : [
+ "true",
+ "false"
+ ]
},
{
"name" : "sm",
"type" : "Number",
"desc" : "colspan out of 12 for tablet-sized screens or 0 for hidden",
- "memberOf" : "Roo.bootstrap.Column"
+ "memberOf" : "Roo.bootstrap.Column",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "smoff",
"type" : "Number",
"desc" : "colspan offset out of 12 for tablet-sized screens or 0 for hidden",
- "memberOf" : "Roo.bootstrap.Column"
+ "memberOf" : "Roo.bootstrap.Column",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "style",
"type" : "String",
"desc" : "any extra css",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "timer",
"type" : "Number",
"desc" : "auto slide timer .. default 0 millisecond",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "tooltip",
"type" : "string",
"desc" : "Text for the tooltip",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "visibilityEl",
"type" : "string|object",
- "desc" : "t) What element to use for visibility (@see getVisibilityEl())",
- "memberOf" : "Roo.bootstrap.Component"
+ "desc" : "t) What element to use for visibility (@see getVisibilityEl(",
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : [
+ "el",
+ "parent"
+ ]
},
{
"name" : "xattr",
"type" : "Object",
"desc" : "extra attributes to add to 'element' (used by builder to store stuff.)",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "xs",
"type" : "Number",
"desc" : "colspan out of 12 for mobile-sized screens or 0 for hidden",
- "memberOf" : "Roo.bootstrap.Column"
+ "memberOf" : "Roo.bootstrap.Column",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "xsoff",
"type" : "Number",
"desc" : "colspan offset out of 12 for mobile-sized screens or 0 for hidden",
- "memberOf" : "Roo.bootstrap.Column"
+ "memberOf" : "Roo.bootstrap.Column",
+ "isOptional" : false,
+ "optvals" : []
}
],
"events" : [
],
"isAbstract" : false,
"isBuilderTop" : false,
- "childClasses" : { },
+ "implementations" : [],
"tree_children" : [
"Roo.bootstrap.TabPanel"
],
"name" : "actionMode",
"type" : "String",
"desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el' for forms you probably want to set this to fieldEl",
- "memberOf" : "Roo.Component"
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "active",
"type" : "Boolean",
"desc" : "panel active",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "allowDomMove",
"type" : "Boolean",
"desc" : "Whether the component can move the Dom node when rendering (defaults to true).",
- "memberOf" : "Roo.Component"
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "can_build_overlaid",
"type" : "Boolean",
"desc" : "True if element can be rebuild from a HTML page",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "cls",
"type" : "String",
"desc" : "css class",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "container_method",
"type" : "string",
"desc" : "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "dataId",
"type" : "string",
"desc" : "cutomer id",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "disableClass",
"type" : "String",
"desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").",
- "memberOf" : "Roo.Component"
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "hideMode",
"type" : "String",
- "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".",
- "memberOf" : "Roo.Component"
+ "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display",
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : [
+ "display",
+ "visibility"
+ ]
},
{
"name" : "href",
"type" : "String",
"desc" : "click to link..",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "html",
"type" : "String",
"desc" : "panel content",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"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"
+ "memberOf" : "Roo.util.Observable",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "name",
"type" : "string",
"desc" : "Specifies name attribute",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "navId",
"type" : "String",
"desc" : "The Roo.bootstrap.nav.Group which triggers show hide ()",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "style",
"type" : "String",
"desc" : "any extra css",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "tabId",
"type" : "String",
"desc" : "unique tab ID (will be autogenerated if not set. - used to match TabItem to Panel)",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "tooltip",
"type" : "string",
"desc" : "Text for the tooltip",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "touchSlide",
"type" : "Boolean",
"desc" : "if swiping slides tab to next panel (default off)",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "visibilityEl",
"type" : "string|object",
- "desc" : "t) What element to use for visibility (@see getVisibilityEl())",
- "memberOf" : "Roo.bootstrap.Component"
+ "desc" : "t) What element to use for visibility (@see getVisibilityEl(",
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : [
+ "el",
+ "parent"
+ ]
},
{
"name" : "xattr",
"type" : "Object",
"desc" : "extra attributes to add to 'element' (used by builder to store stuff.)",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
}
],
"events" : [
],
"isAbstract" : false,
"isBuilderTop" : false,
- "childClasses" : { },
+ "implementations" : [],
"tree_children" : [
"Roo.bootstrap.Alert",
"Roo.bootstrap.BezierSignature",
"Roo.bootstrap.Calendar",
"Roo.bootstrap.Card",
"Roo.bootstrap.Column",
- "Roo.bootstrap.Container",
"Roo.bootstrap.DocumentManager",
"Roo.bootstrap.DocumentSlider",
"Roo.bootstrap.DocumentViewer",
"Roo.bootstrap.form.TextArea",
"Roo.bootstrap.form.TimeField",
"Roo.bootstrap.form.TriggerField",
- "Roo.bootstrap.layout.Border",
"Roo.bootstrap.nav.Group",
"Roo.bootstrap.nav.Headerbar",
"Roo.bootstrap.nav.ProgressBar",
"name" : "actionMode",
"type" : "String",
"desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el' for forms you probably want to set this to fieldEl",
- "memberOf" : "Roo.Component"
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "allowDomMove",
"type" : "Boolean",
"desc" : "Whether the component can move the Dom node when rendering (defaults to true).",
- "memberOf" : "Roo.Component"
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "auto_hide_footer",
"type" : "Boolean",
"desc" : "auto hide footer if only one page (default false)",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "bordered",
"type" : "boolean",
"desc" : "Add borders to the table",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "can_build_overlaid",
"type" : "Boolean",
"desc" : "True if element can be rebuild from a HTML page",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "cellSelection",
"type" : "Boolean",
- "desc" : "e) default false",
- "memberOf" : ""
+ "desc" : "e) default fal",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : [
+ "true",
+ "false"
+ ]
},
{
"name" : "cls",
"type" : "String",
"desc" : "table class",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "cm[]",
"type" : "Roo.grid.ColumnModel",
"desc" : "A column for the grid.",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "condensed",
"type" : "boolean",
"desc" : "Format condensed",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "container_method",
"type" : "string",
"desc" : "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "dataId",
"type" : "string",
"desc" : "cutomer id",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "disableClass",
"type" : "String",
"desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").",
- "memberOf" : "Roo.Component"
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "empty_results",
+ "type" : "string",
+ "desc" : "Text to display for no results",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "enableColumnResize",
"type" : "Boolean",
- "desc" : "default true if columns can be resized (drag/drop)",
- "memberOf" : ""
+ "desc" : "default true if columns can be resized = needs scrollBody to be set to work (drag/drop)",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "footer",
"type" : "Roo.bootstrap.PagingToolbar",
"desc" : "a paging toolbar",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "footerShow",
"type" : "Boolean",
- "desc" : "e) generate tfoot, default true",
- "memberOf" : ""
+ "desc" : "e) generate tfoot, default tr",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : [
+ "true",
+ "false"
+ ]
},
{
"name" : "headerShow",
"type" : "Boolean",
- "desc" : "e) generate thead, default true",
- "memberOf" : ""
+ "desc" : "e) generate thead, default tr",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : [
+ "true",
+ "false"
+ ]
},
{
"name" : "hideMode",
"type" : "String",
- "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".",
- "memberOf" : "Roo.Component"
+ "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display",
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : [
+ "display",
+ "visibility"
+ ]
},
{
"name" : "hover",
"type" : "boolean",
"desc" : "Add hover highlighting",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "lazyLoad",
"type" : "Boolean",
"desc" : "auto load data while scrolling to the end (default false)",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"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"
+ "memberOf" : "Roo.util.Observable",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "loadMask",
"type" : "Boolean",
- "desc" : "e) default false",
- "memberOf" : ""
+ "desc" : "e) default fal",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : [
+ "true",
+ "false"
+ ]
},
{
"name" : "minColumnWidth",
"type" : "Number",
"desc" : "default 50 pixels minimum column width",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "name",
"type" : "string",
"desc" : "Specifies name attribute",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "responsive",
"type" : "boolean",
"desc" : "default false - if this is on, columns are rendered with col-xs-4 etc. classes, otherwise columns will be sized by CSS,\n also adds table-responsive (see bootstrap docs for details)",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "rowSelection",
"type" : "Boolean",
- "desc" : "e) default false",
- "memberOf" : ""
+ "desc" : "e) default fal",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : [
+ "true",
+ "false"
+ ]
},
{
"name" : "scrollBody",
"type" : "Boolean",
- "desc" : "e) default false - body scrolled / fixed header",
- "memberOf" : ""
+ "desc" : "e) default false - body scrolled / fixed header (with resizable column",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : [
+ "true",
+ "false"
+ ]
},
{
"name" : "sm",
"type" : "Roo.grid.AbstractSelectionModel",
"desc" : "The selection model to use (cell selection is not supported yet)",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "store",
"type" : "Roo.data.Store",
"desc" : "The data store to use",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "striped",
"type" : "boolean",
"desc" : "Should the rows be alternative striped",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "style",
"type" : "String",
"desc" : "any extra css",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "tooltip",
"type" : "string",
"desc" : "Text for the tooltip",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "visibilityEl",
"type" : "string|object",
- "desc" : "t) What element to use for visibility (@see getVisibilityEl())",
- "memberOf" : "Roo.bootstrap.Component"
+ "desc" : "t) What element to use for visibility (@see getVisibilityEl(",
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : [
+ "el",
+ "parent"
+ ]
},
{
"name" : "xattr",
"type" : "Object",
"desc" : "extra attributes to add to 'element' (used by builder to store stuff.)",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
}
],
"events" : [
],
"isAbstract" : false,
"isBuilderTop" : false,
- "childClasses" : { },
+ "implementations" : [],
"tree_children" : [
"Roo.bootstrap.TableBody"
],
"name" : "actionMode",
"type" : "String",
"desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el' for forms you probably want to set this to fieldEl",
- "memberOf" : "Roo.Component"
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "align",
"type" : "String",
"desc" : "Aligns the content inside the element",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "allowDomMove",
"type" : "Boolean",
"desc" : "Whether the component can move the Dom node when rendering (defaults to true).",
- "memberOf" : "Roo.Component"
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "can_build_overlaid",
"type" : "Boolean",
"desc" : "True if element can be rebuild from a HTML page",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "charoff",
"type" : "Number",
"desc" : "Sets the number of characters the content inside the element will be aligned from the character specified by the char attribute",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "cls",
"type" : "String",
"desc" : "element class",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "container_method",
"type" : "string",
"desc" : "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "dataId",
"type" : "string",
"desc" : "cutomer id",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "disableClass",
"type" : "String",
"desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").",
- "memberOf" : "Roo.Component"
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "hideMode",
"type" : "String",
- "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".",
- "memberOf" : "Roo.Component"
+ "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display",
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : [
+ "display",
+ "visibility"
+ ]
},
{
"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"
+ "memberOf" : "Roo.util.Observable",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "name",
"type" : "string",
"desc" : "Specifies name attribute",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "style",
"type" : "String",
"desc" : "any extra css",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "tag",
"type" : "String",
"desc" : "element tag (thead|tbody|tfoot) default tbody",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "tooltip",
"type" : "string",
"desc" : "Text for the tooltip",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "valign",
"type" : "String",
"desc" : "Vertical aligns the content inside the <tbody> element",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "visibilityEl",
"type" : "string|object",
- "desc" : "t) What element to use for visibility (@see getVisibilityEl())",
- "memberOf" : "Roo.bootstrap.Component"
+ "desc" : "t) What element to use for visibility (@see getVisibilityEl(",
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : [
+ "el",
+ "parent"
+ ]
},
{
"name" : "xattr",
"type" : "Object",
"desc" : "extra attributes to add to 'element' (used by builder to store stuff.)",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
}
],
"events" : [
],
"isAbstract" : false,
"isBuilderTop" : false,
- "childClasses" : { },
+ "implementations" : [],
"tree_children" : [
"Roo.bootstrap.TableRow"
],
"name" : "abbr",
"type" : "String",
"desc" : "Specifies an abbreviated version of the content in a cell",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "actionMode",
"type" : "String",
"desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el' for forms you probably want to set this to fieldEl",
- "memberOf" : "Roo.Component"
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "align",
"type" : "String",
"desc" : "Aligns the content in a cell",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "allowDomMove",
"type" : "Boolean",
"desc" : "Whether the component can move the Dom node when rendering (defaults to true).",
- "memberOf" : "Roo.Component"
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "axis",
"type" : "String",
"desc" : "Categorizes cells",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "bgcolor",
"type" : "String",
"desc" : "Specifies the background color of a cell",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "can_build_overlaid",
"type" : "Boolean",
"desc" : "True if element can be rebuild from a HTML page",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "charoff",
"type" : "Number",
"desc" : "Sets the number of characters the content will be aligned from the character specified by the char attribute",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "cls",
"type" : "String",
"desc" : "cell class",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "colspan",
"type" : "Number",
"desc" : "Specifies the number of columns a cell should span",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "container_method",
"type" : "string",
"desc" : "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "dataId",
"type" : "string",
"desc" : "cutomer id",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "disableClass",
"type" : "String",
"desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").",
- "memberOf" : "Roo.Component"
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "headers",
"type" : "String",
"desc" : "Specifies one or more header cells a cell is related to",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "height",
"type" : "Number",
"desc" : "Sets the height of a cell",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "hideMode",
"type" : "String",
- "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".",
- "memberOf" : "Roo.Component"
+ "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display",
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : [
+ "display",
+ "visibility"
+ ]
},
{
"name" : "html",
"type" : "String",
"desc" : "cell contain text",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"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"
+ "memberOf" : "Roo.util.Observable",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "name",
"type" : "string",
"desc" : "Specifies name attribute",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "nowrap",
"type" : "String",
"desc" : "Specifies that the content inside a cell should not wrap",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "rowspan",
"type" : "Number",
"desc" : "Sets the number of rows a cell should span",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "scope",
"type" : "String",
"desc" : "Defines a way to associate header cells and data cells in a table",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "style",
"type" : "String",
"desc" : "any extra css",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "tag",
"type" : "String",
"desc" : "cell tag (td|th) default td",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "tooltip",
"type" : "string",
"desc" : "Text for the tooltip",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "valign",
"type" : "String",
"desc" : "Vertical aligns the content in a cell",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "visibilityEl",
"type" : "string|object",
- "desc" : "t) What element to use for visibility (@see getVisibilityEl())",
- "memberOf" : "Roo.bootstrap.Component"
+ "desc" : "t) What element to use for visibility (@see getVisibilityEl(",
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : [
+ "el",
+ "parent"
+ ]
},
{
"name" : "width",
"type" : "Number",
"desc" : "Specifies the width of a cell",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "xattr",
"type" : "Object",
"desc" : "extra attributes to add to 'element' (used by builder to store stuff.)",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
}
],
"events" : [
],
"isAbstract" : false,
"isBuilderTop" : false,
- "childClasses" : { },
+ "implementations" : [],
"tree_children" : [
"Roo.bootstrap.Alert",
"Roo.bootstrap.BezierSignature",
"Roo.bootstrap.Calendar",
"Roo.bootstrap.Card",
"Roo.bootstrap.Column",
- "Roo.bootstrap.Container",
"Roo.bootstrap.DocumentManager",
"Roo.bootstrap.DocumentSlider",
"Roo.bootstrap.DocumentViewer",
"Roo.bootstrap.form.TextArea",
"Roo.bootstrap.form.TimeField",
"Roo.bootstrap.form.TriggerField",
- "Roo.bootstrap.layout.Border",
"Roo.bootstrap.nav.Group",
"Roo.bootstrap.nav.Headerbar",
"Roo.bootstrap.nav.ProgressBar",
"name" : "actionMode",
"type" : "String",
"desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el' for forms you probably want to set this to fieldEl",
- "memberOf" : "Roo.Component"
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "align",
"type" : "String",
"desc" : "Aligns the content in a table row",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "allowDomMove",
"type" : "Boolean",
"desc" : "Whether the component can move the Dom node when rendering (defaults to true).",
- "memberOf" : "Roo.Component"
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "bgcolor",
"type" : "String",
"desc" : "Specifies a background color for a table row",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "can_build_overlaid",
"type" : "Boolean",
"desc" : "True if element can be rebuild from a HTML page",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "charoff",
"type" : "Number",
"desc" : "Sets the number of characters the content will be aligned from the character specified by the char attribute",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "cls",
"type" : "String",
"desc" : "row class",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "container_method",
"type" : "string",
"desc" : "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "dataId",
"type" : "string",
"desc" : "cutomer id",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "disableClass",
"type" : "String",
"desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").",
- "memberOf" : "Roo.Component"
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "hideMode",
"type" : "String",
- "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".",
- "memberOf" : "Roo.Component"
+ "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display",
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : [
+ "display",
+ "visibility"
+ ]
},
{
"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"
+ "memberOf" : "Roo.util.Observable",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "name",
"type" : "string",
"desc" : "Specifies name attribute",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "style",
"type" : "String",
"desc" : "any extra css",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "tooltip",
"type" : "string",
"desc" : "Text for the tooltip",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "valign",
"type" : "String",
"desc" : "Vertical aligns the content in a table row",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "visibilityEl",
"type" : "string|object",
- "desc" : "t) What element to use for visibility (@see getVisibilityEl())",
- "memberOf" : "Roo.bootstrap.Component"
+ "desc" : "t) What element to use for visibility (@see getVisibilityEl(",
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : [
+ "el",
+ "parent"
+ ]
},
{
"name" : "xattr",
"type" : "Object",
"desc" : "extra attributes to add to 'element' (used by builder to store stuff.)",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
}
],
"events" : [
],
"isAbstract" : false,
"isBuilderTop" : false,
- "childClasses" : { },
+ "implementations" : [],
"tree_children" : [
"Roo.bootstrap.TableCell"
],
],
"isAbstract" : false,
"isBuilderTop" : false,
- "childClasses" : { },
+ "implementations" : [],
"tree_children" : [],
"tree_parent" : []
},
"name" : "actionMode",
"type" : "String",
"desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el' for forms you probably want to set this to fieldEl",
- "memberOf" : "Roo.Component"
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "allowDomMove",
"type" : "Boolean",
"desc" : "Whether the component can move the Dom node when rendering (defaults to true).",
- "memberOf" : "Roo.Component"
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "buttons",
"type" : "Array",
"desc" : "default ['rotateLeft', 'pictureBtn', 'rotateRight']",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "can_build_overlaid",
"type" : "Boolean",
"desc" : "True if element can be rebuild from a HTML page",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "cls",
"type" : "String",
"desc" : "css class",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "container_method",
"type" : "string",
"desc" : "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "dataId",
"type" : "string",
"desc" : "cutomer id",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "disableClass",
"type" : "String",
"desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").",
- "memberOf" : "Roo.Component"
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "emptyText",
"type" : "String",
"desc" : "show when image has been loaded",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "errorTimeout",
"type" : "Number",
"desc" : "default 3000",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "hideMode",
"type" : "String",
- "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".",
- "memberOf" : "Roo.Component"
+ "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display",
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : [
+ "display",
+ "visibility"
+ ]
},
{
"name" : "isDocument",
"type" : "Boolean",
- "desc" : "e) default false",
- "memberOf" : ""
+ "desc" : "e) default fal",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : [
+ "true",
+ "false"
+ ]
},
{
"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"
+ "memberOf" : "Roo.util.Observable",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "loadMask",
"type" : "Boolean",
- "desc" : "e) default true",
- "memberOf" : ""
+ "desc" : "e) default tr",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : [
+ "true",
+ "false"
+ ]
},
{
"name" : "loadingText",
"type" : "Boolean",
"desc" : "default 'Loading...'",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "method",
"type" : "String",
"desc" : "default POST",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "minHeight",
"type" : "Number",
"desc" : "default 300",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "minWidth",
"type" : "Number",
"desc" : "default 300",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "name",
"type" : "string",
"desc" : "Specifies name attribute",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "paramName",
"type" : "String",
"desc" : "default 'imageUpload'",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "rotateNotify",
"type" : "String",
"desc" : "show when image too small to rotate",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "style",
"type" : "String",
"desc" : "any extra css",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "tooltip",
"type" : "string",
"desc" : "Text for the tooltip",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "url",
"type" : "String",
"desc" : "action url",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "visibilityEl",
"type" : "string|object",
- "desc" : "t) What element to use for visibility (@see getVisibilityEl())",
- "memberOf" : "Roo.bootstrap.Component"
+ "desc" : "t) What element to use for visibility (@see getVisibilityEl(",
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : [
+ "el",
+ "parent"
+ ]
},
{
"name" : "xattr",
"type" : "Object",
"desc" : "extra attributes to add to 'element' (used by builder to store stuff.)",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
}
],
"events" : [
],
"isAbstract" : false,
"isBuilderTop" : false,
- "childClasses" : { },
+ "implementations" : [],
"tree_children" : [],
"tree_parent" : []
},
"methods" : [],
"isAbstract" : false,
"isBuilderTop" : false,
- "childClasses" : { },
+ "implementations" : [],
"tree_children" : [],
"tree_parent" : []
},
"name" : "actionMode",
"type" : "String",
"desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el' for forms you probably want to set this to fieldEl",
- "memberOf" : "Roo.Component"
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "active",
"type" : "Boolean",
"desc" : "is it active",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "allowDomMove",
"type" : "Boolean",
"desc" : "Whether the component can move the Dom node when rendering (defaults to true).",
- "memberOf" : "Roo.Component"
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "can_build_overlaid",
"type" : "Boolean",
"desc" : "True if element can be rebuild from a HTML page",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "cls",
"type" : "String",
"desc" : "css class",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "container_method",
"type" : "string",
"desc" : "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "dataId",
"type" : "string",
"desc" : "cutomer id",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "disableClass",
"type" : "String",
"desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").",
- "memberOf" : "Roo.Component"
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "hideMode",
"type" : "String",
- "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".",
- "memberOf" : "Roo.Component"
+ "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display",
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : [
+ "display",
+ "visibility"
+ ]
},
{
"name" : "href",
"type" : "String",
"desc" : "where it links to if '#' is used the link will be handled by onClick.",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "html",
"type" : "String",
"desc" : "the content of the link.",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"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"
+ "memberOf" : "Roo.util.Observable",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "name",
"type" : "string",
"desc" : "Specifies name attribute",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "style",
"type" : "String",
"desc" : "any extra css",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "tooltip",
"type" : "string",
"desc" : "Text for the tooltip",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "visibilityEl",
"type" : "string|object",
- "desc" : "t) What element to use for visibility (@see getVisibilityEl())",
- "memberOf" : "Roo.bootstrap.Component"
+ "desc" : "t) What element to use for visibility (@see getVisibilityEl(",
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : [
+ "el",
+ "parent"
+ ]
},
{
"name" : "xattr",
"type" : "Object",
"desc" : "extra attributes to add to 'element' (used by builder to store stuff.)",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
}
],
"events" : [
],
"isAbstract" : false,
"isBuilderTop" : false,
- "childClasses" : { },
+ "implementations" : [],
"tree_children" : [
"Roo.bootstrap.Alert",
"Roo.bootstrap.BezierSignature",
"Roo.bootstrap.Calendar",
"Roo.bootstrap.Card",
"Roo.bootstrap.Column",
- "Roo.bootstrap.Container",
"Roo.bootstrap.DocumentManager",
"Roo.bootstrap.DocumentSlider",
"Roo.bootstrap.DocumentViewer",
"Roo.bootstrap.form.TextArea",
"Roo.bootstrap.form.TimeField",
"Roo.bootstrap.form.TriggerField",
- "Roo.bootstrap.layout.Border",
"Roo.bootstrap.nav.Group",
"Roo.bootstrap.nav.Headerbar",
"Roo.bootstrap.nav.ProgressBar",
"name" : "actionMode",
"type" : "String",
"desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el' for forms you probably want to set this to fieldEl",
- "memberOf" : "Roo.Component"
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "allowDomMove",
"type" : "Boolean",
"desc" : "Whether the component can move the Dom node when rendering (defaults to true).",
- "memberOf" : "Roo.Component"
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "can_build_overlaid",
"type" : "Boolean",
"desc" : "True if element can be rebuild from a HTML page",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "cls",
"type" : "String",
"desc" : "css class",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "container_method",
"type" : "string",
"desc" : "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "dataId",
"type" : "string",
"desc" : "cutomer id",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "disableClass",
"type" : "String",
"desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").",
- "memberOf" : "Roo.Component"
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "hideMode",
"type" : "String",
- "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".",
- "memberOf" : "Roo.Component"
+ "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display",
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : [
+ "display",
+ "visibility"
+ ]
},
{
"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"
+ "memberOf" : "Roo.util.Observable",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "name",
"type" : "string",
"desc" : "Specifies name attribute",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "style",
"type" : "String",
"desc" : "any extra css",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "tooltip",
"type" : "string",
"desc" : "Text for the tooltip",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "visibilityEl",
"type" : "string|object",
- "desc" : "t) What element to use for visibility (@see getVisibilityEl())",
- "memberOf" : "Roo.bootstrap.Component"
+ "desc" : "t) What element to use for visibility (@see getVisibilityEl(",
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : [
+ "el",
+ "parent"
+ ]
},
{
"name" : "xattr",
"type" : "Object",
"desc" : "extra attributes to add to 'element' (used by builder to store stuff.)",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
}
],
"events" : [
],
"isAbstract" : false,
"isBuilderTop" : false,
- "childClasses" : { },
+ "implementations" : [],
"tree_children" : [
"Roo.bootstrap.breadcrumb.Item"
],
"methods" : [],
"isAbstract" : false,
"isBuilderTop" : false,
- "childClasses" : { },
+ "implementations" : [],
"tree_children" : [],
"tree_parent" : []
},
"name" : "actionMode",
"type" : "String",
"desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el' for forms you probably want to set this to fieldEl",
- "memberOf" : "Roo.Component"
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "allowDomMove",
"type" : "Boolean",
"desc" : "Whether the component can move the Dom node when rendering (defaults to true).",
- "memberOf" : "Roo.Component"
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "can_build_overlaid",
"type" : "Boolean",
"desc" : "True if element can be rebuild from a HTML page",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "cls",
"type" : "String",
"desc" : "css class",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "container_method",
"type" : "string",
"desc" : "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "content",
"type" : "String",
"desc" : "Box content",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "dataId",
"type" : "string",
"desc" : "cutomer id",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "disableClass",
"type" : "String",
"desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").",
- "memberOf" : "Roo.Component"
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "fhref",
"type" : "String",
"desc" : "Footer href",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "footer",
"type" : "String",
"desc" : "Footer text",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "headline",
"type" : "String",
"desc" : "Box headline",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "hideMode",
"type" : "String",
- "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".",
- "memberOf" : "Roo.Component"
+ "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display",
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : [
+ "display",
+ "visibility"
+ ]
},
{
"name" : "icon",
"type" : "String",
"desc" : "Box icon",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"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"
+ "memberOf" : "Roo.util.Observable",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "name",
"type" : "string",
"desc" : "Specifies name attribute",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "style",
"type" : "String",
"desc" : "any extra css",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "tooltip",
"type" : "string",
"desc" : "Text for the tooltip",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "visibilityEl",
"type" : "string|object",
- "desc" : "t) What element to use for visibility (@see getVisibilityEl())",
- "memberOf" : "Roo.bootstrap.Component"
+ "desc" : "t) What element to use for visibility (@see getVisibilityEl(",
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : [
+ "el",
+ "parent"
+ ]
},
{
"name" : "xattr",
"type" : "Object",
"desc" : "extra attributes to add to 'element' (used by builder to store stuff.)",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
}
],
"events" : [
],
"isAbstract" : false,
"isBuilderTop" : false,
- "childClasses" : { },
+ "implementations" : [],
"tree_children" : [],
"tree_parent" : []
},
"name" : "actionMode",
"type" : "String",
"desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el' for forms you probably want to set this to fieldEl",
- "memberOf" : "Roo.Component"
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "allowDomMove",
"type" : "Boolean",
"desc" : "Whether the component can move the Dom node when rendering (defaults to true).",
- "memberOf" : "Roo.Component"
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "can_build_overlaid",
"type" : "Boolean",
"desc" : "True if element can be rebuild from a HTML page",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "cls",
"type" : "String",
"desc" : "css class",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "container_method",
"type" : "string",
"desc" : "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "dataId",
"type" : "string",
"desc" : "cutomer id",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "disableClass",
"type" : "String",
"desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").",
- "memberOf" : "Roo.Component"
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "hideMode",
"type" : "String",
- "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".",
- "memberOf" : "Roo.Component"
+ "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display",
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : [
+ "display",
+ "visibility"
+ ]
},
{
"name" : "icon",
"type" : "String",
"desc" : "Icon of the TabBox",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"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"
+ "memberOf" : "Roo.util.Observable",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "name",
"type" : "string",
"desc" : "Specifies name attribute",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "showtabs",
"type" : "Boolean",
- "desc" : "e) show the tabs default true",
- "memberOf" : ""
+ "desc" : "e) show the tabs default tr",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : [
+ "true",
+ "false"
+ ]
},
{
"name" : "style",
"type" : "String",
"desc" : "any extra css",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "tabScrollable",
"type" : "Boolean",
- "desc" : "e) tab scrollable when mobile view default false",
- "memberOf" : ""
+ "desc" : "e) tab scrollable when mobile view default fal",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : [
+ "true",
+ "false"
+ ]
},
{
"name" : "title",
"type" : "String",
"desc" : "Title of the TabBox",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "tooltip",
"type" : "string",
"desc" : "Text for the tooltip",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "visibilityEl",
"type" : "string|object",
- "desc" : "t) What element to use for visibility (@see getVisibilityEl())",
- "memberOf" : "Roo.bootstrap.Component"
+ "desc" : "t) What element to use for visibility (@see getVisibilityEl(",
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : [
+ "el",
+ "parent"
+ ]
},
{
"name" : "xattr",
"type" : "Object",
"desc" : "extra attributes to add to 'element' (used by builder to store stuff.)",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
}
],
"events" : [
],
"isAbstract" : false,
"isBuilderTop" : false,
- "childClasses" : { },
+ "implementations" : [],
"tree_children" : [
"Roo.bootstrap.dash.TabPane"
],
"name" : "actionMode",
"type" : "String",
"desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el' for forms you probably want to set this to fieldEl",
- "memberOf" : "Roo.Component"
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "active",
"type" : "Boolean",
- "desc" : "e) Default false",
- "memberOf" : ""
+ "desc" : "e) Default fal",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : [
+ "false",
+ "true"
+ ]
},
{
"name" : "allowDomMove",
"type" : "Boolean",
"desc" : "Whether the component can move the Dom node when rendering (defaults to true).",
- "memberOf" : "Roo.Component"
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "can_build_overlaid",
"type" : "Boolean",
"desc" : "True if element can be rebuild from a HTML page",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "cls",
"type" : "String",
"desc" : "css class",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "container_method",
"type" : "string",
"desc" : "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "dataId",
"type" : "string",
"desc" : "cutomer id",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "disableClass",
"type" : "String",
"desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").",
- "memberOf" : "Roo.Component"
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "hideMode",
"type" : "String",
- "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".",
- "memberOf" : "Roo.Component"
+ "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display",
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : [
+ "display",
+ "visibility"
+ ]
},
{
"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"
+ "memberOf" : "Roo.util.Observable",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "name",
"type" : "string",
"desc" : "Specifies name attribute",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "style",
"type" : "String",
"desc" : "any extra css",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "title",
"type" : "String",
"desc" : "title of panel",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "tooltip",
"type" : "string",
"desc" : "Text for the tooltip",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "visibilityEl",
"type" : "string|object",
- "desc" : "t) What element to use for visibility (@see getVisibilityEl())",
- "memberOf" : "Roo.bootstrap.Component"
+ "desc" : "t) What element to use for visibility (@see getVisibilityEl(",
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : [
+ "el",
+ "parent"
+ ]
},
{
"name" : "xattr",
"type" : "Object",
"desc" : "extra attributes to add to 'element' (used by builder to store stuff.)",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
}
],
"events" : [
],
"isAbstract" : false,
"isBuilderTop" : false,
- "childClasses" : { },
+ "implementations" : [],
"tree_children" : [
"Roo.bootstrap.Graph",
"Roo.bootstrap.Column",
"methods" : [],
"isAbstract" : false,
"isBuilderTop" : false,
- "childClasses" : { },
+ "implementations" : [],
"tree_children" : [],
"tree_parent" : []
},
"name" : "actionMode",
"type" : "String",
"desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el' for forms you probably want to set this to fieldEl",
- "memberOf" : "Roo.Component"
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "allowDomMove",
"type" : "Boolean",
"desc" : "Whether the component can move the Dom node when rendering (defaults to true).",
- "memberOf" : "Roo.Component"
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "badge",
"type" : "String",
"desc" : "text for badge",
- "memberOf" : "Roo.bootstrap.Button"
+ "memberOf" : "Roo.bootstrap.Button",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "badge_weight",
"type" : "String",
- "desc" : "k) default (same as button)",
- "memberOf" : "Roo.bootstrap.Button"
+ "desc" : "k) default (same as butto",
+ "memberOf" : "Roo.bootstrap.Button",
+ "isOptional" : false,
+ "optvals" : [
+ "default",
+ "primary",
+ "secondary",
+ "success",
+ "info",
+ "warning",
+ "danger",
+ "link",
+ "light",
+ "dark"
+ ]
},
{
"name" : "can_build_overlaid",
"type" : "Boolean",
"desc" : "True if element can be rebuild from a HTML page",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "cls",
"type" : "String",
"desc" : "css class",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "container_method",
"type" : "string",
"desc" : "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "dataId",
"type" : "string",
"desc" : "cutomer id",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "disableClass",
"type" : "String",
"desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").",
- "memberOf" : "Roo.Component"
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "disabled",
"type" : "Boolean",
"desc" : "default false;",
- "memberOf" : "Roo.bootstrap.Button"
+ "memberOf" : "Roo.bootstrap.Button",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "errorTimeout",
"type" : "Number",
"desc" : "default 3000",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "fa",
"type" : "String",
"desc" : "fontawesome icon - eg. 'comment' - without the fa/fas etc..",
- "memberOf" : "Roo.bootstrap.Button"
+ "memberOf" : "Roo.bootstrap.Button",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "glyphicon",
"type" : "String",
"desc" : "depricated - use fa",
- "memberOf" : "Roo.bootstrap.Button"
+ "memberOf" : "Roo.bootstrap.Button",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "grpup",
"type" : "Boolean",
"desc" : "if parent is a btn group - then it turns it into a toogleGroup.",
- "memberOf" : "Roo.bootstrap.Button"
+ "memberOf" : "Roo.bootstrap.Button",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "hideMode",
"type" : "String",
- "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".",
- "memberOf" : "Roo.Component"
+ "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display",
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : [
+ "display",
+ "visibility"
+ ]
},
{
"name" : "href",
"type" : "String",
"desc" : "empty or href",
- "memberOf" : "Roo.bootstrap.Button"
+ "memberOf" : "Roo.bootstrap.Button",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "html",
"type" : "Array",
"desc" : "The button text.",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "images",
"type" : "Array",
"desc" : "an array of ?? Img objects ??? when loading existing files..",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "inverse",
"type" : "Boolean",
"desc" : "dark themed version",
- "memberOf" : "Roo.bootstrap.Button"
+ "memberOf" : "Roo.bootstrap.Button",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "isClose",
"type" : "Boolean",
"desc" : "default false;",
- "memberOf" : "Roo.bootstrap.Button"
+ "memberOf" : "Roo.bootstrap.Button",
+ "isOptional" : false,
+ "optvals" : []
},
{
"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"
+ "memberOf" : "Roo.util.Observable",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "menu",
"type" : "Roo.bootstrap.menu.Menu",
"desc" : "a Menu",
- "memberOf" : "Roo.bootstrap.Button"
+ "memberOf" : "Roo.bootstrap.Button",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "name",
"type" : "string",
"desc" : "Specifies name attribute",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "offtext",
"type" : "String",
"desc" : "text for off slidy toggle state",
- "memberOf" : "Roo.bootstrap.Button"
+ "memberOf" : "Roo.bootstrap.Button",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "ontext",
"type" : "String",
"desc" : "text for on slidy toggle state",
- "memberOf" : "Roo.bootstrap.Button"
+ "memberOf" : "Roo.bootstrap.Button",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "outline",
"type" : "Boolean",
"desc" : "default false (except for weight=default which emulates old behaveiour with an outline)",
- "memberOf" : "Roo.bootstrap.Button"
+ "memberOf" : "Roo.bootstrap.Button",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "pressed",
"type" : "Boolean",
"desc" : "default null - if the button ahs active state",
- "memberOf" : "Roo.bootstrap.Button"
+ "memberOf" : "Roo.bootstrap.Button",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "preventDefault",
"type" : "Boolean",
"desc" : "default true (stop click event triggering the URL if it's a link.)",
- "memberOf" : "Roo.bootstrap.Button"
+ "memberOf" : "Roo.bootstrap.Button",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "removeClass",
"type" : "Boolean",
"desc" : "remove the standard class..",
- "memberOf" : "Roo.bootstrap.Button"
+ "memberOf" : "Roo.bootstrap.Button",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "size",
"type" : "String",
- "desc" : "s)",
- "memberOf" : "Roo.bootstrap.Button"
+ "desc" : "",
+ "memberOf" : "Roo.bootstrap.Button",
+ "isOptional" : false,
+ "optvals" : [
+ "lg",
+ "sm",
+ "xs"
+ ]
},
{
"name" : "style",
"type" : "String",
"desc" : "any extra css",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "tag",
"type" : "String",
- "desc" : "t)",
- "memberOf" : "Roo.bootstrap.Button"
+ "desc" : "",
+ "memberOf" : "Roo.bootstrap.Button",
+ "isOptional" : false,
+ "optvals" : [
+ "a",
+ "input",
+ "submit"
+ ]
},
{
"name" : "target",
"type" : "String",
- "desc" : "r) target for a href.",
- "memberOf" : "Roo.bootstrap.Button"
+ "desc" : "r) target for a hre",
+ "memberOf" : "Roo.bootstrap.Button",
+ "isOptional" : false,
+ "optvals" : [
+ "_self",
+ "_blank",
+ "_parent",
+ "_top",
+ "other"
+ ]
},
{
"name" : "theme",
"type" : "String",
- "desc" : "w)",
- "memberOf" : "Roo.bootstrap.Button"
+ "desc" : "",
+ "memberOf" : "Roo.bootstrap.Button",
+ "isOptional" : false,
+ "optvals" : [
+ "default",
+ "glow"
+ ]
},
{
"name" : "toggle",
"type" : "Boolean",
"desc" : "is it a slidy toggle button",
- "memberOf" : "Roo.bootstrap.Button"
+ "memberOf" : "Roo.bootstrap.Button",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "tooltip",
"type" : "string",
"desc" : "Text for the tooltip",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "visibilityEl",
"type" : "string|object",
- "desc" : "t) What element to use for visibility (@see getVisibilityEl())",
- "memberOf" : "Roo.bootstrap.Component"
+ "desc" : "t) What element to use for visibility (@see getVisibilityEl(",
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : [
+ "el",
+ "parent"
+ ]
},
{
"name" : "weight",
"type" : "String",
- "desc" : "k) default",
- "memberOf" : "Roo.bootstrap.Button"
+ "desc" : "k) defau",
+ "memberOf" : "Roo.bootstrap.Button",
+ "isOptional" : false,
+ "optvals" : [
+ "default",
+ "primary",
+ "secondary",
+ "success",
+ "info",
+ "warning",
+ "danger",
+ "link",
+ "light",
+ "dark"
+ ]
},
{
"name" : "xattr",
"type" : "Object",
"desc" : "extra attributes to add to 'element' (used by builder to store stuff.)",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
}
],
"events" : [
],
"isAbstract" : false,
"isBuilderTop" : false,
- "childClasses" : { },
+ "implementations" : [],
"tree_children" : [],
"tree_parent" : []
},
{
"name" : "accept",
"type" : "String",
- "desc" : "o) use for file input only. (default empty)",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "desc" : "o) use for file input only. (default empt",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : [
+ "image",
+ "video",
+ "audio"
+ ]
},
{
"name" : "actionMode",
"type" : "String",
"desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el' for forms you probably want to set this to fieldEl",
- "memberOf" : "Roo.Component"
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "after",
"type" : "string",
"desc" : "- input group add on after",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "afterButton",
"type" : "Roo.bootstrap.Button",
"desc" : "to show before",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "align",
"type" : "String",
- "desc" : "t) Default left",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "desc" : "t) Default le",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : [
+ "left",
+ "center",
+ "right"
+ ]
},
{
"name" : "allowBlank",
"type" : "Boolean",
"desc" : "False to validate that the value length > 0 (defaults to true)",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "allowDomMove",
"type" : "Boolean",
"desc" : "Whether the component can move the Dom node when rendering (defaults to true).",
- "memberOf" : "Roo.Component"
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "autocomplete",
"type" : "String",
"desc" : "- default is new-password see: https://developers.google.com/web/fundamentals/input/form/label-and-name-inputs?hl=en",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "before",
"type" : "string",
"desc" : "- input group add on before",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "blankText",
"type" : "String",
"desc" : "Error text to display if the allow blank validation fails (defaults to \"This field is required\")",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "boxLabel",
"type" : "String",
"desc" : "The text that appears beside the checkbox",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "can_build_overlaid",
"type" : "Boolean",
"desc" : "True if element can be rebuild from a HTML page",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "capture",
"type" : "String",
- "desc" : "a) use for file input only. (default empty)",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "desc" : "a) use for file input only. (default empt",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : [
+ "user",
+ "camera"
+ ]
},
{
"name" : "checked",
"type" : "Boolean",
"desc" : "initnal the element",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "cls",
"type" : "String",
"desc" : "css class",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "container_method",
"type" : "string",
"desc" : "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "dataId",
"type" : "string",
"desc" : "cutomer id",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "disableClass",
"type" : "String",
"desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").",
- "memberOf" : "Roo.Component"
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "disableKeyFilter",
"type" : "Boolean",
"desc" : "True to disable input keystroke filtering (defaults to false)",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "disabled",
"type" : "Boolean",
"desc" : "is it disabled",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "fieldLabel",
"type" : "string",
"desc" : "- the label associated",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "focusClass",
"type" : "String",
"desc" : "The CSS class to use when the field receives focus (defaults to \"x-form-focus\")",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "forceFeedback",
"type" : "Boolean",
- "desc" : "e) Default false",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "desc" : "e) Default fal",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : [
+ "true",
+ "false"
+ ]
},
{
"name" : "groupId",
"type" : "String",
"desc" : "the checkbox group id // normal just use for checkbox",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "hasFeedback",
"type" : "Boolean",
- "desc" : "e) default true",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "desc" : "e) default tr",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : [
+ "true",
+ "false"
+ ]
},
{
"name" : "hideMode",
"type" : "String",
- "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".",
- "memberOf" : "Roo.Component"
+ "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display",
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : [
+ "display",
+ "visibility"
+ ]
},
{
"name" : "indicatorpos",
"type" : "String",
- "desc" : "t) default left",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "desc" : "t) default le",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : [
+ "left",
+ "right"
+ ]
},
{
"name" : "inline",
"type" : "Boolean",
"desc" : "inline the element (default false)",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "inputType",
"type" : "String",
- "desc" : "t)",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "desc" : "",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : [
+ "button",
+ "checkbox",
+ "email",
+ "file",
+ "hidden",
+ "image",
+ "number",
+ "password",
+ "radio",
+ "range",
+ "reset",
+ "search",
+ "submit",
+ "text"
+ ]
},
{
"name" : "inputValue",
"type" : "String",
"desc" : "The value that should go into the generated input element's value when checked.",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "invalidClass",
"type" : "String",
"desc" : "DEPRICATED - code uses BS4 - is-valid / is-invalid",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "invalidFeedbackIcon",
"type" : "String",
"desc" : "The CSS class to use when create feedback icon (defaults to \"x-form-invalid\")",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "invalidText",
"type" : "String",
"desc" : "The error text to display if {@link #validator} test fails during validation (defaults to \"\")",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "labelAlign",
"type" : "String",
- "desc" : "t)",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "desc" : "",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : [
+ "top",
+ "left"
+ ]
},
{
"name" : "labelWidth",
"type" : "Number",
"desc" : "set the width of label",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "labellg",
"type" : "Number",
"desc" : "set the width of label (1-12)",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "labelmd",
"type" : "Number",
"desc" : "set the width of label (1-12)",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "labelsm",
"type" : "Number",
"desc" : "set the width of label (1-12)",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "labelxs",
"type" : "Number",
"desc" : "set the width of label (1-12)",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "lg",
"type" : "Number",
"desc" : "colspan out of 12 for large computer-sized screens",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"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"
+ "memberOf" : "Roo.util.Observable",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "maskRe",
"type" : "String",
"desc" : "An input mask regular expression that will be used to filter keystrokes that don't match (defaults to null)",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "maxLength",
"type" : "Number",
"desc" : "Maximum input field length allowed (defaults to Number.MAX_VALUE)",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "maxLengthText",
"type" : "String",
"desc" : "Error text to display if the maximum length validation fails (defaults to \"The maximum length for this field is {maxLength}\")",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "md",
"type" : "Number",
"desc" : "colspan out of 12 for computer-sized screens",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "minLength",
"type" : "Number",
"desc" : "Minimum input field length required (defaults to 0)",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "minLengthText",
"type" : "String",
"desc" : "Error text to display if the minimum length validation fails (defaults to \"The minimum length for this field is {minLength}\")",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "name",
"type" : "String",
"desc" : "name of the input",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "placeholder",
"type" : "string",
"desc" : "- placeholder to put in text.",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "preventMark",
"type" : "Boolean",
"desc" : "Do not show tick or cross if error/success",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "readOnly",
"type" : "Boolean",
"desc" : "Specifies that the field should be read-only",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "regex",
"type" : "RegExp",
"desc" : "A JavaScript RegExp object to be tested against the field value during validation (defaults to null).\nIf available, this regex will be evaluated only after the basic validators all return true, and will be passed the\ncurrent field value. If the test fails, the field will be marked invalid using {@link #regexText}.",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "regexText",
"type" : "String",
"desc" : "-- Depricated - use Invalid Text",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "selectOnFocus",
"type" : "Boolean",
"desc" : "True to automatically select any existing field text when the field receives input focus (defaults to false)",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "size",
"type" : "string",
"desc" : "- (lg|sm) or leave empty..",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "sm",
"type" : "Number",
"desc" : "colspan out of 12 for tablet-sized screens",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "style",
"type" : "String",
"desc" : "any extra css",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "tooltip",
"type" : "String",
"desc" : "label tooltip",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "validClass",
"type" : "String",
"desc" : "DEPRICATED - code uses BS4 - is-valid / is-invalid",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "validFeedbackIcon",
"type" : "String",
"desc" : "The CSS class to use when create feedback icon (defaults to \"x-form-invalid\")",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "validateOnBlur",
"type" : "Boolean",
"desc" : "Whether the field should validate when it loses focus (defaults to true).",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "validationDelay",
"type" : "Number",
"desc" : "The length of time in milliseconds after user input begins until validation is initiated (defaults to 250)",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "validationEvent",
"type" : "String/Boolean",
"desc" : "The event that should initiate field validation. Set to false to disable\n automatic validation (defaults to \"keyup\").",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "validator",
"type" : "Function",
"desc" : "A custom validation function to be called during field validation (defaults to null).\nIf available, this function will be called only after the basic validators all return true, and will be passed the\ncurrent field value and expected to return boolean true if the value is valid or a string error message if invalid.",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "value",
"type" : "string",
"desc" : "default value of the input",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "valueOff",
"type" : "String",
"desc" : "The value that should go into the generated input element's value when unchecked.",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "visibilityEl",
"type" : "string|object",
- "desc" : "t) What element to use for visibility (@see getVisibilityEl())",
- "memberOf" : "Roo.bootstrap.Component"
+ "desc" : "t) What element to use for visibility (@see getVisibilityEl(",
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : [
+ "el",
+ "parent"
+ ]
},
{
"name" : "vtype",
"type" : "String",
"desc" : "A validation type name as defined in {@link Roo.form.VTypes} (defaults to null)",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "weight",
"type" : "String",
- "desc" : "s) The text that appears beside the checkbox",
- "memberOf" : ""
+ "desc" : "s) The text that appears beside the checkb",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : [
+ "primary",
+ "warning",
+ "info",
+ "danger",
+ "success"
+ ]
},
{
"name" : "xattr",
"type" : "Object",
"desc" : "extra attributes to add to 'element' (used by builder to store stuff.)",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "xs",
"type" : "Number",
"desc" : "colspan out of 12 for mobile-sized screens",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
}
],
"events" : [
],
"isAbstract" : false,
"isBuilderTop" : false,
- "childClasses" : { },
+ "implementations" : [],
"tree_children" : [],
"tree_parent" : []
},
{
"name" : "accept",
"type" : "String",
- "desc" : "o) use for file input only. (default empty)",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "desc" : "o) use for file input only. (default empt",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : [
+ "image",
+ "video",
+ "audio"
+ ]
},
{
"name" : "actionMode",
"type" : "String",
"desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el' for forms you probably want to set this to fieldEl",
- "memberOf" : "Roo.Component"
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "after",
"type" : "string",
"desc" : "- input group add on after",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "afterButton",
"type" : "Roo.bootstrap.Button",
"desc" : "to show before",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "align",
"type" : "String",
- "desc" : "t) Default left",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "desc" : "t) Default le",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : [
+ "left",
+ "center",
+ "right"
+ ]
},
{
"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" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "allowBlank",
"type" : "Boolean",
"desc" : "False to validate that the value length > 0 (defaults to true)",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "allowDomMove",
"type" : "Boolean",
"desc" : "Whether the component can move the Dom node when rendering (defaults to true).",
- "memberOf" : "Roo.Component"
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "alwaysQuery",
"type" : "Boolean",
"desc" : "Disable caching of results, and always send query",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "animate",
"type" : "Boolean",
"desc" : "default true",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "append",
"type" : "Boolean",
- "desc" : "e) default false",
- "memberOf" : ""
+ "desc" : "e) default fal",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : [
+ "true",
+ "false"
+ ]
},
{
"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" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "autoFocus",
"type" : "Boolean",
- "desc" : "e) auto focus the first item, default true",
- "memberOf" : ""
+ "desc" : "e) auto focus the first item, default tr",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : [
+ "true",
+ "false"
+ ]
},
{
"name" : "autocomplete",
"type" : "String",
"desc" : "- default is new-password see: https://developers.google.com/web/fundamentals/input/form/label-and-name-inputs?hl=en",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "before",
"type" : "string",
"desc" : "- input group add on before",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "blankText",
"type" : "String",
"desc" : "Error text to display if the allow blank validation fails (defaults to \"This field is required\")",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "blockFocus",
"type" : "Boolean",
"desc" : "Prevents all focus calls, so it can work with things like HTML edtor bar",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "btnPosition",
"type" : "String",
"desc" : "set the position of the trigger button (left | right) default right",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "can_build_overlaid",
"type" : "Boolean",
"desc" : "True if element can be rebuild from a HTML page",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "capture",
"type" : "String",
- "desc" : "a) use for file input only. (default empty)",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "desc" : "a) use for file input only. (default empt",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : [
+ "user",
+ "camera"
+ ]
},
{
"name" : "caret",
"type" : "String",
- "desc" : "r) BS3 only - carat fa name",
- "memberOf" : "Roo.bootstrap.form.TriggerField"
+ "desc" : "r) BS3 only - carat fa na",
+ "memberOf" : "Roo.bootstrap.form.TriggerField",
+ "isOptional" : false,
+ "optvals" : [
+ "search",
+ "calendar"
+ ]
},
{
"name" : "cls",
"type" : "String",
"desc" : "css class",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "container_method",
"type" : "string",
"desc" : "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "dataId",
"type" : "string",
"desc" : "cutomer id",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "disableClass",
"type" : "String",
"desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").",
- "memberOf" : "Roo.Component"
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "disableClear",
"type" : "Boolean",
"desc" : "Disable showing of clear button.",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "disableKeyFilter",
"type" : "Boolean",
"desc" : "True to disable input keystroke filtering (defaults to false)",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "disabled",
"type" : "Boolean",
"desc" : "is it disabled",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"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" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"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" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "emptyResultText",
"type" : "Boolean",
"desc" : "only for touch device",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "emptyTitle",
"type" : "String",
"desc" : "default ''",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "fieldLabel",
"type" : "string",
"desc" : "- the label associated",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "focusClass",
"type" : "String",
"desc" : "The CSS class to use when the field receives focus (defaults to \"x-form-focus\")",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "forceFeedback",
"type" : "Boolean",
- "desc" : "e) Default false",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "desc" : "e) Default fal",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : [
+ "true",
+ "false"
+ ]
},
{
"name" : "forceSelection",
"type" : "Boolean",
"desc" : "True to restrict the selected value to one of the values in the list, false to\nallow the user to set arbitrary text into the field (defaults to false)",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "grow",
"type" : "Boolean",
"desc" : "",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "growMax",
"type" : "Number",
"desc" : "",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "growMin",
"type" : "Number",
"desc" : "",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "handleHeight",
"type" : "Number",
"desc" : "The height in pixels of the dropdown list resize handle if resizable = true (defaults to 8)",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "hasFeedback",
"type" : "Boolean",
- "desc" : "e) default true",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "desc" : "e) default tr",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : [
+ "true",
+ "false"
+ ]
},
{
"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" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "hideMode",
"type" : "String",
- "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".",
- "memberOf" : "Roo.Component"
+ "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display",
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : [
+ "display",
+ "visibility"
+ ]
},
{
"name" : "hideTrigger",
"type" : "Boolean",
"desc" : "True to hide the trigger element and display only the base text field (defaults to false)",
- "memberOf" : "Roo.bootstrap.form.TriggerField"
+ "memberOf" : "Roo.bootstrap.form.TriggerField",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "indicatorpos",
"type" : "String",
- "desc" : "t) default left",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "desc" : "t) default le",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : [
+ "left",
+ "right"
+ ]
},
{
"name" : "inputType",
"type" : "String",
- "desc" : "t)",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "desc" : "",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : [
+ "button",
+ "checkbox",
+ "email",
+ "file",
+ "hidden",
+ "image",
+ "number",
+ "password",
+ "radio",
+ "range",
+ "reset",
+ "search",
+ "submit",
+ "text"
+ ]
},
{
"name" : "invalidClass",
"type" : "String",
"desc" : "DEPRICATED - uses BS4 is-valid now",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "invalidFeedbackIcon",
"type" : "String",
"desc" : "The CSS class to use when create feedback icon (defaults to \"x-form-invalid\")",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "invalidText",
"type" : "String",
"desc" : "The error text to display if {@link #validator} test fails during validation (defaults to \"\")",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "labelAlign",
"type" : "String",
- "desc" : "t)",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "desc" : "",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : [
+ "top",
+ "left"
+ ]
},
{
"name" : "labelWidth",
"type" : "Number",
"desc" : "set the width of label",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "labellg",
"type" : "Number",
"desc" : "set the width of label (1-12)",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "labelmd",
"type" : "Number",
"desc" : "set the width of label (1-12)",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "labelsm",
"type" : "Number",
"desc" : "set the width of label (1-12)",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "labelxs",
"type" : "Number",
"desc" : "set the width of label (1-12)",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"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" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "lg",
"type" : "Number",
"desc" : "colspan out of 12 for large computer-sized screens",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"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" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "listClass",
"type" : "String",
"desc" : "CSS class to apply to the dropdown list element (defaults to '')",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "listWidth",
"type" : "Number",
"desc" : "The width in pixels of the dropdown list (defaults to the width of the ComboBox field)",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"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"
+ "memberOf" : "Roo.util.Observable",
+ "isOptional" : false,
+ "optvals" : []
},
{
"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" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "maskRe",
"type" : "String",
"desc" : "An input mask regular expression that will be used to filter keystrokes that don't match (defaults to null)",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "maxHeight",
"type" : "Number",
"desc" : "The maximum height in pixels of the dropdown list before scrollbars are shown (defaults to 300)",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "maxLength",
"type" : "Number",
"desc" : "Maximum input field length allowed (defaults to Number.MAX_VALUE)",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "maxLengthText",
"type" : "String",
"desc" : "Error text to display if the maximum length validation fails (defaults to \"The maximum length for this field is {maxLength}\")",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "md",
"type" : "Number",
"desc" : "colspan out of 12 for computer-sized screens",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"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" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "minLength",
"type" : "Number",
"desc" : "Minimum input field length required (defaults to 0)",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "minLengthText",
"type" : "String",
"desc" : "Error text to display if the minimum length validation fails (defaults to \"The minimum length for this field is {minLength}\")",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"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" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "mobileTouchView",
"type" : "Boolean",
- "desc" : "e) show mobile touch view when using a mobile default true",
- "memberOf" : ""
+ "desc" : "e) show mobile touch view when using a mobile default tr",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : [
+ "true",
+ "false"
+ ]
},
{
"name" : "mobile_restrict_height",
"type" : "Boolean",
- "desc" : "e) restrict height for touch view",
- "memberOf" : ""
+ "desc" : "e) restrict height for touch vi",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : [
+ "true",
+ "false"
+ ]
},
{
"name" : "modalTitle",
"type" : "String",
"desc" : "The title of the dialog that pops up on mobile views.",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "mode",
"type" : "String",
"desc" : "Set to 'local' if the ComboBox loads local data (defaults to 'remote' which loads from the server)",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "multiple",
"type" : "Boolean",
- "desc" : "e) ComboBobArray, default false",
- "memberOf" : ""
+ "desc" : "e) ComboBobArray, default fal",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : [
+ "true",
+ "false"
+ ]
},
{
"name" : "name",
"type" : "String",
"desc" : "name of the input",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"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" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "placeholder",
"type" : "string",
"desc" : "- placeholder to put in text.",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "preventMark",
"type" : "Boolean",
"desc" : "Do not show tick or cross if error/success",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"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" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "queryParam",
"type" : "String",
"desc" : "Name of the query as it will be passed on the querystring (defaults to 'query')",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "readOnly",
"type" : "Boolean",
"desc" : "Specifies that the field should be read-only",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "regex",
"type" : "RegExp",
"desc" : "A JavaScript RegExp object to be tested against the field value during validation (defaults to null).\nIf available, this regex will be evaluated only after the basic validators all return true, and will be passed the\ncurrent field value. If the test fails, the field will be marked invalid using {@link #regexText}.",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "regexText",
"type" : "String",
"desc" : "-- Depricated - use Invalid Text",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "removable",
"type" : "Boolean",
- "desc" : "e) special filter default false",
- "memberOf" : "Roo.bootstrap.form.TriggerField"
+ "desc" : "e) special filter default fal",
+ "memberOf" : "Roo.bootstrap.form.TriggerField",
+ "isOptional" : false,
+ "optvals" : [
+ "true",
+ "false"
+ ]
},
{
"name" : "resizable",
"type" : "Boolean",
"desc" : "True to add a resize handle to the bottom of the dropdown list (defaults to false)",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"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" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "selectedClass",
"type" : "String",
"desc" : "CSS class to apply to the selected item in the dropdown list (defaults to 'x-combo-selected')",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "shadow",
"type" : "Boolean/String",
"desc" : "True or \"sides\" for the default effect, \"frame\" for 4-way shadow, and \"drop\" for bottom-right",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "showToggleBtn",
"type" : "Boolean",
"desc" : "show toggle button or not (true|false) default true",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "size",
"type" : "string",
"desc" : "- (lg|sm) or leave empty..",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "sm",
"type" : "Number",
"desc" : "colspan out of 12 for tablet-sized screens",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "specialFilter",
"type" : "Boolean",
- "desc" : "e) special filter default false",
- "memberOf" : ""
+ "desc" : "e) special filter default fal",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : [
+ "true",
+ "false"
+ ]
},
{
"name" : "store",
"type" : "Roo.data.Store",
"desc" : "The data store to which this combo is bound (defaults to undefined)",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "style",
"type" : "String",
"desc" : "any extra css",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "tickable",
"type" : "Boolean",
"desc" : "ComboBox with tickable selections (true|false), default false",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"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" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "tooltip",
"type" : "string",
"desc" : "Text for the tooltip",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "tpl",
"type" : "String/Roo.Template",
"desc" : "The template to use to render the output default is '<a class=\"dropdown-item\" href=\"#\">{' + this.displayField + '}</a>'",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"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" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"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" : "Roo.bootstrap.form.TriggerField"
+ "memberOf" : "Roo.bootstrap.form.TriggerField",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "triggerList",
"type" : "Boolean",
"desc" : "trigger show the list or not (true|false) default true",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "triggerText",
"type" : "String",
"desc" : "multiple combobox trigger button text default 'Select'",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"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" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"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" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "useNativeIOS",
"type" : "Boolean",
- "desc" : "e) render it as classic select for ios, not support dynamic load data (default false)",
- "memberOf" : ""
+ "desc" : "e) render it as classic select for ios, not support dynamic load data (default fals",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : [
+ "true",
+ "false"
+ ]
},
{
"name" : "validClass",
"type" : "String",
"desc" : "DEPRICATED - uses BS4 is-valid now",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "validFeedbackIcon",
"type" : "String",
"desc" : "The CSS class to use when create feedback icon (defaults to \"x-form-invalid\")",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "validateOnBlur",
"type" : "Boolean",
"desc" : "Whether the field should validate when it loses focus (defaults to true).",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "validationDelay",
"type" : "Number",
"desc" : "The length of time in milliseconds after user input begins until validation is initiated (defaults to 250)",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "validationEvent",
"type" : "String/Boolean",
"desc" : "The event that should initiate field validation. Set to false to disable\n automatic validation (defaults to \"keyup\").",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "validator",
"type" : "Function",
"desc" : "A custom validation function to be called during field validation (defaults to null).\nIf available, this function will be called only after the basic validators all return true, and will be passed the\ncurrent field value and expected to return boolean true if the value is valid or a string error message if invalid.",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "value",
"type" : "string",
"desc" : "default value of the input",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"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" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"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" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "visibilityEl",
"type" : "string|object",
- "desc" : "t) What element to use for visibility (@see getVisibilityEl())",
- "memberOf" : "Roo.bootstrap.Component"
+ "desc" : "t) What element to use for visibility (@see getVisibilityEl(",
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : [
+ "el",
+ "parent"
+ ]
},
{
"name" : "vtype",
"type" : "String",
"desc" : "A validation type name as defined in {@link Roo.form.VTypes} (defaults to null)",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "width",
"type" : "Number",
"desc" : "fixed with? experimental",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "xattr",
"type" : "Object",
"desc" : "extra attributes to add to 'element' (used by builder to store stuff.)",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "xs",
"type" : "Number",
"desc" : "colspan out of 12 for mobile-sized screens",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
}
],
"events" : [
],
"isAbstract" : false,
"isBuilderTop" : false,
- "childClasses" : {
- "Roo.bootstrap.form.ComboBox" : [
- "Roo.bootstrap.form.MoneyField"
- ]
- },
+ "implementations" : [
+ "Roo.bootstrap.form.MoneyField"
+ ],
"tree_children" : [],
"tree_parent" : []
},
{
"name" : "accept",
"type" : "String",
- "desc" : "o) use for file input only. (default empty)",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "desc" : "o) use for file input only. (default empt",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : [
+ "image",
+ "video",
+ "audio"
+ ]
},
{
"name" : "actionMode",
"type" : "String",
"desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el' for forms you probably want to set this to fieldEl",
- "memberOf" : "Roo.Component"
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "after",
"type" : "string",
"desc" : "- input group add on after",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "afterButton",
"type" : "Roo.bootstrap.Button",
"desc" : "to show before",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "align",
"type" : "String",
- "desc" : "t) Default left",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "desc" : "t) Default le",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : [
+ "left",
+ "center",
+ "right"
+ ]
},
{
"name" : "allowBlank",
"type" : "Boolean",
"desc" : "False to validate that the value length > 0 (defaults to true)",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "allowDomMove",
"type" : "Boolean",
"desc" : "Whether the component can move the Dom node when rendering (defaults to true).",
- "memberOf" : "Roo.Component"
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"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" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "autocomplete",
"type" : "String",
"desc" : "- default is new-password see: https://developers.google.com/web/fundamentals/input/form/label-and-name-inputs?hl=en",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "before",
"type" : "string",
"desc" : "- input group add on before",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "blankText",
"type" : "String",
"desc" : "Error text to display if the allow blank validation fails (defaults to \"This field is required\")",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "calendarWeeks",
"type" : "Boolean",
"desc" : "default false",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "can_build_overlaid",
"type" : "Boolean",
"desc" : "True if element can be rebuild from a HTML page",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "capture",
"type" : "String",
- "desc" : "a) use for file input only. (default empty)",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "desc" : "a) use for file input only. (default empt",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : [
+ "user",
+ "camera"
+ ]
},
{
"name" : "cls",
"type" : "String",
"desc" : "css class",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "container_method",
"type" : "string",
"desc" : "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "dataId",
"type" : "string",
"desc" : "cutomer id",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "daysOfWeekDisabled",
"type" : "Object",
"desc" : "default empty",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "disableClass",
"type" : "String",
"desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").",
- "memberOf" : "Roo.Component"
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "disableKeyFilter",
"type" : "Boolean",
"desc" : "True to disable input keystroke filtering (defaults to false)",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "disabled",
"type" : "Boolean",
"desc" : "is it disabled",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "endDate",
"type" : "Number",
"desc" : "default Infinity",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "fieldLabel",
"type" : "string",
"desc" : "- the label associated",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "focusClass",
"type" : "String",
"desc" : "The CSS class to use when the field receives focus (defaults to \"x-form-focus\")",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "forceFeedback",
"type" : "Boolean",
- "desc" : "e) Default false",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "desc" : "e) Default fal",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : [
+ "true",
+ "false"
+ ]
},
{
"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" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "hasFeedback",
"type" : "Boolean",
- "desc" : "e) default true",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "desc" : "e) default tr",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : [
+ "true",
+ "false"
+ ]
},
{
"name" : "hideMode",
"type" : "String",
- "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".",
- "memberOf" : "Roo.Component"
+ "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display",
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : [
+ "display",
+ "visibility"
+ ]
},
{
"name" : "indicatorpos",
"type" : "String",
- "desc" : "t) default left",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "desc" : "t) default le",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : [
+ "left",
+ "right"
+ ]
},
{
"name" : "inputType",
"type" : "String",
- "desc" : "t)",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "desc" : "",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : [
+ "button",
+ "checkbox",
+ "email",
+ "file",
+ "hidden",
+ "image",
+ "number",
+ "password",
+ "radio",
+ "range",
+ "reset",
+ "search",
+ "submit",
+ "text"
+ ]
},
{
"name" : "invalidClass",
"type" : "String",
"desc" : "DEPRICATED - code uses BS4 - is-valid / is-invalid",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "invalidFeedbackIcon",
"type" : "String",
"desc" : "The CSS class to use when create feedback icon (defaults to \"x-form-invalid\")",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "invalidText",
"type" : "String",
"desc" : "The error text to display if {@link #validator} test fails during validation (defaults to \"\")",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "keyboardNavigation",
"type" : "Boolean",
"desc" : "default true",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "labelAlign",
"type" : "String",
- "desc" : "t)",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "desc" : "",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : [
+ "top",
+ "left"
+ ]
},
{
"name" : "labelWidth",
"type" : "Number",
"desc" : "set the width of label",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "labellg",
"type" : "Number",
"desc" : "set the width of label (1-12)",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "labelmd",
"type" : "Number",
"desc" : "set the width of label (1-12)",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "labelsm",
"type" : "Number",
"desc" : "set the width of label (1-12)",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "labelxs",
"type" : "Number",
"desc" : "set the width of label (1-12)",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "language",
"type" : "String",
"desc" : "default en",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "lg",
"type" : "Number",
"desc" : "colspan out of 12 for large computer-sized screens",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"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"
+ "memberOf" : "Roo.util.Observable",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "maskRe",
"type" : "String",
"desc" : "An input mask regular expression that will be used to filter keystrokes that don't match (defaults to null)",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "maxLength",
"type" : "Number",
"desc" : "Maximum input field length allowed (defaults to Number.MAX_VALUE)",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "maxLengthText",
"type" : "String",
"desc" : "Error text to display if the maximum length validation fails (defaults to \"The maximum length for this field is {maxLength}\")",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "md",
"type" : "Number",
"desc" : "colspan out of 12 for computer-sized screens",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "minLength",
"type" : "Number",
"desc" : "Minimum input field length required (defaults to 0)",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "minLengthText",
"type" : "String",
"desc" : "Error text to display if the minimum length validation fails (defaults to \"The minimum length for this field is {minLength}\")",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "minViewMode",
"type" : "String",
"desc" : "default empty, (months|years)",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "name",
"type" : "String",
"desc" : "name of the input",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "placeholder",
"type" : "string",
"desc" : "- placeholder to put in text.",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "preventMark",
"type" : "Boolean",
"desc" : "Do not show tick or cross if error/success",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "readOnly",
"type" : "Boolean",
"desc" : "Specifies that the field should be read-only",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "regex",
"type" : "RegExp",
"desc" : "A JavaScript RegExp object to be tested against the field value during validation (defaults to null).\nIf available, this regex will be evaluated only after the basic validators all return true, and will be passed the\ncurrent field value. If the test fails, the field will be marked invalid using {@link #regexText}.",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "regexText",
"type" : "String",
"desc" : "-- Depricated - use Invalid Text",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "selectOnFocus",
"type" : "Boolean",
"desc" : "True to automatically select any existing field text when the field receives input focus (defaults to false)",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "singleMode",
"type" : "Boolean",
"desc" : "default false (true | false)",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "size",
"type" : "string",
"desc" : "- (lg|sm) or leave empty..",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "sm",
"type" : "Number",
"desc" : "colspan out of 12 for tablet-sized screens",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "startDate",
"type" : "Number",
"desc" : "default -Infinity",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "style",
"type" : "String",
"desc" : "any extra css",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "todayBtn",
"type" : "Boolean",
"desc" : "default false",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "todayHighlight",
"type" : "Boolean",
"desc" : "default false",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "tooltip",
"type" : "string",
"desc" : "Text for the tooltip",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "validClass",
"type" : "String",
"desc" : "DEPRICATED - code uses BS4 - is-valid / is-invalid",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "validFeedbackIcon",
"type" : "String",
"desc" : "The CSS class to use when create feedback icon (defaults to \"x-form-invalid\")",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "validateOnBlur",
"type" : "Boolean",
"desc" : "Whether the field should validate when it loses focus (defaults to true).",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "validationDelay",
"type" : "Number",
"desc" : "The length of time in milliseconds after user input begins until validation is initiated (defaults to 250)",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "validationEvent",
"type" : "String/Boolean",
"desc" : "The event that should initiate field validation. Set to false to disable\n automatic validation (defaults to \"keyup\").",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "validator",
"type" : "Function",
"desc" : "A custom validation function to be called during field validation (defaults to null).\nIf available, this function will be called only after the basic validators all return true, and will be passed the\ncurrent field value and expected to return boolean true if the value is valid or a string error message if invalid.",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "value",
"type" : "string",
"desc" : "default value of the input",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "viewMode",
"type" : "String",
"desc" : "default empty, (months|years)",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "visibilityEl",
"type" : "string|object",
- "desc" : "t) What element to use for visibility (@see getVisibilityEl())",
- "memberOf" : "Roo.bootstrap.Component"
+ "desc" : "t) What element to use for visibility (@see getVisibilityEl(",
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : [
+ "el",
+ "parent"
+ ]
},
{
"name" : "vtype",
"type" : "String",
"desc" : "A validation type name as defined in {@link Roo.form.VTypes} (defaults to null)",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "weekStart",
"type" : "Number",
"desc" : "default 0",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "xattr",
"type" : "Object",
"desc" : "extra attributes to add to 'element' (used by builder to store stuff.)",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "xs",
"type" : "Number",
"desc" : "colspan out of 12 for mobile-sized screens",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
}
],
"events" : [
],
"isAbstract" : false,
"isBuilderTop" : false,
- "childClasses" : { },
+ "implementations" : [],
"tree_children" : [],
"tree_parent" : []
},
"name" : "actionMode",
"type" : "String",
"desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el' for forms you probably want to set this to fieldEl",
- "memberOf" : "Roo.Component"
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "allowDomMove",
"type" : "Boolean",
"desc" : "Whether the component can move the Dom node when rendering (defaults to true).",
- "memberOf" : "Roo.Component"
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "can_build_overlaid",
"type" : "Boolean",
"desc" : "True if element can be rebuild from a HTML page",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "cls",
"type" : "String",
"desc" : "css class",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "container_method",
"type" : "string",
"desc" : "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "dataId",
"type" : "string",
"desc" : "cutomer id",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "dayAllowBlank",
"type" : "Boolean",
- "desc" : "e) default false",
- "memberOf" : ""
+ "desc" : "e) default fal",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : [
+ "true",
+ "false"
+ ]
},
{
"name" : "dayFormat",
"type" : "string",
"desc" : "default 'd'",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "dayPlaceholder",
"type" : "string",
"desc" : "",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "disableClass",
"type" : "String",
"desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").",
- "memberOf" : "Roo.Component"
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "fieldLabel",
"type" : "string",
"desc" : "- the label associated",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "hideMode",
"type" : "String",
- "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".",
- "memberOf" : "Roo.Component"
+ "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display",
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : [
+ "display",
+ "visibility"
+ ]
},
{
"name" : "labelAlign",
"type" : "String",
- "desc" : "t)",
- "memberOf" : ""
+ "desc" : "",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : [
+ "top",
+ "left"
+ ]
},
{
"name" : "labelWidth",
"type" : "Number",
"desc" : "set the width of label (0-12)",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "labellg",
"type" : "Number",
"desc" : "set the width of label (1-12)",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "labelmd",
"type" : "Number",
"desc" : "set the width of label (1-12)",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "labelsm",
"type" : "Number",
"desc" : "set the width of label (1-12)",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "labelxs",
"type" : "Number",
"desc" : "set the width of label (1-12)",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"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"
+ "memberOf" : "Roo.util.Observable",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "monthAllowBlank",
"type" : "Boolean",
- "desc" : "e) default false",
- "memberOf" : ""
+ "desc" : "e) default fal",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : [
+ "true",
+ "false"
+ ]
},
{
"name" : "monthFormat",
"type" : "string",
"desc" : "default 'm'",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "monthPlaceholder",
"type" : "string",
"desc" : "",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "name",
"type" : "string",
"desc" : "Specifies name attribute",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "style",
"type" : "String",
"desc" : "any extra css",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "tooltip",
"type" : "string",
"desc" : "Text for the tooltip",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "visibilityEl",
"type" : "string|object",
- "desc" : "t) What element to use for visibility (@see getVisibilityEl())",
- "memberOf" : "Roo.bootstrap.Component"
+ "desc" : "t) What element to use for visibility (@see getVisibilityEl(",
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : [
+ "el",
+ "parent"
+ ]
},
{
"name" : "xattr",
"type" : "Object",
"desc" : "extra attributes to add to 'element' (used by builder to store stuff.)",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "yearAllowBlank",
"type" : "Boolean",
- "desc" : "e) default false",
- "memberOf" : ""
+ "desc" : "e) default fal",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : [
+ "true",
+ "false"
+ ]
},
{
"name" : "yearFormat",
"type" : "string",
"desc" : "default 'Y'",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "yearPlaceholder",
"type" : "string",
"desc" : "",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
}
],
"events" : [
],
"isAbstract" : false,
"isBuilderTop" : false,
- "childClasses" : { },
+ "implementations" : [],
"tree_children" : [],
"tree_parent" : []
},
"name" : "actionMode",
"type" : "String",
"desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el' for forms you probably want to set this to fieldEl",
- "memberOf" : "Roo.Component"
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "allowBlank",
"type" : "Boolean",
- "desc" : "e) target allowBlank default true",
- "memberOf" : ""
+ "desc" : "e) target allowBlank default tr",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : [
+ "true",
+ "false"
+ ]
},
{
"name" : "allowDomMove",
"type" : "Boolean",
"desc" : "Whether the component can move the Dom node when rendering (defaults to true).",
- "memberOf" : "Roo.Component"
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "can_build_overlaid",
"type" : "Boolean",
"desc" : "True if element can be rebuild from a HTML page",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "cls",
"type" : "String",
"desc" : "class of the element",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "container_method",
"type" : "string",
"desc" : "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "dataId",
"type" : "string",
"desc" : "cutomer id",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "disableClass",
"type" : "String",
"desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").",
- "memberOf" : "Roo.Component"
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "hideMode",
"type" : "String",
- "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".",
- "memberOf" : "Roo.Component"
+ "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display",
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : [
+ "display",
+ "visibility"
+ ]
},
{
"name" : "html",
"type" : "String",
"desc" : "contents of the element",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "iconTooltip",
"type" : "String",
"desc" : "default \"This field is required\"",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "indicatorpos",
"type" : "String",
- "desc" : "t) default left",
- "memberOf" : ""
+ "desc" : "t) default le",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : [
+ "left",
+ "right"
+ ]
},
{
"name" : "invalidClass",
"type" : "String",
"desc" : "DEPRICATED - BS4 uses is-invalid",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"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"
+ "memberOf" : "Roo.util.Observable",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "name",
"type" : "string",
"desc" : "Specifies name attribute",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "style",
"type" : "String",
"desc" : "any extra css",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "tag",
"type" : "String",
"desc" : "tag of the element default label",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "target",
"type" : "String",
"desc" : "label target",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "tooltip",
"type" : "string",
"desc" : "Text for the tooltip",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "validClass",
"type" : "String",
"desc" : "DEPRICATED - BS4 uses is-valid",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "visibilityEl",
"type" : "string|object",
- "desc" : "t) What element to use for visibility (@see getVisibilityEl())",
- "memberOf" : "Roo.bootstrap.Component"
+ "desc" : "t) What element to use for visibility (@see getVisibilityEl(",
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : [
+ "el",
+ "parent"
+ ]
},
{
"name" : "xattr",
"type" : "Object",
"desc" : "extra attributes to add to 'element' (used by builder to store stuff.)",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
}
],
"events" : [
],
"isAbstract" : false,
"isBuilderTop" : false,
- "childClasses" : { },
+ "implementations" : [],
"tree_children" : [],
"tree_parent" : []
},
"name" : "actionMode",
"type" : "String",
"desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el' for forms you probably want to set this to fieldEl",
- "memberOf" : "Roo.Component"
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "align",
"type" : "String",
"desc" : "left | right - for navbars",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "allowDomMove",
"type" : "Boolean",
"desc" : "Whether the component can move the Dom node when rendering (defaults to true).",
- "memberOf" : "Roo.Component"
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "baseParams",
"type" : "Object",
"desc" : "Parameters to pass with all requests. e.g. baseParams: {id: '123', foo: 'bar'}.",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "can_build_overlaid",
"type" : "Boolean",
"desc" : "True if element can be rebuild from a HTML page",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "cls",
"type" : "String",
"desc" : "css class",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "container_method",
"type" : "string",
"desc" : "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "dataId",
"type" : "string",
"desc" : "cutomer id",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "disableClass",
"type" : "String",
"desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").",
- "memberOf" : "Roo.Component"
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "errorMask",
"type" : "Boolean",
- "desc" : "e) default false",
- "memberOf" : ""
+ "desc" : "e) default fal",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : [
+ "true",
+ "false"
+ ]
},
{
"name" : "fileUpload",
"type" : "Boolean",
"desc" : "Set to true if this form is a file upload.",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "hideMode",
"type" : "String",
- "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".",
- "memberOf" : "Roo.Component"
+ "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display",
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : [
+ "display",
+ "visibility"
+ ]
},
{
"name" : "labelAlign",
"type" : "String",
"desc" : "top | left (default top)",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"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"
+ "memberOf" : "Roo.util.Observable",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "loadMask",
"type" : "Boolean",
"desc" : "load mask when submit (default true)",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "maskBody",
"type" : "Boolean",
"desc" : "",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "maskOffset",
"type" : "Number",
"desc" : "Default 100",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "method",
"type" : "String",
"desc" : "GET | POST (default POST)",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "name",
"type" : "string",
"desc" : "Specifies name attribute",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "style",
"type" : "String",
"desc" : "any extra css",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "timeout",
"type" : "Number",
"desc" : "Timeout for form actions in seconds (default is 30 seconds).",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "tooltip",
"type" : "string",
"desc" : "Text for the tooltip",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "url",
"type" : "String",
"desc" : "The URL to use for form actions if one isn't supplied in the action options.",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "visibilityEl",
"type" : "string|object",
- "desc" : "t) What element to use for visibility (@see getVisibilityEl())",
- "memberOf" : "Roo.bootstrap.Component"
+ "desc" : "t) What element to use for visibility (@see getVisibilityEl(",
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : [
+ "el",
+ "parent"
+ ]
},
{
"name" : "xattr",
"type" : "Object",
"desc" : "extra attributes to add to 'element' (used by builder to store stuff.)",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
}
],
"events" : [
],
"isAbstract" : false,
"isBuilderTop" : false,
- "childClasses" : { },
+ "implementations" : [],
"tree_children" : [
"Roo.bootstrap.Alert",
"Roo.bootstrap.BezierSignature",
"Roo.bootstrap.Calendar",
"Roo.bootstrap.Card",
"Roo.bootstrap.Column",
- "Roo.bootstrap.Container",
"Roo.bootstrap.DocumentManager",
"Roo.bootstrap.DocumentSlider",
"Roo.bootstrap.DocumentViewer",
"Roo.bootstrap.form.TextArea",
"Roo.bootstrap.form.TimeField",
"Roo.bootstrap.form.TriggerField",
- "Roo.bootstrap.layout.Border",
"Roo.bootstrap.nav.Group",
"Roo.bootstrap.nav.Headerbar",
"Roo.bootstrap.nav.ProgressBar",
{
"name" : "accept",
"type" : "String",
- "desc" : "o) use for file input only. (default empty)",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "desc" : "o) use for file input only. (default empt",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : [
+ "image",
+ "video",
+ "audio"
+ ]
},
{
"name" : "actionMode",
"type" : "String",
"desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el' for forms you probably want to set this to fieldEl",
- "memberOf" : "Roo.Component"
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "after",
"type" : "string",
"desc" : "- input group add on after",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "afterButton",
"type" : "Roo.bootstrap.Button",
"desc" : "to show before",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "align",
"type" : "String",
- "desc" : "t) Default left",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "desc" : "t) Default le",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : [
+ "left",
+ "center",
+ "right"
+ ]
},
{
"name" : "allowBlank",
"type" : "Boolean",
"desc" : "False to validate that the value length > 0 (defaults to true)",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "allowDomMove",
"type" : "Boolean",
"desc" : "Whether the component can move the Dom node when rendering (defaults to true).",
- "memberOf" : "Roo.Component"
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "autocomplete",
"type" : "String",
"desc" : "- default is new-password see: https://developers.google.com/web/fundamentals/input/form/label-and-name-inputs?hl=en",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "before",
"type" : "string",
"desc" : "- input group add on before",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "blankText",
"type" : "String",
"desc" : "Error text to display if the allow blank validation fails (defaults to \"This field is required\")",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "buttons",
"type" : "Array",
"desc" : "Array of toolbar's buttons. - defaults to empty",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "can_build_overlaid",
"type" : "Boolean",
"desc" : "True if element can be rebuild from a HTML page",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "capture",
"type" : "String",
- "desc" : "a) use for file input only. (default empty)",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "desc" : "a) use for file input only. (default empt",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : [
+ "user",
+ "camera"
+ ]
},
{
"name" : "cls",
"type" : "String",
"desc" : "css class",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "cols",
"type" : "Number",
"desc" : "Specifies the visible width of a text area",
- "memberOf" : "Roo.bootstrap.form.TextArea"
+ "memberOf" : "Roo.bootstrap.form.TextArea",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "container_method",
"type" : "string",
"desc" : "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "dataId",
"type" : "string",
"desc" : "cutomer id",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "disableClass",
"type" : "String",
"desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").",
- "memberOf" : "Roo.Component"
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "disableKeyFilter",
"type" : "Boolean",
"desc" : "True to disable input keystroke filtering (defaults to false)",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "disabled",
"type" : "Boolean",
"desc" : "is it disabled",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "fieldLabel",
"type" : "string",
"desc" : "- the label associated",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "forceFeedback",
"type" : "Boolean",
- "desc" : "e) Default false",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "desc" : "e) Default fal",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : [
+ "true",
+ "false"
+ ]
},
{
"name" : "hasFeedback",
"type" : "Boolean",
- "desc" : "e) default true",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "desc" : "e) default tr",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : [
+ "true",
+ "false"
+ ]
},
{
"name" : "height",
"type" : "Number",
"desc" : "(in pixels)",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "hideMode",
"type" : "String",
- "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".",
- "memberOf" : "Roo.Component"
+ "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display",
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : [
+ "display",
+ "visibility"
+ ]
},
{
"name" : "html",
"type" : "string",
"desc" : "text",
- "memberOf" : "Roo.bootstrap.form.TextArea"
+ "memberOf" : "Roo.bootstrap.form.TextArea",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "indicatorpos",
"type" : "String",
- "desc" : "t) default left",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "desc" : "t) default le",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : [
+ "left",
+ "right"
+ ]
},
{
"name" : "invalidClass",
"type" : "String",
"desc" : "DEPRICATED - code uses BS4 - is-valid / is-invalid",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "invalidFeedbackIcon",
"type" : "String",
"desc" : "The CSS class to use when create feedback icon (defaults to \"x-form-invalid\")",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "labelAlign",
"type" : "String",
- "desc" : "t)",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "desc" : "",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : [
+ "top",
+ "left"
+ ]
},
{
"name" : "labelWidth",
"type" : "Number",
"desc" : "set the width of label",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "labellg",
"type" : "Number",
"desc" : "set the width of label (1-12)",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "labelmd",
"type" : "Number",
"desc" : "set the width of label (1-12)",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "labelsm",
"type" : "Number",
"desc" : "set the width of label (1-12)",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "labelxs",
"type" : "Number",
"desc" : "set the width of label (1-12)",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "lg",
"type" : "Number",
"desc" : "colspan out of 12 for large computer-sized screens",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"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"
+ "memberOf" : "Roo.util.Observable",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "maskRe",
"type" : "String",
"desc" : "An input mask regular expression that will be used to filter keystrokes that don't match (defaults to null)",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "maxLength",
"type" : "Number",
"desc" : "Maximum input field length allowed (defaults to Number.MAX_VALUE)",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "maxLengthText",
"type" : "String",
"desc" : "Error text to display if the maximum length validation fails (defaults to \"The maximum length for this field is {maxLength}\")",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "md",
"type" : "Number",
"desc" : "colspan out of 12 for computer-sized screens",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "minLength",
"type" : "Number",
"desc" : "Minimum input field length required (defaults to 0)",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "minLengthText",
"type" : "String",
"desc" : "Error text to display if the minimum length validation fails (defaults to \"The minimum length for this field is {minLength}\")",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "name",
"type" : "String",
"desc" : "name of the input",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "placeholder",
"type" : "string",
"desc" : "- placeholder to put in text.",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "preventMark",
"type" : "Boolean",
"desc" : "Do not show tick or cross if error/success",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "readOnly",
"type" : "Boolean",
"desc" : "Specifies that the field should be read-only",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "regex",
"type" : "RegExp",
"desc" : "A JavaScript RegExp object to be tested against the field value during validation (defaults to null).\nIf available, this regex will be evaluated only after the basic validators all return true, and will be passed the\ncurrent field value. If the test fails, the field will be marked invalid using {@link #regexText}.",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "regexText",
"type" : "String",
"desc" : "-- Depricated - use Invalid Text",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "resizable",
"type" : "String",
"desc" : "'s' or 'se' or 'e' - wrapps the element in a\n Roo.resizable.",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "resize",
"type" : "string",
- "desc" : "l)",
- "memberOf" : "Roo.bootstrap.form.TextArea"
+ "desc" : "",
+ "memberOf" : "Roo.bootstrap.form.TextArea",
+ "isOptional" : false,
+ "optvals" : [
+ "none",
+ "both",
+ "horizontal",
+ "vertical",
+ "inherit",
+ "initial"
+ ]
},
{
"name" : "rows",
"type" : "Number",
"desc" : "Specifies the visible number of lines in a text area",
- "memberOf" : "Roo.bootstrap.form.TextArea"
+ "memberOf" : "Roo.bootstrap.form.TextArea",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "selectOnFocus",
"type" : "Boolean",
"desc" : "True to automatically select any existing field text when the field receives input focus (defaults to false)",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "size",
"type" : "string",
"desc" : "- (lg|sm) or leave empty..",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "sm",
"type" : "Number",
"desc" : "colspan out of 12 for tablet-sized screens",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "style",
"type" : "String",
"desc" : "any extra css",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "stylesheets",
"type" : "Array",
"desc" : "url of stylesheets. set to [] to disable stylesheets.",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "toolbars",
"type" : "Array",
"desc" : "Array of toolbars. - defaults to just the Standard one",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "tooltip",
"type" : "string",
"desc" : "Text for the tooltip",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "validClass",
"type" : "String",
"desc" : "DEPRICATED - code uses BS4 - is-valid / is-invalid",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "validFeedbackIcon",
"type" : "String",
"desc" : "The CSS class to use when create feedback icon (defaults to \"x-form-invalid\")",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "validationDelay",
"type" : "Number",
"desc" : "The length of time in milliseconds after user input begins until validation is initiated (defaults to 250)",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "validationEvent",
"type" : "String/Boolean",
"desc" : "The event that should initiate field validation. Set to false to disable\n automatic validation (defaults to \"keyup\").",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "validator",
"type" : "Function",
"desc" : "A custom validation function to be called during field validation (defaults to null).\nIf available, this function will be called only after the basic validators all return true, and will be passed the\ncurrent field value and expected to return boolean true if the value is valid or a string error message if invalid.",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "value",
"type" : "string",
"desc" : "default value of the input",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "visibilityEl",
"type" : "string|object",
- "desc" : "t) What element to use for visibility (@see getVisibilityEl())",
- "memberOf" : "Roo.bootstrap.Component"
+ "desc" : "t) What element to use for visibility (@see getVisibilityEl(",
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : [
+ "el",
+ "parent"
+ ]
},
{
"name" : "vtype",
"type" : "String",
"desc" : "A validation type name as defined in {@link Roo.form.VTypes} (defaults to null)",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "width",
"type" : "Number",
"desc" : "(in pixels)",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "wrap",
"type" : "string",
- "desc" : "d)Specifies how the text in a text area is to be wrapped when submitted in a form",
- "memberOf" : "Roo.bootstrap.form.TextArea"
+ "desc" : "d)Specifies how the text in a text area is to be wrapped when submitted in a fo",
+ "memberOf" : "Roo.bootstrap.form.TextArea",
+ "isOptional" : false,
+ "optvals" : [
+ "soft",
+ "hard"
+ ]
},
{
"name" : "xattr",
"type" : "Object",
"desc" : "extra attributes to add to 'element' (used by builder to store stuff.)",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "xs",
"type" : "Number",
"desc" : "colspan out of 12 for mobile-sized screens",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
}
],
"events" : [
],
"isAbstract" : false,
"isBuilderTop" : false,
- "childClasses" : { },
+ "implementations" : [],
"tree_children" : [],
"tree_parent" : []
},
"name" : "actionMode",
"type" : "String",
"desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el' for forms you probably want to set this to fieldEl",
- "memberOf" : "Roo.Component"
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "align",
"type" : "String",
- "desc" : "t) alignment",
- "memberOf" : "Roo.bootstrap.nav.Simplebar"
+ "desc" : "t) alignme",
+ "memberOf" : "Roo.bootstrap.nav.Simplebar",
+ "isOptional" : false,
+ "optvals" : [
+ "left",
+ "right"
+ ]
},
{
"name" : "allowDomMove",
"type" : "Boolean",
"desc" : "Whether the component can move the Dom node when rendering (defaults to true).",
- "memberOf" : "Roo.Component"
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "arrangement",
"type" : "Boolean",
"desc" : "stacked | justified",
- "memberOf" : "Roo.bootstrap.nav.Simplebar"
+ "memberOf" : "Roo.bootstrap.nav.Simplebar",
+ "isOptional" : false,
+ "optvals" : []
},
{
"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" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "can_build_overlaid",
"type" : "Boolean",
"desc" : "True if element can be rebuild from a HTML page",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "cls",
"type" : "String",
"desc" : "css class",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "container_method",
"type" : "string",
"desc" : "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "dataId",
"type" : "string",
"desc" : "cutomer id",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "disable",
"type" : "Object",
"desc" : "List of elements to disable..",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "disableClass",
"type" : "String",
"desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").",
- "memberOf" : "Roo.Component"
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "hideMode",
"type" : "String",
- "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".",
- "memberOf" : "Roo.Component"
+ "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display",
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : [
+ "display",
+ "visibility"
+ ]
},
{
"name" : "inverse",
"type" : "Boolean",
"desc" : "is inverted color",
- "memberOf" : "Roo.bootstrap.nav.Simplebar"
+ "memberOf" : "Roo.bootstrap.nav.Simplebar",
+ "isOptional" : false,
+ "optvals" : []
},
{
"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"
+ "memberOf" : "Roo.util.Observable",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "loadMask",
"type" : "Boolean",
- "desc" : "e) loadMask on the bar",
- "memberOf" : "Roo.bootstrap.nav.Simplebar"
+ "desc" : "e) loadMask on the b",
+ "memberOf" : "Roo.bootstrap.nav.Simplebar",
+ "isOptional" : false,
+ "optvals" : [
+ "true",
+ "false"
+ ]
},
{
"name" : "main",
"type" : "Boolean",
- "desc" : "e) main nav bar? default false",
- "memberOf" : "Roo.bootstrap.nav.Simplebar"
+ "desc" : "e) main nav bar? default fal",
+ "memberOf" : "Roo.bootstrap.nav.Simplebar",
+ "isOptional" : false,
+ "optvals" : [
+ "true",
+ "false"
+ ]
},
{
"name" : "name",
"type" : "string",
"desc" : "Specifies name attribute",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "style",
"type" : "String",
"desc" : "any extra css",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "tag",
"type" : "String",
- "desc" : "v) default is nav",
- "memberOf" : "Roo.bootstrap.nav.Simplebar"
+ "desc" : "v) default is n",
+ "memberOf" : "Roo.bootstrap.nav.Simplebar",
+ "isOptional" : false,
+ "optvals" : [
+ "header",
+ "footer",
+ "nav",
+ "div"
+ ]
},
{
"name" : "tooltip",
"type" : "string",
"desc" : "Text for the tooltip",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "type",
"type" : "String",
- "desc" : "s)",
- "memberOf" : "Roo.bootstrap.nav.Simplebar"
+ "desc" : "",
+ "memberOf" : "Roo.bootstrap.nav.Simplebar",
+ "isOptional" : false,
+ "optvals" : [
+ "nav",
+ "pills",
+ "tabs"
+ ]
},
{
"name" : "visibilityEl",
"type" : "string|object",
- "desc" : "t) What element to use for visibility (@see getVisibilityEl())",
- "memberOf" : "Roo.bootstrap.Component"
+ "desc" : "t) What element to use for visibility (@see getVisibilityEl(",
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : [
+ "el",
+ "parent"
+ ]
},
{
"name" : "weight",
"type" : "String",
- "desc" : "e) default is light.",
- "memberOf" : "Roo.bootstrap.nav.Simplebar"
+ "desc" : "e) default is ligh",
+ "memberOf" : "Roo.bootstrap.nav.Simplebar",
+ "isOptional" : false,
+ "optvals" : [
+ "light",
+ "primary",
+ "secondary",
+ "success",
+ "danger",
+ "warning",
+ "info",
+ "dark",
+ "white"
+ ]
},
{
"name" : "xattr",
"type" : "Object",
"desc" : "extra attributes to add to 'element' (used by builder to store stuff.)",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
}
],
"events" : [
],
"isAbstract" : false,
"isBuilderTop" : false,
- "childClasses" : { },
+ "implementations" : [],
"tree_children" : [],
"tree_parent" : [
"Roo.bootstrap.form.HtmlEditor"
{
"name" : "accept",
"type" : "String",
- "desc" : "o) use for file input only. (default empty)",
- "memberOf" : ""
+ "desc" : "o) use for file input only. (default empt",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : [
+ "image",
+ "video",
+ "audio"
+ ]
},
{
"name" : "actionMode",
"type" : "String",
"desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el' for forms you probably want to set this to fieldEl",
- "memberOf" : "Roo.Component"
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "after",
"type" : "string",
"desc" : "- input group add on after",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "afterButton",
"type" : "Roo.bootstrap.Button",
"desc" : "to show before",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "align",
"type" : "String",
- "desc" : "t) Default left",
- "memberOf" : ""
+ "desc" : "t) Default le",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : [
+ "left",
+ "center",
+ "right"
+ ]
},
{
"name" : "allowBlank",
"type" : "Boolean",
"desc" : "False to validate that the value length > 0 (defaults to true)",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "allowDomMove",
"type" : "Boolean",
"desc" : "Whether the component can move the Dom node when rendering (defaults to true).",
- "memberOf" : "Roo.Component"
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "autocomplete",
"type" : "String",
"desc" : "- default is new-password see: https://developers.google.com/web/fundamentals/input/form/label-and-name-inputs?hl=en",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "before",
"type" : "string",
"desc" : "- input group add on before",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "blankText",
"type" : "String",
"desc" : "Error text to display if the allow blank validation fails (defaults to \"This field is required\")",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "can_build_overlaid",
"type" : "Boolean",
"desc" : "True if element can be rebuild from a HTML page",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "capture",
"type" : "String",
- "desc" : "a) use for file input only. (default empty)",
- "memberOf" : ""
+ "desc" : "a) use for file input only. (default empt",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : [
+ "user",
+ "camera"
+ ]
},
{
"name" : "cls",
"type" : "String",
"desc" : "css class",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "container_method",
"type" : "string",
"desc" : "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "dataId",
"type" : "string",
"desc" : "cutomer id",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "disableClass",
"type" : "String",
"desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").",
- "memberOf" : "Roo.Component"
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "disableKeyFilter",
"type" : "Boolean",
"desc" : "True to disable input keystroke filtering (defaults to false)",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "disabled",
"type" : "Boolean",
"desc" : "is it disabled",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "fieldLabel",
"type" : "string",
"desc" : "- the label associated",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "focusClass",
"type" : "String",
"desc" : "The CSS class to use when the field receives focus (defaults to \"x-form-focus\")",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "forceFeedback",
"type" : "Boolean",
- "desc" : "e) Default false",
- "memberOf" : ""
+ "desc" : "e) Default fal",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : [
+ "true",
+ "false"
+ ]
},
{
"name" : "hasFeedback",
"type" : "Boolean",
- "desc" : "e) default true",
- "memberOf" : ""
+ "desc" : "e) default tr",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : [
+ "true",
+ "false"
+ ]
},
{
"name" : "hideMode",
"type" : "String",
- "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".",
- "memberOf" : "Roo.Component"
+ "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display",
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : [
+ "display",
+ "visibility"
+ ]
},
{
"name" : "indicatorpos",
"type" : "String",
- "desc" : "t) default left",
- "memberOf" : ""
+ "desc" : "t) default le",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : [
+ "left",
+ "right"
+ ]
},
{
"name" : "inputType",
"type" : "String",
- "desc" : "t)",
- "memberOf" : ""
+ "desc" : "",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : [
+ "button",
+ "checkbox",
+ "email",
+ "file",
+ "hidden",
+ "image",
+ "number",
+ "password",
+ "radio",
+ "range",
+ "reset",
+ "search",
+ "submit",
+ "text"
+ ]
},
{
"name" : "invalidClass",
"type" : "String",
"desc" : "DEPRICATED - code uses BS4 - is-valid / is-invalid",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "invalidFeedbackIcon",
"type" : "String",
"desc" : "The CSS class to use when create feedback icon (defaults to \"x-form-invalid\")",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "invalidText",
"type" : "String",
"desc" : "The error text to display if {@link #validator} test fails during validation (defaults to \"\")",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "labelAlign",
"type" : "String",
- "desc" : "t)",
- "memberOf" : ""
+ "desc" : "",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : [
+ "top",
+ "left"
+ ]
},
{
"name" : "labelWidth",
"type" : "Number",
"desc" : "set the width of label",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "labellg",
"type" : "Number",
"desc" : "set the width of label (1-12)",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "labelmd",
"type" : "Number",
"desc" : "set the width of label (1-12)",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "labelsm",
"type" : "Number",
"desc" : "set the width of label (1-12)",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "labelxs",
"type" : "Number",
"desc" : "set the width of label (1-12)",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "lg",
"type" : "Number",
"desc" : "colspan out of 12 for large computer-sized screens",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"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"
+ "memberOf" : "Roo.util.Observable",
+ "isOptional" : false,
+ "optvals" : []
},
{
"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" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "maxLength",
"type" : "Number",
"desc" : "Maximum input field length allowed (defaults to Number.MAX_VALUE)",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"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" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "md",
"type" : "Number",
"desc" : "colspan out of 12 for computer-sized screens",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "minLength",
"type" : "Number",
"desc" : "Minimum input field length required (defaults to 0)",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"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" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "name",
"type" : "String",
"desc" : "name of the input",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "placeholder",
"type" : "string",
"desc" : "- placeholder to put in text.",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "preventMark",
"type" : "Boolean",
"desc" : "Do not show tick or cross if error/success",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "readOnly",
"type" : "Boolean",
"desc" : "Specifies that the field should be read-only",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"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" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "regexText",
"type" : "String",
"desc" : "-- Depricated - use Invalid Text",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "selectOnFocus",
"type" : "Boolean",
"desc" : "True to automatically select any existing field text when the field receives input focus (defaults to false)",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "size",
"type" : "string",
"desc" : "- (lg|sm) or leave empty..",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "sm",
"type" : "Number",
"desc" : "colspan out of 12 for tablet-sized screens",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "style",
"type" : "String",
"desc" : "any extra css",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "tooltip",
"type" : "string",
"desc" : "Text for the tooltip",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "validClass",
"type" : "String",
"desc" : "DEPRICATED - code uses BS4 - is-valid / is-invalid",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "validFeedbackIcon",
"type" : "String",
"desc" : "The CSS class to use when create feedback icon (defaults to \"x-form-invalid\")",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "validateOnBlur",
"type" : "Boolean",
"desc" : "Whether the field should validate when it loses focus (defaults to true).",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "validationDelay",
"type" : "Number",
"desc" : "The length of time in milliseconds after user input begins until validation is initiated (defaults to 250)",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"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" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"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" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "value",
"type" : "string",
"desc" : "default value of the input",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "visibilityEl",
"type" : "string|object",
- "desc" : "t) What element to use for visibility (@see getVisibilityEl())",
- "memberOf" : "Roo.bootstrap.Component"
+ "desc" : "t) What element to use for visibility (@see getVisibilityEl(",
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : [
+ "el",
+ "parent"
+ ]
},
{
"name" : "vtype",
"type" : "String",
"desc" : "A validation type name as defined in {@link Roo.form.VTypes} (defaults to null)",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "xattr",
"type" : "Object",
"desc" : "extra attributes to add to 'element' (used by builder to store stuff.)",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "xs",
"type" : "Number",
"desc" : "colspan out of 12 for mobile-sized screens",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
}
],
"events" : [
],
"isAbstract" : false,
"isBuilderTop" : false,
- "childClasses" : {
- "Roo.bootstrap.form.TextArea" : [
- "Roo.bootstrap.form.HtmlEditor",
- "Roo.bootstrap.form.Markdown"
- ],
- "Roo.bootstrap.form.TriggerField" : [
- "Roo.bootstrap.form.ComboBox",
- "Roo.bootstrap.form.PhoneInput"
- ],
- "Roo.bootstrap.form.ComboBox" : [
- "Roo.bootstrap.form.MoneyField"
- ],
- "Roo.bootstrap.form.Input" : [
- "Roo.bootstrap.form.CheckBox",
- "Roo.bootstrap.form.DateField",
- "Roo.bootstrap.form.MonthField",
- "Roo.bootstrap.form.NumberField",
- "Roo.bootstrap.form.RadioSet",
- "Roo.bootstrap.form.SecurePass",
- "Roo.bootstrap.form.TextArea",
- "Roo.bootstrap.form.TimeField",
- "Roo.bootstrap.form.TriggerField"
- ]
- },
+ "implementations" : [
+ "Roo.bootstrap.form.CheckBox",
+ "Roo.bootstrap.form.ComboBox",
+ "Roo.bootstrap.form.DateField",
+ "Roo.bootstrap.form.HtmlEditor",
+ "Roo.bootstrap.form.Markdown",
+ "Roo.bootstrap.form.MoneyField",
+ "Roo.bootstrap.form.MonthField",
+ "Roo.bootstrap.form.NumberField",
+ "Roo.bootstrap.form.PhoneInput",
+ "Roo.bootstrap.form.RadioSet",
+ "Roo.bootstrap.form.SecurePass",
+ "Roo.bootstrap.form.TextArea",
+ "Roo.bootstrap.form.TimeField",
+ "Roo.bootstrap.form.TriggerField"
+ ],
"tree_children" : [],
"tree_parent" : []
},
{
"name" : "accept",
"type" : "String",
- "desc" : "o) use for file input only. (default empty)",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "desc" : "o) use for file input only. (default empt",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : [
+ "image",
+ "video",
+ "audio"
+ ]
},
{
"name" : "actionMode",
"type" : "String",
"desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el' for forms you probably want to set this to fieldEl",
- "memberOf" : "Roo.Component"
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "after",
"type" : "string",
"desc" : "- input group add on after",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "afterButton",
"type" : "Roo.bootstrap.Button",
"desc" : "to show before",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "align",
"type" : "String",
- "desc" : "t) Default left",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "desc" : "t) Default le",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : [
+ "left",
+ "center",
+ "right"
+ ]
},
{
"name" : "allowBlank",
"type" : "Boolean",
"desc" : "False to validate that the value length > 0 (defaults to true)",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "allowDomMove",
"type" : "Boolean",
"desc" : "Whether the component can move the Dom node when rendering (defaults to true).",
- "memberOf" : "Roo.Component"
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "autocomplete",
"type" : "String",
"desc" : "- default is new-password see: https://developers.google.com/web/fundamentals/input/form/label-and-name-inputs?hl=en",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "before",
"type" : "string",
"desc" : "- input group add on before",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "blankText",
"type" : "String",
"desc" : "Error text to display if the allow blank validation fails (defaults to \"This field is required\")",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "can_build_overlaid",
"type" : "Boolean",
"desc" : "True if element can be rebuild from a HTML page",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "capture",
"type" : "String",
- "desc" : "a) use for file input only. (default empty)",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "desc" : "a) use for file input only. (default empt",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : [
+ "user",
+ "camera"
+ ]
},
{
"name" : "cls",
"type" : "String",
"desc" : "css class",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "cols",
"type" : "Number",
"desc" : "Specifies the visible width of a text area",
- "memberOf" : "Roo.bootstrap.form.TextArea"
+ "memberOf" : "Roo.bootstrap.form.TextArea",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "container_method",
"type" : "string",
"desc" : "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "content",
"type" : "string",
"desc" : "",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "dataId",
"type" : "string",
"desc" : "cutomer id",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "disableClass",
"type" : "String",
"desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").",
- "memberOf" : "Roo.Component"
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "disableKeyFilter",
"type" : "Boolean",
"desc" : "True to disable input keystroke filtering (defaults to false)",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "disabled",
"type" : "Boolean",
"desc" : "is it disabled",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "fieldLabel",
"type" : "string",
"desc" : "- the label associated",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "focusClass",
"type" : "String",
"desc" : "The CSS class to use when the field receives focus (defaults to \"x-form-focus\")",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "forceFeedback",
"type" : "Boolean",
- "desc" : "e) Default false",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "desc" : "e) Default fal",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : [
+ "true",
+ "false"
+ ]
},
{
"name" : "hasFeedback",
"type" : "Boolean",
- "desc" : "e) default true",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "desc" : "e) default tr",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : [
+ "true",
+ "false"
+ ]
},
{
"name" : "hideMode",
"type" : "String",
- "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".",
- "memberOf" : "Roo.Component"
+ "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display",
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : [
+ "display",
+ "visibility"
+ ]
},
{
"name" : "html",
"type" : "string",
"desc" : "text",
- "memberOf" : "Roo.bootstrap.form.TextArea"
+ "memberOf" : "Roo.bootstrap.form.TextArea",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "indicatorpos",
"type" : "String",
- "desc" : "t) default left",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "desc" : "t) default le",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : [
+ "left",
+ "right"
+ ]
},
{
"name" : "inputType",
"type" : "String",
- "desc" : "t)",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "desc" : "",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : [
+ "button",
+ "checkbox",
+ "email",
+ "file",
+ "hidden",
+ "image",
+ "number",
+ "password",
+ "radio",
+ "range",
+ "reset",
+ "search",
+ "submit",
+ "text"
+ ]
},
{
"name" : "invalidClass",
"type" : "String",
"desc" : "DEPRICATED - code uses BS4 - is-valid / is-invalid",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "invalidFeedbackIcon",
"type" : "String",
"desc" : "The CSS class to use when create feedback icon (defaults to \"x-form-invalid\")",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "invalidText",
"type" : "String",
"desc" : "The error text to display if {@link #validator} test fails during validation (defaults to \"\")",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "labelAlign",
"type" : "String",
- "desc" : "t)",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "desc" : "",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : [
+ "top",
+ "left"
+ ]
},
{
"name" : "labelWidth",
"type" : "Number",
"desc" : "set the width of label",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "labellg",
"type" : "Number",
"desc" : "set the width of label (1-12)",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "labelmd",
"type" : "Number",
"desc" : "set the width of label (1-12)",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "labelsm",
"type" : "Number",
"desc" : "set the width of label (1-12)",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "labelxs",
"type" : "Number",
"desc" : "set the width of label (1-12)",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "lg",
"type" : "Number",
"desc" : "colspan out of 12 for large computer-sized screens",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"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"
+ "memberOf" : "Roo.util.Observable",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "maskRe",
"type" : "String",
"desc" : "An input mask regular expression that will be used to filter keystrokes that don't match (defaults to null)",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "maxLength",
"type" : "Number",
"desc" : "Maximum input field length allowed (defaults to Number.MAX_VALUE)",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "maxLengthText",
"type" : "String",
"desc" : "Error text to display if the maximum length validation fails (defaults to \"The maximum length for this field is {maxLength}\")",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "md",
"type" : "Number",
"desc" : "colspan out of 12 for computer-sized screens",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "minLength",
"type" : "Number",
"desc" : "Minimum input field length required (defaults to 0)",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "minLengthText",
"type" : "String",
"desc" : "Error text to display if the minimum length validation fails (defaults to \"The minimum length for this field is {minLength}\")",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "name",
"type" : "String",
"desc" : "name of the input",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "placeholder",
"type" : "string",
"desc" : "- placeholder to put in text.",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "preventMark",
"type" : "Boolean",
"desc" : "Do not show tick or cross if error/success",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "readOnly",
"type" : "Boolean",
"desc" : "Specifies that the field should be read-only",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "regex",
"type" : "RegExp",
"desc" : "A JavaScript RegExp object to be tested against the field value during validation (defaults to null).\nIf available, this regex will be evaluated only after the basic validators all return true, and will be passed the\ncurrent field value. If the test fails, the field will be marked invalid using {@link #regexText}.",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "regexText",
"type" : "String",
"desc" : "-- Depricated - use Invalid Text",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "resize",
"type" : "string",
- "desc" : "l)",
- "memberOf" : "Roo.bootstrap.form.TextArea"
+ "desc" : "",
+ "memberOf" : "Roo.bootstrap.form.TextArea",
+ "isOptional" : false,
+ "optvals" : [
+ "none",
+ "both",
+ "horizontal",
+ "vertical",
+ "inherit",
+ "initial"
+ ]
},
{
"name" : "rows",
"type" : "Number",
"desc" : "Specifies the visible number of lines in a text area",
- "memberOf" : "Roo.bootstrap.form.TextArea"
+ "memberOf" : "Roo.bootstrap.form.TextArea",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "selectOnFocus",
"type" : "Boolean",
"desc" : "True to automatically select any existing field text when the field receives input focus (defaults to false)",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "size",
"type" : "string",
"desc" : "- (lg|sm) or leave empty..",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "sm",
"type" : "Number",
"desc" : "colspan out of 12 for tablet-sized screens",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "style",
"type" : "String",
"desc" : "any extra css",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "tooltip",
"type" : "string",
"desc" : "Text for the tooltip",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "validClass",
"type" : "String",
"desc" : "DEPRICATED - code uses BS4 - is-valid / is-invalid",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "validFeedbackIcon",
"type" : "String",
"desc" : "The CSS class to use when create feedback icon (defaults to \"x-form-invalid\")",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "validateOnBlur",
"type" : "Boolean",
"desc" : "Whether the field should validate when it loses focus (defaults to true).",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "validationDelay",
"type" : "Number",
"desc" : "The length of time in milliseconds after user input begins until validation is initiated (defaults to 250)",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "validationEvent",
"type" : "String/Boolean",
"desc" : "The event that should initiate field validation. Set to false to disable\n automatic validation (defaults to \"keyup\").",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "validator",
"type" : "Function",
"desc" : "A custom validation function to be called during field validation (defaults to null).\nIf available, this function will be called only after the basic validators all return true, and will be passed the\ncurrent field value and expected to return boolean true if the value is valid or a string error message if invalid.",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "value",
"type" : "string",
"desc" : "default value of the input",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "visibilityEl",
"type" : "string|object",
- "desc" : "t) What element to use for visibility (@see getVisibilityEl())",
- "memberOf" : "Roo.bootstrap.Component"
+ "desc" : "t) What element to use for visibility (@see getVisibilityEl(",
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : [
+ "el",
+ "parent"
+ ]
},
{
"name" : "vtype",
"type" : "String",
"desc" : "A validation type name as defined in {@link Roo.form.VTypes} (defaults to null)",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "wrap",
"type" : "string",
- "desc" : "d)Specifies how the text in a text area is to be wrapped when submitted in a form",
- "memberOf" : "Roo.bootstrap.form.TextArea"
+ "desc" : "d)Specifies how the text in a text area is to be wrapped when submitted in a fo",
+ "memberOf" : "Roo.bootstrap.form.TextArea",
+ "isOptional" : false,
+ "optvals" : [
+ "soft",
+ "hard"
+ ]
},
{
"name" : "xattr",
"type" : "Object",
"desc" : "extra attributes to add to 'element' (used by builder to store stuff.)",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "xs",
"type" : "Number",
"desc" : "colspan out of 12 for mobile-sized screens",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
}
],
"events" : [
],
"isAbstract" : false,
"isBuilderTop" : false,
- "childClasses" : { },
+ "implementations" : [],
"tree_children" : [],
"tree_parent" : []
},
{
"name" : "accept",
"type" : "String",
- "desc" : "o) use for file input only. (default empty)",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "desc" : "o) use for file input only. (default empt",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : [
+ "image",
+ "video",
+ "audio"
+ ]
},
{
"name" : "actionMode",
"type" : "String",
"desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el' for forms you probably want to set this to fieldEl",
- "memberOf" : "Roo.Component"
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "after",
"type" : "string",
"desc" : "- input group add on after",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "afterButton",
"type" : "Roo.bootstrap.Button",
"desc" : "to show before",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "align",
"type" : "String",
- "desc" : "t) Default left",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "desc" : "t) Default le",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : [
+ "left",
+ "center",
+ "right"
+ ]
},
{
"name" : "allQuery",
"type" : "String",
"desc" : "The text query to send to the server to return all records for the list with no filtering (defaults to '')",
- "memberOf" : "Roo.bootstrap.form.ComboBox"
+ "memberOf" : "Roo.bootstrap.form.ComboBox",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "allowBlank",
"type" : "Boolean",
"desc" : "False to validate that the value length > 0 (defaults to true)",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "allowDecimals",
"type" : "Boolean",
"desc" : "False to disallow decimal values (defaults to true)",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "allowDomMove",
"type" : "Boolean",
"desc" : "Whether the component can move the Dom node when rendering (defaults to true).",
- "memberOf" : "Roo.Component"
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "allowNegative",
"type" : "Boolean",
"desc" : "False to prevent entering a negative sign (defaults to true)",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "allowZero",
"type" : "Boolean",
"desc" : "False to blank out if the user enters '0' (defaults to true)",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "alwaysQuery",
"type" : "Boolean",
"desc" : "Disable caching of results, and always send query",
- "memberOf" : "Roo.bootstrap.form.ComboBox"
+ "memberOf" : "Roo.bootstrap.form.ComboBox",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "animate",
"type" : "Boolean",
"desc" : "default true",
- "memberOf" : "Roo.bootstrap.form.ComboBox"
+ "memberOf" : "Roo.bootstrap.form.ComboBox",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "append",
"type" : "Boolean",
- "desc" : "e) default false",
- "memberOf" : "Roo.bootstrap.form.ComboBox"
+ "desc" : "e) default fal",
+ "memberOf" : "Roo.bootstrap.form.ComboBox",
+ "isOptional" : false,
+ "optvals" : [
+ "true",
+ "false"
+ ]
},
{
"name" : "autoCreate",
"type" : "Boolean/Object",
"desc" : "A DomHelper element spec, or true for a default element spec (defaults to:\n{tag: \"input\", type: \"text\", size: \"24\", autocomplete: \"off\"})",
- "memberOf" : "Roo.bootstrap.form.ComboBox"
+ "memberOf" : "Roo.bootstrap.form.ComboBox",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "autoFocus",
"type" : "Boolean",
- "desc" : "e) auto focus the first item, default true",
- "memberOf" : "Roo.bootstrap.form.ComboBox"
+ "desc" : "e) auto focus the first item, default tr",
+ "memberOf" : "Roo.bootstrap.form.ComboBox",
+ "isOptional" : false,
+ "optvals" : [
+ "true",
+ "false"
+ ]
},
{
"name" : "autocomplete",
"type" : "String",
"desc" : "- default is new-password see: https://developers.google.com/web/fundamentals/input/form/label-and-name-inputs?hl=en",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "before",
"type" : "string",
"desc" : "- input group add on before",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "blankText",
"type" : "String",
"desc" : "Error text to display if the allow blank validation fails (defaults to \"This field is required\")",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "blockFocus",
"type" : "Boolean",
"desc" : "Prevents all focus calls, so it can work with things like HTML edtor bar",
- "memberOf" : "Roo.bootstrap.form.ComboBox"
+ "memberOf" : "Roo.bootstrap.form.ComboBox",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "btnPosition",
"type" : "String",
"desc" : "set the position of the trigger button (left | right) default right",
- "memberOf" : "Roo.bootstrap.form.ComboBox"
+ "memberOf" : "Roo.bootstrap.form.ComboBox",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "can_build_overlaid",
"type" : "Boolean",
"desc" : "True if element can be rebuild from a HTML page",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "capture",
"type" : "String",
- "desc" : "a) use for file input only. (default empty)",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "desc" : "a) use for file input only. (default empt",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : [
+ "user",
+ "camera"
+ ]
},
{
"name" : "caret",
"type" : "String",
- "desc" : "r) BS3 only - carat fa name",
- "memberOf" : "Roo.bootstrap.form.TriggerField"
+ "desc" : "r) BS3 only - carat fa na",
+ "memberOf" : "Roo.bootstrap.form.TriggerField",
+ "isOptional" : false,
+ "optvals" : [
+ "search",
+ "calendar"
+ ]
},
{
"name" : "castInt",
"type" : "Boolean",
- "desc" : "e) cast int if true (defalut true)",
- "memberOf" : ""
+ "desc" : "e) cast int if true (defalut tru",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : [
+ "true",
+ "false"
+ ]
},
{
"name" : "cls",
"type" : "String",
"desc" : "css class",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "container_method",
"type" : "string",
"desc" : "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "dataId",
"type" : "string",
"desc" : "cutomer id",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "decimalPrecision",
"type" : "Number",
"desc" : "The maximum precision to display after the decimal separator (defaults to 2)",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "decimalSeparator",
"type" : "String",
"desc" : "Character(s) to allow as the decimal separator (defaults to '.')",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "defaults",
"type" : "String",
"desc" : "currency of the MoneyField\nvalue should be in lkey",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "disableClass",
"type" : "String",
"desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").",
- "memberOf" : "Roo.Component"
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "disableClear",
"type" : "Boolean",
"desc" : "Disable showing of clear button.",
- "memberOf" : "Roo.bootstrap.form.ComboBox"
+ "memberOf" : "Roo.bootstrap.form.ComboBox",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "disableKeyFilter",
"type" : "Boolean",
"desc" : "True to disable input keystroke filtering (defaults to false)",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "disabled",
"type" : "Boolean",
"desc" : "is it disabled",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "displayField",
"type" : "String",
"desc" : "The underlying data field name to bind to this CombBox (defaults to undefined if\nmode = 'remote' or 'text' if mode = 'local')",
- "memberOf" : "Roo.bootstrap.form.ComboBox"
+ "memberOf" : "Roo.bootstrap.form.ComboBox",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "editable",
"type" : "Boolean",
"desc" : "False to prevent the user from typing text directly into the field, just like a\ntraditional select (defaults to true)",
- "memberOf" : "Roo.bootstrap.form.ComboBox"
+ "memberOf" : "Roo.bootstrap.form.ComboBox",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "emptyResultText",
"type" : "Boolean",
"desc" : "only for touch device",
- "memberOf" : "Roo.bootstrap.form.ComboBox"
+ "memberOf" : "Roo.bootstrap.form.ComboBox",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "emptyTitle",
"type" : "String",
"desc" : "default ''",
- "memberOf" : "Roo.bootstrap.form.ComboBox"
+ "memberOf" : "Roo.bootstrap.form.ComboBox",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "fieldLabel",
"type" : "string",
"desc" : "- the label associated",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "focusClass",
"type" : "String",
"desc" : "The CSS class to use when the field receives focus (defaults to \"x-form-focus\")",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "forceFeedback",
"type" : "Boolean",
- "desc" : "e) Default false",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "desc" : "e) Default fal",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : [
+ "true",
+ "false"
+ ]
},
{
"name" : "forceSelection",
"type" : "Boolean",
"desc" : "True to restrict the selected value to one of the values in the list, false to\nallow the user to set arbitrary text into the field (defaults to false)",
- "memberOf" : "Roo.bootstrap.form.ComboBox"
+ "memberOf" : "Roo.bootstrap.form.ComboBox",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "grow",
"type" : "Boolean",
"desc" : "",
- "memberOf" : "Roo.bootstrap.form.ComboBox"
+ "memberOf" : "Roo.bootstrap.form.ComboBox",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "growMax",
"type" : "Number",
"desc" : "",
- "memberOf" : "Roo.bootstrap.form.ComboBox"
+ "memberOf" : "Roo.bootstrap.form.ComboBox",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "growMin",
"type" : "Number",
"desc" : "",
- "memberOf" : "Roo.bootstrap.form.ComboBox"
+ "memberOf" : "Roo.bootstrap.form.ComboBox",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "handleHeight",
"type" : "Number",
"desc" : "The height in pixels of the dropdown list resize handle if resizable = true (defaults to 8)",
- "memberOf" : "Roo.bootstrap.form.ComboBox"
+ "memberOf" : "Roo.bootstrap.form.ComboBox",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "hasFeedback",
"type" : "Boolean",
- "desc" : "e) default true",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "desc" : "e) default tr",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : [
+ "true",
+ "false"
+ ]
},
{
"name" : "hiddenName",
"type" : "String",
"desc" : "If specified, a hidden form field with this name is dynamically generated to store the\nfield's data value (defaults to the underlying DOM element's name)",
- "memberOf" : "Roo.bootstrap.form.ComboBox"
+ "memberOf" : "Roo.bootstrap.form.ComboBox",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "hideMode",
"type" : "String",
- "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".",
- "memberOf" : "Roo.Component"
+ "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display",
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : [
+ "display",
+ "visibility"
+ ]
},
{
"name" : "hideTrigger",
"type" : "Boolean",
"desc" : "True to hide the trigger element and display only the base text field (defaults to false)",
- "memberOf" : "Roo.bootstrap.form.TriggerField"
+ "memberOf" : "Roo.bootstrap.form.TriggerField",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "indicatorpos",
"type" : "String",
- "desc" : "t) default left",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "desc" : "t) default le",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : [
+ "left",
+ "right"
+ ]
},
{
"name" : "inputType",
"type" : "String",
- "desc" : "t)",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "desc" : "",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : [
+ "button",
+ "checkbox",
+ "email",
+ "file",
+ "hidden",
+ "image",
+ "number",
+ "password",
+ "radio",
+ "range",
+ "reset",
+ "search",
+ "submit",
+ "text"
+ ]
},
{
"name" : "invalidClass",
"type" : "String",
"desc" : "DEPRICATED - uses BS4 is-valid now",
- "memberOf" : "Roo.bootstrap.form.ComboBox"
+ "memberOf" : "Roo.bootstrap.form.ComboBox",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "invalidFeedbackIcon",
"type" : "String",
"desc" : "The CSS class to use when create feedback icon (defaults to \"x-form-invalid\")",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "invalidText",
"type" : "String",
"desc" : "The error text to display if {@link #validator} test fails during validation (defaults to \"\")",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "labelAlign",
"type" : "String",
- "desc" : "t)",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "desc" : "",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : [
+ "top",
+ "left"
+ ]
},
{
"name" : "labelWidth",
"type" : "Number",
"desc" : "set the width of label",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "labellg",
"type" : "Number",
"desc" : "set the width of label (1-12)",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "labelmd",
"type" : "Number",
"desc" : "set the width of label (1-12)",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "labelsm",
"type" : "Number",
"desc" : "set the width of label (1-12)",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "labelxs",
"type" : "Number",
"desc" : "set the width of label (1-12)",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "lazyRender",
"type" : "Boolean",
"desc" : "True to prevent the ComboBox from rendering until requested (should always be used when\nrendering into an Roo.Editor, defaults to false)",
- "memberOf" : "Roo.bootstrap.form.ComboBox"
+ "memberOf" : "Roo.bootstrap.form.ComboBox",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "lg",
"type" : "Number",
"desc" : "colspan out of 12 for large computer-sized screens",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "listAlign",
"type" : "String",
"desc" : "A valid anchor position value. See {@link Roo.Element#alignTo} for details on supported\nanchor positions (defaults to 'tl-bl')",
- "memberOf" : "Roo.bootstrap.form.ComboBox"
+ "memberOf" : "Roo.bootstrap.form.ComboBox",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "listClass",
"type" : "String",
"desc" : "CSS class to apply to the dropdown list element (defaults to '')",
- "memberOf" : "Roo.bootstrap.form.ComboBox"
+ "memberOf" : "Roo.bootstrap.form.ComboBox",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "listWidth",
"type" : "Number",
"desc" : "The width in pixels of the dropdown list (defaults to the width of the ComboBox field)",
- "memberOf" : "Roo.bootstrap.form.ComboBox"
+ "memberOf" : "Roo.bootstrap.form.ComboBox",
+ "isOptional" : false,
+ "optvals" : []
},
{
"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"
+ "memberOf" : "Roo.util.Observable",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "loadingText",
"type" : "String",
"desc" : "The text to display in the dropdown list while data is loading. Only applies\nwhen mode = 'remote' (defaults to 'Loading...')",
- "memberOf" : "Roo.bootstrap.form.ComboBox"
+ "memberOf" : "Roo.bootstrap.form.ComboBox",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "maskRe",
"type" : "String",
"desc" : "An input mask regular expression that will be used to filter keystrokes that don't match (defaults to null)",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "maxHeight",
"type" : "Number",
"desc" : "The maximum height in pixels of the dropdown list before scrollbars are shown (defaults to 300)",
- "memberOf" : "Roo.bootstrap.form.ComboBox"
+ "memberOf" : "Roo.bootstrap.form.ComboBox",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "maxLength",
"type" : "Number",
"desc" : "Maximum input field length allowed (defaults to Number.MAX_VALUE)",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "maxLengthText",
"type" : "String",
"desc" : "Error text to display if the maximum length validation fails (defaults to \"The maximum length for this field is {maxLength}\")",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"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" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "maxValue",
"type" : "Number",
"desc" : "The maximum allowed value (defaults to Number.MAX_VALUE)",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "max_length",
"type" : "Number",
"desc" : "Maximum input field length allowed (defaults to Number.MAX_VALUE)",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "md",
"type" : "Number",
"desc" : "colspan out of 12 for computer-sized screens",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "minChars",
"type" : "Number",
"desc" : "The minimum number of characters the user must type before autocomplete and typeahead activate\n(defaults to 4, does not apply if editable = false)",
- "memberOf" : "Roo.bootstrap.form.ComboBox"
+ "memberOf" : "Roo.bootstrap.form.ComboBox",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "minLength",
"type" : "Number",
"desc" : "Minimum input field length required (defaults to 0)",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "minLengthText",
"type" : "String",
"desc" : "Error text to display if the minimum length validation fails (defaults to \"The minimum length for this field is {minLength}\")",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "minListWidth",
"type" : "Number",
"desc" : "The minimum width of the dropdown list in pixels (defaults to 70, will be ignored if\nlistWidth has a higher value)",
- "memberOf" : "Roo.bootstrap.form.ComboBox"
+ "memberOf" : "Roo.bootstrap.form.ComboBox",
+ "isOptional" : false,
+ "optvals" : []
},
{
"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" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "minValue",
"type" : "Number",
"desc" : "The minimum allowed value (defaults to Number.NEGATIVE_INFINITY)",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "mobileTouchView",
"type" : "Boolean",
- "desc" : "e) show mobile touch view when using a mobile default true",
- "memberOf" : "Roo.bootstrap.form.ComboBox"
+ "desc" : "e) show mobile touch view when using a mobile default tr",
+ "memberOf" : "Roo.bootstrap.form.ComboBox",
+ "isOptional" : false,
+ "optvals" : [
+ "true",
+ "false"
+ ]
},
{
"name" : "mobile_restrict_height",
"type" : "Boolean",
- "desc" : "e) restrict height for touch view",
- "memberOf" : "Roo.bootstrap.form.ComboBox"
+ "desc" : "e) restrict height for touch vi",
+ "memberOf" : "Roo.bootstrap.form.ComboBox",
+ "isOptional" : false,
+ "optvals" : [
+ "true",
+ "false"
+ ]
},
{
"name" : "modalTitle",
"type" : "String",
"desc" : "The title of the dialog that pops up on mobile views.",
- "memberOf" : "Roo.bootstrap.form.ComboBox"
+ "memberOf" : "Roo.bootstrap.form.ComboBox",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "mode",
"type" : "String",
"desc" : "Set to 'local' if the ComboBox loads local data (defaults to 'remote' which loads from the server)",
- "memberOf" : "Roo.bootstrap.form.ComboBox"
+ "memberOf" : "Roo.bootstrap.form.ComboBox",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "multiple",
"type" : "Boolean",
- "desc" : "e) ComboBobArray, default false",
- "memberOf" : "Roo.bootstrap.form.ComboBox"
+ "desc" : "e) ComboBobArray, default fal",
+ "memberOf" : "Roo.bootstrap.form.ComboBox",
+ "isOptional" : false,
+ "optvals" : [
+ "true",
+ "false"
+ ]
},
{
"name" : "name",
"type" : "String",
"desc" : "name of the input",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"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" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "pageSize",
"type" : "Number",
"desc" : "If greater than 0, a paging toolbar is displayed in the footer of the dropdown list and the\nfilter queries will execute with page start and limit parameters. Only applies when mode = 'remote' (defaults to 0)",
- "memberOf" : "Roo.bootstrap.form.ComboBox"
+ "memberOf" : "Roo.bootstrap.form.ComboBox",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "placeholder",
"type" : "string",
"desc" : "- placeholder to put in text.",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "preventMark",
"type" : "Boolean",
"desc" : "Do not show tick or cross if error/success",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "queryDelay",
"type" : "Number",
"desc" : "The length of time in milliseconds to delay between the start of typing and sending the\nquery to filter the dropdown list (defaults to 500 if mode = 'remote' or 10 if mode = 'local')",
- "memberOf" : "Roo.bootstrap.form.ComboBox"
+ "memberOf" : "Roo.bootstrap.form.ComboBox",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "queryParam",
"type" : "String",
"desc" : "Name of the query as it will be passed on the querystring (defaults to 'query')",
- "memberOf" : "Roo.bootstrap.form.ComboBox"
+ "memberOf" : "Roo.bootstrap.form.ComboBox",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "readOnly",
"type" : "Boolean",
"desc" : "Specifies that the field should be read-only",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "regex",
"type" : "RegExp",
"desc" : "A JavaScript RegExp object to be tested against the field value during validation (defaults to null).\nIf available, this regex will be evaluated only after the basic validators all return true, and will be passed the\ncurrent field value. If the test fails, the field will be marked invalid using {@link #regexText}.",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "regexText",
"type" : "String",
"desc" : "-- Depricated - use Invalid Text",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "removable",
"type" : "Boolean",
- "desc" : "e) special filter default false",
- "memberOf" : "Roo.bootstrap.form.TriggerField"
+ "desc" : "e) special filter default fal",
+ "memberOf" : "Roo.bootstrap.form.TriggerField",
+ "isOptional" : false,
+ "optvals" : [
+ "true",
+ "false"
+ ]
},
{
"name" : "resizable",
"type" : "Boolean",
"desc" : "True to add a resize handle to the bottom of the dropdown list (defaults to false)",
- "memberOf" : "Roo.bootstrap.form.ComboBox"
+ "memberOf" : "Roo.bootstrap.form.ComboBox",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "selectOnFocus",
"type" : "Boolean",
"desc" : "True to select any existing text in the field immediately on focus. Only applies\nwhen editable = true (defaults to false)",
- "memberOf" : "Roo.bootstrap.form.ComboBox"
+ "memberOf" : "Roo.bootstrap.form.ComboBox",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "selectedClass",
"type" : "String",
"desc" : "CSS class to apply to the selected item in the dropdown list (defaults to 'x-combo-selected')",
- "memberOf" : "Roo.bootstrap.form.ComboBox"
+ "memberOf" : "Roo.bootstrap.form.ComboBox",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "shadow",
"type" : "Boolean/String",
"desc" : "True or \"sides\" for the default effect, \"frame\" for 4-way shadow, and \"drop\" for bottom-right",
- "memberOf" : "Roo.bootstrap.form.ComboBox"
+ "memberOf" : "Roo.bootstrap.form.ComboBox",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "showToggleBtn",
"type" : "Boolean",
"desc" : "show toggle button or not (true|false) default true",
- "memberOf" : "Roo.bootstrap.form.ComboBox"
+ "memberOf" : "Roo.bootstrap.form.ComboBox",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "size",
"type" : "string",
"desc" : "- (lg|sm) or leave empty..",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "sm",
"type" : "Number",
"desc" : "colspan out of 12 for tablet-sized screens",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "specialFilter",
"type" : "Boolean",
- "desc" : "e) special filter default false",
- "memberOf" : "Roo.bootstrap.form.ComboBox"
+ "desc" : "e) special filter default fal",
+ "memberOf" : "Roo.bootstrap.form.ComboBox",
+ "isOptional" : false,
+ "optvals" : [
+ "true",
+ "false"
+ ]
},
{
"name" : "store",
"type" : "Roo.data.Store",
"desc" : "Store to lookup currency??",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "style",
"type" : "String",
"desc" : "any extra css",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "thousandsDelimiter",
"type" : "String",
"desc" : "Symbol of thousandsDelimiter",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "tickable",
"type" : "Boolean",
"desc" : "ComboBox with tickable selections (true|false), default false",
- "memberOf" : "Roo.bootstrap.form.ComboBox"
+ "memberOf" : "Roo.bootstrap.form.ComboBox",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "title",
"type" : "String",
"desc" : "If supplied, a header element is created containing this text and added into the top of\nthe dropdown list (defaults to undefined, with no header element)",
- "memberOf" : "Roo.bootstrap.form.ComboBox"
+ "memberOf" : "Roo.bootstrap.form.ComboBox",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "tooltip",
"type" : "string",
"desc" : "Text for the tooltip",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "tpl",
"type" : "String/Roo.Template",
"desc" : "The template to use to render the output default is '<a class=\"dropdown-item\" href=\"#\">{' + this.displayField + '}</a>'",
- "memberOf" : "Roo.bootstrap.form.ComboBox"
+ "memberOf" : "Roo.bootstrap.form.ComboBox",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "triggerAction",
"type" : "String",
"desc" : "The action to execute when the trigger field is activated. Use 'all' to run the\nquery specified by the allQuery config option (defaults to 'query')",
- "memberOf" : "Roo.bootstrap.form.ComboBox"
+ "memberOf" : "Roo.bootstrap.form.ComboBox",
+ "isOptional" : false,
+ "optvals" : []
},
{
"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" : "Roo.bootstrap.form.TriggerField"
+ "memberOf" : "Roo.bootstrap.form.TriggerField",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "triggerList",
"type" : "Boolean",
"desc" : "trigger show the list or not (true|false) default true",
- "memberOf" : "Roo.bootstrap.form.ComboBox"
+ "memberOf" : "Roo.bootstrap.form.ComboBox",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "triggerText",
"type" : "String",
"desc" : "multiple combobox trigger button text default 'Select'",
- "memberOf" : "Roo.bootstrap.form.ComboBox"
+ "memberOf" : "Roo.bootstrap.form.ComboBox",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "typeAhead",
"type" : "Boolean",
"desc" : "True to populate and autoselect the remainder of the text being typed after a configurable\ndelay (typeAheadDelay) if it matches a known value (defaults to false)",
- "memberOf" : "Roo.bootstrap.form.ComboBox"
+ "memberOf" : "Roo.bootstrap.form.ComboBox",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "typeAheadDelay",
"type" : "Number",
"desc" : "The length of time in milliseconds to wait until the typeahead text is displayed\nif typeAhead = true (defaults to 250)",
- "memberOf" : "Roo.bootstrap.form.ComboBox"
+ "memberOf" : "Roo.bootstrap.form.ComboBox",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "useNativeIOS",
"type" : "Boolean",
- "desc" : "e) render it as classic select for ios, not support dynamic load data (default false)",
- "memberOf" : "Roo.bootstrap.form.ComboBox"
+ "desc" : "e) render it as classic select for ios, not support dynamic load data (default fals",
+ "memberOf" : "Roo.bootstrap.form.ComboBox",
+ "isOptional" : false,
+ "optvals" : [
+ "true",
+ "false"
+ ]
},
{
"name" : "validClass",
"type" : "String",
"desc" : "DEPRICATED - uses BS4 is-valid now",
- "memberOf" : "Roo.bootstrap.form.ComboBox"
+ "memberOf" : "Roo.bootstrap.form.ComboBox",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "validFeedbackIcon",
"type" : "String",
"desc" : "The CSS class to use when create feedback icon (defaults to \"x-form-invalid\")",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "validateOnBlur",
"type" : "Boolean",
"desc" : "Whether the field should validate when it loses focus (defaults to true).",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "validationDelay",
"type" : "Number",
"desc" : "The length of time in milliseconds after user input begins until validation is initiated (defaults to 250)",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "validationEvent",
"type" : "String/Boolean",
"desc" : "The event that should initiate field validation. Set to false to disable\n automatic validation (defaults to \"keyup\").",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "validator",
"type" : "Function",
"desc" : "A custom validation function to be called during field validation (defaults to null).\nIf available, this function will be called only after the basic validators all return true, and will be passed the\ncurrent field value and expected to return boolean true if the value is valid or a string error message if invalid.",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "value",
"type" : "string",
"desc" : "default value of the input",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "valueField",
"type" : "String",
"desc" : "The underlying data value name to bind to this CombBox (defaults to undefined if\nmode = 'remote' or 'value' if mode = 'local'). \nNote: use of a valueField requires the user make a selection\nin order for a value to be mapped.",
- "memberOf" : "Roo.bootstrap.form.ComboBox"
+ "memberOf" : "Roo.bootstrap.form.ComboBox",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "valueNotFoundText",
"type" : "String",
"desc" : "When using a name/value combo, if the value passed to setValue is not found in\nthe store, valueNotFoundText will be displayed as the field text if defined (defaults to undefined)",
- "memberOf" : "Roo.bootstrap.form.ComboBox"
+ "memberOf" : "Roo.bootstrap.form.ComboBox",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "visibilityEl",
"type" : "string|object",
- "desc" : "t) What element to use for visibility (@see getVisibilityEl())",
- "memberOf" : "Roo.bootstrap.Component"
+ "desc" : "t) What element to use for visibility (@see getVisibilityEl(",
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : [
+ "el",
+ "parent"
+ ]
},
{
"name" : "vtype",
"type" : "String",
"desc" : "A validation type name as defined in {@link Roo.form.VTypes} (defaults to null)",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "width",
"type" : "Number",
"desc" : "fixed with? experimental",
- "memberOf" : "Roo.bootstrap.form.ComboBox"
+ "memberOf" : "Roo.bootstrap.form.ComboBox",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "xattr",
"type" : "Object",
"desc" : "extra attributes to add to 'element' (used by builder to store stuff.)",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "xs",
"type" : "Number",
"desc" : "colspan out of 12 for mobile-sized screens",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
}
],
"events" : [
],
"isAbstract" : false,
"isBuilderTop" : false,
- "childClasses" : { },
+ "implementations" : [],
"tree_children" : [],
"tree_parent" : []
},
{
"name" : "accept",
"type" : "String",
- "desc" : "o) use for file input only. (default empty)",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "desc" : "o) use for file input only. (default empt",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : [
+ "image",
+ "video",
+ "audio"
+ ]
},
{
"name" : "actionMode",
"type" : "String",
"desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el' for forms you probably want to set this to fieldEl",
- "memberOf" : "Roo.Component"
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "after",
"type" : "string",
"desc" : "- input group add on after",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "afterButton",
"type" : "Roo.bootstrap.Button",
"desc" : "to show before",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "align",
"type" : "String",
- "desc" : "t) Default left",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "desc" : "t) Default le",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : [
+ "left",
+ "center",
+ "right"
+ ]
},
{
"name" : "allowBlank",
"type" : "Boolean",
"desc" : "False to validate that the value length > 0 (defaults to true)",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "allowDomMove",
"type" : "Boolean",
"desc" : "Whether the component can move the Dom node when rendering (defaults to true).",
- "memberOf" : "Roo.Component"
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "autocomplete",
"type" : "String",
"desc" : "- default is new-password see: https://developers.google.com/web/fundamentals/input/form/label-and-name-inputs?hl=en",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "before",
"type" : "string",
"desc" : "- input group add on before",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "blankText",
"type" : "String",
"desc" : "Error text to display if the allow blank validation fails (defaults to \"This field is required\")",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "can_build_overlaid",
"type" : "Boolean",
"desc" : "True if element can be rebuild from a HTML page",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "capture",
"type" : "String",
- "desc" : "a) use for file input only. (default empty)",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "desc" : "a) use for file input only. (default empt",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : [
+ "user",
+ "camera"
+ ]
},
{
"name" : "cls",
"type" : "String",
"desc" : "css class",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "container_method",
"type" : "string",
"desc" : "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "dataId",
"type" : "string",
"desc" : "cutomer id",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "disableClass",
"type" : "String",
"desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").",
- "memberOf" : "Roo.Component"
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "disableKeyFilter",
"type" : "Boolean",
"desc" : "True to disable input keystroke filtering (defaults to false)",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "disabled",
"type" : "Boolean",
"desc" : "is it disabled",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "fieldLabel",
"type" : "string",
"desc" : "- the label associated",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "focusClass",
"type" : "String",
"desc" : "The CSS class to use when the field receives focus (defaults to \"x-form-focus\")",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "forceFeedback",
"type" : "Boolean",
- "desc" : "e) Default false",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "desc" : "e) Default fal",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : [
+ "true",
+ "false"
+ ]
},
{
"name" : "hasFeedback",
"type" : "Boolean",
- "desc" : "e) default true",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "desc" : "e) default tr",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : [
+ "true",
+ "false"
+ ]
},
{
"name" : "hideMode",
"type" : "String",
- "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".",
- "memberOf" : "Roo.Component"
+ "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display",
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : [
+ "display",
+ "visibility"
+ ]
},
{
"name" : "indicatorpos",
"type" : "String",
- "desc" : "t) default left",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "desc" : "t) default le",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : [
+ "left",
+ "right"
+ ]
},
{
"name" : "inputType",
"type" : "String",
- "desc" : "t)",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "desc" : "",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : [
+ "button",
+ "checkbox",
+ "email",
+ "file",
+ "hidden",
+ "image",
+ "number",
+ "password",
+ "radio",
+ "range",
+ "reset",
+ "search",
+ "submit",
+ "text"
+ ]
},
{
"name" : "invalidClass",
"type" : "String",
"desc" : "DEPRICATED - code uses BS4 - is-valid / is-invalid",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "invalidFeedbackIcon",
"type" : "String",
"desc" : "The CSS class to use when create feedback icon (defaults to \"x-form-invalid\")",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "invalidText",
"type" : "String",
"desc" : "The error text to display if {@link #validator} test fails during validation (defaults to \"\")",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "labelAlign",
"type" : "String",
- "desc" : "t)",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "desc" : "",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : [
+ "top",
+ "left"
+ ]
},
{
"name" : "labelWidth",
"type" : "Number",
"desc" : "set the width of label",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "labellg",
"type" : "Number",
"desc" : "set the width of label (1-12)",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "labelmd",
"type" : "Number",
"desc" : "set the width of label (1-12)",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "labelsm",
"type" : "Number",
"desc" : "set the width of label (1-12)",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "labelxs",
"type" : "Number",
"desc" : "set the width of label (1-12)",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "language",
"type" : "String",
"desc" : "default en",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "lg",
"type" : "Number",
"desc" : "colspan out of 12 for large computer-sized screens",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"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"
+ "memberOf" : "Roo.util.Observable",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "maskRe",
"type" : "String",
"desc" : "An input mask regular expression that will be used to filter keystrokes that don't match (defaults to null)",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "maxLength",
"type" : "Number",
"desc" : "Maximum input field length allowed (defaults to Number.MAX_VALUE)",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "maxLengthText",
"type" : "String",
"desc" : "Error text to display if the maximum length validation fails (defaults to \"The maximum length for this field is {maxLength}\")",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "md",
"type" : "Number",
"desc" : "colspan out of 12 for computer-sized screens",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "minLength",
"type" : "Number",
"desc" : "Minimum input field length required (defaults to 0)",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "minLengthText",
"type" : "String",
"desc" : "Error text to display if the minimum length validation fails (defaults to \"The minimum length for this field is {minLength}\")",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "name",
"type" : "String",
"desc" : "name of the input",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "placeholder",
"type" : "string",
"desc" : "- placeholder to put in text.",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "preventMark",
"type" : "Boolean",
"desc" : "Do not show tick or cross if error/success",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "readOnly",
"type" : "Boolean",
"desc" : "Specifies that the field should be read-only",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "regex",
"type" : "RegExp",
"desc" : "A JavaScript RegExp object to be tested against the field value during validation (defaults to null).\nIf available, this regex will be evaluated only after the basic validators all return true, and will be passed the\ncurrent field value. If the test fails, the field will be marked invalid using {@link #regexText}.",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "regexText",
"type" : "String",
"desc" : "-- Depricated - use Invalid Text",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "selectOnFocus",
"type" : "Boolean",
"desc" : "True to automatically select any existing field text when the field receives input focus (defaults to false)",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "size",
"type" : "string",
"desc" : "- (lg|sm) or leave empty..",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "sm",
"type" : "Number",
"desc" : "colspan out of 12 for tablet-sized screens",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "style",
"type" : "String",
"desc" : "any extra css",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "tooltip",
"type" : "string",
"desc" : "Text for the tooltip",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "validClass",
"type" : "String",
"desc" : "DEPRICATED - code uses BS4 - is-valid / is-invalid",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "validFeedbackIcon",
"type" : "String",
"desc" : "The CSS class to use when create feedback icon (defaults to \"x-form-invalid\")",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "validateOnBlur",
"type" : "Boolean",
"desc" : "Whether the field should validate when it loses focus (defaults to true).",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "validationDelay",
"type" : "Number",
"desc" : "The length of time in milliseconds after user input begins until validation is initiated (defaults to 250)",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "validationEvent",
"type" : "String/Boolean",
"desc" : "The event that should initiate field validation. Set to false to disable\n automatic validation (defaults to \"keyup\").",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "validator",
"type" : "Function",
"desc" : "A custom validation function to be called during field validation (defaults to null).\nIf available, this function will be called only after the basic validators all return true, and will be passed the\ncurrent field value and expected to return boolean true if the value is valid or a string error message if invalid.",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "value",
"type" : "string",
"desc" : "default value of the input",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "visibilityEl",
"type" : "string|object",
- "desc" : "t) What element to use for visibility (@see getVisibilityEl())",
- "memberOf" : "Roo.bootstrap.Component"
+ "desc" : "t) What element to use for visibility (@see getVisibilityEl(",
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : [
+ "el",
+ "parent"
+ ]
},
{
"name" : "vtype",
"type" : "String",
"desc" : "A validation type name as defined in {@link Roo.form.VTypes} (defaults to null)",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "xattr",
"type" : "Object",
"desc" : "extra attributes to add to 'element' (used by builder to store stuff.)",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "xs",
"type" : "Number",
"desc" : "colspan out of 12 for mobile-sized screens",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
}
],
"events" : [
],
"isAbstract" : false,
"isBuilderTop" : false,
- "childClasses" : { },
+ "implementations" : [],
"tree_children" : [],
"tree_parent" : []
},
{
"name" : "accept",
"type" : "String",
- "desc" : "o) use for file input only. (default empty)",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "desc" : "o) use for file input only. (default empt",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : [
+ "image",
+ "video",
+ "audio"
+ ]
},
{
"name" : "actionMode",
"type" : "String",
"desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el' for forms you probably want to set this to fieldEl",
- "memberOf" : "Roo.Component"
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "after",
"type" : "string",
"desc" : "- input group add on after",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "afterButton",
"type" : "Roo.bootstrap.Button",
"desc" : "to show before",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "align",
"type" : "String",
- "desc" : "t) Default left",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "desc" : "t) Default le",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : [
+ "left",
+ "center",
+ "right"
+ ]
},
{
"name" : "allowBlank",
"type" : "Boolean",
"desc" : "False to validate that the value length > 0 (defaults to true)",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "allowDecimals",
"type" : "Boolean",
"desc" : "False to disallow decimal values (defaults to true)",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "allowDomMove",
"type" : "Boolean",
"desc" : "Whether the component can move the Dom node when rendering (defaults to true).",
- "memberOf" : "Roo.Component"
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "allowNegative",
"type" : "Boolean",
"desc" : "False to prevent entering a negative sign (defaults to true)",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "allowZero",
"type" : "Boolean",
"desc" : "False to blank out if the user enters '0' (defaults to true)",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "autocomplete",
"type" : "String",
"desc" : "- default is new-password see: https://developers.google.com/web/fundamentals/input/form/label-and-name-inputs?hl=en",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "before",
"type" : "string",
"desc" : "- input group add on before",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "blankText",
"type" : "String",
"desc" : "Error text to display if the allow blank validation fails (defaults to \"This field is required\")",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "can_build_overlaid",
"type" : "Boolean",
"desc" : "True if element can be rebuild from a HTML page",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "capture",
"type" : "String",
- "desc" : "a) use for file input only. (default empty)",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "desc" : "a) use for file input only. (default empt",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : [
+ "user",
+ "camera"
+ ]
},
{
"name" : "cls",
"type" : "String",
"desc" : "css class",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "container_method",
"type" : "string",
"desc" : "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "dataId",
"type" : "string",
"desc" : "cutomer id",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "decimalPrecision",
"type" : "Number",
"desc" : "The maximum precision to display after the decimal separator (defaults to 2)",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "decimalSeparator",
"type" : "String",
"desc" : "Character(s) to allow as the decimal separator (defaults to '.')",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "disableClass",
"type" : "String",
"desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").",
- "memberOf" : "Roo.Component"
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "disableKeyFilter",
"type" : "Boolean",
"desc" : "True to disable input keystroke filtering (defaults to false)",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "disabled",
"type" : "Boolean",
"desc" : "is it disabled",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "fieldLabel",
"type" : "string",
"desc" : "- the label associated",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "focusClass",
"type" : "String",
"desc" : "The CSS class to use when the field receives focus (defaults to \"x-form-focus\")",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "forceFeedback",
"type" : "Boolean",
- "desc" : "e) Default false",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "desc" : "e) Default fal",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : [
+ "true",
+ "false"
+ ]
},
{
"name" : "hasFeedback",
"type" : "Boolean",
- "desc" : "e) default true",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "desc" : "e) default tr",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : [
+ "true",
+ "false"
+ ]
},
{
"name" : "hideMode",
"type" : "String",
- "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".",
- "memberOf" : "Roo.Component"
+ "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display",
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : [
+ "display",
+ "visibility"
+ ]
},
{
"name" : "indicatorpos",
"type" : "String",
- "desc" : "t) default left",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "desc" : "t) default le",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : [
+ "left",
+ "right"
+ ]
},
{
"name" : "inputType",
"type" : "String",
- "desc" : "t)",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "desc" : "",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : [
+ "button",
+ "checkbox",
+ "email",
+ "file",
+ "hidden",
+ "image",
+ "number",
+ "password",
+ "radio",
+ "range",
+ "reset",
+ "search",
+ "submit",
+ "text"
+ ]
},
{
"name" : "invalidClass",
"type" : "String",
"desc" : "DEPRICATED - code uses BS4 - is-valid / is-invalid",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "invalidFeedbackIcon",
"type" : "String",
"desc" : "The CSS class to use when create feedback icon (defaults to \"x-form-invalid\")",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "invalidText",
"type" : "String",
"desc" : "The error text to display if {@link #validator} test fails during validation (defaults to \"\")",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "labelAlign",
"type" : "String",
- "desc" : "t)",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "desc" : "",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : [
+ "top",
+ "left"
+ ]
},
{
"name" : "labelWidth",
"type" : "Number",
"desc" : "set the width of label",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "labellg",
"type" : "Number",
"desc" : "set the width of label (1-12)",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "labelmd",
"type" : "Number",
"desc" : "set the width of label (1-12)",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "labelsm",
"type" : "Number",
"desc" : "set the width of label (1-12)",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "labelxs",
"type" : "Number",
"desc" : "set the width of label (1-12)",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "lg",
"type" : "Number",
"desc" : "colspan out of 12 for large computer-sized screens",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"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"
+ "memberOf" : "Roo.util.Observable",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "maskRe",
"type" : "String",
"desc" : "An input mask regular expression that will be used to filter keystrokes that don't match (defaults to null)",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "maxLength",
"type" : "Number",
"desc" : "Maximum input field length allowed (defaults to Number.MAX_VALUE)",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "maxLengthText",
"type" : "String",
"desc" : "Error text to display if the maximum length validation fails (defaults to \"The maximum length for this field is {maxLength}\")",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"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" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "maxValue",
"type" : "Number",
"desc" : "The maximum allowed value (defaults to Number.MAX_VALUE)",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "md",
"type" : "Number",
"desc" : "colspan out of 12 for computer-sized screens",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "minLength",
"type" : "Number",
"desc" : "Minimum input field length required (defaults to 0)",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "minLengthText",
"type" : "String",
"desc" : "Error text to display if the minimum length validation fails (defaults to \"The minimum length for this field is {minLength}\")",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"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" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "minValue",
"type" : "Number",
"desc" : "The minimum allowed value (defaults to Number.NEGATIVE_INFINITY)",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "name",
"type" : "String",
"desc" : "name of the input",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"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" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "placeholder",
"type" : "string",
"desc" : "- placeholder to put in text.",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "preventMark",
"type" : "Boolean",
"desc" : "Do not show tick or cross if error/success",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "readOnly",
"type" : "Boolean",
"desc" : "Specifies that the field should be read-only",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "regex",
"type" : "RegExp",
"desc" : "A JavaScript RegExp object to be tested against the field value during validation (defaults to null).\nIf available, this regex will be evaluated only after the basic validators all return true, and will be passed the\ncurrent field value. If the test fails, the field will be marked invalid using {@link #regexText}.",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "regexText",
"type" : "String",
"desc" : "-- Depricated - use Invalid Text",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "selectOnFocus",
"type" : "Boolean",
"desc" : "True to automatically select any existing field text when the field receives input focus (defaults to false)",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "size",
"type" : "string",
"desc" : "- (lg|sm) or leave empty..",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "sm",
"type" : "Number",
"desc" : "colspan out of 12 for tablet-sized screens",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "style",
"type" : "String",
"desc" : "any extra css",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "thousandsDelimiter",
"type" : "String",
"desc" : "Symbol of thousandsDelimiter",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "tooltip",
"type" : "string",
"desc" : "Text for the tooltip",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "validClass",
"type" : "String",
"desc" : "DEPRICATED - code uses BS4 - is-valid / is-invalid",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "validFeedbackIcon",
"type" : "String",
"desc" : "The CSS class to use when create feedback icon (defaults to \"x-form-invalid\")",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "validateOnBlur",
"type" : "Boolean",
"desc" : "Whether the field should validate when it loses focus (defaults to true).",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "validationDelay",
"type" : "Number",
"desc" : "The length of time in milliseconds after user input begins until validation is initiated (defaults to 250)",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "validationEvent",
"type" : "String/Boolean",
"desc" : "The event that should initiate field validation. Set to false to disable\n automatic validation (defaults to \"keyup\").",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "validator",
"type" : "Function",
"desc" : "A custom validation function to be called during field validation (defaults to null).\nIf available, this function will be called only after the basic validators all return true, and will be passed the\ncurrent field value and expected to return boolean true if the value is valid or a string error message if invalid.",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "value",
"type" : "string",
"desc" : "default value of the input",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "valueAlign",
"type" : "String",
"desc" : "alignment of value",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "visibilityEl",
"type" : "string|object",
- "desc" : "t) What element to use for visibility (@see getVisibilityEl())",
- "memberOf" : "Roo.bootstrap.Component"
+ "desc" : "t) What element to use for visibility (@see getVisibilityEl(",
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : [
+ "el",
+ "parent"
+ ]
},
{
"name" : "vtype",
"type" : "String",
"desc" : "A validation type name as defined in {@link Roo.form.VTypes} (defaults to null)",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "xattr",
"type" : "Object",
"desc" : "extra attributes to add to 'element' (used by builder to store stuff.)",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "xs",
"type" : "Number",
"desc" : "colspan out of 12 for mobile-sized screens",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
}
],
"events" : [
],
"isAbstract" : false,
"isBuilderTop" : false,
- "childClasses" : { },
+ "implementations" : [],
"tree_children" : [],
"tree_parent" : []
},
{
"name" : "accept",
"type" : "String",
- "desc" : "o) use for file input only. (default empty)",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "desc" : "o) use for file input only. (default empt",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : [
+ "image",
+ "video",
+ "audio"
+ ]
},
{
"name" : "actionMode",
"type" : "String",
"desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el' for forms you probably want to set this to fieldEl",
- "memberOf" : "Roo.Component"
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "after",
"type" : "string",
"desc" : "- input group add on after",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "afterButton",
"type" : "Roo.bootstrap.Button",
"desc" : "to show before",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "align",
"type" : "String",
- "desc" : "t) Default left",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "desc" : "t) Default le",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : [
+ "left",
+ "center",
+ "right"
+ ]
},
{
"name" : "allowBlank",
"type" : "Boolean",
"desc" : "False to validate that the value length > 0 (defaults to true)",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "allowDomMove",
"type" : "Boolean",
"desc" : "Whether the component can move the Dom node when rendering (defaults to true).",
- "memberOf" : "Roo.Component"
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "autocomplete",
"type" : "String",
"desc" : "- default is new-password see: https://developers.google.com/web/fundamentals/input/form/label-and-name-inputs?hl=en",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "before",
"type" : "string",
"desc" : "- input group add on before",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "blankText",
"type" : "String",
"desc" : "Error text to display if the allow blank validation fails (defaults to \"This field is required\")",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "can_build_overlaid",
"type" : "Boolean",
"desc" : "True if element can be rebuild from a HTML page",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "capture",
"type" : "String",
- "desc" : "a) use for file input only. (default empty)",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "desc" : "a) use for file input only. (default empt",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : [
+ "user",
+ "camera"
+ ]
},
{
"name" : "caret",
"type" : "String",
- "desc" : "r) BS3 only - carat fa name",
- "memberOf" : "Roo.bootstrap.form.TriggerField"
+ "desc" : "r) BS3 only - carat fa na",
+ "memberOf" : "Roo.bootstrap.form.TriggerField",
+ "isOptional" : false,
+ "optvals" : [
+ "search",
+ "calendar"
+ ]
},
{
"name" : "cls",
"type" : "String",
"desc" : "css class",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "container_method",
"type" : "string",
"desc" : "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "dataId",
"type" : "string",
"desc" : "cutomer id",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "defaultDialCode",
"type" : "String",
"desc" : "default '+852'",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "disableClass",
"type" : "String",
"desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").",
- "memberOf" : "Roo.Component"
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "disableKeyFilter",
"type" : "Boolean",
"desc" : "True to disable input keystroke filtering (defaults to false)",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "disabled",
"type" : "Boolean",
"desc" : "is it disabled",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "fieldLabel",
"type" : "string",
"desc" : "- the label associated",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "focusClass",
"type" : "String",
"desc" : "The CSS class to use when the field receives focus (defaults to \"x-form-focus\")",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "forceFeedback",
"type" : "Boolean",
- "desc" : "e) Default false",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "desc" : "e) Default fal",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : [
+ "true",
+ "false"
+ ]
},
{
"name" : "hasFeedback",
"type" : "Boolean",
- "desc" : "e) default true",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "desc" : "e) default tr",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : [
+ "true",
+ "false"
+ ]
},
{
"name" : "hideMode",
"type" : "String",
- "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".",
- "memberOf" : "Roo.Component"
+ "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display",
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : [
+ "display",
+ "visibility"
+ ]
},
{
"name" : "hideTrigger",
"type" : "Boolean",
"desc" : "True to hide the trigger element and display only the base text field (defaults to false)",
- "memberOf" : "Roo.bootstrap.form.TriggerField"
+ "memberOf" : "Roo.bootstrap.form.TriggerField",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "indicatorpos",
"type" : "String",
- "desc" : "t) default left",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "desc" : "t) default le",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : [
+ "left",
+ "right"
+ ]
},
{
"name" : "inputType",
"type" : "String",
- "desc" : "t)",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "desc" : "",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : [
+ "button",
+ "checkbox",
+ "email",
+ "file",
+ "hidden",
+ "image",
+ "number",
+ "password",
+ "radio",
+ "range",
+ "reset",
+ "search",
+ "submit",
+ "text"
+ ]
},
{
"name" : "invalidClass",
"type" : "String",
"desc" : "DEPRICATED - code uses BS4 - is-valid / is-invalid",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "invalidFeedbackIcon",
"type" : "String",
"desc" : "The CSS class to use when create feedback icon (defaults to \"x-form-invalid\")",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "invalidText",
"type" : "String",
"desc" : "The error text to display if {@link #validator} test fails during validation (defaults to \"\")",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "labelAlign",
"type" : "String",
- "desc" : "t)",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "desc" : "",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : [
+ "top",
+ "left"
+ ]
},
{
"name" : "labelWidth",
"type" : "Number",
"desc" : "set the width of label",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "labellg",
"type" : "Number",
"desc" : "set the width of label (1-12)",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "labelmd",
"type" : "Number",
"desc" : "set the width of label (1-12)",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "labelsm",
"type" : "Number",
"desc" : "set the width of label (1-12)",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "labelxs",
"type" : "Number",
"desc" : "set the width of label (1-12)",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "lg",
"type" : "Number",
"desc" : "colspan out of 12 for large computer-sized screens",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"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"
+ "memberOf" : "Roo.util.Observable",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "maskRe",
"type" : "String",
"desc" : "An input mask regular expression that will be used to filter keystrokes that don't match (defaults to null)",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "maxLength",
"type" : "Number",
"desc" : "Maximum input field length allowed (defaults to Number.MAX_VALUE)",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "maxLengthText",
"type" : "String",
"desc" : "Error text to display if the maximum length validation fails (defaults to \"The maximum length for this field is {maxLength}\")",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "md",
"type" : "Number",
"desc" : "colspan out of 12 for computer-sized screens",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "minLength",
"type" : "Number",
"desc" : "Minimum input field length required (defaults to 0)",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "minLengthText",
"type" : "String",
"desc" : "Error text to display if the minimum length validation fails (defaults to \"The minimum length for this field is {minLength}\")",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "name",
"type" : "String",
"desc" : "name of the input",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "placeholder",
"type" : "string",
"desc" : "- placeholder to put in text.",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "preferedCountries",
"type" : "Array",
"desc" : "default []",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "preventMark",
"type" : "Boolean",
"desc" : "Do not show tick or cross if error/success",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "readOnly",
"type" : "Boolean",
"desc" : "Specifies that the field should be read-only",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "regex",
"type" : "RegExp",
"desc" : "A JavaScript RegExp object to be tested against the field value during validation (defaults to null).\nIf available, this regex will be evaluated only after the basic validators all return true, and will be passed the\ncurrent field value. If the test fails, the field will be marked invalid using {@link #regexText}.",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "regexText",
"type" : "String",
"desc" : "-- Depricated - use Invalid Text",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "removable",
"type" : "Boolean",
- "desc" : "e) special filter default false",
- "memberOf" : "Roo.bootstrap.form.TriggerField"
+ "desc" : "e) special filter default fal",
+ "memberOf" : "Roo.bootstrap.form.TriggerField",
+ "isOptional" : false,
+ "optvals" : [
+ "true",
+ "false"
+ ]
},
{
"name" : "selectOnFocus",
"type" : "Boolean",
"desc" : "True to automatically select any existing field text when the field receives input focus (defaults to false)",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "size",
"type" : "string",
"desc" : "- (lg|sm) or leave empty..",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "sm",
"type" : "Number",
"desc" : "colspan out of 12 for tablet-sized screens",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "store",
"type" : "Roo.data.Store",
- "desc" : "[required] The data store to which this combo is bound (defaults to undefined)",
- "memberOf" : ""
+ "desc" : "The data store to which this combo is bound (defaults to undefined)",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "style",
"type" : "String",
"desc" : "any extra css",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "tooltip",
"type" : "string",
"desc" : "Text for the tooltip",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"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" : "Roo.bootstrap.form.TriggerField"
+ "memberOf" : "Roo.bootstrap.form.TriggerField",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "validClass",
"type" : "String",
"desc" : "DEPRICATED - code uses BS4 - is-valid / is-invalid",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "validFeedbackIcon",
"type" : "String",
"desc" : "The CSS class to use when create feedback icon (defaults to \"x-form-invalid\")",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "validateOnBlur",
"type" : "Boolean",
"desc" : "Whether the field should validate when it loses focus (defaults to true).",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "validationDelay",
"type" : "Number",
"desc" : "The length of time in milliseconds after user input begins until validation is initiated (defaults to 250)",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "validationEvent",
"type" : "String/Boolean",
"desc" : "The event that should initiate field validation. Set to false to disable\n automatic validation (defaults to \"keyup\").",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "validator",
"type" : "Function",
"desc" : "A custom validation function to be called during field validation (defaults to null).\nIf available, this function will be called only after the basic validators all return true, and will be passed the\ncurrent field value and expected to return boolean true if the value is valid or a string error message if invalid.",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "value",
"type" : "string",
"desc" : "default value of the input",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "visibilityEl",
"type" : "string|object",
- "desc" : "t) What element to use for visibility (@see getVisibilityEl())",
- "memberOf" : "Roo.bootstrap.Component"
+ "desc" : "t) What element to use for visibility (@see getVisibilityEl(",
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : [
+ "el",
+ "parent"
+ ]
},
{
"name" : "vtype",
"type" : "String",
"desc" : "A validation type name as defined in {@link Roo.form.VTypes} (defaults to null)",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "xattr",
"type" : "Object",
"desc" : "extra attributes to add to 'element' (used by builder to store stuff.)",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "xs",
"type" : "Number",
"desc" : "colspan out of 12 for mobile-sized screens",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
}
],
"events" : [
],
"isAbstract" : false,
"isBuilderTop" : false,
- "childClasses" : { },
+ "implementations" : [],
"tree_children" : [],
"tree_parent" : []
},
"name" : "actionMode",
"type" : "String",
"desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el' for forms you probably want to set this to fieldEl",
- "memberOf" : "Roo.Component"
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "allowDomMove",
"type" : "Boolean",
"desc" : "Whether the component can move the Dom node when rendering (defaults to true).",
- "memberOf" : "Roo.Component"
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "boxLabel",
"type" : "String",
"desc" : "- the label associated",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "can_build_overlaid",
"type" : "Boolean",
"desc" : "True if element can be rebuild from a HTML page",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "cls",
"type" : "String",
"desc" : "css class",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "container_method",
"type" : "string",
"desc" : "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "dataId",
"type" : "string",
"desc" : "cutomer id",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "disableClass",
"type" : "String",
"desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").",
- "memberOf" : "Roo.Component"
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "hideMode",
"type" : "String",
- "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".",
- "memberOf" : "Roo.Component"
+ "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display",
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : [
+ "display",
+ "visibility"
+ ]
},
{
"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"
+ "memberOf" : "Roo.util.Observable",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "name",
"type" : "string",
"desc" : "Specifies name attribute",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "style",
"type" : "String",
"desc" : "any extra css",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "tooltip",
"type" : "string",
"desc" : "Text for the tooltip",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "value",
"type" : "String",
"desc" : "- the value of radio",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "visibilityEl",
"type" : "string|object",
- "desc" : "t) What element to use for visibility (@see getVisibilityEl())",
- "memberOf" : "Roo.bootstrap.Component"
+ "desc" : "t) What element to use for visibility (@see getVisibilityEl(",
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : [
+ "el",
+ "parent"
+ ]
},
{
"name" : "xattr",
"type" : "Object",
"desc" : "extra attributes to add to 'element' (used by builder to store stuff.)",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
}
],
"events" : [
],
"isAbstract" : false,
"isBuilderTop" : false,
- "childClasses" : { },
+ "implementations" : [],
"tree_children" : [],
"tree_parent" : []
},
{
"name" : "accept",
"type" : "String",
- "desc" : "o) use for file input only. (default empty)",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "desc" : "o) use for file input only. (default empt",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : [
+ "image",
+ "video",
+ "audio"
+ ]
},
{
"name" : "actionMode",
"type" : "String",
"desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el' for forms you probably want to set this to fieldEl",
- "memberOf" : "Roo.Component"
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "after",
"type" : "string",
"desc" : "- input group add on after",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "afterButton",
"type" : "Roo.bootstrap.Button",
"desc" : "to show before",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "align",
"type" : "String",
- "desc" : "t) Default left",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "desc" : "t) Default le",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : [
+ "left",
+ "center",
+ "right"
+ ]
},
{
"name" : "allowBlank",
"type" : "Boolean",
"desc" : "False to validate that the value length > 0 (defaults to true)",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "allowDomMove",
"type" : "Boolean",
"desc" : "Whether the component can move the Dom node when rendering (defaults to true).",
- "memberOf" : "Roo.Component"
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "autocomplete",
"type" : "String",
"desc" : "- default is new-password see: https://developers.google.com/web/fundamentals/input/form/label-and-name-inputs?hl=en",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "before",
"type" : "string",
"desc" : "- input group add on before",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "blankText",
"type" : "String",
"desc" : "Error text to display if the allow blank validation fails (defaults to \"This field is required\")",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "can_build_overlaid",
"type" : "Boolean",
"desc" : "True if element can be rebuild from a HTML page",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "capture",
"type" : "String",
- "desc" : "a) use for file input only. (default empty)",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "desc" : "a) use for file input only. (default empt",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : [
+ "user",
+ "camera"
+ ]
},
{
"name" : "cls",
"type" : "String",
"desc" : "css class",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "container_method",
"type" : "string",
"desc" : "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "dataId",
"type" : "string",
"desc" : "cutomer id",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "disableClass",
"type" : "String",
"desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").",
- "memberOf" : "Roo.Component"
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "disableKeyFilter",
"type" : "Boolean",
"desc" : "True to disable input keystroke filtering (defaults to false)",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "disabled",
"type" : "Boolean",
"desc" : "is it disabled",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "fieldLabel",
"type" : "string",
"desc" : "- the label associated",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "focusClass",
"type" : "String",
"desc" : "The CSS class to use when the field receives focus (defaults to \"x-form-focus\")",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "forceFeedback",
"type" : "Boolean",
- "desc" : "e) Default false",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "desc" : "e) Default fal",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : [
+ "true",
+ "false"
+ ]
},
{
"name" : "hasFeedback",
"type" : "Boolean",
- "desc" : "e) default true",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "desc" : "e) default tr",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : [
+ "true",
+ "false"
+ ]
},
{
"name" : "hideMode",
"type" : "String",
- "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".",
- "memberOf" : "Roo.Component"
+ "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display",
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : [
+ "display",
+ "visibility"
+ ]
},
{
"name" : "indicatorpos",
"type" : "String",
- "desc" : "t) default left",
- "memberOf" : ""
+ "desc" : "t) default le",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : [
+ "left",
+ "right"
+ ]
},
{
"name" : "inline",
"type" : "Boolean",
- "desc" : "e) inline the element (default true)",
- "memberOf" : ""
+ "desc" : "e) inline the element (default tru",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : [
+ "true",
+ "false"
+ ]
},
{
"name" : "inputType",
"type" : "String",
- "desc" : "t)",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "desc" : "",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : [
+ "button",
+ "checkbox",
+ "email",
+ "file",
+ "hidden",
+ "image",
+ "number",
+ "password",
+ "radio",
+ "range",
+ "reset",
+ "search",
+ "submit",
+ "text"
+ ]
},
{
"name" : "invalidClass",
"type" : "String",
"desc" : "DEPRICATED - code uses BS4 - is-valid / is-invalid",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "invalidFeedbackIcon",
"type" : "String",
"desc" : "The CSS class to use when create feedback icon (defaults to \"x-form-invalid\")",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "invalidText",
"type" : "String",
"desc" : "The error text to display if {@link #validator} test fails during validation (defaults to \"\")",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "labelAlign",
"type" : "String",
- "desc" : "t)",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "desc" : "",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : [
+ "top",
+ "left"
+ ]
},
{
"name" : "labelWidth",
"type" : "Number",
"desc" : "set the width of label",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "labellg",
"type" : "Number",
"desc" : "set the width of label (1-12)",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "labelmd",
"type" : "Number",
"desc" : "set the width of label (1-12)",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "labelsm",
"type" : "Number",
"desc" : "set the width of label (1-12)",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "labelxs",
"type" : "Number",
"desc" : "set the width of label (1-12)",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "lg",
"type" : "Number",
"desc" : "colspan out of 12 for large computer-sized screens",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"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"
+ "memberOf" : "Roo.util.Observable",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "maskRe",
"type" : "String",
"desc" : "An input mask regular expression that will be used to filter keystrokes that don't match (defaults to null)",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "maxLength",
"type" : "Number",
"desc" : "Maximum input field length allowed (defaults to Number.MAX_VALUE)",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "maxLengthText",
"type" : "String",
"desc" : "Error text to display if the maximum length validation fails (defaults to \"The maximum length for this field is {maxLength}\")",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "md",
"type" : "Number",
"desc" : "colspan out of 12 for computer-sized screens",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "minLength",
"type" : "Number",
"desc" : "Minimum input field length required (defaults to 0)",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "minLengthText",
"type" : "String",
"desc" : "Error text to display if the minimum length validation fails (defaults to \"The minimum length for this field is {minLength}\")",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "name",
"type" : "String",
"desc" : "name of the input",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "placeholder",
"type" : "string",
"desc" : "- placeholder to put in text.",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "preventMark",
"type" : "Boolean",
"desc" : "Do not show tick or cross if error/success",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "readOnly",
"type" : "Boolean",
"desc" : "Specifies that the field should be read-only",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "regex",
"type" : "RegExp",
"desc" : "A JavaScript RegExp object to be tested against the field value during validation (defaults to null).\nIf available, this regex will be evaluated only after the basic validators all return true, and will be passed the\ncurrent field value. If the test fails, the field will be marked invalid using {@link #regexText}.",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "regexText",
"type" : "String",
"desc" : "-- Depricated - use Invalid Text",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "selectOnFocus",
"type" : "Boolean",
"desc" : "True to automatically select any existing field text when the field receives input focus (defaults to false)",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "size",
"type" : "string",
"desc" : "- (lg|sm) or leave empty..",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "sm",
"type" : "Number",
"desc" : "colspan out of 12 for tablet-sized screens",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "style",
"type" : "String",
"desc" : "any extra css",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "tooltip",
"type" : "string",
"desc" : "Text for the tooltip",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "validClass",
"type" : "String",
"desc" : "DEPRICATED - code uses BS4 - is-valid / is-invalid",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "validFeedbackIcon",
"type" : "String",
"desc" : "The CSS class to use when create feedback icon (defaults to \"x-form-invalid\")",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "validateOnBlur",
"type" : "Boolean",
"desc" : "Whether the field should validate when it loses focus (defaults to true).",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "validationDelay",
"type" : "Number",
"desc" : "The length of time in milliseconds after user input begins until validation is initiated (defaults to 250)",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "validationEvent",
"type" : "String/Boolean",
"desc" : "The event that should initiate field validation. Set to false to disable\n automatic validation (defaults to \"keyup\").",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "validator",
"type" : "Function",
"desc" : "A custom validation function to be called during field validation (defaults to null).\nIf available, this function will be called only after the basic validators all return true, and will be passed the\ncurrent field value and expected to return boolean true if the value is valid or a string error message if invalid.",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "value",
"type" : "string",
"desc" : "default value of the input",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "visibilityEl",
"type" : "string|object",
- "desc" : "t) What element to use for visibility (@see getVisibilityEl())",
- "memberOf" : "Roo.bootstrap.Component"
+ "desc" : "t) What element to use for visibility (@see getVisibilityEl(",
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : [
+ "el",
+ "parent"
+ ]
},
{
"name" : "vtype",
"type" : "String",
"desc" : "A validation type name as defined in {@link Roo.form.VTypes} (defaults to null)",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "weight",
"type" : "String",
- "desc" : "s) The text that appears beside the radio",
- "memberOf" : ""
+ "desc" : "s) The text that appears beside the rad",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : [
+ "primary",
+ "warning",
+ "info",
+ "danger",
+ "success"
+ ]
},
{
"name" : "xattr",
"type" : "Object",
"desc" : "extra attributes to add to 'element' (used by builder to store stuff.)",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "xs",
"type" : "Number",
"desc" : "colspan out of 12 for mobile-sized screens",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
}
],
"events" : [
],
"isAbstract" : false,
"isBuilderTop" : false,
- "childClasses" : { },
+ "implementations" : [],
"tree_children" : [
"Roo.bootstrap.form.Radio"
],
"name" : "Label",
"type" : "String/Object",
"desc" : "for the strength meter (defaults to\n'Password strength:')",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "accept",
"type" : "String",
- "desc" : "o) use for file input only. (default empty)",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "desc" : "o) use for file input only. (default empt",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : [
+ "image",
+ "video",
+ "audio"
+ ]
},
{
"name" : "actionMode",
"type" : "String",
"desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el' for forms you probably want to set this to fieldEl",
- "memberOf" : "Roo.Component"
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "after",
"type" : "string",
"desc" : "- input group add on after",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "afterButton",
"type" : "Roo.bootstrap.Button",
"desc" : "to show before",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "align",
"type" : "String",
- "desc" : "t) Default left",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "desc" : "t) Default le",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : [
+ "left",
+ "center",
+ "right"
+ ]
},
{
"name" : "allowBlank",
"type" : "Boolean",
"desc" : "False to validate that the value length > 0 (defaults to true)",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "allowDomMove",
"type" : "Boolean",
"desc" : "Whether the component can move the Dom node when rendering (defaults to true).",
- "memberOf" : "Roo.Component"
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "autocomplete",
"type" : "String",
"desc" : "- default is new-password see: https://developers.google.com/web/fundamentals/input/form/label-and-name-inputs?hl=en",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "before",
"type" : "string",
"desc" : "- input group add on before",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "blankText",
"type" : "String",
"desc" : "Error text to display if the allow blank validation fails (defaults to \"This field is required\")",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "can_build_overlaid",
"type" : "Boolean",
"desc" : "True if element can be rebuild from a HTML page",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "capture",
"type" : "String",
- "desc" : "a) use for file input only. (default empty)",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "desc" : "a) use for file input only. (default empt",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : [
+ "user",
+ "camera"
+ ]
},
{
"name" : "cls",
"type" : "String",
"desc" : "css class",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "container_method",
"type" : "string",
"desc" : "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "dataId",
"type" : "string",
"desc" : "cutomer id",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "disableClass",
"type" : "String",
"desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").",
- "memberOf" : "Roo.Component"
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "disableKeyFilter",
"type" : "Boolean",
"desc" : "True to disable input keystroke filtering (defaults to false)",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "disabled",
"type" : "Boolean",
"desc" : "is it disabled",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "errors",
"type" : "String/Object",
"desc" : "A Error spec, or true for a default spec (defaults to\n{\n PwdEmpty: \"Please type a password, and then retype it to confirm.\",\n PwdShort: \"Your password must be at least 6 characters long. Please type a different password.\",\n PwdLong: \"Your password can't contain more than 16 characters. Please type a different password.\",\n PwdBadChar: \"The password contains characters that aren't allowed. Please type a different password.\",\n IDInPwd: \"Your password can't include the part of your ID. Please type a different password.\",\n FNInPwd: \"Your password can't contain your first name. Please type a different password.\",\n LNInPwd: \"Your password can't contain your last name. Please type a different password.\"\n})",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "fieldLabel",
"type" : "string",
"desc" : "- the label associated",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "focusClass",
"type" : "String",
"desc" : "The CSS class to use when the field receives focus (defaults to \"x-form-focus\")",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "forceFeedback",
"type" : "Boolean",
- "desc" : "e) Default false",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "desc" : "e) Default fal",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : [
+ "true",
+ "false"
+ ]
},
{
"name" : "hasFeedback",
"type" : "Boolean",
- "desc" : "e) default true",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "desc" : "e) default tr",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : [
+ "true",
+ "false"
+ ]
},
{
"name" : "hideMode",
"type" : "String",
- "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".",
- "memberOf" : "Roo.Component"
+ "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display",
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : [
+ "display",
+ "visibility"
+ ]
},
{
"name" : "indicatorpos",
"type" : "String",
- "desc" : "t) default left",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "desc" : "t) default le",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : [
+ "left",
+ "right"
+ ]
},
{
"name" : "inputType",
"type" : "String",
- "desc" : "t)",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "desc" : "",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : [
+ "button",
+ "checkbox",
+ "email",
+ "file",
+ "hidden",
+ "image",
+ "number",
+ "password",
+ "radio",
+ "range",
+ "reset",
+ "search",
+ "submit",
+ "text"
+ ]
},
{
"name" : "invalidClass",
"type" : "String",
"desc" : "DEPRICATED - code uses BS4 - is-valid / is-invalid",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "invalidFeedbackIcon",
"type" : "String",
"desc" : "The CSS class to use when create feedback icon (defaults to \"x-form-invalid\")",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "invalidText",
"type" : "String",
"desc" : "The error text to display if {@link #validator} test fails during validation (defaults to \"\")",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "labelAlign",
"type" : "String",
- "desc" : "t)",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "desc" : "",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : [
+ "top",
+ "left"
+ ]
},
{
"name" : "labelWidth",
"type" : "Number",
"desc" : "set the width of label",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "labellg",
"type" : "Number",
"desc" : "set the width of label (1-12)",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "labelmd",
"type" : "Number",
"desc" : "set the width of label (1-12)",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "labelsm",
"type" : "Number",
"desc" : "set the width of label (1-12)",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "labelxs",
"type" : "Number",
"desc" : "set the width of label (1-12)",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "lg",
"type" : "Number",
"desc" : "colspan out of 12 for large computer-sized screens",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"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"
+ "memberOf" : "Roo.util.Observable",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "maskRe",
"type" : "String",
"desc" : "An input mask regular expression that will be used to filter keystrokes that don't match (defaults to null)",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "maxLength",
"type" : "Number",
"desc" : "Maximum input field length allowed (defaults to Number.MAX_VALUE)",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "maxLengthText",
"type" : "String",
"desc" : "Error text to display if the maximum length validation fails (defaults to \"The maximum length for this field is {maxLength}\")",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "md",
"type" : "Number",
"desc" : "colspan out of 12 for computer-sized screens",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "minLength",
"type" : "Number",
"desc" : "Minimum input field length required (defaults to 0)",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "minLengthText",
"type" : "String",
"desc" : "Error text to display if the minimum length validation fails (defaults to \"The minimum length for this field is {minLength}\")",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "name",
"type" : "String",
"desc" : "name of the input",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "placeholder",
"type" : "string",
"desc" : "- placeholder to put in text.",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "preventMark",
"type" : "Boolean",
"desc" : "Do not show tick or cross if error/success",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "pwdStrengths",
"type" : "String/Object",
"desc" : "A pwdStrengths spec, or true for a default spec (defaults to\n['Weak', 'Medium', 'Strong'])",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "readOnly",
"type" : "Boolean",
"desc" : "Specifies that the field should be read-only",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "regex",
"type" : "RegExp",
"desc" : "A JavaScript RegExp object to be tested against the field value during validation (defaults to null).\nIf available, this regex will be evaluated only after the basic validators all return true, and will be passed the\ncurrent field value. If the test fails, the field will be marked invalid using {@link #regexText}.",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "regexText",
"type" : "String",
"desc" : "-- Depricated - use Invalid Text",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "selectOnFocus",
"type" : "Boolean",
"desc" : "True to automatically select any existing field text when the field receives input focus (defaults to false)",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "size",
"type" : "string",
"desc" : "- (lg|sm) or leave empty..",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "sm",
"type" : "Number",
"desc" : "colspan out of 12 for tablet-sized screens",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "style",
"type" : "String",
"desc" : "any extra css",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "tooltip",
"type" : "string",
"desc" : "Text for the tooltip",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "validClass",
"type" : "String",
"desc" : "DEPRICATED - code uses BS4 - is-valid / is-invalid",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "validFeedbackIcon",
"type" : "String",
"desc" : "The CSS class to use when create feedback icon (defaults to \"x-form-invalid\")",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "validateOnBlur",
"type" : "Boolean",
"desc" : "Whether the field should validate when it loses focus (defaults to true).",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "validationDelay",
"type" : "Number",
"desc" : "The length of time in milliseconds after user input begins until validation is initiated (defaults to 250)",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "validationEvent",
"type" : "String/Boolean",
"desc" : "The event that should initiate field validation. Set to false to disable\n automatic validation (defaults to \"keyup\").",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "validator",
"type" : "Function",
"desc" : "A custom validation function to be called during field validation (defaults to null).\nIf available, this function will be called only after the basic validators all return true, and will be passed the\ncurrent field value and expected to return boolean true if the value is valid or a string error message if invalid.",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "value",
"type" : "string",
"desc" : "default value of the input",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "visibilityEl",
"type" : "string|object",
- "desc" : "t) What element to use for visibility (@see getVisibilityEl())",
- "memberOf" : "Roo.bootstrap.Component"
+ "desc" : "t) What element to use for visibility (@see getVisibilityEl(",
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : [
+ "el",
+ "parent"
+ ]
},
{
"name" : "vtype",
"type" : "String",
"desc" : "A validation type name as defined in {@link Roo.form.VTypes} (defaults to null)",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "xattr",
"type" : "Object",
"desc" : "extra attributes to add to 'element' (used by builder to store stuff.)",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "xs",
"type" : "Number",
"desc" : "colspan out of 12 for mobile-sized screens",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
}
],
"events" : [
],
"isAbstract" : false,
"isBuilderTop" : false,
- "childClasses" : { },
+ "implementations" : [],
"tree_children" : [],
"tree_parent" : []
},
{
"name" : "accept",
"type" : "String",
- "desc" : "o) use for file input only. (default empty)",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "desc" : "o) use for file input only. (default empt",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : [
+ "image",
+ "video",
+ "audio"
+ ]
},
{
"name" : "actionMode",
"type" : "String",
"desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el' for forms you probably want to set this to fieldEl",
- "memberOf" : "Roo.Component"
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "after",
"type" : "string",
"desc" : "- input group add on after",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "afterButton",
"type" : "Roo.bootstrap.Button",
"desc" : "to show before",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "align",
"type" : "String",
- "desc" : "t) Default left",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "desc" : "t) Default le",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : [
+ "left",
+ "center",
+ "right"
+ ]
},
{
"name" : "allowBlank",
"type" : "Boolean",
"desc" : "False to validate that the value length > 0 (defaults to true)",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "allowDomMove",
"type" : "Boolean",
"desc" : "Whether the component can move the Dom node when rendering (defaults to true).",
- "memberOf" : "Roo.Component"
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "autocomplete",
"type" : "String",
"desc" : "- default is new-password see: https://developers.google.com/web/fundamentals/input/form/label-and-name-inputs?hl=en",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "before",
"type" : "string",
"desc" : "- input group add on before",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "blankText",
"type" : "String",
"desc" : "Error text to display if the allow blank validation fails (defaults to \"This field is required\")",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "can_build_overlaid",
"type" : "Boolean",
"desc" : "True if element can be rebuild from a HTML page",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "capture",
"type" : "String",
- "desc" : "a) use for file input only. (default empty)",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "desc" : "a) use for file input only. (default empt",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : [
+ "user",
+ "camera"
+ ]
},
{
"name" : "cls",
"type" : "String",
"desc" : "css class",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "cols",
"type" : "Number",
"desc" : "Specifies the visible width of a text area",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "container_method",
"type" : "string",
"desc" : "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "dataId",
"type" : "string",
"desc" : "cutomer id",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "disableClass",
"type" : "String",
"desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").",
- "memberOf" : "Roo.Component"
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "disableKeyFilter",
"type" : "Boolean",
"desc" : "True to disable input keystroke filtering (defaults to false)",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "disabled",
"type" : "Boolean",
"desc" : "is it disabled",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "fieldLabel",
"type" : "string",
"desc" : "- the label associated",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "focusClass",
"type" : "String",
"desc" : "The CSS class to use when the field receives focus (defaults to \"x-form-focus\")",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "forceFeedback",
"type" : "Boolean",
- "desc" : "e) Default false",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "desc" : "e) Default fal",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : [
+ "true",
+ "false"
+ ]
},
{
"name" : "hasFeedback",
"type" : "Boolean",
- "desc" : "e) default true",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "desc" : "e) default tr",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : [
+ "true",
+ "false"
+ ]
},
{
"name" : "hideMode",
"type" : "String",
- "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".",
- "memberOf" : "Roo.Component"
+ "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display",
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : [
+ "display",
+ "visibility"
+ ]
},
{
"name" : "html",
"type" : "string",
"desc" : "text",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "indicatorpos",
"type" : "String",
- "desc" : "t) default left",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "desc" : "t) default le",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : [
+ "left",
+ "right"
+ ]
},
{
"name" : "inputType",
"type" : "String",
- "desc" : "t)",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "desc" : "",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : [
+ "button",
+ "checkbox",
+ "email",
+ "file",
+ "hidden",
+ "image",
+ "number",
+ "password",
+ "radio",
+ "range",
+ "reset",
+ "search",
+ "submit",
+ "text"
+ ]
},
{
"name" : "invalidClass",
"type" : "String",
"desc" : "DEPRICATED - code uses BS4 - is-valid / is-invalid",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "invalidFeedbackIcon",
"type" : "String",
"desc" : "The CSS class to use when create feedback icon (defaults to \"x-form-invalid\")",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "invalidText",
"type" : "String",
"desc" : "The error text to display if {@link #validator} test fails during validation (defaults to \"\")",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "labelAlign",
"type" : "String",
- "desc" : "t)",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "desc" : "",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : [
+ "top",
+ "left"
+ ]
},
{
"name" : "labelWidth",
"type" : "Number",
"desc" : "set the width of label",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "labellg",
"type" : "Number",
"desc" : "set the width of label (1-12)",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "labelmd",
"type" : "Number",
"desc" : "set the width of label (1-12)",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "labelsm",
"type" : "Number",
"desc" : "set the width of label (1-12)",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "labelxs",
"type" : "Number",
"desc" : "set the width of label (1-12)",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "lg",
"type" : "Number",
"desc" : "colspan out of 12 for large computer-sized screens",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"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"
+ "memberOf" : "Roo.util.Observable",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "maskRe",
"type" : "String",
"desc" : "An input mask regular expression that will be used to filter keystrokes that don't match (defaults to null)",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "maxLength",
"type" : "Number",
"desc" : "Maximum input field length allowed (defaults to Number.MAX_VALUE)",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "maxLengthText",
"type" : "String",
"desc" : "Error text to display if the maximum length validation fails (defaults to \"The maximum length for this field is {maxLength}\")",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "md",
"type" : "Number",
"desc" : "colspan out of 12 for computer-sized screens",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "minLength",
"type" : "Number",
"desc" : "Minimum input field length required (defaults to 0)",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "minLengthText",
"type" : "String",
"desc" : "Error text to display if the minimum length validation fails (defaults to \"The minimum length for this field is {minLength}\")",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "name",
"type" : "String",
"desc" : "name of the input",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "placeholder",
"type" : "string",
"desc" : "- placeholder to put in text.",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "preventMark",
"type" : "Boolean",
"desc" : "Do not show tick or cross if error/success",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "readOnly",
"type" : "Boolean",
"desc" : "Specifies that the field should be read-only",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "regex",
"type" : "RegExp",
"desc" : "A JavaScript RegExp object to be tested against the field value during validation (defaults to null).\nIf available, this regex will be evaluated only after the basic validators all return true, and will be passed the\ncurrent field value. If the test fails, the field will be marked invalid using {@link #regexText}.",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "regexText",
"type" : "String",
"desc" : "-- Depricated - use Invalid Text",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "resize",
"type" : "string",
- "desc" : "l)",
- "memberOf" : ""
+ "desc" : "",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : [
+ "none",
+ "both",
+ "horizontal",
+ "vertical",
+ "inherit",
+ "initial"
+ ]
},
{
"name" : "rows",
"type" : "Number",
"desc" : "Specifies the visible number of lines in a text area",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "selectOnFocus",
"type" : "Boolean",
"desc" : "True to automatically select any existing field text when the field receives input focus (defaults to false)",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "size",
"type" : "string",
"desc" : "- (lg|sm) or leave empty..",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "sm",
"type" : "Number",
"desc" : "colspan out of 12 for tablet-sized screens",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "style",
"type" : "String",
"desc" : "any extra css",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "tooltip",
"type" : "string",
"desc" : "Text for the tooltip",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "validClass",
"type" : "String",
"desc" : "DEPRICATED - code uses BS4 - is-valid / is-invalid",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "validFeedbackIcon",
"type" : "String",
"desc" : "The CSS class to use when create feedback icon (defaults to \"x-form-invalid\")",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "validateOnBlur",
"type" : "Boolean",
"desc" : "Whether the field should validate when it loses focus (defaults to true).",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "validationDelay",
"type" : "Number",
"desc" : "The length of time in milliseconds after user input begins until validation is initiated (defaults to 250)",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "validationEvent",
"type" : "String/Boolean",
"desc" : "The event that should initiate field validation. Set to false to disable\n automatic validation (defaults to \"keyup\").",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "validator",
"type" : "Function",
"desc" : "A custom validation function to be called during field validation (defaults to null).\nIf available, this function will be called only after the basic validators all return true, and will be passed the\ncurrent field value and expected to return boolean true if the value is valid or a string error message if invalid.",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "value",
"type" : "string",
"desc" : "default value of the input",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "visibilityEl",
"type" : "string|object",
- "desc" : "t) What element to use for visibility (@see getVisibilityEl())",
- "memberOf" : "Roo.bootstrap.Component"
+ "desc" : "t) What element to use for visibility (@see getVisibilityEl(",
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : [
+ "el",
+ "parent"
+ ]
},
{
"name" : "vtype",
"type" : "String",
"desc" : "A validation type name as defined in {@link Roo.form.VTypes} (defaults to null)",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "wrap",
"type" : "string",
- "desc" : "d)Specifies how the text in a text area is to be wrapped when submitted in a form",
- "memberOf" : ""
+ "desc" : "d)Specifies how the text in a text area is to be wrapped when submitted in a fo",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : [
+ "soft",
+ "hard"
+ ]
},
{
"name" : "xattr",
"type" : "Object",
"desc" : "extra attributes to add to 'element' (used by builder to store stuff.)",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "xs",
"type" : "Number",
"desc" : "colspan out of 12 for mobile-sized screens",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
}
],
"events" : [
],
"isAbstract" : false,
"isBuilderTop" : false,
- "childClasses" : {
- "Roo.bootstrap.form.TextArea" : [
- "Roo.bootstrap.form.HtmlEditor",
- "Roo.bootstrap.form.Markdown"
- ]
- },
+ "implementations" : [
+ "Roo.bootstrap.form.HtmlEditor",
+ "Roo.bootstrap.form.Markdown"
+ ],
"tree_children" : [],
"tree_parent" : []
},
{
"name" : "accept",
"type" : "String",
- "desc" : "o) use for file input only. (default empty)",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "desc" : "o) use for file input only. (default empt",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : [
+ "image",
+ "video",
+ "audio"
+ ]
},
{
"name" : "actionMode",
"type" : "String",
"desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el' for forms you probably want to set this to fieldEl",
- "memberOf" : "Roo.Component"
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "after",
"type" : "string",
"desc" : "- input group add on after",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "afterButton",
"type" : "Roo.bootstrap.Button",
"desc" : "to show before",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "align",
"type" : "String",
- "desc" : "t) Default left",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "desc" : "t) Default le",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : [
+ "left",
+ "center",
+ "right"
+ ]
},
{
"name" : "allowBlank",
"type" : "Boolean",
"desc" : "False to validate that the value length > 0 (defaults to true)",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "allowDomMove",
"type" : "Boolean",
"desc" : "Whether the component can move the Dom node when rendering (defaults to true).",
- "memberOf" : "Roo.Component"
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "autocomplete",
"type" : "String",
"desc" : "- default is new-password see: https://developers.google.com/web/fundamentals/input/form/label-and-name-inputs?hl=en",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "before",
"type" : "string",
"desc" : "- input group add on before",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "blankText",
"type" : "String",
"desc" : "Error text to display if the allow blank validation fails (defaults to \"This field is required\")",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "can_build_overlaid",
"type" : "Boolean",
"desc" : "True if element can be rebuild from a HTML page",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "capture",
"type" : "String",
- "desc" : "a) use for file input only. (default empty)",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "desc" : "a) use for file input only. (default empt",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : [
+ "user",
+ "camera"
+ ]
},
{
"name" : "cls",
"type" : "String",
"desc" : "css class",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "container_method",
"type" : "string",
"desc" : "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "dataId",
"type" : "string",
"desc" : "cutomer id",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "disableClass",
"type" : "String",
"desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").",
- "memberOf" : "Roo.Component"
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "disableKeyFilter",
"type" : "Boolean",
"desc" : "True to disable input keystroke filtering (defaults to false)",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "disabled",
"type" : "Boolean",
"desc" : "is it disabled",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "fieldLabel",
"type" : "string",
"desc" : "- the label associated",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "focusClass",
"type" : "String",
"desc" : "The CSS class to use when the field receives focus (defaults to \"x-form-focus\")",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "forceFeedback",
"type" : "Boolean",
- "desc" : "e) Default false",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "desc" : "e) Default fal",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : [
+ "true",
+ "false"
+ ]
},
{
"name" : "format",
"type" : "String",
"desc" : "The default time format string which can be overriden for localization support. The format must be\nvalid according to {@link Date#parseDate} (defaults to 'H:i').",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "hasFeedback",
"type" : "Boolean",
- "desc" : "e) default true",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "desc" : "e) default tr",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : [
+ "true",
+ "false"
+ ]
},
{
"name" : "hideMode",
"type" : "String",
- "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".",
- "memberOf" : "Roo.Component"
+ "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display",
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : [
+ "display",
+ "visibility"
+ ]
},
{
"name" : "indicatorpos",
"type" : "String",
- "desc" : "t) default left",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "desc" : "t) default le",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : [
+ "left",
+ "right"
+ ]
},
{
"name" : "inputType",
"type" : "String",
- "desc" : "t)",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "desc" : "",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : [
+ "button",
+ "checkbox",
+ "email",
+ "file",
+ "hidden",
+ "image",
+ "number",
+ "password",
+ "radio",
+ "range",
+ "reset",
+ "search",
+ "submit",
+ "text"
+ ]
},
{
"name" : "invalidClass",
"type" : "String",
"desc" : "DEPRICATED - code uses BS4 - is-valid / is-invalid",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "invalidFeedbackIcon",
"type" : "String",
"desc" : "The CSS class to use when create feedback icon (defaults to \"x-form-invalid\")",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "invalidText",
"type" : "String",
"desc" : "The error text to display if {@link #validator} test fails during validation (defaults to \"\")",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "labelAlign",
"type" : "String",
- "desc" : "t)",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "desc" : "",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : [
+ "top",
+ "left"
+ ]
},
{
"name" : "labelWidth",
"type" : "Number",
"desc" : "set the width of label",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "labellg",
"type" : "Number",
"desc" : "set the width of label (1-12)",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "labelmd",
"type" : "Number",
"desc" : "set the width of label (1-12)",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "labelsm",
"type" : "Number",
"desc" : "set the width of label (1-12)",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "labelxs",
"type" : "Number",
"desc" : "set the width of label (1-12)",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "lg",
"type" : "Number",
"desc" : "colspan out of 12 for large computer-sized screens",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"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"
+ "memberOf" : "Roo.util.Observable",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "maskRe",
"type" : "String",
"desc" : "An input mask regular expression that will be used to filter keystrokes that don't match (defaults to null)",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "maxLength",
"type" : "Number",
"desc" : "Maximum input field length allowed (defaults to Number.MAX_VALUE)",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "maxLengthText",
"type" : "String",
"desc" : "Error text to display if the maximum length validation fails (defaults to \"The maximum length for this field is {maxLength}\")",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "md",
"type" : "Number",
"desc" : "colspan out of 12 for computer-sized screens",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "minLength",
"type" : "Number",
"desc" : "Minimum input field length required (defaults to 0)",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "minLengthText",
"type" : "String",
"desc" : "Error text to display if the minimum length validation fails (defaults to \"The minimum length for this field is {minLength}\")",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "name",
"type" : "String",
"desc" : "name of the input",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "placeholder",
"type" : "string",
"desc" : "- placeholder to put in text.",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "preventMark",
"type" : "Boolean",
"desc" : "Do not show tick or cross if error/success",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "readOnly",
"type" : "Boolean",
"desc" : "Specifies that the field should be read-only",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "regex",
"type" : "RegExp",
"desc" : "A JavaScript RegExp object to be tested against the field value during validation (defaults to null).\nIf available, this regex will be evaluated only after the basic validators all return true, and will be passed the\ncurrent field value. If the test fails, the field will be marked invalid using {@link #regexText}.",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "regexText",
"type" : "String",
"desc" : "-- Depricated - use Invalid Text",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "selectOnFocus",
"type" : "Boolean",
"desc" : "True to automatically select any existing field text when the field receives input focus (defaults to false)",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "size",
"type" : "string",
"desc" : "- (lg|sm) or leave empty..",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "sm",
"type" : "Number",
"desc" : "colspan out of 12 for tablet-sized screens",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "style",
"type" : "String",
"desc" : "any extra css",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "tooltip",
"type" : "string",
"desc" : "Text for the tooltip",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "validClass",
"type" : "String",
"desc" : "DEPRICATED - code uses BS4 - is-valid / is-invalid",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "validFeedbackIcon",
"type" : "String",
"desc" : "The CSS class to use when create feedback icon (defaults to \"x-form-invalid\")",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "validateOnBlur",
"type" : "Boolean",
"desc" : "Whether the field should validate when it loses focus (defaults to true).",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "validationDelay",
"type" : "Number",
"desc" : "The length of time in milliseconds after user input begins until validation is initiated (defaults to 250)",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "validationEvent",
"type" : "String/Boolean",
"desc" : "The event that should initiate field validation. Set to false to disable\n automatic validation (defaults to \"keyup\").",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "validator",
"type" : "Function",
"desc" : "A custom validation function to be called during field validation (defaults to null).\nIf available, this function will be called only after the basic validators all return true, and will be passed the\ncurrent field value and expected to return boolean true if the value is valid or a string error message if invalid.",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "value",
"type" : "string",
"desc" : "default value of the input",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "visibilityEl",
"type" : "string|object",
- "desc" : "t) What element to use for visibility (@see getVisibilityEl())",
- "memberOf" : "Roo.bootstrap.Component"
+ "desc" : "t) What element to use for visibility (@see getVisibilityEl(",
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : [
+ "el",
+ "parent"
+ ]
},
{
"name" : "vtype",
"type" : "String",
"desc" : "A validation type name as defined in {@link Roo.form.VTypes} (defaults to null)",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "xattr",
"type" : "Object",
"desc" : "extra attributes to add to 'element' (used by builder to store stuff.)",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "xs",
"type" : "Number",
"desc" : "colspan out of 12 for mobile-sized screens",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
}
],
"events" : [
],
"isAbstract" : false,
"isBuilderTop" : false,
- "childClasses" : { },
+ "implementations" : [],
"tree_children" : [],
"tree_parent" : []
},
{
"name" : "accept",
"type" : "String",
- "desc" : "o) use for file input only. (default empty)",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "desc" : "o) use for file input only. (default empt",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : [
+ "image",
+ "video",
+ "audio"
+ ]
},
{
"name" : "actionMode",
"type" : "String",
"desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el' for forms you probably want to set this to fieldEl",
- "memberOf" : "Roo.Component"
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "after",
"type" : "string",
"desc" : "- input group add on after",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "afterButton",
"type" : "Roo.bootstrap.Button",
"desc" : "to show before",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "align",
"type" : "String",
- "desc" : "t) Default left",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "desc" : "t) Default le",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : [
+ "left",
+ "center",
+ "right"
+ ]
},
{
"name" : "allowBlank",
"type" : "Boolean",
"desc" : "False to validate that the value length > 0 (defaults to true)",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "allowDomMove",
"type" : "Boolean",
"desc" : "Whether the component can move the Dom node when rendering (defaults to true).",
- "memberOf" : "Roo.Component"
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "autocomplete",
"type" : "String",
"desc" : "- default is new-password see: https://developers.google.com/web/fundamentals/input/form/label-and-name-inputs?hl=en",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "before",
"type" : "string",
"desc" : "- input group add on before",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "blankText",
"type" : "String",
"desc" : "Error text to display if the allow blank validation fails (defaults to \"This field is required\")",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "can_build_overlaid",
"type" : "Boolean",
"desc" : "True if element can be rebuild from a HTML page",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "capture",
"type" : "String",
- "desc" : "a) use for file input only. (default empty)",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "desc" : "a) use for file input only. (default empt",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : [
+ "user",
+ "camera"
+ ]
},
{
"name" : "caret",
"type" : "String",
- "desc" : "r) BS3 only - carat fa name",
- "memberOf" : ""
+ "desc" : "r) BS3 only - carat fa na",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : [
+ "search",
+ "calendar"
+ ]
},
{
"name" : "cls",
"type" : "String",
"desc" : "css class",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "container_method",
"type" : "string",
"desc" : "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "dataId",
"type" : "string",
"desc" : "cutomer id",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "disableClass",
"type" : "String",
"desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").",
- "memberOf" : "Roo.Component"
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "disableKeyFilter",
"type" : "Boolean",
"desc" : "True to disable input keystroke filtering (defaults to false)",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "disabled",
"type" : "Boolean",
"desc" : "is it disabled",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "fieldLabel",
"type" : "string",
"desc" : "- the label associated",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "focusClass",
"type" : "String",
"desc" : "The CSS class to use when the field receives focus (defaults to \"x-form-focus\")",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "forceFeedback",
"type" : "Boolean",
- "desc" : "e) Default false",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "desc" : "e) Default fal",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : [
+ "true",
+ "false"
+ ]
},
{
"name" : "hasFeedback",
"type" : "Boolean",
- "desc" : "e) default true",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "desc" : "e) default tr",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : [
+ "true",
+ "false"
+ ]
},
{
"name" : "hideMode",
"type" : "String",
- "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".",
- "memberOf" : "Roo.Component"
+ "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display",
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : [
+ "display",
+ "visibility"
+ ]
},
{
"name" : "hideTrigger",
"type" : "Boolean",
"desc" : "True to hide the trigger element and display only the base text field (defaults to false)",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "indicatorpos",
"type" : "String",
- "desc" : "t) default left",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "desc" : "t) default le",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : [
+ "left",
+ "right"
+ ]
},
{
"name" : "inputType",
"type" : "String",
- "desc" : "t)",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "desc" : "",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : [
+ "button",
+ "checkbox",
+ "email",
+ "file",
+ "hidden",
+ "image",
+ "number",
+ "password",
+ "radio",
+ "range",
+ "reset",
+ "search",
+ "submit",
+ "text"
+ ]
},
{
"name" : "invalidClass",
"type" : "String",
"desc" : "DEPRICATED - code uses BS4 - is-valid / is-invalid",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "invalidFeedbackIcon",
"type" : "String",
"desc" : "The CSS class to use when create feedback icon (defaults to \"x-form-invalid\")",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "invalidText",
"type" : "String",
"desc" : "The error text to display if {@link #validator} test fails during validation (defaults to \"\")",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "labelAlign",
"type" : "String",
- "desc" : "t)",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "desc" : "",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : [
+ "top",
+ "left"
+ ]
},
{
"name" : "labelWidth",
"type" : "Number",
"desc" : "set the width of label",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "labellg",
"type" : "Number",
"desc" : "set the width of label (1-12)",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "labelmd",
"type" : "Number",
"desc" : "set the width of label (1-12)",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "labelsm",
"type" : "Number",
"desc" : "set the width of label (1-12)",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "labelxs",
"type" : "Number",
"desc" : "set the width of label (1-12)",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "lg",
"type" : "Number",
"desc" : "colspan out of 12 for large computer-sized screens",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"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"
+ "memberOf" : "Roo.util.Observable",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "maskRe",
"type" : "String",
"desc" : "An input mask regular expression that will be used to filter keystrokes that don't match (defaults to null)",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "maxLength",
"type" : "Number",
"desc" : "Maximum input field length allowed (defaults to Number.MAX_VALUE)",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "maxLengthText",
"type" : "String",
"desc" : "Error text to display if the maximum length validation fails (defaults to \"The maximum length for this field is {maxLength}\")",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "md",
"type" : "Number",
"desc" : "colspan out of 12 for computer-sized screens",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "minLength",
"type" : "Number",
"desc" : "Minimum input field length required (defaults to 0)",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "minLengthText",
"type" : "String",
"desc" : "Error text to display if the minimum length validation fails (defaults to \"The minimum length for this field is {minLength}\")",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "name",
"type" : "String",
"desc" : "name of the input",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "placeholder",
"type" : "string",
"desc" : "- placeholder to put in text.",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "preventMark",
"type" : "Boolean",
"desc" : "Do not show tick or cross if error/success",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "readOnly",
"type" : "Boolean",
"desc" : "Specifies that the field should be read-only",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "regex",
"type" : "RegExp",
"desc" : "A JavaScript RegExp object to be tested against the field value during validation (defaults to null).\nIf available, this regex will be evaluated only after the basic validators all return true, and will be passed the\ncurrent field value. If the test fails, the field will be marked invalid using {@link #regexText}.",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "regexText",
"type" : "String",
"desc" : "-- Depricated - use Invalid Text",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "removable",
"type" : "Boolean",
- "desc" : "e) special filter default false",
- "memberOf" : ""
+ "desc" : "e) special filter default fal",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : [
+ "true",
+ "false"
+ ]
},
{
"name" : "selectOnFocus",
"type" : "Boolean",
"desc" : "True to automatically select any existing field text when the field receives input focus (defaults to false)",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "size",
"type" : "string",
"desc" : "- (lg|sm) or leave empty..",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "sm",
"type" : "Number",
"desc" : "colspan out of 12 for tablet-sized screens",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "style",
"type" : "String",
"desc" : "any extra css",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "tooltip",
"type" : "string",
"desc" : "Text for the tooltip",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"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" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "validClass",
"type" : "String",
"desc" : "DEPRICATED - code uses BS4 - is-valid / is-invalid",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "validFeedbackIcon",
"type" : "String",
"desc" : "The CSS class to use when create feedback icon (defaults to \"x-form-invalid\")",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "validateOnBlur",
"type" : "Boolean",
"desc" : "Whether the field should validate when it loses focus (defaults to true).",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "validationDelay",
"type" : "Number",
"desc" : "The length of time in milliseconds after user input begins until validation is initiated (defaults to 250)",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "validationEvent",
"type" : "String/Boolean",
"desc" : "The event that should initiate field validation. Set to false to disable\n automatic validation (defaults to \"keyup\").",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "validator",
"type" : "Function",
"desc" : "A custom validation function to be called during field validation (defaults to null).\nIf available, this function will be called only after the basic validators all return true, and will be passed the\ncurrent field value and expected to return boolean true if the value is valid or a string error message if invalid.",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "value",
"type" : "string",
"desc" : "default value of the input",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "visibilityEl",
"type" : "string|object",
- "desc" : "t) What element to use for visibility (@see getVisibilityEl())",
- "memberOf" : "Roo.bootstrap.Component"
+ "desc" : "t) What element to use for visibility (@see getVisibilityEl(",
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : [
+ "el",
+ "parent"
+ ]
},
{
"name" : "vtype",
"type" : "String",
"desc" : "A validation type name as defined in {@link Roo.form.VTypes} (defaults to null)",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "xattr",
"type" : "Object",
"desc" : "extra attributes to add to 'element' (used by builder to store stuff.)",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "xs",
"type" : "Number",
"desc" : "colspan out of 12 for mobile-sized screens",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
}
],
"events" : [
],
"isAbstract" : false,
"isBuilderTop" : false,
- "childClasses" : {
- "Roo.bootstrap.form.TriggerField" : [
- "Roo.bootstrap.form.ComboBox",
- "Roo.bootstrap.form.PhoneInput"
- ],
- "Roo.bootstrap.form.ComboBox" : [
- "Roo.bootstrap.form.MoneyField"
- ]
- },
+ "implementations" : [
+ "Roo.bootstrap.form.ComboBox",
+ "Roo.bootstrap.form.MoneyField",
+ "Roo.bootstrap.form.PhoneInput"
+ ],
"tree_children" : [],
"tree_parent" : []
},
"methods" : [],
"isAbstract" : false,
"isBuilderTop" : false,
- "childClasses" : { },
+ "implementations" : [],
"tree_children" : [],
"tree_parent" : []
},
"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"
+ "memberOf" : "Roo.util.Observable",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "mgr",
"type" : "Roo.bootstrap.layout.Manager",
"desc" : "The manager",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "region",
"type" : "string",
"desc" : "the region that it inhabits..",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "skipConfig",
"type" : "bool",
"desc" : "skip config?",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
}
],
"events" : [],
],
"isAbstract" : false,
"isBuilderTop" : false,
- "childClasses" : {
- "Roo.bootstrap.layout.Basic" : [
- "Roo.bootstrap.layout.Region"
- ]
- },
+ "implementations" : [
+ "Roo.bootstrap.layout.Region"
+ ],
"tree_children" : [],
"tree_parent" : []
},
"name" : "actionMode",
"type" : "String",
"desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el' for forms you probably want to set this to fieldEl",
- "memberOf" : "Roo.Component"
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "allowDomMove",
"type" : "Boolean",
"desc" : "Whether the component can move the Dom node when rendering (defaults to true).",
- "memberOf" : "Roo.Component"
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "can_build_overlaid",
"type" : "Boolean",
"desc" : "True if element can be rebuild from a HTML page",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "center",
"type" : "Roo.bootstrap.layout.Region",
"desc" : "region to go in center",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "cls",
"type" : "String",
"desc" : "css class",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "container_method",
"type" : "string",
"desc" : "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "dataId",
"type" : "string",
"desc" : "cutomer id",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "disableClass",
"type" : "String",
"desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").",
- "memberOf" : "Roo.Component"
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "east",
"type" : "Roo.bootstrap.layout.Region",
"desc" : "region to go in east",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "hideMode",
"type" : "String",
- "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".",
- "memberOf" : "Roo.Component"
+ "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display",
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : [
+ "display",
+ "visibility"
+ ]
},
{
"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"
+ "memberOf" : "Roo.util.Observable",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "name",
"type" : "string",
"desc" : "Specifies name attribute",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "north",
"type" : "Roo.bootstrap.layout.Region",
"desc" : "region to go in north",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "south",
"type" : "Roo.bootstrap.layout.Region",
"desc" : "region to go in south",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "style",
"type" : "String",
"desc" : "any extra css",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "tooltip",
"type" : "string",
"desc" : "Text for the tooltip",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "visibilityEl",
"type" : "string|object",
- "desc" : "t) What element to use for visibility (@see getVisibilityEl())",
- "memberOf" : "Roo.bootstrap.Component"
+ "desc" : "t) What element to use for visibility (@see getVisibilityEl(",
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : [
+ "el",
+ "parent"
+ ]
},
{
"name" : "west",
"type" : "Roo.bootstrap.layout.Region",
"desc" : "region to go in west",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "xattr",
"type" : "Object",
"desc" : "extra attributes to add to 'element' (used by builder to store stuff.)",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
}
],
"events" : [
}
],
"isAbstract" : false,
- "isBuilderTop" : true,
- "childClasses" : { },
+ "isBuilderTop" : false,
+ "implementations" : [],
"tree_children" : [
"Roo.bootstrap.panel.Content",
"Roo.bootstrap.panel.Grid",
"Roo.bootstrap.panel.Nest",
"Roo.bootstrap.panel.Grid"
],
- "tree_parent" : []
+ "tree_parent" : [
+ "builder",
+ "Roo.bootstrap.panel.Nest",
+ "Roo.bootstrap.panel.Nest",
+ "Roo.bootstrap.Modal"
+ ]
},
"Roo.bootstrap.layout.Manager" : {
"props" : [
"name" : "actionMode",
"type" : "String",
"desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el' for forms you probably want to set this to fieldEl",
- "memberOf" : "Roo.Component"
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "allowDomMove",
"type" : "Boolean",
"desc" : "Whether the component can move the Dom node when rendering (defaults to true).",
- "memberOf" : "Roo.Component"
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "can_build_overlaid",
"type" : "Boolean",
"desc" : "True if element can be rebuild from a HTML page",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "cls",
"type" : "String",
"desc" : "css class",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "container_method",
"type" : "string",
"desc" : "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "dataId",
"type" : "string",
"desc" : "cutomer id",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "disableClass",
"type" : "String",
"desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").",
- "memberOf" : "Roo.Component"
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "hideMode",
"type" : "String",
- "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".",
- "memberOf" : "Roo.Component"
+ "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display",
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : [
+ "display",
+ "visibility"
+ ]
},
{
"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"
+ "memberOf" : "Roo.util.Observable",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "name",
"type" : "string",
"desc" : "Specifies name attribute",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "style",
"type" : "String",
"desc" : "any extra css",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "tooltip",
"type" : "string",
"desc" : "Text for the tooltip",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "visibilityEl",
"type" : "string|object",
- "desc" : "t) What element to use for visibility (@see getVisibilityEl())",
- "memberOf" : "Roo.bootstrap.Component"
+ "desc" : "t) What element to use for visibility (@see getVisibilityEl(",
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : [
+ "el",
+ "parent"
+ ]
},
{
"name" : "xattr",
"type" : "Object",
"desc" : "extra attributes to add to 'element' (used by builder to store stuff.)",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
}
],
"events" : [
],
"isAbstract" : true,
"isBuilderTop" : false,
- "childClasses" : {
- "Roo.bootstrap.layout.Manager" : [
- "Roo.bootstrap.layout.Border"
- ]
- },
+ "implementations" : [
+ "Roo.bootstrap.layout.Border"
+ ],
"tree_children" : [],
"tree_parent" : []
},
"name" : "alwaysShowTabs",
"type" : "Boolean",
"desc" : "True to always display tabs even when there is only 1 panel (defaults to false)",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "animate",
"type" : "Boolean",
"desc" : "True to animate expand/collapse (defaults to false)",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "autoHide",
"type" : "Boolean",
"desc" : "False to disable auto hiding when the mouse leaves the \"floated\" region (defaults to true)",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "autoScroll",
"type" : "Boolean",
"desc" : "True to enable overflow scrolling (defaults to false)",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "closeOnTab",
"type" : "Boolean",
"desc" : "True to place the close icon on the tabs instead of the region titlebar (defaults to false)",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "cls",
"type" : "string",
"desc" : "Extra CSS classes to add to region",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"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" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "disableTabTips",
"type" : "Boolean",
"desc" : "True to disable tab tooltips",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "height",
"type" : "Number",
"desc" : "For North/South panels",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "hidden",
"type" : "Boolean",
"desc" : "True to start the region hidden (defaults to false)",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "hideTabs",
"type" : "Boolean",
"desc" : "True to hide the tab strip (defaults to false)",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "hideWhenEmpty",
"type" : "Boolean",
"desc" : "True to hide the region when it has no panels",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"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"
+ "memberOf" : "Roo.util.Observable",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "margins",
"type" : "Object",
"desc" : "Margins for the element (defaults to {top: 0, left: 0, right:0, bottom: 0})",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "mgr",
"type" : "Roo.bootstrap.layout.Manager",
"desc" : "The manager",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "minTabWidth",
"type" : "Number",
"desc" : "The minimum tab width (defaults to 40)",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "overflow",
"type" : "String",
- "desc" : "e) if you have menus in the region, then you need to set this to visible.",
- "memberOf" : ""
+ "desc" : "e) if you have menus in the region, then you need to set this to visibl",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : [
+ "hidden",
+ "visible"
+ ]
},
{
"name" : "preferredTabWidth",
"type" : "Number",
"desc" : "The preferred tab width (defaults to 150)",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "preservePanels",
"type" : "Boolean",
"desc" : "True to preserve removed panels so they can be readded later (defaults to false)",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "region",
"type" : "string",
"desc" : "the region that it inhabits..",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"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" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "skipConfig",
"type" : "bool",
"desc" : "skip config?",
- "memberOf" : "Roo.bootstrap.layout.Basic"
+ "memberOf" : "Roo.bootstrap.layout.Basic",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "split",
"type" : "Boolean",
"desc" : "To show the splitter",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "tabPosition",
"type" : "String",
- "desc" : "m) \"top\" or \"bottom\" (defaults to \"bottom\")",
- "memberOf" : ""
+ "desc" : "m) \"top\" or \"bottom\" (defaults to \"bottom",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : [
+ "top",
+ "bottom"
+ ]
},
{
"name" : "title",
"type" : "String",
"desc" : "The title for the region (overrides panel titles)",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "titlebar",
"type" : "Boolean",
"desc" : "True to display a title bar (defaults to true)",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "toolbar",
"type" : "Boolean",
"desc" : "xtype configuration for a toolbar - shows on right of tabbar",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "width",
"type" : "Number",
"desc" : "For East/West panels",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
}
],
"events" : [],
],
"isAbstract" : false,
"isBuilderTop" : false,
- "childClasses" : { },
+ "implementations" : [],
"tree_children" : [],
"tree_parent" : []
},
"name" : "alwaysShowTabs",
"type" : "Boolean",
"desc" : "True to always display tabs even when there is only 1 panel (defaults to false)",
- "memberOf" : "Roo.LayoutRegion"
+ "memberOf" : "Roo.LayoutRegion",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "animate",
"type" : "Boolean",
"desc" : "True to animate expand/collapse (defaults to false)",
- "memberOf" : "Roo.LayoutRegion"
+ "memberOf" : "Roo.LayoutRegion",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "autoHide",
"type" : "Boolean",
"desc" : "False to disable auto hiding when the mouse leaves the \"floated\" region (defaults to true)",
- "memberOf" : "Roo.LayoutRegion"
+ "memberOf" : "Roo.LayoutRegion",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "autoScroll",
"type" : "Boolean",
"desc" : "True to enable overflow scrolling (defaults to false)",
- "memberOf" : "Roo.LayoutRegion"
+ "memberOf" : "Roo.LayoutRegion",
+ "isOptional" : false,
+ "optvals" : []
},
{
"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"
+ "memberOf" : "Roo.LayoutRegion",
+ "isOptional" : false,
+ "optvals" : []
},
{
"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"
+ "memberOf" : "Roo.LayoutRegion",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "collapsed",
"type" : "Boolean",
"desc" : "True to set the initial display to collapsed (defaults to false)",
- "memberOf" : "Roo.LayoutRegion"
+ "memberOf" : "Roo.LayoutRegion",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "collapsedTitle",
"type" : "String",
"desc" : "Optional string message to display in the collapsed block of a north or south region",
- "memberOf" : "Roo.LayoutRegion"
+ "memberOf" : "Roo.LayoutRegion",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "collapsible",
"type" : "Boolean",
"desc" : "False to disable collapsing (defaults to true)",
- "memberOf" : "Roo.LayoutRegion"
+ "memberOf" : "Roo.LayoutRegion",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "disableTabTips",
"type" : "Boolean",
"desc" : "True to disable tab tooltips",
- "memberOf" : "Roo.LayoutRegion"
+ "memberOf" : "Roo.LayoutRegion",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "floatable",
"type" : "Boolean",
"desc" : "False to disable floating (defaults to true)",
- "memberOf" : "Roo.LayoutRegion"
+ "memberOf" : "Roo.LayoutRegion",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "height",
"type" : "Number",
"desc" : "For North/South panels",
- "memberOf" : "Roo.LayoutRegion"
+ "memberOf" : "Roo.LayoutRegion",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "hidden",
"type" : "Boolean",
"desc" : "True to start the region hidden (defaults to false)",
- "memberOf" : "Roo.LayoutRegion"
+ "memberOf" : "Roo.LayoutRegion",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "hideTabs",
"type" : "Boolean",
"desc" : "True to hide the tab strip (defaults to false)",
- "memberOf" : "Roo.LayoutRegion"
+ "memberOf" : "Roo.LayoutRegion",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "hideWhenEmpty",
"type" : "Boolean",
"desc" : "True to hide the region when it has no panels",
- "memberOf" : "Roo.LayoutRegion"
+ "memberOf" : "Roo.LayoutRegion",
+ "isOptional" : false,
+ "optvals" : []
},
{
"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"
+ "memberOf" : "Roo.util.Observable",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "margins",
"type" : "Object",
"desc" : "Margins for the element (defaults to {top: 0, left: 0, right:0, bottom: 0})",
- "memberOf" : "Roo.LayoutRegion"
+ "memberOf" : "Roo.LayoutRegion",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "minTabWidth",
"type" : "Number",
"desc" : "The minimum tab width (defaults to 40)",
- "memberOf" : "Roo.LayoutRegion"
+ "memberOf" : "Roo.LayoutRegion",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "preferredTabWidth",
"type" : "Number",
"desc" : "The preferred tab width (defaults to 150)",
- "memberOf" : "Roo.LayoutRegion"
+ "memberOf" : "Roo.LayoutRegion",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "preservePanels",
"type" : "Boolean",
"desc" : "True to preserve removed panels so they can be readded later (defaults to false)",
- "memberOf" : "Roo.LayoutRegion"
+ "memberOf" : "Roo.LayoutRegion",
+ "isOptional" : false,
+ "optvals" : []
},
{
"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"
+ "memberOf" : "Roo.LayoutRegion",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "showPin",
"type" : "Boolean",
"desc" : "True to show a pin button",
- "memberOf" : "Roo.LayoutRegion"
+ "memberOf" : "Roo.LayoutRegion",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "split",
"type" : "Boolean",
"desc" : "To show the splitter",
- "memberOf" : "Roo.LayoutRegion"
+ "memberOf" : "Roo.LayoutRegion",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "tabPosition",
"type" : "String",
- "desc" : "m) \"top\" or \"bottom\" (defaults to \"bottom\")",
- "memberOf" : "Roo.LayoutRegion"
+ "desc" : "m) \"top\" or \"bottom\" (defaults to \"bottom",
+ "memberOf" : "Roo.LayoutRegion",
+ "isOptional" : false,
+ "optvals" : [
+ "top",
+ "bottom"
+ ]
},
{
"name" : "title",
"type" : "String",
"desc" : "The title for the region (overrides panel titles)",
- "memberOf" : "Roo.LayoutRegion"
+ "memberOf" : "Roo.LayoutRegion",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "titlebar",
"type" : "Boolean",
"desc" : "True to display a title bar (defaults to true)",
- "memberOf" : "Roo.LayoutRegion"
+ "memberOf" : "Roo.LayoutRegion",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "toolbar",
"type" : "Boolean",
"desc" : "xtype configuration for a toolbar - shows on right of tabbar",
- "memberOf" : "Roo.LayoutRegion"
+ "memberOf" : "Roo.LayoutRegion",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "width",
"type" : "Number",
"desc" : "For East/West panels",
- "memberOf" : "Roo.LayoutRegion"
+ "memberOf" : "Roo.LayoutRegion",
+ "isOptional" : false,
+ "optvals" : []
}
],
"events" : [
],
"isAbstract" : false,
"isBuilderTop" : false,
- "childClasses" : { },
+ "implementations" : [],
"tree_children" : [],
"tree_parent" : []
},
"methods" : [],
"isAbstract" : false,
"isBuilderTop" : false,
- "childClasses" : { },
+ "implementations" : [],
"tree_children" : [],
"tree_parent" : []
},
"name" : "actionMode",
"type" : "String",
"desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el' for forms you probably want to set this to fieldEl",
- "memberOf" : "Roo.Component"
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "active",
"type" : "Boolean",
"desc" : "used on sidebars to highlight active itesm",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "allowDomMove",
"type" : "Boolean",
"desc" : "Whether the component can move the Dom node when rendering (defaults to true).",
- "memberOf" : "Roo.Component"
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "can_build_overlaid",
"type" : "Boolean",
"desc" : "True if element can be rebuild from a HTML page",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "cls",
"type" : "String",
"desc" : "css class",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "container_method",
"type" : "string",
"desc" : "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "dataId",
"type" : "string",
"desc" : "cutomer id",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "disableClass",
"type" : "String",
"desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").",
- "memberOf" : "Roo.Component"
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "fa",
"type" : "String",
"desc" : "favicon to show on left of menu item.",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "hideMode",
"type" : "String",
- "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".",
- "memberOf" : "Roo.Component"
+ "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display",
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : [
+ "display",
+ "visibility"
+ ]
},
{
"name" : "href",
"type" : "String",
"desc" : "the link",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "html",
"type" : "String",
"desc" : "the menu label",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "isContainer",
"type" : "Boolean",
"desc" : "is it a container - just returns a drop down item..",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"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"
+ "memberOf" : "Roo.util.Observable",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "menu",
"type" : "Roo.bootsrap.Menu",
"desc" : "the child menu.",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "name",
"type" : "string",
"desc" : "Specifies name attribute",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "preventDefault",
"type" : "Boolean",
"desc" : "do not trigger A href on clicks (default false).",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "style",
"type" : "String",
"desc" : "any extra css",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "tooltip",
"type" : "string",
"desc" : "Text for the tooltip",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "visibilityEl",
"type" : "string|object",
- "desc" : "t) What element to use for visibility (@see getVisibilityEl())",
- "memberOf" : "Roo.bootstrap.Component"
+ "desc" : "t) What element to use for visibility (@see getVisibilityEl(",
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : [
+ "el",
+ "parent"
+ ]
},
{
"name" : "xattr",
"type" : "Object",
"desc" : "extra attributes to add to 'element' (used by builder to store stuff.)",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
}
],
"events" : [
],
"isAbstract" : false,
"isBuilderTop" : false,
- "childClasses" : { },
+ "implementations" : [],
"tree_children" : [
"Roo.bootstrap.Button",
"Roo.bootstrap.ButtonUploader",
"Roo.bootstrap.ButtonUploader",
"Roo.bootstrap.Row",
"Roo.bootstrap.Column",
- "Roo.bootstrap.TabGroup",
- "Roo.bootstrap.Container"
+ "Roo.bootstrap.TabGroup"
],
"tree_parent" : [
"Roo.bootstrap.menu.Menu"
],
"isAbstract" : false,
"isBuilderTop" : false,
- "childClasses" : { },
+ "implementations" : [],
"tree_children" : [],
"tree_parent" : []
},
"name" : "actionMode",
"type" : "String",
"desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el' for forms you probably want to set this to fieldEl",
- "memberOf" : "Roo.Component"
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "align",
"type" : "String",
"desc" : "default tl-bl? == below - how the menu should be aligned.",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "allowDomMove",
"type" : "Boolean",
"desc" : "Whether the component can move the Dom node when rendering (defaults to true).",
- "memberOf" : "Roo.Component"
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "can_build_overlaid",
"type" : "Boolean",
"desc" : "True if element can be rebuild from a HTML page",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "cls",
"type" : "String",
"desc" : "css class",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "container_method",
"type" : "string",
"desc" : "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "dataId",
"type" : "string",
"desc" : "cutomer id",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "disableClass",
"type" : "String",
"desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").",
- "memberOf" : "Roo.Component"
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "hidden",
"type" : "bool",
"desc" : "if the menu should be hidden when rendered.",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "hideMode",
"type" : "String",
- "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".",
- "memberOf" : "Roo.Component"
+ "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display",
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : [
+ "display",
+ "visibility"
+ ]
},
{
"name" : "hideTrigger",
"type" : "bool",
- "desc" : "e) default false - hide the carret for trigger.",
- "memberOf" : ""
+ "desc" : "e) default false - hide the carret for trigge",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : [
+ "true",
+ "false"
+ ]
},
{
"name" : "isLink",
"type" : "bool",
- "desc" : "e) the menu has link disable auto expand and collaspe (default false)",
- "memberOf" : ""
+ "desc" : "e) the menu has link disable auto expand and collaspe (default fals",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : [
+ "true",
+ "false"
+ ]
},
{
"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"
+ "memberOf" : "Roo.util.Observable",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "name",
"type" : "string",
"desc" : "Specifies name attribute",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "registerMenu",
"type" : "Boolean",
"desc" : "True (default) - means that clicking on screen etc. hides it.",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "stopEvent",
"type" : "bool",
- "desc" : "e) Stop event after trigger press (default true)",
- "memberOf" : ""
+ "desc" : "e) Stop event after trigger press (default tru",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : [
+ "true",
+ "false"
+ ]
},
{
"name" : "style",
"type" : "String",
"desc" : "any extra css",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "tooltip",
"type" : "string",
"desc" : "Text for the tooltip",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "type",
"type" : "String",
- "desc" : "u) type of menu",
- "memberOf" : ""
+ "desc" : "u) type of me",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : [
+ "dropdown",
+ "treeview",
+ "submenu"
+ ]
},
{
"name" : "visibilityEl",
"type" : "string|object",
- "desc" : "t) What element to use for visibility (@see getVisibilityEl())",
- "memberOf" : "Roo.bootstrap.Component"
+ "desc" : "t) What element to use for visibility (@see getVisibilityEl(",
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : [
+ "el",
+ "parent"
+ ]
},
{
"name" : "xattr",
"type" : "Object",
"desc" : "extra attributes to add to 'element' (used by builder to store stuff.)",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
}
],
"events" : [
],
"isAbstract" : false,
"isBuilderTop" : false,
- "childClasses" : { },
+ "implementations" : [],
"tree_children" : [
- "Roo.bootstrap.menu.Item"
+ "Roo.bootstrap.menu.Item",
+ "Roo.bootstrap.menu.Separator"
],
"tree_parent" : [
"none"
"name" : "actionMode",
"type" : "String",
"desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el' for forms you probably want to set this to fieldEl",
- "memberOf" : "Roo.Component"
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "allowDomMove",
"type" : "Boolean",
"desc" : "Whether the component can move the Dom node when rendering (defaults to true).",
- "memberOf" : "Roo.Component"
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "can_build_overlaid",
"type" : "Boolean",
"desc" : "True if element can be rebuild from a HTML page",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "cls",
"type" : "String",
"desc" : "css class",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "container_method",
"type" : "string",
"desc" : "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "dataId",
"type" : "string",
"desc" : "cutomer id",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "disableClass",
"type" : "String",
"desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").",
- "memberOf" : "Roo.Component"
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "hideMode",
"type" : "String",
- "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".",
- "memberOf" : "Roo.Component"
+ "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display",
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : [
+ "display",
+ "visibility"
+ ]
},
{
"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"
+ "memberOf" : "Roo.util.Observable",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "name",
"type" : "string",
"desc" : "Specifies name attribute",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "style",
"type" : "String",
"desc" : "any extra css",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "tooltip",
"type" : "string",
"desc" : "Text for the tooltip",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "visibilityEl",
"type" : "string|object",
- "desc" : "t) What element to use for visibility (@see getVisibilityEl())",
- "memberOf" : "Roo.bootstrap.Component"
+ "desc" : "t) What element to use for visibility (@see getVisibilityEl(",
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : [
+ "el",
+ "parent"
+ ]
},
{
"name" : "xattr",
"type" : "Object",
"desc" : "extra attributes to add to 'element' (used by builder to store stuff.)",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
}
],
"events" : [
],
"isAbstract" : false,
"isBuilderTop" : false,
- "childClasses" : { },
+ "implementations" : [],
"tree_children" : [],
"tree_parent" : [
"Roo.bootstrap.menu.Menu"
"methods" : [],
"isAbstract" : false,
"isBuilderTop" : false,
- "childClasses" : { },
+ "implementations" : [],
"tree_children" : [],
"tree_parent" : []
},
"name" : "actionMode",
"type" : "String",
"desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el' for forms you probably want to set this to fieldEl",
- "memberOf" : "Roo.Component"
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "allowDomMove",
"type" : "Boolean",
"desc" : "Whether the component can move the Dom node when rendering (defaults to true).",
- "memberOf" : "Roo.Component"
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "can_build_overlaid",
"type" : "Boolean",
"desc" : "True if element can be rebuild from a HTML page",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "cls",
"type" : "String",
"desc" : "css class",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "container_method",
"type" : "string",
"desc" : "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "dataId",
"type" : "string",
"desc" : "cutomer id",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "disableClass",
"type" : "String",
"desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").",
- "memberOf" : "Roo.Component"
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "hideMode",
"type" : "String",
- "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".",
- "memberOf" : "Roo.Component"
+ "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display",
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : [
+ "display",
+ "visibility"
+ ]
},
{
"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"
+ "memberOf" : "Roo.util.Observable",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "name",
"type" : "string",
"desc" : "Specifies name attribute",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "style",
"type" : "String",
"desc" : "any extra css",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "tooltip",
"type" : "string",
"desc" : "Text for the tooltip",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "visibilityEl",
"type" : "string|object",
- "desc" : "t) What element to use for visibility (@see getVisibilityEl())",
- "memberOf" : "Roo.bootstrap.Component"
+ "desc" : "t) What element to use for visibility (@see getVisibilityEl(",
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : [
+ "el",
+ "parent"
+ ]
},
{
"name" : "xattr",
"type" : "Object",
"desc" : "extra attributes to add to 'element' (used by builder to store stuff.)",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
}
],
"events" : [
],
"isAbstract" : true,
"isBuilderTop" : false,
- "childClasses" : {
- "Roo.bootstrap.nav.Bar" : [
- "Roo.bootstrap.nav.Sidebar",
- "Roo.bootstrap.nav.Simplebar"
- ],
- "Roo.bootstrap.nav.Simplebar" : [
- "Roo.bootstrap.PagingToolbar",
- "Roo.bootstrap.PopoverNav",
- "Roo.bootstrap.form.HtmlEditorToolbarStandard",
- "Roo.bootstrap.nav.Headerbar"
- ]
- },
+ "implementations" : [
+ "Roo.bootstrap.PagingToolbar",
+ "Roo.bootstrap.PopoverNav",
+ "Roo.bootstrap.form.HtmlEditorToolbarStandard",
+ "Roo.bootstrap.nav.Headerbar",
+ "Roo.bootstrap.nav.Sidebar",
+ "Roo.bootstrap.nav.Simplebar"
+ ],
"tree_children" : [],
"tree_parent" : []
},
"name" : "actionMode",
"type" : "String",
"desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el' for forms you probably want to set this to fieldEl",
- "memberOf" : "Roo.Component"
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "align",
"type" : "String",
- "desc" : "t)",
- "memberOf" : ""
+ "desc" : "",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : [
+ "left",
+ "right"
+ ]
},
{
"name" : "allowDomMove",
"type" : "Boolean",
"desc" : "Whether the component can move the Dom node when rendering (defaults to true).",
- "memberOf" : "Roo.Component"
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "can_build_overlaid",
"type" : "Boolean",
"desc" : "True if element can be rebuild from a HTML page",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "cls",
"type" : "String",
"desc" : "css class",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "container_method",
"type" : "string",
"desc" : "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "dataId",
"type" : "string",
"desc" : "cutomer id",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "disableClass",
"type" : "String",
"desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").",
- "memberOf" : "Roo.Component"
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "hideMode",
"type" : "String",
- "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".",
- "memberOf" : "Roo.Component"
+ "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display",
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : [
+ "display",
+ "visibility"
+ ]
},
{
"name" : "inverse",
"type" : "Boolean",
"desc" : "",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"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"
+ "memberOf" : "Roo.util.Observable",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "name",
"type" : "string",
"desc" : "Specifies name attribute",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "navId",
"type" : "String",
"desc" : "- reference Id for navbar.",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "pilltype",
"type" : "Boolean",
"desc" : "default true (turn to off to disable active toggle)",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "style",
"type" : "String",
"desc" : "any extra css",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "tooltip",
"type" : "string",
"desc" : "Text for the tooltip",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "type",
"type" : "String",
- "desc" : "b) default nav",
- "memberOf" : ""
+ "desc" : "b) default n",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : [
+ "nav",
+ "pills",
+ "tab"
+ ]
},
{
"name" : "visibilityEl",
"type" : "string|object",
- "desc" : "t) What element to use for visibility (@see getVisibilityEl())",
- "memberOf" : "Roo.bootstrap.Component"
+ "desc" : "t) What element to use for visibility (@see getVisibilityEl(",
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : [
+ "el",
+ "parent"
+ ]
},
{
"name" : "xattr",
"type" : "Object",
"desc" : "extra attributes to add to 'element' (used by builder to store stuff.)",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
}
],
"events" : [
],
"isAbstract" : false,
"isBuilderTop" : false,
- "childClasses" : { },
+ "implementations" : [],
"tree_children" : [
"Roo.bootstrap.nav.Item",
"Roo.bootstrap.nav.SidebarItem"
"name" : "actionMode",
"type" : "String",
"desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el' for forms you probably want to set this to fieldEl",
- "memberOf" : "Roo.Component"
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "align",
"type" : "String",
- "desc" : "t) alignment",
- "memberOf" : "Roo.bootstrap.nav.Simplebar"
+ "desc" : "t) alignme",
+ "memberOf" : "Roo.bootstrap.nav.Simplebar",
+ "isOptional" : false,
+ "optvals" : [
+ "left",
+ "right"
+ ]
},
{
"name" : "allowDomMove",
"type" : "Boolean",
"desc" : "Whether the component can move the Dom node when rendering (defaults to true).",
- "memberOf" : "Roo.Component"
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "arrangement",
"type" : "Boolean",
"desc" : "stacked | justified",
- "memberOf" : "Roo.bootstrap.nav.Simplebar"
+ "memberOf" : "Roo.bootstrap.nav.Simplebar",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "autohide",
"type" : "Boolean",
"desc" : "a top nav bar header that hides on scroll.",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "brand",
"type" : "String",
"desc" : "what is brand",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "brand_href",
"type" : "String",
"desc" : "href of the brand",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "can_build_overlaid",
"type" : "Boolean",
"desc" : "True if element can be rebuild from a HTML page",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "cls",
"type" : "String",
"desc" : "css class",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "container_method",
"type" : "string",
"desc" : "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "dataId",
"type" : "string",
"desc" : "cutomer id",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "desktopCenter",
"type" : "Boolean",
"desc" : "should the header be centered on desktop using a container class",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "disableClass",
"type" : "String",
"desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").",
- "memberOf" : "Roo.Component"
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "hideMode",
"type" : "String",
- "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".",
- "memberOf" : "Roo.Component"
+ "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display",
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : [
+ "display",
+ "visibility"
+ ]
},
{
"name" : "inverse",
"type" : "Boolean",
"desc" : "is inverted color",
- "memberOf" : "Roo.bootstrap.nav.Simplebar"
+ "memberOf" : "Roo.bootstrap.nav.Simplebar",
+ "isOptional" : false,
+ "optvals" : []
},
{
"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"
+ "memberOf" : "Roo.util.Observable",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "loadMask",
"type" : "Boolean",
- "desc" : "e) loadMask on the bar",
- "memberOf" : "Roo.bootstrap.nav.Simplebar"
+ "desc" : "e) loadMask on the b",
+ "memberOf" : "Roo.bootstrap.nav.Simplebar",
+ "isOptional" : false,
+ "optvals" : [
+ "true",
+ "false"
+ ]
},
{
"name" : "main",
"type" : "Boolean",
- "desc" : "e) main nav bar? default false",
- "memberOf" : "Roo.bootstrap.nav.Simplebar"
+ "desc" : "e) main nav bar? default fal",
+ "memberOf" : "Roo.bootstrap.nav.Simplebar",
+ "isOptional" : false,
+ "optvals" : [
+ "true",
+ "false"
+ ]
},
{
"name" : "mobilerow",
"type" : "Roo.bootstrap.Row",
"desc" : "- a row to display on mobile only..",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "name",
"type" : "string",
"desc" : "Specifies name attribute",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "position",
"type" : "String",
- "desc" : "p) position",
- "memberOf" : ""
+ "desc" : "p) positi",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : [
+ "fixed-top",
+ "fixed-bottom",
+ "static-top"
+ ]
},
{
"name" : "srButton",
"type" : "Boolean",
"desc" : "generate the (screen reader / mobile) sr-only button default true",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "style",
"type" : "String",
"desc" : "any extra css",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "tag",
"type" : "String",
- "desc" : "v) default is nav",
- "memberOf" : "Roo.bootstrap.nav.Simplebar"
+ "desc" : "v) default is n",
+ "memberOf" : "Roo.bootstrap.nav.Simplebar",
+ "isOptional" : false,
+ "optvals" : [
+ "header",
+ "footer",
+ "nav",
+ "div"
+ ]
},
{
"name" : "tooltip",
"type" : "string",
"desc" : "Text for the tooltip",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "type",
"type" : "String",
- "desc" : "s)",
- "memberOf" : "Roo.bootstrap.nav.Simplebar"
+ "desc" : "",
+ "memberOf" : "Roo.bootstrap.nav.Simplebar",
+ "isOptional" : false,
+ "optvals" : [
+ "nav",
+ "pills",
+ "tabs"
+ ]
},
{
"name" : "visibilityEl",
"type" : "string|object",
- "desc" : "t) What element to use for visibility (@see getVisibilityEl())",
- "memberOf" : "Roo.bootstrap.Component"
+ "desc" : "t) What element to use for visibility (@see getVisibilityEl(",
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : [
+ "el",
+ "parent"
+ ]
},
{
"name" : "weight",
"type" : "String",
- "desc" : "e) default is light.",
- "memberOf" : "Roo.bootstrap.nav.Simplebar"
+ "desc" : "e) default is ligh",
+ "memberOf" : "Roo.bootstrap.nav.Simplebar",
+ "isOptional" : false,
+ "optvals" : [
+ "light",
+ "primary",
+ "secondary",
+ "success",
+ "danger",
+ "warning",
+ "info",
+ "dark",
+ "white"
+ ]
},
{
"name" : "xattr",
"type" : "Object",
"desc" : "extra attributes to add to 'element' (used by builder to store stuff.)",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
}
],
"events" : [
],
"isAbstract" : false,
"isBuilderTop" : false,
- "childClasses" : { },
+ "implementations" : [],
"tree_children" : [
"Roo.bootstrap.nav.Group",
- "Roo.bootstrap.Container",
"Roo.bootstrap.form.Form",
"Roo.bootstrap.Row",
"Roo.bootstrap.Column",
"name" : "actionMode",
"type" : "String",
"desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el' for forms you probably want to set this to fieldEl",
- "memberOf" : "Roo.Component"
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "active",
"type" : "Boolean",
"desc" : "Is item active",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "allowDomMove",
"type" : "Boolean",
"desc" : "Whether the component can move the Dom node when rendering (defaults to true).",
- "memberOf" : "Roo.Component"
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "animateRef",
"type" : "Boolean",
- "desc" : "e) link to element default false",
- "memberOf" : ""
+ "desc" : "e) link to element default fal",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : [
+ "true",
+ "false"
+ ]
},
{
"name" : "badge",
"type" : "String",
"desc" : "text inside badge",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "badgecls",
"type" : "String",
- "desc" : "w)the extra classes for the badge",
- "memberOf" : ""
+ "desc" : "w)the extra classes for the bad",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : [
+ "bg-green",
+ "bg-red",
+ "bg-yellow"
+ ]
},
{
"name" : "button_outline",
"type" : "Boolean",
"desc" : "show and outlined button",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "button_weight",
"type" : "String",
- "desc" : "k) default none",
- "memberOf" : ""
+ "desc" : "k) default no",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : [
+ "default",
+ "primary",
+ "secondary",
+ "success",
+ "info",
+ "warning",
+ "danger",
+ "link",
+ "light",
+ "dark"
+ ]
},
{
"name" : "can_build_overlaid",
"type" : "Boolean",
"desc" : "True if element can be rebuild from a HTML page",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "cls",
"type" : "String",
"desc" : "css class",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "container_method",
"type" : "string",
"desc" : "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "dataId",
"type" : "string",
"desc" : "cutomer id",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "disableClass",
"type" : "String",
"desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").",
- "memberOf" : "Roo.Component"
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "disabled",
"type" : "Boolean",
"desc" : "Is item disabled",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "fa",
"type" : "String",
"desc" : "- Fontawsome icon name (can add stuff to it like fa-2x)",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "glyphicon",
"type" : "String",
"desc" : "DEPRICATED - use fa",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "hideMode",
"type" : "String",
- "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".",
- "memberOf" : "Roo.Component"
+ "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display",
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : [
+ "display",
+ "visibility"
+ ]
},
{
"name" : "href",
"type" : "String",
"desc" : "link to",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "html",
"type" : "String",
"desc" : "content of button",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "icon",
"type" : "String",
"desc" : "DEPRICATED - use fa",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "linkcls",
"type" : "String",
"desc" : "Link Class",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"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"
+ "memberOf" : "Roo.util.Observable",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "menu",
"type" : "Roo.bootstrap.menu.Menu",
"desc" : "a Menu",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "name",
"type" : "string",
"desc" : "Specifies name attribute",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "preventDefault",
"type" : "Boolean",
- "desc" : "e) default false",
- "memberOf" : ""
+ "desc" : "e) default fal",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : [
+ "true",
+ "false"
+ ]
},
{
"name" : "style",
"type" : "String",
"desc" : "any extra css",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "tabId",
"type" : "String",
"desc" : "the tab that this item activates.",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "tagtype",
"type" : "String",
- "desc" : "n) render as a href or span?",
- "memberOf" : ""
+ "desc" : "n) render as a href or spa",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : [
+ "a",
+ "span"
+ ]
},
{
"name" : "tooltip",
"type" : "string",
"desc" : "Text for the tooltip",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "visibilityEl",
"type" : "string|object",
- "desc" : "t) What element to use for visibility (@see getVisibilityEl())",
- "memberOf" : "Roo.bootstrap.Component"
+ "desc" : "t) What element to use for visibility (@see getVisibilityEl(",
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : [
+ "el",
+ "parent"
+ ]
},
{
"name" : "xattr",
"type" : "Object",
"desc" : "extra attributes to add to 'element' (used by builder to store stuff.)",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
}
],
"events" : [
],
"isAbstract" : false,
"isBuilderTop" : false,
- "childClasses" : {
- "Roo.bootstrap.nav.Item" : [
- "Roo.bootstrap.nav.SidebarItem"
- ]
- },
+ "implementations" : [
+ "Roo.bootstrap.nav.SidebarItem"
+ ],
"tree_children" : [
- "Roo.bootstrap.Container",
"Roo.bootstrap.Button",
"Roo.bootstrap.ButtonUploader",
"Roo.bootstrap.form.CardUploader"
"name" : "NavProgressBar:bullets[]",
"type" : "Roo.bootstrap.nav.ProgressItem",
"desc" : "Bullets for the Nav Progress bar for the toolbar",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "actionMode",
"type" : "String",
"desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el' for forms you probably want to set this to fieldEl",
- "memberOf" : "Roo.Component"
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "allowDomMove",
"type" : "Boolean",
"desc" : "Whether the component can move the Dom node when rendering (defaults to true).",
- "memberOf" : "Roo.Component"
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "can_build_overlaid",
"type" : "Boolean",
"desc" : "True if element can be rebuild from a HTML page",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "cls",
"type" : "String",
"desc" : "css class",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "container_method",
"type" : "string",
"desc" : "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "dataId",
"type" : "string",
"desc" : "cutomer id",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "disableClass",
"type" : "String",
"desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").",
- "memberOf" : "Roo.Component"
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "hideMode",
"type" : "String",
- "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".",
- "memberOf" : "Roo.Component"
+ "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display",
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : [
+ "display",
+ "visibility"
+ ]
},
{
"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"
+ "memberOf" : "Roo.util.Observable",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "name",
"type" : "string",
"desc" : "Specifies name attribute",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "style",
"type" : "String",
"desc" : "any extra css",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "tooltip",
"type" : "string",
"desc" : "Text for the tooltip",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "visibilityEl",
"type" : "string|object",
- "desc" : "t) What element to use for visibility (@see getVisibilityEl())",
- "memberOf" : "Roo.bootstrap.Component"
+ "desc" : "t) What element to use for visibility (@see getVisibilityEl(",
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : [
+ "el",
+ "parent"
+ ]
},
{
"name" : "xattr",
"type" : "Object",
"desc" : "extra attributes to add to 'element' (used by builder to store stuff.)",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
}
],
"events" : [
],
"isAbstract" : false,
"isBuilderTop" : false,
- "childClasses" : { },
+ "implementations" : [],
"tree_children" : [
"Roo.bootstrap.nav.ProgressBarItem"
],
"name" : "actionMode",
"type" : "String",
"desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el' for forms you probably want to set this to fieldEl",
- "memberOf" : "Roo.Component"
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "active",
"type" : "Boolean",
- "desc" : "e) Is item active default false",
- "memberOf" : ""
+ "desc" : "e) Is item active default fal",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : [
+ "true",
+ "false"
+ ]
},
{
"name" : "allowDomMove",
"type" : "Boolean",
"desc" : "Whether the component can move the Dom node when rendering (defaults to true).",
- "memberOf" : "Roo.Component"
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "can_build_overlaid",
"type" : "Boolean",
"desc" : "True if element can be rebuild from a HTML page",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "cls",
"type" : "String",
"desc" : "css class",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "container_method",
"type" : "string",
"desc" : "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "dataId",
"type" : "string",
"desc" : "cutomer id",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "disableClass",
"type" : "String",
"desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").",
- "memberOf" : "Roo.Component"
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "disabled",
"type" : "Boolean",
- "desc" : "e) Is item active default false",
- "memberOf" : ""
+ "desc" : "e) Is item active default fal",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : [
+ "true",
+ "false"
+ ]
},
{
"name" : "hideMode",
"type" : "String",
- "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".",
- "memberOf" : "Roo.Component"
+ "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display",
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : [
+ "display",
+ "visibility"
+ ]
},
{
"name" : "html",
"type" : "String",
"desc" : "",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "icon",
"type" : "String",
"desc" : "show icon instead of number",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"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"
+ "memberOf" : "Roo.util.Observable",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "name",
"type" : "string",
"desc" : "Specifies name attribute",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "position",
"type" : "String",
- "desc" : "m) text position default bottom",
- "memberOf" : ""
+ "desc" : "m) text position default bott",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : [
+ "top",
+ "bottom"
+ ]
},
{
"name" : "rid",
"type" : "String",
"desc" : "the reference id",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "style",
"type" : "String",
"desc" : "any extra css",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "tooltip",
"type" : "string",
"desc" : "Text for the tooltip",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "visibilityEl",
"type" : "string|object",
- "desc" : "t) What element to use for visibility (@see getVisibilityEl())",
- "memberOf" : "Roo.bootstrap.Component"
+ "desc" : "t) What element to use for visibility (@see getVisibilityEl(",
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : [
+ "el",
+ "parent"
+ ]
},
{
"name" : "xattr",
"type" : "Object",
"desc" : "extra attributes to add to 'element' (used by builder to store stuff.)",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
}
],
"events" : [
],
"isAbstract" : false,
"isBuilderTop" : false,
- "childClasses" : { },
+ "implementations" : [],
"tree_children" : [],
"tree_parent" : []
},
"name" : "actionMode",
"type" : "String",
"desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el' for forms you probably want to set this to fieldEl",
- "memberOf" : "Roo.Component"
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "allowDomMove",
"type" : "Boolean",
"desc" : "Whether the component can move the Dom node when rendering (defaults to true).",
- "memberOf" : "Roo.Component"
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "can_build_overlaid",
"type" : "Boolean",
"desc" : "True if element can be rebuild from a HTML page",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "cls",
"type" : "String",
"desc" : "css class",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "container_method",
"type" : "string",
"desc" : "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "dataId",
"type" : "string",
"desc" : "cutomer id",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "disableClass",
"type" : "String",
"desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").",
- "memberOf" : "Roo.Component"
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "hideMode",
"type" : "String",
- "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".",
- "memberOf" : "Roo.Component"
+ "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display",
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : [
+ "display",
+ "visibility"
+ ]
},
{
"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"
+ "memberOf" : "Roo.util.Observable",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "name",
"type" : "string",
"desc" : "Specifies name attribute",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "style",
"type" : "String",
"desc" : "any extra css",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "tooltip",
"type" : "string",
"desc" : "Text for the tooltip",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "visibilityEl",
"type" : "string|object",
- "desc" : "t) What element to use for visibility (@see getVisibilityEl())",
- "memberOf" : "Roo.bootstrap.Component"
+ "desc" : "t) What element to use for visibility (@see getVisibilityEl(",
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : [
+ "el",
+ "parent"
+ ]
},
{
"name" : "xattr",
"type" : "Object",
"desc" : "extra attributes to add to 'element' (used by builder to store stuff.)",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
}
],
"events" : [
],
"isAbstract" : false,
"isBuilderTop" : false,
- "childClasses" : { },
+ "implementations" : [],
"tree_children" : [
"Roo.bootstrap.nav.Group",
- "Roo.bootstrap.Container",
"Roo.bootstrap.form.Form",
"Roo.bootstrap.Row",
"Roo.bootstrap.Column",
"name" : "actionMode",
"type" : "String",
"desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el' for forms you probably want to set this to fieldEl",
- "memberOf" : "Roo.Component"
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "active",
"type" : "Boolean",
"desc" : "Is item active",
- "memberOf" : "Roo.bootstrap.nav.Item"
+ "memberOf" : "Roo.bootstrap.nav.Item",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "allowDomMove",
"type" : "Boolean",
"desc" : "Whether the component can move the Dom node when rendering (defaults to true).",
- "memberOf" : "Roo.Component"
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "animateRef",
"type" : "Boolean",
- "desc" : "e) link to element default false",
- "memberOf" : "Roo.bootstrap.nav.Item"
+ "desc" : "e) link to element default fal",
+ "memberOf" : "Roo.bootstrap.nav.Item",
+ "isOptional" : false,
+ "optvals" : [
+ "true",
+ "false"
+ ]
},
{
"name" : "badge",
"type" : "String",
"desc" : "text inside badge",
- "memberOf" : "Roo.bootstrap.nav.Item"
+ "memberOf" : "Roo.bootstrap.nav.Item",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "badgecls",
"type" : "String",
- "desc" : "w)the extra classes for the badge",
- "memberOf" : "Roo.bootstrap.nav.Item"
+ "desc" : "w)the extra classes for the bad",
+ "memberOf" : "Roo.bootstrap.nav.Item",
+ "isOptional" : false,
+ "optvals" : [
+ "bg-green",
+ "bg-red",
+ "bg-yellow"
+ ]
},
{
"name" : "button_outline",
"type" : "Boolean",
"desc" : "show and outlined button",
- "memberOf" : "Roo.bootstrap.nav.Item"
+ "memberOf" : "Roo.bootstrap.nav.Item",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "button_weight",
"type" : "String",
- "desc" : "k) default none",
- "memberOf" : "Roo.bootstrap.nav.Item"
+ "desc" : "k) default no",
+ "memberOf" : "Roo.bootstrap.nav.Item",
+ "isOptional" : false,
+ "optvals" : [
+ "default",
+ "primary",
+ "secondary",
+ "success",
+ "info",
+ "warning",
+ "danger",
+ "link",
+ "light",
+ "dark"
+ ]
},
{
"name" : "can_build_overlaid",
"type" : "Boolean",
"desc" : "True if element can be rebuild from a HTML page",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "cls",
"type" : "String",
"desc" : "css class",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "container_method",
"type" : "string",
"desc" : "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "dataId",
"type" : "string",
"desc" : "cutomer id",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "disableClass",
"type" : "String",
"desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").",
- "memberOf" : "Roo.Component"
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "disabled",
"type" : "Boolean",
"desc" : "Is item disabled",
- "memberOf" : "Roo.bootstrap.nav.Item"
+ "memberOf" : "Roo.bootstrap.nav.Item",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "fa",
"type" : "String",
"desc" : "- Fontawsome icon name (can add stuff to it like fa-2x)",
- "memberOf" : "Roo.bootstrap.nav.Item"
+ "memberOf" : "Roo.bootstrap.nav.Item",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "glyphicon",
"type" : "String",
"desc" : "DEPRICATED - use fa",
- "memberOf" : "Roo.bootstrap.nav.Item"
+ "memberOf" : "Roo.bootstrap.nav.Item",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "hideMode",
"type" : "String",
- "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".",
- "memberOf" : "Roo.Component"
+ "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display",
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : [
+ "display",
+ "visibility"
+ ]
},
{
"name" : "href",
"type" : "String",
"desc" : "link to",
- "memberOf" : "Roo.bootstrap.nav.Item"
+ "memberOf" : "Roo.bootstrap.nav.Item",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "html",
"type" : "String",
"desc" : "content of button",
- "memberOf" : "Roo.bootstrap.nav.Item"
+ "memberOf" : "Roo.bootstrap.nav.Item",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "icon",
"type" : "String",
"desc" : "DEPRICATED - use fa",
- "memberOf" : "Roo.bootstrap.nav.Item"
+ "memberOf" : "Roo.bootstrap.nav.Item",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "linkcls",
"type" : "String",
"desc" : "Link Class",
- "memberOf" : "Roo.bootstrap.nav.Item"
+ "memberOf" : "Roo.bootstrap.nav.Item",
+ "isOptional" : false,
+ "optvals" : []
},
{
"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"
+ "memberOf" : "Roo.util.Observable",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "menu",
"type" : "Roo.bootstrap.menu.Menu",
"desc" : "a Menu",
- "memberOf" : "Roo.bootstrap.nav.Item"
+ "memberOf" : "Roo.bootstrap.nav.Item",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "name",
"type" : "string",
"desc" : "Specifies name attribute",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "preventDefault",
"type" : "Boolean",
- "desc" : "e) default false",
- "memberOf" : "Roo.bootstrap.nav.Item"
+ "desc" : "e) default fal",
+ "memberOf" : "Roo.bootstrap.nav.Item",
+ "isOptional" : false,
+ "optvals" : [
+ "true",
+ "false"
+ ]
},
{
"name" : "style",
"type" : "String",
"desc" : "any extra css",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "tabId",
"type" : "String",
"desc" : "the tab that this item activates.",
- "memberOf" : "Roo.bootstrap.nav.Item"
+ "memberOf" : "Roo.bootstrap.nav.Item",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "tagtype",
"type" : "String",
- "desc" : "n) render as a href or span?",
- "memberOf" : "Roo.bootstrap.nav.Item"
+ "desc" : "n) render as a href or spa",
+ "memberOf" : "Roo.bootstrap.nav.Item",
+ "isOptional" : false,
+ "optvals" : [
+ "a",
+ "span"
+ ]
},
{
"name" : "tooltip",
"type" : "string",
"desc" : "Text for the tooltip",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "visibilityEl",
"type" : "string|object",
- "desc" : "t) What element to use for visibility (@see getVisibilityEl())",
- "memberOf" : "Roo.bootstrap.Component"
+ "desc" : "t) What element to use for visibility (@see getVisibilityEl(",
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : [
+ "el",
+ "parent"
+ ]
},
{
"name" : "xattr",
"type" : "Object",
"desc" : "extra attributes to add to 'element' (used by builder to store stuff.)",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
}
],
"events" : [
],
"isAbstract" : false,
"isBuilderTop" : false,
- "childClasses" : { },
+ "implementations" : [],
"tree_children" : [],
"tree_parent" : []
},
"name" : "actionMode",
"type" : "String",
"desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el' for forms you probably want to set this to fieldEl",
- "memberOf" : "Roo.Component"
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "align",
"type" : "String",
- "desc" : "t) alignment",
- "memberOf" : ""
+ "desc" : "t) alignme",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : [
+ "left",
+ "right"
+ ]
},
{
"name" : "allowDomMove",
"type" : "Boolean",
"desc" : "Whether the component can move the Dom node when rendering (defaults to true).",
- "memberOf" : "Roo.Component"
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "arrangement",
"type" : "Boolean",
"desc" : "stacked | justified",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "can_build_overlaid",
"type" : "Boolean",
"desc" : "True if element can be rebuild from a HTML page",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "cls",
"type" : "String",
"desc" : "css class",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "container_method",
"type" : "string",
"desc" : "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "dataId",
"type" : "string",
"desc" : "cutomer id",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "disableClass",
"type" : "String",
"desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").",
- "memberOf" : "Roo.Component"
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "hideMode",
"type" : "String",
- "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".",
- "memberOf" : "Roo.Component"
+ "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display",
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : [
+ "display",
+ "visibility"
+ ]
},
{
"name" : "inverse",
"type" : "Boolean",
"desc" : "is inverted color",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"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"
+ "memberOf" : "Roo.util.Observable",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "loadMask",
"type" : "Boolean",
- "desc" : "e) loadMask on the bar",
- "memberOf" : ""
+ "desc" : "e) loadMask on the b",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : [
+ "true",
+ "false"
+ ]
},
{
"name" : "main",
"type" : "Boolean",
- "desc" : "e) main nav bar? default false",
- "memberOf" : ""
+ "desc" : "e) main nav bar? default fal",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : [
+ "true",
+ "false"
+ ]
},
{
"name" : "name",
"type" : "string",
"desc" : "Specifies name attribute",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "style",
"type" : "String",
"desc" : "any extra css",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "tag",
"type" : "String",
- "desc" : "v) default is nav",
- "memberOf" : ""
+ "desc" : "v) default is n",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : [
+ "header",
+ "footer",
+ "nav",
+ "div"
+ ]
},
{
"name" : "tooltip",
"type" : "string",
"desc" : "Text for the tooltip",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "type",
"type" : "String",
- "desc" : "s)",
- "memberOf" : ""
+ "desc" : "",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : [
+ "nav",
+ "pills",
+ "tabs"
+ ]
},
{
"name" : "visibilityEl",
"type" : "string|object",
- "desc" : "t) What element to use for visibility (@see getVisibilityEl())",
- "memberOf" : "Roo.bootstrap.Component"
+ "desc" : "t) What element to use for visibility (@see getVisibilityEl(",
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : [
+ "el",
+ "parent"
+ ]
},
{
"name" : "weight",
"type" : "String",
- "desc" : "e) default is light.",
- "memberOf" : ""
+ "desc" : "e) default is ligh",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : [
+ "light",
+ "primary",
+ "secondary",
+ "success",
+ "danger",
+ "warning",
+ "info",
+ "dark",
+ "white"
+ ]
},
{
"name" : "xattr",
"type" : "Object",
"desc" : "extra attributes to add to 'element' (used by builder to store stuff.)",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
}
],
"events" : [
],
"isAbstract" : false,
"isBuilderTop" : false,
- "childClasses" : {
- "Roo.bootstrap.nav.Simplebar" : [
- "Roo.bootstrap.PagingToolbar",
- "Roo.bootstrap.PopoverNav",
- "Roo.bootstrap.form.HtmlEditorToolbarStandard",
- "Roo.bootstrap.nav.Headerbar"
- ]
- },
+ "implementations" : [
+ "Roo.bootstrap.PagingToolbar",
+ "Roo.bootstrap.PopoverNav",
+ "Roo.bootstrap.form.HtmlEditorToolbarStandard",
+ "Roo.bootstrap.nav.Headerbar"
+ ],
"tree_children" : [
"Roo.bootstrap.nav.Group",
- "Roo.bootstrap.Container",
"Roo.bootstrap.form.Form",
"Roo.bootstrap.Row",
"Roo.bootstrap.Column",
"methods" : [],
"isAbstract" : false,
"isBuilderTop" : false,
- "childClasses" : { },
+ "implementations" : [],
"tree_children" : [],
"tree_parent" : []
},
"name" : "adjustments",
"type" : "Array",
"desc" : "Values to <b>add</b> to the width/height when doing a {@link #fitToFrame} (default is [0, 0])",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"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" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "autoScroll",
"type" : "Boolean",
"desc" : "True to scroll overflow in this panel (use with {@link #fitToFrame})",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "background",
"type" : "Boolean",
"desc" : "True if the panel should not be activated when it is added (defaults to false)",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "badges",
"type" : "Boolean",
"desc" : "render the badges",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "closable",
"type" : "Boolean",
"desc" : "True if the panel can be closed/removed",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "cls",
"type" : "String",
"desc" : "extra classes to use",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "content",
"type" : "String",
"desc" : "Raw content to fill content panel with (uses setContent on construction.)",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "fitContainer",
"type" : "Boolean",
"desc" : "When using {@link #fitToFrame} and {@link #resizeEl}, you can also fit the parent container (defaults to false)",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "fitToFrame",
"type" : "Boolean",
"desc" : "True for this panel to adjust its size to fit when the region resizes (defaults to false)",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "iframe",
"type" : "Boolean",
"desc" : "contents are an iframe - makes showing remote sources/CSS feasible..",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"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"
+ "memberOf" : "Roo.util.Observable",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "loadOnce",
"type" : "Boolean",
"desc" : "When used with {@link #url}, calls {@link #setUrl} with this value",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "params",
"type" : "String/Object",
"desc" : "When used with {@link #url}, calls {@link #setUrl} with this value",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "region",
"type" : "String",
- "desc" : "[required] (center|north|south|east|west) which region to put this panel on (when used with xtype constructors)",
- "memberOf" : ""
+ "desc" : "(center|north|south|east|west) which region to put this panel on (when used with xtype constructors)",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "resizeEl",
"type" : "String/HTMLElement/Element",
"desc" : "An element to resize if {@link #fitToFrame} is true (instead of this panel's element)",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "title",
"type" : "String",
"desc" : "The title for this panel",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "toolbar",
"type" : "Toolbar",
"desc" : "A toolbar for this panel",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "url",
"type" : "String",
"desc" : "Calls {@link #setUrl} with this value",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
}
],
"events" : [
}
],
"isAbstract" : false,
- "isBuilderTop" : true,
- "childClasses" : {
- "Roo.bootstrap.panel.Content" : [
- "Roo.bootstrap.panel.Grid",
- "Roo.bootstrap.panel.Nest"
- ]
- },
+ "isBuilderTop" : false,
+ "implementations" : [
+ "Roo.bootstrap.panel.Grid",
+ "Roo.bootstrap.panel.Nest"
+ ],
"tree_children" : [
"Roo.bootstrap.Alert",
"Roo.bootstrap.BezierSignature",
"Roo.bootstrap.Calendar",
"Roo.bootstrap.Card",
"Roo.bootstrap.Column",
- "Roo.bootstrap.Container",
"Roo.bootstrap.DocumentManager",
"Roo.bootstrap.DocumentSlider",
"Roo.bootstrap.DocumentViewer",
"Roo.bootstrap.form.TextArea",
"Roo.bootstrap.form.TimeField",
"Roo.bootstrap.form.TriggerField",
- "Roo.bootstrap.layout.Border",
"Roo.bootstrap.nav.Group",
"Roo.bootstrap.nav.Headerbar",
"Roo.bootstrap.nav.ProgressBar",
"Roo.bootstrap.nav.SidebarItem",
"Roo.bootstrap.nav.Simplebar"
],
- "tree_parent" : []
+ "tree_parent" : [
+ "builder",
+ "Roo.bootstrap.layout.Border"
+ ]
},
"Roo.bootstrap.panel.Grid" : {
"props" : [
"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.bootstrap.panel.Content"
+ "memberOf" : "Roo.bootstrap.panel.Content",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "autoCreate",
"type" : "Boolean/Object",
"desc" : "True to auto generate the DOM element for this panel, or a {@link Roo.DomHelper} config of the element to create",
- "memberOf" : "Roo.bootstrap.panel.Content"
+ "memberOf" : "Roo.bootstrap.panel.Content",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "autoScroll",
"type" : "Boolean",
"desc" : "True to scroll overflow in this panel (use with {@link #fitToFrame})",
- "memberOf" : "Roo.bootstrap.panel.Content"
+ "memberOf" : "Roo.bootstrap.panel.Content",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "background",
"type" : "Boolean",
"desc" : "True if the panel should not be activated when it is added (defaults to false)",
- "memberOf" : "Roo.bootstrap.panel.Content"
+ "memberOf" : "Roo.bootstrap.panel.Content",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "badges",
"type" : "Boolean",
"desc" : "render the badges",
- "memberOf" : "Roo.bootstrap.panel.Content"
+ "memberOf" : "Roo.bootstrap.panel.Content",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "closable",
"type" : "Boolean",
"desc" : "True if the panel can be closed/removed",
- "memberOf" : "Roo.bootstrap.panel.Content"
+ "memberOf" : "Roo.bootstrap.panel.Content",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "cls",
"type" : "String",
"desc" : "extra classes to use",
- "memberOf" : "Roo.bootstrap.panel.Content"
+ "memberOf" : "Roo.bootstrap.panel.Content",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "content",
"type" : "String",
"desc" : "Raw content to fill content panel with (uses setContent on construction.)",
- "memberOf" : "Roo.bootstrap.panel.Content"
+ "memberOf" : "Roo.bootstrap.panel.Content",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "fitContainer",
"type" : "Boolean",
"desc" : "When using {@link #fitToFrame} and {@link #resizeEl}, you can also fit the parent container (defaults to false)",
- "memberOf" : "Roo.bootstrap.panel.Content"
+ "memberOf" : "Roo.bootstrap.panel.Content",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "fitToFrame",
"type" : "Boolean",
"desc" : "True for this panel to adjust its size to fit when the region resizes (defaults to false)",
- "memberOf" : "Roo.bootstrap.panel.Content"
+ "memberOf" : "Roo.bootstrap.panel.Content",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "grid",
"type" : "Roo.bootstrap.Table",
"desc" : "The grid for this panel",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "iframe",
"type" : "Boolean",
"desc" : "contents are an iframe - makes showing remote sources/CSS feasible..",
- "memberOf" : "Roo.bootstrap.panel.Content"
+ "memberOf" : "Roo.bootstrap.panel.Content",
+ "isOptional" : false,
+ "optvals" : []
},
{
"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"
+ "memberOf" : "Roo.util.Observable",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "loadOnce",
"type" : "Boolean",
"desc" : "When used with {@link #url}, calls {@link #setUrl} with this value",
- "memberOf" : "Roo.bootstrap.panel.Content"
+ "memberOf" : "Roo.bootstrap.panel.Content",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "params",
"type" : "String/Object",
"desc" : "When used with {@link #url}, calls {@link #setUrl} with this value",
- "memberOf" : "Roo.bootstrap.panel.Content"
+ "memberOf" : "Roo.bootstrap.panel.Content",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "region",
"type" : "String",
- "desc" : "[required] (center|north|south|east|west) which region to put this panel on (when used with xtype constructors)",
- "memberOf" : "Roo.bootstrap.panel.Content"
+ "desc" : "(center|north|south|east|west) which region to put this panel on (when used with xtype constructors)",
+ "memberOf" : "Roo.bootstrap.panel.Content",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "resizeEl",
"type" : "String/HTMLElement/Element",
"desc" : "An element to resize if {@link #fitToFrame} is true (instead of this panel's element)",
- "memberOf" : "Roo.bootstrap.panel.Content"
+ "memberOf" : "Roo.bootstrap.panel.Content",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "title",
"type" : "String",
"desc" : "The title for this panel",
- "memberOf" : "Roo.bootstrap.panel.Content"
+ "memberOf" : "Roo.bootstrap.panel.Content",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "toolbar",
"type" : "Roo.bootstrap.nav.Simplebar",
"desc" : "the toolbar at the top of the grid.",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "url",
"type" : "String",
"desc" : "Calls {@link #setUrl} with this value",
- "memberOf" : "Roo.bootstrap.panel.Content"
+ "memberOf" : "Roo.bootstrap.panel.Content",
+ "isOptional" : false,
+ "optvals" : []
}
],
"events" : [
],
"isAbstract" : false,
"isBuilderTop" : false,
- "childClasses" : { },
+ "implementations" : [],
"tree_children" : [],
"tree_parent" : []
},
"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.bootstrap.panel.Content"
+ "memberOf" : "Roo.bootstrap.panel.Content",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "autoCreate",
"type" : "Boolean/Object",
"desc" : "True to auto generate the DOM element for this panel, or a {@link Roo.DomHelper} config of the element to create",
- "memberOf" : "Roo.bootstrap.panel.Content"
+ "memberOf" : "Roo.bootstrap.panel.Content",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "autoScroll",
"type" : "Boolean",
"desc" : "True to scroll overflow in this panel (use with {@link #fitToFrame})",
- "memberOf" : "Roo.bootstrap.panel.Content"
+ "memberOf" : "Roo.bootstrap.panel.Content",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "background",
"type" : "Boolean",
"desc" : "True if the panel should not be activated when it is added (defaults to false)",
- "memberOf" : "Roo.bootstrap.panel.Content"
+ "memberOf" : "Roo.bootstrap.panel.Content",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "badges",
"type" : "Boolean",
"desc" : "render the badges",
- "memberOf" : "Roo.bootstrap.panel.Content"
+ "memberOf" : "Roo.bootstrap.panel.Content",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "closable",
"type" : "Boolean",
"desc" : "True if the panel can be closed/removed",
- "memberOf" : "Roo.bootstrap.panel.Content"
+ "memberOf" : "Roo.bootstrap.panel.Content",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "cls",
"type" : "String",
"desc" : "extra classes to use",
- "memberOf" : "Roo.bootstrap.panel.Content"
+ "memberOf" : "Roo.bootstrap.panel.Content",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "content",
"type" : "String",
"desc" : "Raw content to fill content panel with (uses setContent on construction.)",
- "memberOf" : "Roo.bootstrap.panel.Content"
+ "memberOf" : "Roo.bootstrap.panel.Content",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "fitContainer",
"type" : "Boolean",
"desc" : "When using {@link #fitToFrame} and {@link #resizeEl}, you can also fit the parent container (defaults to false)",
- "memberOf" : "Roo.bootstrap.panel.Content"
+ "memberOf" : "Roo.bootstrap.panel.Content",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "fitToFrame",
"type" : "Boolean",
"desc" : "True for this panel to adjust its size to fit when the region resizes (defaults to false)",
- "memberOf" : "Roo.bootstrap.panel.Content"
+ "memberOf" : "Roo.bootstrap.panel.Content",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "iframe",
"type" : "Boolean",
"desc" : "contents are an iframe - makes showing remote sources/CSS feasible..",
- "memberOf" : "Roo.bootstrap.panel.Content"
+ "memberOf" : "Roo.bootstrap.panel.Content",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "layout",
"type" : "Roo.BorderLayout",
"desc" : "The layout for this panel",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"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"
+ "memberOf" : "Roo.util.Observable",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "loadOnce",
"type" : "Boolean",
"desc" : "When used with {@link #url}, calls {@link #setUrl} with this value",
- "memberOf" : "Roo.bootstrap.panel.Content"
+ "memberOf" : "Roo.bootstrap.panel.Content",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "params",
"type" : "String/Object",
"desc" : "When used with {@link #url}, calls {@link #setUrl} with this value",
- "memberOf" : "Roo.bootstrap.panel.Content"
+ "memberOf" : "Roo.bootstrap.panel.Content",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "region",
"type" : "String",
- "desc" : "[required] (center|north|south|east|west) which region to put this panel on (when used with xtype constructors)",
- "memberOf" : "Roo.bootstrap.panel.Content"
+ "desc" : "(center|north|south|east|west) which region to put this panel on (when used with xtype constructors)",
+ "memberOf" : "Roo.bootstrap.panel.Content",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "resizeEl",
"type" : "String/HTMLElement/Element",
"desc" : "An element to resize if {@link #fitToFrame} is true (instead of this panel's element)",
- "memberOf" : "Roo.bootstrap.panel.Content"
+ "memberOf" : "Roo.bootstrap.panel.Content",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "title",
"type" : "String",
"desc" : "The title for this panel",
- "memberOf" : "Roo.bootstrap.panel.Content"
+ "memberOf" : "Roo.bootstrap.panel.Content",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "toolbar",
"type" : "Toolbar",
"desc" : "A toolbar for this panel",
- "memberOf" : "Roo.bootstrap.panel.Content"
+ "memberOf" : "Roo.bootstrap.panel.Content",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "url",
"type" : "String",
"desc" : "Calls {@link #setUrl} with this value",
- "memberOf" : "Roo.bootstrap.panel.Content"
+ "memberOf" : "Roo.bootstrap.panel.Content",
+ "isOptional" : false,
+ "optvals" : []
}
],
"events" : [
],
"isAbstract" : false,
"isBuilderTop" : false,
- "childClasses" : { },
+ "implementations" : [],
"tree_children" : [],
"tree_parent" : []
},
"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"
+ "memberOf" : "Roo.util.Observable",
+ "isOptional" : false,
+ "optvals" : []
}
],
"events" : [
],
"isAbstract" : false,
"isBuilderTop" : false,
- "childClasses" : { },
+ "implementations" : [],
"tree_children" : [],
"tree_parent" : []
},
"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"
+ "memberOf" : "Roo.util.Observable",
+ "isOptional" : false,
+ "optvals" : []
}
],
"events" : [
],
"isAbstract" : false,
"isBuilderTop" : false,
- "childClasses" : { },
+ "implementations" : [],
"tree_children" : [],
"tree_parent" : []
},
"methods" : [],
"isAbstract" : false,
"isBuilderTop" : false,
- "childClasses" : { },
+ "implementations" : [],
"tree_children" : [],
"tree_parent" : []
},
"name" : "fields",
"type" : "Array",
"desc" : "Array of field definition objects",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "id",
"type" : "String",
"desc" : "Name of the property within a row object that contains a record identifier value.\nas specified to {@link Roo.data.Record#create},\nor an {@link Roo.data.Record} object\n\n\ncreated using {@link Roo.data.Record#create}.",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
}
],
"events" : [],
],
"isAbstract" : false,
"isBuilderTop" : false,
- "childClasses" : { },
+ "implementations" : [],
"tree_children" : [],
"tree_parent" : []
},
{
"name" : "autoAbort",
"type" : "Boolean",
- "desc" : "(Optional) Whether this request should abort any pending requests. (defaults to false)",
- "memberOf" : ""
+ "desc" : "Whether this request should abort any pending requests. (defaults to false)",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"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" : ""
+ "desc" : "An object containing request headers which are added\n to each request made by this object. (defaults to undefined)",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "disableCaching",
"type" : "Boolean",
- "desc" : "(Optional) True to add a unique cache-buster param to GET requests. (defaults to true)",
- "memberOf" : ""
+ "desc" : "True to add a unique cache-buster param to GET requests. (defaults to true)",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"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" : "An object containing properties which are used as\nextra parameters to each request made by this object. (defaults to undefined)",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"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"
+ "memberOf" : "Roo.util.Observable",
+ "isOptional" : false,
+ "optvals" : []
},
{
"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" : ""
+ "desc" : "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" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "timeout",
"type" : "Number",
- "desc" : "(Optional) The timeout in milliseconds to be used for requests. (defaults to 30000)",
- "memberOf" : ""
+ "desc" : "The timeout in milliseconds to be used for requests. (defaults to 30000)",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "url",
"type" : "String",
- "desc" : "(Optional) The default URL to be used for requests to the server. (defaults to undefined)",
- "memberOf" : ""
+ "desc" : "The default URL to be used for requests to the server. (defaults to undefined)",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
}
],
"events" : [
{
"name" : "transactionId",
"type" : "Number",
- "desc" : "(Optional) defaults to the last transaction",
+ "desc" : "defaults to the last transaction",
"isOptional" : false
}
],
{
"name" : "transactionId",
"type" : "Number",
- "desc" : "(Optional) defaults to the last transaction",
+ "desc" : "defaults to the last transaction",
"isOptional" : false
}
],
{
"name" : "options",
"type" : "Object",
- "desc" : "An object which may contain the following properties:<ul>\n<li><b>url</b> {String} (Optional) The URL to which to send the request. Defaults to configured URL</li>\n<li><b>params</b> {Object/String/Function} (Optional) An object containing properties which are used as parameters to the\nrequest, a url encoded string or a function to call to get either.</li>\n<li><b>method</b> {String} (Optional) The HTTP method to use for the request. Defaults to the configured method, or\nif no method was configured, \"GET\" if no parameters are being sent, and \"POST\" if parameters are being sent.</li>\n<li><b>callback</b> {Function} (Optional) The function to be called upon receipt of the HTTP response.\nThe callback is called regardless of success or failure and is passed the following parameters:<ul>\n<li>options {Object} The parameter to the request call.</li>\n<li>success {Boolean} True if the request succeeded.</li>\n<li>response {Object} The XMLHttpRequest object containing the response data.</li>\n</ul></li>\n<li><b>success</b> {Function} (Optional) The function to be called upon success of the request.\nThe callback is passed the following parameters:<ul>\n<li>response {Object} The XMLHttpRequest object containing the response data.</li>\n<li>options {Object} The parameter to the request call.</li>\n</ul></li>\n<li><b>failure</b> {Function} (Optional) The function to be called upon failure of the request.\nThe callback is passed the following parameters:<ul>\n<li>response {Object} The XMLHttpRequest object containing the response data.</li>\n<li>options {Object} The parameter to the request call.</li>\n</ul></li>\n<li><b>scope</b> {Object} (Optional) The scope in which to execute the callbacks: The \"this\" object\nfor the callback function. Defaults to the browser window.</li>\n<li><b>form</b> {Object/String} (Optional) A form object or id to pull parameters from.</li>\n<li><b>isUpload</b> {Boolean} (Optional) True if the form object is a file upload (will usually be automatically detected).</li>\n<li><b>headers</b> {Object} (Optional) Request headers to set for the request.</li>\n<li><b>xmlData</b> {Object} (Optional) XML document to use for the post. Note: This will be used instead of\nparams for the post data. Any params will be appended to the URL.</li>\n<li><b>disableCaching</b> {Boolean} (Optional) True to add a unique cache-buster param to GET requests.</li>\n</ul>",
+ "desc" : "An object which may contain the following properties:<ul>\n<li><b>url</b> {String} The URL to which to send the request. Defaults to configured URL</li>\n<li><b>params</b> {Object/String/Function} An object containing properties which are used as parameters to the\nrequest, a url encoded string or a function to call to get either.</li>\n<li><b>method</b> {String} The HTTP method to use for the request. Defaults to the configured method, or\nif no method was configured, \"GET\" if no parameters are being sent, and \"POST\" if parameters are being sent.</li>\n<li><b>callback</b> {Function} The function to be called upon receipt of the HTTP response.\nThe callback is called regardless of success or failure and is passed the following parameters:<ul>\n<li>options {Object} The parameter to the request call.</li>\n<li>success {Boolean} True if the request succeeded.</li>\n<li>response {Object} The XMLHttpRequest object containing the response data.</li>\n</ul></li>\n<li><b>success</b> {Function} The function to be called upon success of the request.\nThe callback is passed the following parameters:<ul>\n<li>response {Object} The XMLHttpRequest object containing the response data.</li>\n<li>options {Object} The parameter to the request call.</li>\n</ul></li>\n<li><b>failure</b> {Function} The function to be called upon failure of the request.\nThe callback is passed the following parameters:<ul>\n<li>response {Object} The XMLHttpRequest object containing the response data.</li>\n<li>options {Object} The parameter to the request call.</li>\n</ul></li>\n<li><b>scope</b> {Object} The scope in which to execute the callbacks: The \"this\" object\nfor the callback function. Defaults to the browser window.</li>\n<li><b>form</b> {Object/String} A form object or id to pull parameters from.</li>\n<li><b>isUpload</b> {Boolean} True if the form object is a file upload (will usually be automatically detected).</li>\n<li><b>headers</b> {Object} Request headers to set for the request.</li>\n<li><b>xmlData</b> {Object} XML document to use for the post. Note: This will be used instead of\nparams for the post data. Any params will be appended to the URL.</li>\n<li><b>disableCaching</b> {Boolean} True to add a unique cache-buster param to GET requests.</li>\n</ul>",
"isOptional" : false
}
],
],
"isAbstract" : false,
"isBuilderTop" : false,
- "childClasses" : {
- "Roo.data.Connection" : [
- "Roo.Ajax"
- ]
- },
+ "implementations" : [
+ "Roo.Ajax"
+ ],
"tree_children" : [],
"tree_parent" : []
},
"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"
+ "memberOf" : "Roo.util.Observable",
+ "isOptional" : false,
+ "optvals" : []
}
],
"events" : [
],
"isAbstract" : true,
"isBuilderTop" : false,
- "childClasses" : {
- "Roo.data.DataProxy" : [
- "Roo.data.HttpProxy"
- ]
- },
+ "implementations" : [
+ "Roo.data.HttpProxy",
+ "Roo.data.MemoryProxy"
+ ],
"tree_children" : [],
"tree_parent" : []
},
],
"isAbstract" : true,
"isBuilderTop" : false,
- "childClasses" : {
- "Roo.data.DataReader" : [
- "Roo.data.ArrayReader",
- "Roo.data.JsonReader",
- "Roo.data.XmlReader"
- ]
- },
+ "implementations" : [
+ "Roo.data.ArrayReader",
+ "Roo.data.JsonReader",
+ "Roo.data.XmlReader"
+ ],
"tree_children" : [],
"tree_parent" : []
},
{
"name" : "autoAbort",
"type" : "Boolean",
- "desc" : "(Optional) Whether this request should abort any pending requests. (defaults to false)",
- "memberOf" : ""
+ "desc" : "Whether this request should abort any pending requests. (defaults to false)",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"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" : ""
+ "desc" : "An object containing request headers which are added\n to each request made by this object. (defaults to undefined)",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "disableCaching",
"type" : "Boolean",
- "desc" : "(Optional) True to add a unique cache-buster param to GET requests. (defaults to true)",
- "memberOf" : ""
+ "desc" : "True to add a unique cache-buster param to GET requests. (defaults to true)",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"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" : "An object containing properties which are used as\nextra parameters to each request made by this object. (defaults to undefined)",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"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"
+ "memberOf" : "Roo.util.Observable",
+ "isOptional" : false,
+ "optvals" : []
},
{
"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" : ""
+ "desc" : "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" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "timeout",
"type" : "Number",
- "desc" : "(Optional) The timeout in milliseconds to be used for requests. (defaults to 30000)",
- "memberOf" : ""
+ "desc" : "The timeout in milliseconds to be used for requests. (defaults to 30000)",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "url",
"type" : "String",
- "desc" : "(Optional) The default URL to be used for requests to the server. (defaults to undefined)",
- "memberOf" : ""
+ "desc" : "The default URL to be used for requests to the server. (defaults to undefined)",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
}
],
"events" : [
],
"isAbstract" : false,
"isBuilderTop" : false,
- "childClasses" : { },
+ "implementations" : [],
"tree_children" : [],
"tree_parent" : []
},
"name" : "fields",
"type" : "Array",
"desc" : "Array of field definition objects",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "id",
"type" : "String",
"desc" : "Name of the property within a row object that contains a record identifier value.",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "root",
"type" : "String",
"desc" : "name of the property which contains the Array of row objects.",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "successProperty",
"type" : "String",
"desc" : "Name of the property from which to retrieve the success attribute used by forms.",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"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" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
}
],
"events" : [],
],
"isAbstract" : false,
"isBuilderTop" : false,
- "childClasses" : { },
+ "implementations" : [],
"tree_children" : [],
"tree_parent" : []
},
"name" : "baseParams",
"type" : "Object",
"desc" : "An object containing properties which are to be sent as parameters\non any HTTP request",
- "memberOf" : "Roo.data.Store"
+ "memberOf" : "Roo.data.Store",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "data",
"type" : "Array",
"desc" : "Inline data to be loaded when the store is initialized.",
- "memberOf" : "Roo.data.Store"
+ "memberOf" : "Roo.data.Store",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "fields",
"type" : "Array",
"desc" : "An array of field definition objects, or field name strings.",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"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"
+ "memberOf" : "Roo.data.Store",
+ "isOptional" : false,
+ "optvals" : []
},
{
"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"
+ "memberOf" : "Roo.util.Observable",
+ "isOptional" : false,
+ "optvals" : []
},
{
"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"
+ "memberOf" : "Roo.data.Store",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "proxy",
"type" : "Roo.data.DataProxy",
- "desc" : "[required] The Proxy object which provides access to a data object.",
- "memberOf" : "Roo.data.Store"
+ "desc" : "The Proxy object which provides access to a data object.",
+ "memberOf" : "Roo.data.Store",
+ "isOptional" : false,
+ "optvals" : []
},
{
"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"
+ "memberOf" : "Roo.data.Store",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "reader",
"type" : "Roo.data.DataReader",
- "desc" : "[required] The Reader object which processes the data object and returns\nan Array of Roo.data.record objects which are cached keyed by their <em>id</em> property.",
- "memberOf" : "Roo.data.Store"
+ "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",
+ "isOptional" : false,
+ "optvals" : []
},
{
"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"
+ "memberOf" : "Roo.data.Store",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "sortInfo",
"type" : "Object",
"desc" : "A config object in the format: {field: \"fieldName\", direction: \"ASC|DESC\"}",
- "memberOf" : "Roo.data.Store"
+ "memberOf" : "Roo.data.Store",
+ "isOptional" : false,
+ "optvals" : []
}
],
"events" : [
{
"name" : "options",
"type" : "Object",
- "desc" : "An object containing properties which control loading options:<ul>\n<li>params {Object} An object containing properties to pass as HTTP parameters to a remote data source.</li>\n<li>callback {Function} A function to be called after the Records have been loaded. The callback is\npassed the following arguments:<ul>\n<li>r : Roo.data.Record[]</li>\n<li>options: Options object from the load call</li>\n<li>success: Boolean success indicator</li></ul></li>\n<li>scope {Object} Scope with which to call the callback (defaults to the Store object)</li>\n<li>add {Boolean} indicator to append loaded records rather than replace the current cache.</li>\n</ul>",
+ "desc" : "An object containing properties which control loading options:<ul>\n<li>params {Object} An object containing properties to pass as HTTP parameters to a remote data source.</li>\n<li>
params.data {Object} if you are using a MemoryProxy / JsonReader, use this as the data to load stuff..\n<pre>\n {\n data : data, // array of key=>value data like JsonReader\n total : data.length,\n success : true\n \n }\n </pre>\n }.</li>\n<li>callback {Function} A function to be called after the Records have been loaded. The callback is\npassed the following arguments:<ul>\n<li>r : Roo.data.Record[]</li>\n<li>options: Options object from the load call</li>\n<li>success: Boolean success indicator</li></ul></li>\n<li>scope {Object} Scope with which to call the callback (defaults to the Store object)</li>\n<li>add {Boolean} indicator to append loaded records rather than replace the current cache.</li>\n</ul>",
"isOptional" : false
}
],
{
"name" : "append",
"type" : "Boolean",
- "desc" : "(Optional) True to append the new Records rather than replace the existing cache.",
+ "desc" : "True to append the new Records rather than replace the existing cache.",
"isOptional" : false
}
],
],
"isAbstract" : false,
"isBuilderTop" : false,
- "childClasses" : { },
+ "implementations" : [],
"tree_children" : [],
"tree_parent" : []
},
"Roo.data.MemoryProxy" : {
- "props" : [],
- "events" : [],
+ "props" : [
+ {
+ "name" : "data",
+ "type" : "Object",
+ "desc" : "The data object which the Reader uses to construct a block of Roo.data.Records.",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "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",
+ "isOptional" : false,
+ "optvals" : []
+ }
+ ],
+ "events" : [
+ {
+ "name" : "beforeload",
+ "type" : "function",
+ "desc" : "Fires before a network request is made to retrieve a data object.",
+ "sig" : "function (This, params)\n{\n\n}",
+ "memberOf" : "Roo.data.DataProxy",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "This",
+ "type" : "Object",
+ "desc" : "DataProxy object.",
+ "isOptional" : false
+ },
+ {
+ "name" : "params",
+ "type" : "Object",
+ "desc" : "The params parameter to the load function.",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "load",
+ "type" : "function",
+ "desc" : "Fires before the load method's callback is called.",
+ "sig" : "function (This, o, arg)\n{\n\n}",
+ "memberOf" : "Roo.data.DataProxy",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "This",
+ "type" : "Object",
+ "desc" : "DataProxy object.",
+ "isOptional" : false
+ },
+ {
+ "name" : "o",
+ "type" : "Object",
+ "desc" : "The data object.",
+ "isOptional" : false
+ },
+ {
+ "name" : "arg",
+ "type" : "Object",
+ "desc" : "The callback argument object passed to the load function.",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "loadexception",
+ "type" : "function",
+ "desc" : "Fires if an Exception occurs during data retrieval.",
+ "sig" : "function (This, o, arg, e)\n{\n\n}",
+ "memberOf" : "Roo.data.DataProxy",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "This",
+ "type" : "Object",
+ "desc" : "DataProxy object.",
+ "isOptional" : false
+ },
+ {
+ "name" : "o",
+ "type" : "Object",
+ "desc" : "The data object.",
+ "isOptional" : false
+ },
+ {
+ "name" : "arg",
+ "type" : "Object",
+ "desc" : "The callback argument object passed to the load function.",
+ "isOptional" : false
+ },
+ {
+ "name" : "e",
+ "type" : "Object",
+ "desc" : "The Exception.",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ }
+ ],
"methods" : [
+ {
+ "name" : "addEvents",
+ "type" : "function",
+ "desc" : "Used to define events on this Observable",
+ "sig" : "(object)",
+ "static" : false,
+ "memberOf" : "Roo.util.Observable",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "object",
+ "type" : "Object",
+ "desc" : "The object with the events defined",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "addListener",
+ "type" : "function",
+ "desc" : "Appends an event handler to this component",
+ "sig" : "(eventName, handler, scope, options)",
+ "static" : false,
+ "memberOf" : "Roo.util.Observable",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "eventName",
+ "type" : "String",
+ "desc" : "The type of event to listen for",
+ "isOptional" : false
+ },
+ {
+ "name" : "handler",
+ "type" : "Function",
+ "desc" : "The method the event invokes",
+ "isOptional" : false
+ },
+ {
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
+ "isOptional" : false
+ },
+ {
+ "name" : "options",
+ "type" : "Object",
+ "desc" : "(optional) An object containing handler configuration\nproperties. This may contain any of the following properties:<ul>\n<li>scope {Object} The scope in which to execute the handler function. The handler function's \"this\" context.</li>\n<li>delay {Number} The number of milliseconds to delay the invocation of the handler after te event fires.</li>\n<li>single {Boolean} True to add a handler to handle just the next firing of the event, and then remove itself.</li>\n<li>buffer {Number} Causes the handler to be scheduled to run in an {@link Roo.util.DelayedTask} delayed\nby the specified number of milliseconds. If the event fires again within that time, the original\nhandler is <em>not</em> invoked, but the new handler is scheduled in its place.</li>\n</ul><br>\n<p>\n<b>Combining Options</b><br>\nUsing the options argument, it is possible to combine different types of listeners:<br>\n<br>\nA normalized, delayed, one-time listener that auto stops the event and passes a custom argument (forumId)\n\t\t<pre><code>\n\t\tel.on('click', this.onClick, this, {\n \t\t\tsingle: true,\n \t\tdelay: 100,\n \t\tforumId: 4\n\t\t});\n\t\t</code></pre>\n<p>\n<b>Attaching multiple handlers in 1 call</b><br>\nThe method also allows for a single argument to be passed which is a config object containing properties\nwhich specify multiple handlers.\n<pre><code>\n\t\tel.on({\n\t\t\t'click': {\n \t\tfn: this.onClick,\n \t\tscope: this,\n \t\tdelay: 100\n \t\t}, \n \t\t'mouseover': {\n \t\tfn: this.onMouseOver,\n \t\tscope: this\n \t\t},\n \t\t'mouseout': {\n \t\tfn: this.onMouseOut,\n \t\tscope: this\n \t\t}\n\t\t});\n\t\t</code></pre>\n<p>\nOr a shorthand syntax which passes the same scope object to all handlers:\n \t<pre><code>\n\t\tel.on({\n\t\t\t'click': this.onClick,\n \t\t'mouseover': this.onMouseOver,\n \t\t'mouseout': this.onMouseOut,\n \t\tscope: this\n\t\t});\n\t\t</code></pre>",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "capture",
+ "type" : "function",
+ "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\n<b>before</b> the event is fired. If the supplied function returns false,\nthe event will not fire.",
+ "sig" : "(o, fn, scope)",
+ "static" : true,
+ "memberOf" : "Roo.util.Observable",
+ "isStatic" : true,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "o",
+ "type" : "Observable",
+ "desc" : "The Observable to capture",
+ "isOptional" : false
+ },
+ {
+ "name" : "fn",
+ "type" : "Function",
+ "desc" : "The function to call",
+ "isOptional" : false
+ },
+ {
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "(optional) The scope (this object) for the fn",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "fireEvent",
+ "type" : "function",
+ "desc" : "Fires the specified event with the passed parameters (minus the event name).",
+ "sig" : "(eventName, args)",
+ "static" : false,
+ "memberOf" : "Roo.util.Observable",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "eventName",
+ "type" : "String",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "args",
+ "type" : "Object...",
+ "desc" : "Variable number of parameters are passed to handlers",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Boolean",
+ "desc" : "returns false if any of the handlers return false otherwise it returns true"
+ }
+ ]
+ },
+ {
+ "name" : "hasListener",
+ "type" : "function",
+ "desc" : "Checks to see if this object has any listeners for a specified event",
+ "sig" : "(eventName)",
+ "static" : false,
+ "memberOf" : "Roo.util.Observable",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "eventName",
+ "type" : "String",
+ "desc" : "The name of the event to check for",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Boolean",
+ "desc" : "True if the event is being listened for, else false"
+ }
+ ]
+ },
{
"name" : "load",
"type" : "function",
}
],
"returns" : []
+ },
+ {
+ "name" : "on",
+ "type" : "function",
+ "desc" : "Appends an event handler to this element (shorthand for addListener)",
+ "sig" : "(eventName, handler, scope, options)",
+ "static" : false,
+ "memberOf" : "Roo.util.Observable",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "eventName",
+ "type" : "String",
+ "desc" : "The type of event to listen for",
+ "isOptional" : false
+ },
+ {
+ "name" : "handler",
+ "type" : "Function",
+ "desc" : "The method the event invokes",
+ "isOptional" : false
+ },
+ {
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
+ "isOptional" : false
+ },
+ {
+ "name" : "options",
+ "type" : "Object",
+ "desc" : "(optional)",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "purgeListeners",
+ "type" : "function",
+ "desc" : "Removes all listeners for this object",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.util.Observable",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
+ {
+ "name" : "releaseCapture",
+ "type" : "function",
+ "desc" : "Removes <b>all</b> added captures from the Observable.",
+ "sig" : "(o)",
+ "static" : true,
+ "memberOf" : "Roo.util.Observable",
+ "isStatic" : true,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "o",
+ "type" : "Observable",
+ "desc" : "The Observable to release",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "removeListener",
+ "type" : "function",
+ "desc" : "Removes a listener",
+ "sig" : "(eventName, handler, scope)",
+ "static" : false,
+ "memberOf" : "Roo.util.Observable",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "eventName",
+ "type" : "String",
+ "desc" : "The type of event to listen for",
+ "isOptional" : false
+ },
+ {
+ "name" : "handler",
+ "type" : "Function",
+ "desc" : "The handler to remove",
+ "isOptional" : false
+ },
+ {
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "(optional) The scope (this object) for the handler",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "un",
+ "type" : "function",
+ "desc" : "Removes a listener (shorthand for removeListener)",
+ "sig" : "(eventName, handler, scope)",
+ "static" : false,
+ "memberOf" : "Roo.util.Observable",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "eventName",
+ "type" : "String",
+ "desc" : "The type of event to listen for",
+ "isOptional" : false
+ },
+ {
+ "name" : "handler",
+ "type" : "Function",
+ "desc" : "The handler to remove",
+ "isOptional" : false
+ },
+ {
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "(optional) The scope (this object) for the handler",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
}
],
"isAbstract" : false,
"isBuilderTop" : false,
- "childClasses" : { },
+ "implementations" : [],
"tree_children" : [],
"tree_parent" : []
},
"name" : "id",
"type" : "String",
"desc" : "The id for this node. If one is not specified, one is generated.",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "leaf",
"type" : "Boolean",
"desc" : "true if this node is a leaf and does not have children",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"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"
+ "memberOf" : "Roo.util.Observable",
+ "isOptional" : false,
+ "optvals" : []
}
],
"events" : [
],
"isAbstract" : false,
"isBuilderTop" : false,
- "childClasses" : {
- "Roo.data.Node" : [
- "Roo.tree.TreeNode"
- ],
- "Roo.tree.TreeNode" : [
- "Roo.tree.AsyncTreeNode"
- ]
- },
+ "implementations" : [
+ "Roo.tree.AsyncTreeNode",
+ "Roo.tree.TreeNode"
+ ],
"tree_children" : [],
"tree_parent" : []
},
{
"name" : "o",
"type" : "Array",
- "desc" : "An Array of field definition objects which specify field names, and optionally,\ndata types, and a mapping for an {@link Roo.data.Reader} to extract the field's value from a data object.\nEach field definition object may contain the following properties: <ul>\n<li><b>name</b> : String<p style=\"margin-left:1em\">The name by which the field is referenced within the Record. This is referenced by,\nfor example the <em>dataIndex</em> property in column definition objects passed to {@link Roo.grid.ColumnModel}</p></li>\n<li><b>mapping</b> : String<p style=\"margin-left:1em\">
(Optional) A path specification for use by the {@link Roo.data.Reader} implementation\nthat is creating the Record to access the data value from the data object. If an {@link Roo.data.JsonReader}\nis being used, then this is a string containing the javascript expression to reference the data relative to \nthe record item's root. If an {@link Roo.data.XmlReader} is being used, this is an {@link Roo.DomQuery} path\nto the data item relative to the record element. If the mapping expression is the same as the field name,\nthis may be omitted.</p></li>\n<li><b>type</b> : String<p style=\"margin-left:1em\">(Optional) The data type for conversion to displayable value. Possible values are\n<ul><li>auto (Default, implies no conversion)</li>\n<li>string</li>\n<li>int</li>\n<li>float</li>\n<li>boolean</li>\n<li>date</li></ul></p></li>\n<li><b>sortType</b> : Mixed<p style=\"margin-left:1em\">(Optional) A member of {@link Roo.data.SortTypes}.</p></li>\n<li><b>sortDir</b> : String<p style=\"margin-left:1em\">(Optional) Initial direction to sort. \"ASC\" or \"DESC\"</p></li>\n<li><b>convert</b> : Function<p style=\"margin-left:1em\">(Optional) A function which converts the value provided\nby the Reader into an object that will be stored in the Record. It is passed the\nfollowing parameters:<ul>\n<li><b>v</b> : Mixed<p style=\"margin-left:1em\">The data value as read by the Reader.</p></li>\n</ul></p></li>\n<li><b>dateFormat</b> : String<p style=\"margin-left:1em\">(Optional) A format String for the Date.parseDate function.</p></li>\n</ul>\n<br>usage:<br><pre><code>\nvar TopicRecord = Roo.data.Record.create(\n {name: 'title', mapping: 'topic_title'},\n {name: 'author', mapping: 'username'},\n {name: 'totalPosts', mapping: 'topic_replies', type: 'int'},\n {name: 'lastPost', mapping: 'post_time', type: 'date'},\n {name: 'lastPoster', mapping: 'user2'},\n {name: 'excerpt', mapping: 'post_text'}\n);\n\nvar myNewRecord = new TopicRecord({\n title: 'Do my job please',\n author: 'noobie',\n totalPosts: 1,\n lastPost: new Date(),\n lastPoster: 'Animal',\n excerpt: 'No way dude!'\n});\nmyStore.add(myNewRecord);\n</code></pre>",
+ "desc" : "An Array of field definition objects which specify field names, and optionally,\ndata types, and a mapping for an {@link Roo.data.Reader} to extract the field's value from a data object.\nEach field definition object may contain the following properties: <ul>\n<li><b>name</b> : String<p style=\"margin-left:1em\">The name by which the field is referenced within the Record. This is referenced by,\nfor example the <em>dataIndex</em> property in column definition objects passed to {@link Roo.grid.ColumnModel}</p></li>\n<li><b>mapping</b> : String<p style=\"margin-left:1em\">
A path specification for use by the {@link Roo.data.Reader} implementation\nthat is creating the Record to access the data value from the data object. If an {@link Roo.data.JsonReader}\nis being used, then this is a string containing the javascript expression to reference the data relative to \nthe record item's root. If an {@link Roo.data.XmlReader} is being used, this is an {@link Roo.DomQuery} path\nto the data item relative to the record element. If the mapping expression is the same as the field name,\nthis may be omitted.</p></li>\n<li><b>type</b> : String<p style=\"margin-left:1em\"> The data type for conversion to displayable value. Possible values are\n<ul><li>auto (Default, implies no conversion)</li>\n<li>string</li>\n<li>int</li>\n<li>float</li>\n<li>boolean</li>\n<li>date</li></ul></p></li>\n<li><b>sortType</b> : Mixed<p style=\"margin-left:1em\"> A member of {@link Roo.data.SortTypes}.</p></li>\n<li><b>sortDir</b> : String<p style=\"margin-left:1em\"> Initial direction to sort. \"ASC\" or \"DESC\"</p></li>\n<li><b>convert</b> : Function<p style=\"margin-left:1em\"> A function which converts the value provided\nby the Reader into an object that will be stored in the Record. It is passed the\nfollowing parameters:<ul>\n<li><b>v</b> : Mixed<p style=\"margin-left:1em\">The data value as read by the Reader.</p></li>\n</ul></p></li>\n<li><b>dateFormat</b> : String<p style=\"margin-left:1em\"> A format String for the Date.parseDate function.</p></li>\n</ul>\n<br>usage:<br><pre><code>\nvar TopicRecord = Roo.data.Record.create(\n {name: 'title', mapping: 'topic_title'},\n {name: 'author', mapping: 'username'},\n {name: 'totalPosts', mapping: 'topic_replies', type: 'int'},\n {name: 'lastPost', mapping: 'post_time', type: 'date'},\n {name: 'lastPoster', mapping: 'user2'},\n {name: 'excerpt', mapping: 'post_text'}\n);\n\nvar myNewRecord = new TopicRecord({\n title: 'Do my job please',\n author: 'noobie',\n totalPosts: 1,\n lastPost: new Date(),\n lastPoster: 'Animal',\n excerpt: 'No way dude!'\n});\nmyStore.add(myNewRecord);\n</code></pre>",
"isOptional" : false
}
],
],
"isAbstract" : false,
"isBuilderTop" : false,
- "childClasses" : { },
+ "implementations" : [],
"tree_children" : [],
"tree_parent" : []
},
{
"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" : ""
+ "desc" : "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" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "nocache",
"type" : "Boolean",
- "desc" : "(Optional) Defaults to true. Disable cacheing by adding a unique parameter\nname to the request.",
- "memberOf" : ""
+ "desc" : "Defaults to true. Disable cacheing by adding a unique parameter\nname to the request.",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "timeout",
"type" : "Number",
- "desc" : "(Optional) The number of milliseconds to wait for a response. Defaults to 30 seconds.",
- "memberOf" : ""
+ "desc" : "The number of milliseconds to wait for a response. Defaults to 30 seconds.",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "url",
"type" : "String",
"desc" : "The URL from which to request the data object.",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
}
],
"events" : [],
],
"isAbstract" : false,
"isBuilderTop" : false,
- "childClasses" : { },
+ "implementations" : [],
"tree_children" : [],
"tree_parent" : []
},
"name" : "an",
"type" : "Object",
"desc" : "existing reader (eg. copied from another store)",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "baseParams",
"type" : "Object",
"desc" : "An object containing properties which are to be sent as parameters\non any HTTP request",
- "memberOf" : "Roo.data.Store"
+ "memberOf" : "Roo.data.Store",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "data",
"type" : "Array",
"desc" : "The multi-dimensional array of data",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "fields",
"type" : "Array",
"desc" : "An array of field definition objects, or field name strings.",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "id",
"type" : "Number",
"desc" : "The array index of the record id. Leave blank to auto generate ids.",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"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"
+ "memberOf" : "Roo.data.Store",
+ "isOptional" : false,
+ "optvals" : []
},
{
"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"
+ "memberOf" : "Roo.util.Observable",
+ "isOptional" : false,
+ "optvals" : []
},
{
"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"
+ "memberOf" : "Roo.data.Store",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "proxy",
"type" : "Roo.data.DataProxy",
"desc" : "[not-required]",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"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"
+ "memberOf" : "Roo.data.Store",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "reader",
"type" : "Roo.data.Reader",
"desc" : "[not-required]",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"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"
+ "memberOf" : "Roo.data.Store",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "sortInfo",
"type" : "Object",
"desc" : "A config object in the format: {field: \"fieldName\", direction: \"ASC|DESC\"}",
- "memberOf" : "Roo.data.Store"
+ "memberOf" : "Roo.data.Store",
+ "isOptional" : false,
+ "optvals" : []
}
],
"events" : [
{
"name" : "options",
"type" : "Object",
- "desc" : "An object containing properties which control loading options:<ul>\n<li>params {Object} An object containing properties to pass as HTTP parameters to a remote data source.</li>\n<li>callback {Function} A function to be called after the Records have been loaded. The callback is\npassed the following arguments:<ul>\n<li>r : Roo.data.Record[]</li>\n<li>options: Options object from the load call</li>\n<li>success: Boolean success indicator</li></ul></li>\n<li>scope {Object} Scope with which to call the callback (defaults to the Store object)</li>\n<li>add {Boolean} indicator to append loaded records rather than replace the current cache.</li>\n</ul>",
+ "desc" : "An object containing properties which control loading options:<ul>\n<li>params {Object} An object containing properties to pass as HTTP parameters to a remote data source.</li>\n<li>
params.data {Object} if you are using a MemoryProxy / JsonReader, use this as the data to load stuff..\n<pre>\n {\n data : data, // array of key=>value data like JsonReader\n total : data.length,\n success : true\n \n }\n </pre>\n }.</li>\n<li>callback {Function} A function to be called after the Records have been loaded. The callback is\npassed the following arguments:<ul>\n<li>r : Roo.data.Record[]</li>\n<li>options: Options object from the load call</li>\n<li>success: Boolean success indicator</li></ul></li>\n<li>scope {Object} Scope with which to call the callback (defaults to the Store object)</li>\n<li>add {Boolean} indicator to append loaded records rather than replace the current cache.</li>\n</ul>",
"isOptional" : false
}
],
{
"name" : "append",
"type" : "Boolean",
- "desc" : "(Optional) True to append the new Records rather than replace the existing cache.",
+ "desc" : "True to append the new Records rather than replace the existing cache.",
"isOptional" : false
}
],
],
"isAbstract" : false,
"isBuilderTop" : false,
- "childClasses" : { },
+ "implementations" : [],
"tree_children" : [],
"tree_parent" : []
},
],
"isAbstract" : false,
"isBuilderTop" : false,
- "childClasses" : { },
+ "implementations" : [],
"tree_children" : [],
"tree_parent" : []
},
"name" : "baseParams",
"type" : "Object",
"desc" : "An object containing properties which are to be sent as parameters\non any HTTP request",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "data",
"type" : "Array",
"desc" : "Inline data to be loaded when the store is initialized.",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"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" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"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"
+ "memberOf" : "Roo.util.Observable",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "multiSort",
"type" : "Boolean",
"desc" : "enable multi column sorting (sort is based on the order of columns, remote only at present)",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "proxy",
"type" : "Roo.data.DataProxy",
- "desc" : "[required] The Proxy object which provides access to a data object.",
- "memberOf" : ""
+ "desc" : "The Proxy object which provides access to a data object.",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"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" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "reader",
"type" : "Roo.data.DataReader",
- "desc" : "[required] The Reader object which processes the data object and returns\nan Array of Roo.data.record objects which are cached keyed by their <em>id</em> property.",
- "memberOf" : ""
+ "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" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"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" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "sortInfo",
"type" : "Object",
"desc" : "A config object in the format: {field: \"fieldName\", direction: \"ASC|DESC\"}",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
}
],
"events" : [
{
"name" : "options",
"type" : "Object",
- "desc" : "An object containing properties which control loading options:<ul>\n<li>params {Object} An object containing properties to pass as HTTP parameters to a remote data source.</li>\n<li>callback {Function} A function to be called after the Records have been loaded. The callback is\npassed the following arguments:<ul>\n<li>r : Roo.data.Record[]</li>\n<li>options: Options object from the load call</li>\n<li>success: Boolean success indicator</li></ul></li>\n<li>scope {Object} Scope with which to call the callback (defaults to the Store object)</li>\n<li>add {Boolean} indicator to append loaded records rather than replace the current cache.</li>\n</ul>",
+ "desc" : "An object containing properties which control loading options:<ul>\n<li>params {Object} An object containing properties to pass as HTTP parameters to a remote data source.</li>\n<li>
params.data {Object} if you are using a MemoryProxy / JsonReader, use this as the data to load stuff..\n<pre>\n {\n data : data, // array of key=>value data like JsonReader\n total : data.length,\n success : true\n \n }\n </pre>\n }.</li>\n<li>callback {Function} A function to be called after the Records have been loaded. The callback is\npassed the following arguments:<ul>\n<li>r : Roo.data.Record[]</li>\n<li>options: Options object from the load call</li>\n<li>success: Boolean success indicator</li></ul></li>\n<li>scope {Object} Scope with which to call the callback (defaults to the Store object)</li>\n<li>add {Boolean} indicator to append loaded records rather than replace the current cache.</li>\n</ul>",
"isOptional" : false
}
],
{
"name" : "append",
"type" : "Boolean",
- "desc" : "(Optional) True to append the new Records rather than replace the existing cache.",
+ "desc" : "True to append the new Records rather than replace the existing cache.",
"isOptional" : false
}
],
],
"isAbstract" : false,
"isBuilderTop" : false,
- "childClasses" : {
- "Roo.data.Store" : [
- "Roo.data.JsonStore",
- "Roo.data.SimpleStore"
- ]
- },
+ "implementations" : [
+ "Roo.data.JsonStore",
+ "Roo.data.SimpleStore"
+ ],
"tree_children" : [],
"tree_parent" : []
},
"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"
+ "memberOf" : "Roo.util.Observable",
+ "isOptional" : false,
+ "optvals" : []
}
],
"events" : [
],
"isAbstract" : false,
"isBuilderTop" : false,
- "childClasses" : {
- "Roo.tree.TreePanel" : [
- "Roo.tree.ColumnTree"
- ],
- "Roo.data.Tree" : [
- "Roo.tree.TreePanel"
- ]
- },
+ "implementations" : [
+ "Roo.tree.ColumnTree",
+ "Roo.tree.TreePanel"
+ ],
"tree_children" : [],
"tree_parent" : []
},
"name" : "id",
"type" : "String",
"desc" : "The DomQuery path relative from the record element to the element that contains\na record identifier value.",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "record",
"type" : "String",
"desc" : "The DomQuery path to the repeated element which contains record information.",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "success",
"type" : "String",
"desc" : "The DomQuery path to the success attribute used by forms.",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"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" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
}
],
"events" : [],
],
"isAbstract" : false,
"isBuilderTop" : false,
- "childClasses" : { },
+ "implementations" : [],
"tree_children" : [],
"tree_parent" : []
},
"methods" : [],
"isAbstract" : false,
"isBuilderTop" : false,
- "childClasses" : { },
+ "implementations" : [],
"tree_children" : [],
"tree_parent" : []
},
"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"
+ "memberOf" : "Roo.util.Observable",
+ "isOptional" : false,
+ "optvals" : []
}
],
"events" : [],
],
"isAbstract" : false,
"isBuilderTop" : false,
- "childClasses" : {
- "Roo.dd.DDProxy" : [
- "Roo.dd.DragSource",
- "Roo.grid.SplitDragZone"
- ],
- "Roo.dd.DD" : [
- "Roo.dd.DDProxy"
- ],
- "Roo.dd.DragSource" : [
- "Roo.dd.DragZone"
- ]
- },
+ "implementations" : [
+ "Roo.dd.DDProxy",
+ "Roo.dd.DragSource",
+ "Roo.dd.DragZone",
+ "Roo.grid.SplitDragZone"
+ ],
"tree_children" : [],
"tree_parent" : []
},
"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"
+ "memberOf" : "Roo.util.Observable",
+ "isOptional" : false,
+ "optvals" : []
}
],
"events" : [],
],
"isAbstract" : false,
"isBuilderTop" : false,
- "childClasses" : {
- "Roo.dd.DDProxy" : [
- "Roo.dd.DragSource",
- "Roo.grid.SplitDragZone"
- ],
- "Roo.dd.DragSource" : [
- "Roo.dd.DragZone"
- ]
- },
+ "implementations" : [
+ "Roo.dd.DragSource",
+ "Roo.dd.DragZone",
+ "Roo.grid.SplitDragZone"
+ ],
"tree_children" : [],
"tree_parent" : []
},
"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"
+ "memberOf" : "Roo.util.Observable",
+ "isOptional" : false,
+ "optvals" : []
}
],
"events" : [],
],
"isAbstract" : false,
"isBuilderTop" : false,
- "childClasses" : {
- "Roo.dd.DropTarget" : [
- "Roo.dd.DropZone"
- ],
- "Roo.dd.DDTarget" : [
- "Roo.dd.DropTarget"
- ]
- },
+ "implementations" : [
+ "Roo.dd.DropTarget",
+ "Roo.dd.DropZone"
+ ],
"tree_children" : [],
"tree_parent" : []
},
"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"
+ "memberOf" : "Roo.util.Observable",
+ "isOptional" : false,
+ "optvals" : []
}
],
"events" : [],
],
"isAbstract" : false,
"isBuilderTop" : false,
- "childClasses" : {
- "Roo.dd.DragDrop" : [
- "Roo.dd.DD",
- "Roo.dd.DDTarget"
- ],
- "Roo.dd.DDProxy" : [
- "Roo.dd.DragSource",
- "Roo.grid.SplitDragZone"
- ],
- "Roo.dd.DD" : [
- "Roo.dd.DDProxy"
- ],
- "Roo.dd.DDTarget" : [
- "Roo.dd.DropTarget"
- ],
- "Roo.dd.DropTarget" : [
- "Roo.dd.DropZone"
- ],
- "Roo.dd.DragSource" : [
- "Roo.dd.DragZone"
- ]
- },
+ "implementations" : [
+ "Roo.dd.DD",
+ "Roo.dd.DDProxy",
+ "Roo.dd.DDTarget",
+ "Roo.dd.DragSource",
+ "Roo.dd.DragZone",
+ "Roo.dd.DropTarget",
+ "Roo.dd.DropZone",
+ "Roo.grid.SplitDragZone"
+ ],
"tree_children" : [],
"tree_parent" : []
},
"name" : "dropAllowed",
"type" : "String",
"desc" : "The CSS class returned to the drag source when drop is allowed (defaults to \"x-dd-drop-ok\").",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"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" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"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"
+ "memberOf" : "Roo.util.Observable",
+ "isOptional" : false,
+ "optvals" : []
}
],
"events" : [],
"returns" : []
},
{
- "name" : "alignElWithMouse",
+ "name" : "afterDragDrop",
"type" : "function",
- "desc" : "Sets the element to the location of the mousedown or click event,\nmaintaining the cursor location relative to the location on the element\nthat was clicked. Override this if you want to place the element in a\nlocation other than where the cursor is.",
- "sig" : "(el, iPageX, iPageY)",
+ "desc" : "An empty function by default, but provided so that you can perform a custom action\nafter a valid drag drop has occurred by providing an implementation.",
+ "sig" : "(target, e, id)",
"static" : false,
- "memberOf" : "Roo.dd.DD",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "el",
- "type" : "HTMLElement",
- "desc" : "the element to move",
+ "name" : "target",
+ "type" : "Roo.dd.DragDrop",
+ "desc" : "The drop target",
"isOptional" : false
},
{
- "name" : "iPageX",
- "type" : "int",
- "desc" : "the X coordinate of the mousedown or drag event",
+ "name" : "e",
+ "type" : "Event",
+ "desc" : "The event object",
"isOptional" : false
},
{
- "name" : "iPageY",
- "type" : "int",
- "desc" : "the Y coordinate of the mousedown or drag event",
+ "name" : "id",
+ "type" : "String",
+ "desc" : "The id of the dropped element",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "applyConfig",
- "type" : "function",
- "desc" : "Applies the configuration parameters that were passed into the constructor.\nThis is supposed to happen at each level through the inheritance chain. So\na DDProxy implentation will execute apply config on DDProxy, DD, and\nDragDrop in order to get all of the parameters that are available in\neach object.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.dd.DragDrop",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
- {
- "name" : "autoOffset",
+ "name" : "afterDragEnter",
"type" : "function",
- "desc" : "Sets the pointer offset to the distance between the linked element's top\nleft corner and the location the element was clicked",
- "sig" : "(iPageX, iPageY)",
+ "desc" : "An empty function by default, but provided so that you can perform a custom action\nwhen the dragged item enters the drop target by providing an implementation.",
+ "sig" : "(target, e, id)",
"static" : false,
- "memberOf" : "Roo.dd.DD",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "iPageX",
- "type" : "int",
- "desc" : "the X coordinate of the click",
+ "name" : "target",
+ "type" : "Roo.dd.DragDrop",
+ "desc" : "The drop target",
"isOptional" : false
},
{
- "name" : "iPageY",
- "type" : "int",
- "desc" : "the Y coordinate of the click",
+ "name" : "e",
+ "type" : "Event",
+ "desc" : "The event object",
+ "isOptional" : false
+ },
+ {
+ "name" : "id",
+ "type" : "String",
+ "desc" : "The id of the dragged element",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "beforeDragDrop",
+ "name" : "afterDragOut",
"type" : "function",
- "desc" : "An empty function by default, but provided so that you can perform a custom action before the dragged\nitem is dropped onto the target and optionally cancel the onDragDrop.",
+ "desc" : "An empty function by default, but provided so that you can perform a custom action\nafter the dragged item is dragged out of the target without dropping.",
+ "sig" : "(target, e, id)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "target",
+ "type" : "Roo.dd.DragDrop",
+ "desc" : "The drop target",
+ "isOptional" : false
+ },
+ {
+ "name" : "e",
+ "type" : "Event",
+ "desc" : "The event object",
+ "isOptional" : false
+ },
+ {
+ "name" : "id",
+ "type" : "String",
+ "desc" : "The id of the dragged element",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "afterDragOver",
+ "type" : "function",
+ "desc" : "An empty function by default, but provided so that you can perform a custom action\nwhile the dragged item is over the drop target by providing an implementation.",
+ "sig" : "(target, e, id)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "target",
+ "type" : "Roo.dd.DragDrop",
+ "desc" : "The drop target",
+ "isOptional" : false
+ },
+ {
+ "name" : "e",
+ "type" : "Event",
+ "desc" : "The event object",
+ "isOptional" : false
+ },
+ {
+ "name" : "id",
+ "type" : "String",
+ "desc" : "The id of the dragged element",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "afterInvalidDrop",
+ "type" : "function",
+ "desc" : "An empty function by default, but provided so that you can perform a custom action\nafter an invalid drop has occurred by providing an implementation.",
+ "sig" : "(e, id)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "e",
+ "type" : "Event",
+ "desc" : "The event object",
+ "isOptional" : false
+ },
+ {
+ "name" : "id",
+ "type" : "String",
+ "desc" : "The id of the dropped element",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "afterValidDrop",
+ "type" : "function",
+ "desc" : "An empty function by default, but provided so that you can perform a custom action\nafter a valid drop has occurred by providing an implementation.",
+ "sig" : "(target, e, id)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "target",
+ "type" : "Object",
+ "desc" : "The target DD",
+ "isOptional" : false
+ },
+ {
+ "name" : "e",
+ "type" : "Event",
+ "desc" : "The event object",
+ "isOptional" : false
+ },
+ {
+ "name" : "id",
+ "type" : "String",
+ "desc" : "The id of the dropped element",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "alignElWithMouse",
+ "type" : "function",
+ "desc" : "Sets the element to the location of the mousedown or click event,\nmaintaining the cursor location relative to the location on the element\nthat was clicked. Override this if you want to place the element in a\nlocation other than where the cursor is.",
+ "sig" : "(el, iPageX, iPageY)",
+ "static" : false,
+ "memberOf" : "Roo.dd.DD",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "el",
+ "type" : "HTMLElement",
+ "desc" : "the element to move",
+ "isOptional" : false
+ },
+ {
+ "name" : "iPageX",
+ "type" : "int",
+ "desc" : "the X coordinate of the mousedown or drag event",
+ "isOptional" : false
+ },
+ {
+ "name" : "iPageY",
+ "type" : "int",
+ "desc" : "the Y coordinate of the mousedown or drag event",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "applyConfig",
+ "type" : "function",
+ "desc" : "Applies the configuration parameters that were passed into the constructor.\nThis is supposed to happen at each level through the inheritance chain. So\na DDProxy implentation will execute apply config on DDProxy, DD, and\nDragDrop in order to get all of the parameters that are available in\neach object.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.dd.DragDrop",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
+ {
+ "name" : "autoOffset",
+ "type" : "function",
+ "desc" : "Sets the pointer offset to the distance between the linked element's top\nleft corner and the location the element was clicked",
+ "sig" : "(iPageX, iPageY)",
+ "static" : false,
+ "memberOf" : "Roo.dd.DD",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "iPageX",
+ "type" : "int",
+ "desc" : "the X coordinate of the click",
+ "isOptional" : false
+ },
+ {
+ "name" : "iPageY",
+ "type" : "int",
+ "desc" : "the Y coordinate of the click",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "beforeDragDrop",
+ "type" : "function",
+ "desc" : "An empty function by default, but provided so that you can perform a custom action before the dragged\nitem is dropped onto the target and optionally cancel the onDragDrop.",
"sig" : "(target, e, id)",
"static" : false,
"memberOf" : "",
],
"isAbstract" : false,
"isBuilderTop" : false,
- "childClasses" : {
- "Roo.dd.DragSource" : [
- "Roo.dd.DragZone"
- ]
- },
+ "implementations" : [
+ "Roo.dd.DragZone"
+ ],
"tree_children" : [],
"tree_parent" : []
},
"name" : "containerScroll",
"type" : "Boolean",
"desc" : "True to register this container with the Scrollmanager\nfor auto scrolling during drag operations.",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"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"
+ "memberOf" : "Roo.dd.DragSource",
+ "isOptional" : false,
+ "optvals" : []
},
{
"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"
+ "memberOf" : "Roo.dd.DragSource",
+ "isOptional" : false,
+ "optvals" : []
},
{
"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" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"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"
+ "memberOf" : "Roo.util.Observable",
+ "isOptional" : false,
+ "optvals" : []
}
],
"events" : [],
"returns" : []
},
{
- "name" : "afterRepair",
+ "name" : "afterDragDrop",
"type" : "function",
- "desc" : "Called after a repair of an invalid drop. By default, highlights this.dragData.ddel",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
- {
- "name" : "alignElWithMouse",
- "type" : "function",
- "desc" : "Sets the element to the location of the mousedown or click event,\nmaintaining the cursor location relative to the location on the element\nthat was clicked. Override this if you want to place the element in a\nlocation other than where the cursor is.",
- "sig" : "(el, iPageX, iPageY)",
+ "desc" : "An empty function by default, but provided so that you can perform a custom action\nafter a valid drag drop has occurred by providing an implementation.",
+ "sig" : "(target, e, id)",
"static" : false,
- "memberOf" : "Roo.dd.DD",
+ "memberOf" : "Roo.dd.DragSource",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "el",
- "type" : "HTMLElement",
- "desc" : "the element to move",
+ "name" : "target",
+ "type" : "Roo.dd.DragDrop",
+ "desc" : "The drop target",
"isOptional" : false
},
{
- "name" : "iPageX",
- "type" : "int",
- "desc" : "the X coordinate of the mousedown or drag event",
+ "name" : "e",
+ "type" : "Event",
+ "desc" : "The event object",
"isOptional" : false
},
{
- "name" : "iPageY",
- "type" : "int",
- "desc" : "the Y coordinate of the mousedown or drag event",
+ "name" : "id",
+ "type" : "String",
+ "desc" : "The id of the dropped element",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "applyConfig",
+ "name" : "afterDragEnter",
"type" : "function",
- "desc" : "Applies the configuration parameters that were passed into the constructor.\nThis is supposed to happen at each level through the inheritance chain. So\na DDProxy implentation will execute apply config on DDProxy, DD, and\nDragDrop in order to get all of the parameters that are available in\neach object.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.dd.DragDrop",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
- {
- "name" : "autoOffset",
- "type" : "function",
- "desc" : "Sets the pointer offset to the distance between the linked element's top\nleft corner and the location the element was clicked",
- "sig" : "(iPageX, iPageY)",
+ "desc" : "An empty function by default, but provided so that you can perform a custom action\nwhen the dragged item enters the drop target by providing an implementation.",
+ "sig" : "(target, e, id)",
"static" : false,
- "memberOf" : "Roo.dd.DD",
+ "memberOf" : "Roo.dd.DragSource",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "iPageX",
- "type" : "int",
- "desc" : "the X coordinate of the click",
+ "name" : "target",
+ "type" : "Roo.dd.DragDrop",
+ "desc" : "The drop target",
"isOptional" : false
},
{
- "name" : "iPageY",
- "type" : "int",
- "desc" : "the Y coordinate of the click",
+ "name" : "e",
+ "type" : "Event",
+ "desc" : "The event object",
+ "isOptional" : false
+ },
+ {
+ "name" : "id",
+ "type" : "String",
+ "desc" : "The id of the dragged element",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "beforeDragDrop",
+ "name" : "afterDragOut",
"type" : "function",
- "desc" : "An empty function by default, but provided so that you can perform a custom action before the dragged\nitem is dropped onto the target and optionally cancel the onDragDrop.",
+ "desc" : "An empty function by default, but provided so that you can perform a custom action\nafter the dragged item is dragged out of the target without dropping.",
+ "sig" : "(target, e, id)",
+ "static" : false,
+ "memberOf" : "Roo.dd.DragSource",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "target",
+ "type" : "Roo.dd.DragDrop",
+ "desc" : "The drop target",
+ "isOptional" : false
+ },
+ {
+ "name" : "e",
+ "type" : "Event",
+ "desc" : "The event object",
+ "isOptional" : false
+ },
+ {
+ "name" : "id",
+ "type" : "String",
+ "desc" : "The id of the dragged element",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "afterDragOver",
+ "type" : "function",
+ "desc" : "An empty function by default, but provided so that you can perform a custom action\nwhile the dragged item is over the drop target by providing an implementation.",
+ "sig" : "(target, e, id)",
+ "static" : false,
+ "memberOf" : "Roo.dd.DragSource",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "target",
+ "type" : "Roo.dd.DragDrop",
+ "desc" : "The drop target",
+ "isOptional" : false
+ },
+ {
+ "name" : "e",
+ "type" : "Event",
+ "desc" : "The event object",
+ "isOptional" : false
+ },
+ {
+ "name" : "id",
+ "type" : "String",
+ "desc" : "The id of the dragged element",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "afterInvalidDrop",
+ "type" : "function",
+ "desc" : "An empty function by default, but provided so that you can perform a custom action\nafter an invalid drop has occurred by providing an implementation.",
+ "sig" : "(e, id)",
+ "static" : false,
+ "memberOf" : "Roo.dd.DragSource",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "e",
+ "type" : "Event",
+ "desc" : "The event object",
+ "isOptional" : false
+ },
+ {
+ "name" : "id",
+ "type" : "String",
+ "desc" : "The id of the dropped element",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "afterRepair",
+ "type" : "function",
+ "desc" : "Called after a repair of an invalid drop. By default, highlights this.dragData.ddel",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
+ {
+ "name" : "afterValidDrop",
+ "type" : "function",
+ "desc" : "An empty function by default, but provided so that you can perform a custom action\nafter a valid drop has occurred by providing an implementation.",
+ "sig" : "(target, e, id)",
+ "static" : false,
+ "memberOf" : "Roo.dd.DragSource",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "target",
+ "type" : "Object",
+ "desc" : "The target DD",
+ "isOptional" : false
+ },
+ {
+ "name" : "e",
+ "type" : "Event",
+ "desc" : "The event object",
+ "isOptional" : false
+ },
+ {
+ "name" : "id",
+ "type" : "String",
+ "desc" : "The id of the dropped element",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "alignElWithMouse",
+ "type" : "function",
+ "desc" : "Sets the element to the location of the mousedown or click event,\nmaintaining the cursor location relative to the location on the element\nthat was clicked. Override this if you want to place the element in a\nlocation other than where the cursor is.",
+ "sig" : "(el, iPageX, iPageY)",
+ "static" : false,
+ "memberOf" : "Roo.dd.DD",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "el",
+ "type" : "HTMLElement",
+ "desc" : "the element to move",
+ "isOptional" : false
+ },
+ {
+ "name" : "iPageX",
+ "type" : "int",
+ "desc" : "the X coordinate of the mousedown or drag event",
+ "isOptional" : false
+ },
+ {
+ "name" : "iPageY",
+ "type" : "int",
+ "desc" : "the Y coordinate of the mousedown or drag event",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "applyConfig",
+ "type" : "function",
+ "desc" : "Applies the configuration parameters that were passed into the constructor.\nThis is supposed to happen at each level through the inheritance chain. So\na DDProxy implentation will execute apply config on DDProxy, DD, and\nDragDrop in order to get all of the parameters that are available in\neach object.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.dd.DragDrop",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
+ {
+ "name" : "autoOffset",
+ "type" : "function",
+ "desc" : "Sets the pointer offset to the distance between the linked element's top\nleft corner and the location the element was clicked",
+ "sig" : "(iPageX, iPageY)",
+ "static" : false,
+ "memberOf" : "Roo.dd.DD",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "iPageX",
+ "type" : "int",
+ "desc" : "the X coordinate of the click",
+ "isOptional" : false
+ },
+ {
+ "name" : "iPageY",
+ "type" : "int",
+ "desc" : "the Y coordinate of the click",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "beforeDragDrop",
+ "type" : "function",
+ "desc" : "An empty function by default, but provided so that you can perform a custom action before the dragged\nitem is dropped onto the target and optionally cancel the onDragDrop.",
"sig" : "(target, e, id)",
"static" : false,
"memberOf" : "Roo.dd.DragSource",
],
"isAbstract" : false,
"isBuilderTop" : false,
- "childClasses" : { },
+ "implementations" : [],
"tree_children" : [],
"tree_parent" : []
},
"name" : "ddGroup",
"type" : "String",
"desc" : "The drag drop group to handle drop events for",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "dropAllowed",
"type" : "String",
"desc" : "The CSS class returned to the drag source when drop is allowed (defaults to \"x-dd-drop-ok\").",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"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" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"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"
+ "memberOf" : "Roo.util.Observable",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "overClass",
"type" : "String",
"desc" : "The CSS class applied to the drop target element while the drag source is over it (defaults to \"\").",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "success",
"type" : "boolean",
"desc" : "set this after drop listener..",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"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" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
}
],
"events" : [
],
"isAbstract" : false,
"isBuilderTop" : false,
- "childClasses" : {
- "Roo.dd.DropTarget" : [
- "Roo.dd.DropZone"
- ]
- },
+ "implementations" : [
+ "Roo.dd.DropZone"
+ ],
"tree_children" : [],
"tree_parent" : []
},
"name" : "ddGroup",
"type" : "String",
"desc" : "The drag drop group to handle drop events for",
- "memberOf" : "Roo.dd.DropTarget"
+ "memberOf" : "Roo.dd.DropTarget",
+ "isOptional" : false,
+ "optvals" : []
},
{
"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"
+ "memberOf" : "Roo.dd.DropTarget",
+ "isOptional" : false,
+ "optvals" : []
},
{
"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"
+ "memberOf" : "Roo.dd.DropTarget",
+ "isOptional" : false,
+ "optvals" : []
},
{
"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"
+ "memberOf" : "Roo.util.Observable",
+ "isOptional" : false,
+ "optvals" : []
},
{
"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"
+ "memberOf" : "Roo.dd.DropTarget",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "success",
"type" : "boolean",
"desc" : "set this after drop listener..",
- "memberOf" : "Roo.dd.DropTarget"
+ "memberOf" : "Roo.dd.DropTarget",
+ "isOptional" : false,
+ "optvals" : []
},
{
"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"
+ "memberOf" : "Roo.dd.DropTarget",
+ "isOptional" : false,
+ "optvals" : []
}
],
"events" : [
],
"isAbstract" : false,
"isBuilderTop" : false,
- "childClasses" : { },
+ "implementations" : [],
"tree_children" : [],
"tree_parent" : []
},
],
"isAbstract" : false,
"isBuilderTop" : false,
- "childClasses" : { },
+ "implementations" : [],
"tree_children" : [],
"tree_parent" : []
},
],
"isAbstract" : false,
"isBuilderTop" : false,
- "childClasses" : { },
+ "implementations" : [],
"tree_children" : [],
"tree_parent" : []
},
"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" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"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" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
}
],
"events" : [],
],
"isAbstract" : false,
"isBuilderTop" : false,
- "childClasses" : { },
- "tree_children" : [],
- "tree_parent" : []
- },
- "Roo.form" : {
- "props" : [],
- "events" : [],
- "methods" : [],
- "isAbstract" : false,
- "isBuilderTop" : false,
- "childClasses" : { },
+ "implementations" : [],
"tree_children" : [],
"tree_parent" : []
},
- "Roo.form.Action" : {
+ "Roo.dialog" : {
"props" : [],
"events" : [],
"methods" : [],
"isAbstract" : false,
"isBuilderTop" : false,
- "childClasses" : { },
+ "implementations" : [],
"tree_children" : [],
"tree_parent" : []
},
- "Roo.form.BasicForm" : {
+ "Roo.dialog.UploadCropbox" : {
"props" : [
{
- "name" : "baseParams",
- "type" : "Object",
- "desc" : "Parameters to pass with all requests. e.g. baseParams: {id: '123', foo: 'bar'}.",
- "memberOf" : ""
+ "name" : "actionMode",
+ "type" : "String",
+ "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el' for forms you probably want to set this to fieldEl",
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
- "name" : "errorMask",
+ "name" : "allowDomMove",
"type" : "Boolean",
- "desc" : "e) default false",
- "memberOf" : ""
+ "desc" : "Whether the component can move the Dom node when rendering (defaults to true).",
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
- "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" : "buttons",
+ "type" : "Array",
+ "desc" : "default ['rotateLeft', 'pictureBtn', 'rotateRight']",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
- "name" : "fileUpload",
+ "name" : "disableClass",
+ "type" : "String",
+ "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").",
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "emptyText",
+ "type" : "String",
+ "desc" : "show when image has been loaded",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "errorTimeout",
+ "type" : "Number",
+ "desc" : "default 3000",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "height",
+ "type" : "Number",
+ "desc" : "height (optional) size of component",
+ "memberOf" : "Roo.BoxComponent",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "hideMode",
+ "type" : "String",
+ "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display",
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : [
+ "display",
+ "visibility"
+ ]
+ },
+ {
+ "name" : "isDocument",
"type" : "Boolean",
- "desc" : "Set to true if this form is a file upload.",
- "memberOf" : ""
+ "desc" : "e) default fal",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : [
+ "true",
+ "false"
+ ]
},
{
"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"
+ "memberOf" : "Roo.util.Observable",
+ "isOptional" : false,
+ "optvals" : []
},
{
- "name" : "maskOffset",
- "type" : "Number",
- "desc" : "Default 100",
- "memberOf" : ""
+ "name" : "loadMask",
+ "type" : "Boolean",
+ "desc" : "e) default tr",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : [
+ "true",
+ "false"
+ ]
+ },
+ {
+ "name" : "loadingText",
+ "type" : "Boolean",
+ "desc" : "default 'Loading...'",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"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" : ""
+ "desc" : "default POST",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
- "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" : "minHeight",
+ "type" : "Number",
+ "desc" : "default 300",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
- "name" : "timeout",
+ "name" : "minWidth",
"type" : "Number",
- "desc" : "Timeout for form actions in seconds (default is 30 seconds).",
- "memberOf" : ""
+ "desc" : "default 300",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
- "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" : "outputMaxWidth",
+ "type" : "Number",
+ "desc" : "default 1200",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "paramName",
+ "type" : "String",
+ "desc" : "default 'imageUpload'",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "rotateNotify",
+ "type" : "String",
+ "desc" : "show when image too small to rotate",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "style",
+ "type" : "String",
+ "desc" : "css styles to add to component\neg. text-align:right;",
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "url",
"type" : "String",
- "desc" : "The URL to use for form actions if one isn't supplied in the action options.",
- "memberOf" : ""
+ "desc" : "action url",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "width",
+ "type" : "Number",
+ "desc" : "width (optional) size of component",
+ "memberOf" : "Roo.BoxComponent",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "windowSize",
+ "type" : "Number",
+ "desc" : "default 300",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
}
],
"events" : [
{
- "name" : "actioncomplete",
+ "name" : "arrange",
"type" : "function",
- "desc" : "Fires when an action is completed.",
- "sig" : "function (_self, action)\n{\n\n}",
+ "desc" : "Fire when arrange the file data",
+ "sig" : "function (_self, formData)\n{\n\n}",
"memberOf" : "",
"example" : "",
"deprecated" : "",
"params" : [
{
"name" : "this",
- "type" : "Form",
+ "type" : "Roo.dialog.UploadCropbox",
"desc" : "",
"isOptional" : false
},
{
- "name" : "action",
- "type" : "Action",
- "desc" : "The action that completed",
+ "name" : "formData",
+ "type" : "Object",
+ "desc" : "",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "actionfailed",
+ "name" : "beforedestroy",
"type" : "function",
- "desc" : "Fires when an action fails.",
- "sig" : "function (_self, action)\n{\n\n}",
+ "desc" : "Fires before the component is destroyed. Return false to stop the destroy.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.Component",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "beforehide",
+ "type" : "function",
+ "desc" : "Fires before the component is hidden. Return false to stop the hide.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.Component",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "beforeloadcanvas",
+ "type" : "function",
+ "desc" : "Fire before load the canvas",
+ "sig" : "function (_self, src)\n{\n\n}",
"memberOf" : "",
"example" : "",
"deprecated" : "",
"params" : [
{
"name" : "this",
- "type" : "Form",
+ "type" : "Roo.dialog.UploadCropbox",
"desc" : "",
"isOptional" : false
},
{
- "name" : "action",
- "type" : "Action",
- "desc" : "The action that failed",
+ "name" : "src",
+ "type" : "String",
+ "desc" : "",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "beforeaction",
+ "name" : "beforerender",
"type" : "function",
- "desc" : "Fires before any action is performed. Return false to cancel the action.",
- "sig" : "function (_self, action)\n{\n\n}",
+ "desc" : "Fires before the component is rendered. Return false to stop the render.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.Component",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "beforeselectfile",
+ "type" : "function",
+ "desc" : "Fire before select file",
+ "sig" : "function (_self)\n{\n\n}",
"memberOf" : "",
"example" : "",
"deprecated" : "",
"params" : [
{
"name" : "this",
- "type" : "Form",
+ "type" : "Roo.dialog.UploadCropbox",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "beforeshow",
+ "type" : "function",
+ "desc" : "Fires before the component is shown. Return false to stop the show.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.Component",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "crop",
+ "type" : "function",
+ "desc" : "Fire after initEvent",
+ "sig" : "function (_self, data)\n{\n\n}",
+ "memberOf" : "",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.dialog.UploadCropbox",
"desc" : "",
"isOptional" : false
},
{
- "name" : "action",
- "type" : "Action",
- "desc" : "The action to be performed",
+ "name" : "data",
+ "type" : "String",
+ "desc" : "",
"isOptional" : false
}
],
"returns" : []
- }
- ],
- "methods" : [
+ },
{
- "name" : "add",
+ "name" : "destroy",
"type" : "function",
- "desc" : "Add Roo.form components to this form.",
- "sig" : "(field1, field2, etc)",
- "static" : false,
+ "desc" : "Fires after the component is destroyed.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.Component",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "disable",
+ "type" : "function",
+ "desc" : "Fires after the component is disabled.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.Component",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "download",
+ "type" : "function",
+ "desc" : "Fire when download the image",
+ "sig" : "function (_self)\n{\n\n}",
"memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
"params" : [
{
- "name" : "field1",
- "type" : "Field",
+ "name" : "this",
+ "type" : "Roo.dialog.UploadCropbox",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "enable",
+ "type" : "function",
+ "desc" : "Fires after the component is enabled.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.Component",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "exception",
+ "type" : "function",
+ "desc" : "Fire when get exception",
+ "sig" : "function (_self, xhr)\n{\n\n}",
+ "memberOf" : "",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.dialog.UploadCropbox",
"desc" : "",
"isOptional" : false
},
{
- "name" : "field2",
- "type" : "Field",
- "desc" : "(optional)",
+ "name" : "xhr",
+ "type" : "XMLHttpRequest",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "footerbuttonclick",
+ "type" : "function",
+ "desc" : "Fire when footerbuttonclick",
+ "sig" : "function (_self, type)\n{\n\n}",
+ "memberOf" : "",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.dialog.UploadCropbox",
+ "desc" : "",
"isOptional" : false
},
{
- "name" : "etc",
- "type" : "Field",
- "desc" : "(optional)",
+ "name" : "type",
+ "type" : "String",
+ "desc" : "",
"isOptional" : false
}
],
- "returns" : [
+ "returns" : []
+ },
+ {
+ "name" : "hide",
+ "type" : "function",
+ "desc" : "Fires after the component is hidden.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
{
- "name" : "",
- "type" : "BasicForm",
- "desc" : "this"
+ "name" : "this",
+ "type" : "Roo.Component",
+ "desc" : "",
+ "isOptional" : false
}
- ]
+ ],
+ "returns" : []
},
{
- "name" : "addEvents",
+ "name" : "initial",
"type" : "function",
- "desc" : "Used to define events on this Observable",
- "sig" : "(object)",
- "static" : false,
- "memberOf" : "Roo.util.Observable",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
+ "desc" : "Fire after initEvent",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
"params" : [
{
- "name" : "object",
+ "name" : "this",
+ "type" : "Roo.dialog.UploadCropbox",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "inspect",
+ "type" : "function",
+ "desc" : "Fire when inspect the file",
+ "sig" : "function (_self, file)\n{\n\n}",
+ "memberOf" : "",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.dialog.UploadCropbox",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "file",
"type" : "Object",
- "desc" : "The object with the events defined",
+ "desc" : "",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "addForm",
+ "name" : "loadcanvas",
"type" : "function",
- "desc" : "Add a secondary form to this one, \nUsed to provide tabbed forms. One form is primary, with hidden values \nwhich mirror the elements from the other forms.",
- "sig" : "(form)",
- "static" : false,
+ "desc" : "Fire after load the canvas",
+ "sig" : "function (, imgEl)\n{\n\n}",
"memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
"params" : [
{
- "name" : "form",
- "type" : "Roo.form.Form",
- "desc" : "to add.",
+ "name" : "",
+ "type" : "Roo.dialog.UploadCropbox",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "imgEl",
+ "type" : "Object",
+ "desc" : "",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "addListener",
+ "name" : "move",
"type" : "function",
- "desc" : "Appends an event handler to this component",
- "sig" : "(eventName, handler, scope, options)",
- "static" : false,
- "memberOf" : "Roo.util.Observable",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
+ "desc" : "Fires after the component is moved.",
+ "sig" : "function (_self, x, y)\n{\n\n}",
+ "memberOf" : "Roo.BoxComponent",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
"params" : [
{
- "name" : "eventName",
- "type" : "String",
- "desc" : "The type of event to listen for",
+ "name" : "this",
+ "type" : "Roo.Component",
+ "desc" : "",
"isOptional" : false
},
{
- "name" : "handler",
- "type" : "Function",
- "desc" : "The method the event invokes",
+ "name" : "x",
+ "type" : "Number",
+ "desc" : "The new x position",
"isOptional" : false
},
{
- "name" : "scope",
- "type" : "Object",
- "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
+ "name" : "y",
+ "type" : "Number",
+ "desc" : "The new y position",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "prepare",
+ "type" : "function",
+ "desc" : "Fire when preparing the file data",
+ "sig" : "function (_self, file)\n{\n\n}",
+ "memberOf" : "",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.dialog.UploadCropbox",
+ "desc" : "",
"isOptional" : false
},
{
- "name" : "options",
+ "name" : "file",
"type" : "Object",
- "desc" : "(optional) An object containing handler configuration\nproperties. This may contain any of the following properties:<ul>\n<li>scope {Object} The scope in which to execute the handler function. The handler function's \"this\" context.</li>\n<li>delay {Number} The number of milliseconds to delay the invocation of the handler after te event fires.</li>\n<li>single {Boolean} True to add a handler to handle just the next firing of the event, and then remove itself.</li>\n<li>buffer {Number} Causes the handler to be scheduled to run in an {@link Roo.util.DelayedTask} delayed\nby the specified number of milliseconds. If the event fires again within that time, the original\nhandler is <em>not</em> invoked, but the new handler is scheduled in its place.</li>\n</ul><br>\n<p>\n<b>Combining Options</b><br>\nUsing the options argument, it is possible to combine different types of listeners:<br>\n<br>\nA normalized, delayed, one-time listener that auto stops the event and passes a custom argument (forumId)\n\t\t<pre><code>\n\t\tel.on('click', this.onClick, this, {\n \t\t\tsingle: true,\n \t\tdelay: 100,\n \t\tforumId: 4\n\t\t});\n\t\t</code></pre>\n<p>\n<b>Attaching multiple handlers in 1 call</b><br>\nThe method also allows for a single argument to be passed which is a config object containing properties\nwhich specify multiple handlers.\n<pre><code>\n\t\tel.on({\n\t\t\t'click': {\n \t\tfn: this.onClick,\n \t\tscope: this,\n \t\tdelay: 100\n \t\t}, \n \t\t'mouseover': {\n \t\tfn: this.onMouseOver,\n \t\tscope: this\n \t\t},\n \t\t'mouseout': {\n \t\tfn: this.onMouseOut,\n \t\tscope: this\n \t\t}\n\t\t});\n\t\t</code></pre>\n<p>\nOr a shorthand syntax which passes the same scope object to all handlers:\n \t<pre><code>\n\t\tel.on({\n\t\t\t'click': this.onClick,\n \t\t'mouseover': this.onMouseOver,\n \t\t'mouseout': this.onMouseOut,\n \t\tscope: this\n\t\t});\n\t\t</code></pre>",
+ "desc" : "",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "applyIfToFields",
+ "name" : "render",
"type" : "function",
- "desc" : "Calls {@link Ext#applyIf} for all field in this form with the passed object.",
- "sig" : "(values)",
- "static" : false,
+ "desc" : "Fires after the component is rendered.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.Component",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "resize",
+ "type" : "function",
+ "desc" : "Fire when resize",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.dialog.UploadCropbox",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "rotate",
+ "type" : "function",
+ "desc" : "Fire when rotate the image",
+ "sig" : "function (_self, pos)\n{\n\n}",
+ "memberOf" : "",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.dialog.UploadCropbox",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "pos",
+ "type" : "String",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "show",
+ "type" : "function",
+ "desc" : "Fires after the component is shown.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.Component",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "trash",
+ "type" : "function",
+ "desc" : "Fire when trash image",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.dialog.UploadCropbox",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "upload",
+ "type" : "function",
+ "desc" : "Fire when xhr upload the file",
+ "sig" : "function (_self, data)\n{\n\n}",
"memberOf" : "",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.dialog.UploadCropbox",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "data",
+ "type" : "Object",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ }
+ ],
+ "methods" : [
+ {
+ "name" : "addEvents",
+ "type" : "function",
+ "desc" : "Used to define events on this Observable",
+ "sig" : "(object)",
+ "static" : false,
+ "memberOf" : "Roo.util.Observable",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "values",
+ "name" : "object",
"type" : "Object",
- "desc" : "",
+ "desc" : "The object with the events defined",
"isOptional" : false
}
],
- "returns" : [
- {
- "name" : "",
- "type" : "BasicForm",
- "desc" : "this"
- }
- ]
+ "returns" : []
},
{
- "name" : "applyToFields",
+ "name" : "addListener",
"type" : "function",
- "desc" : "Calls {@link Ext#apply} for all fields in this form with the passed object.",
- "sig" : "(values)",
+ "desc" : "Appends an event handler to this component",
+ "sig" : "(eventName, handler, scope, options)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.util.Observable",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "values",
+ "name" : "eventName",
+ "type" : "String",
+ "desc" : "The type of event to listen for",
+ "isOptional" : false
+ },
+ {
+ "name" : "handler",
+ "type" : "Function",
+ "desc" : "The method the event invokes",
+ "isOptional" : false
+ },
+ {
+ "name" : "scope",
"type" : "Object",
- "desc" : "",
+ "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
"isOptional" : false
- }
- ],
- "returns" : [
+ },
{
- "name" : "",
- "type" : "BasicForm",
- "desc" : "this"
+ "name" : "options",
+ "type" : "Object",
+ "desc" : "(optional) An object containing handler configuration\nproperties. This may contain any of the following properties:<ul>\n<li>scope {Object} The scope in which to execute the handler function. The handler function's \"this\" context.</li>\n<li>delay {Number} The number of milliseconds to delay the invocation of the handler after te event fires.</li>\n<li>single {Boolean} True to add a handler to handle just the next firing of the event, and then remove itself.</li>\n<li>buffer {Number} Causes the handler to be scheduled to run in an {@link Roo.util.DelayedTask} delayed\nby the specified number of milliseconds. If the event fires again within that time, the original\nhandler is <em>not</em> invoked, but the new handler is scheduled in its place.</li>\n</ul><br>\n<p>\n<b>Combining Options</b><br>\nUsing the options argument, it is possible to combine different types of listeners:<br>\n<br>\nA normalized, delayed, one-time listener that auto stops the event and passes a custom argument (forumId)\n\t\t<pre><code>\n\t\tel.on('click', this.onClick, this, {\n \t\t\tsingle: true,\n \t\tdelay: 100,\n \t\tforumId: 4\n\t\t});\n\t\t</code></pre>\n<p>\n<b>Attaching multiple handlers in 1 call</b><br>\nThe method also allows for a single argument to be passed which is a config object containing properties\nwhich specify multiple handlers.\n<pre><code>\n\t\tel.on({\n\t\t\t'click': {\n \t\tfn: this.onClick,\n \t\tscope: this,\n \t\tdelay: 100\n \t\t}, \n \t\t'mouseover': {\n \t\tfn: this.onMouseOver,\n \t\tscope: this\n \t\t},\n \t\t'mouseout': {\n \t\tfn: this.onMouseOut,\n \t\tscope: this\n \t\t}\n\t\t});\n\t\t</code></pre>\n<p>\nOr a shorthand syntax which passes the same scope object to all handlers:\n \t<pre><code>\n\t\tel.on({\n\t\t\t'click': this.onClick,\n \t\t'mouseover': this.onMouseOver,\n \t\t'mouseout': this.onMouseOut,\n \t\tscope: this\n\t\t});\n\t\t</code></pre>",
+ "isOptional" : false
}
- ]
+ ],
+ "returns" : []
},
{
"name" : "capture",
"returns" : []
},
{
- "name" : "clearInvalid",
+ "name" : "destroy",
"type" : "function",
- "desc" : "Clears all invalid messages in this form.",
+ "desc" : "Destroys this component by purging any event listeners, removing the component's element from the DOM,\nremoving the component from its {@link Roo.Container} (if applicable) and unregistering it from {@link Roo.ComponentMgr}.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"exceptions" : "",
"requires" : "",
"params" : [],
- "returns" : [
- {
- "name" : "",
- "type" : "BasicForm",
- "desc" : "this"
- }
- ]
+ "returns" : []
},
{
- "name" : "doAction",
+ "name" : "disable",
"type" : "function",
- "desc" : "Performs a predefined action (submit or load) or custom actions you define on this form.",
- "sig" : "(actionName, options)",
+ "desc" : "Disable this component.",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "actionName",
- "type" : "String",
- "desc" : "The name of the action type",
- "isOptional" : false
- },
- {
- "name" : "options",
- "type" : "Object",
- "desc" : "(optional) The options to pass to the action. All of the config options listed\nbelow are supported by both the submit and load actions unless otherwise noted (custom actions could also\naccept other config options):\n<pre>\nProperty Type Description\n---------------- --------------- ----------------------------------------------------------------------------------\nurl String The url for the action (defaults to the form's url)\nmethod String The form method to use (defaults to the form's method, or POST if not defined)\nparams String/Object The params to pass (defaults to the form's baseParams, or none if not defined)\nclientValidation Boolean Applies to submit only. Pass true to call form.isValid() prior to posting to\n validate the form on the client (defaults to false)\n</pre>",
- "isOptional" : false
- }
- ],
+ "params" : [],
"returns" : [
{
"name" : "",
- "type" : "BasicForm",
+ "type" : "Roo.Component",
"desc" : "this"
}
]
},
{
- "name" : "findField",
+ "name" : "enable",
"type" : "function",
- "desc" : "Find a Roo.form.Field in this form by id, dataIndex, name or hiddenName",
- "sig" : "(id)",
+ "desc" : "Enable this component.",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "id",
- "type" : "String",
- "desc" : "The value to search for",
- "isOptional" : false
- }
- ],
+ "params" : [],
"returns" : [
{
"name" : "",
- "type" : "",
- "desc" : "Field"
+ "type" : "Roo.Component",
+ "desc" : "this"
}
]
},
]
},
{
- "name" : "getFieldValues",
- "type" : "function",
- "desc" : "Returns the fields in this form as an object with key/value pairs. \nThis differs from getValues as it calls getValue on each child item, rather than using dom data.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : [
- {
- "name" : "",
- "type" : "Object",
- "desc" : ""
- }
- ]
- },
- {
- "name" : "getValues",
+ "name" : "focus",
"type" : "function",
- "desc" : "Returns the fields in this form as an object with key/value pairs. If multiple fields exist with the same name\nthey are returned as an array.",
- "sig" : "(asString)",
+ "desc" : "Try to focus this component.",
+ "sig" : "(selectText)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "asString",
+ "name" : "selectText",
"type" : "Boolean",
- "desc" : "",
+ "desc" : "True to also select the text in this component (if applicable)",
"isOptional" : false
}
],
"returns" : [
{
"name" : "",
- "type" : "Object",
- "desc" : ""
+ "type" : "Roo.Component",
+ "desc" : "this"
}
]
},
{
- "name" : "hasChanged",
+ "name" : "getBox",
"type" : "function",
- "desc" : "Returns true if any fields in this form have changed since their original load. (New version)",
- "sig" : "()\n{\n\n}",
+ "desc" : "Gets the current box measurements of the component's underlying element.",
+ "sig" : "(local)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.BoxComponent",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
- "returns" : [
+ "params" : [
{
- "name" : "",
- "type" : "",
- "desc" : "Boolean"
+ "name" : "local",
+ "type" : "Boolean",
+ "desc" : "(optional) If true the element's left and top are returned instead of page XY (defaults to false)",
+ "isOptional" : false
}
- ]
+ ],
+ "returns" : []
},
{
- "name" : "hasListener",
+ "name" : "getEl",
"type" : "function",
- "desc" : "Checks to see if this object has any listeners for a specified event",
- "sig" : "(eventName)",
+ "desc" : "Returns the underlying {@link Roo.Element}.",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.util.Observable",
+ "memberOf" : "Roo.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "eventName",
- "type" : "String",
- "desc" : "The name of the event to check for",
- "isOptional" : false
- }
- ],
+ "params" : [],
"returns" : [
{
"name" : "",
- "type" : "Boolean",
- "desc" : "True if the event is being listened for, else false"
+ "type" : "Roo.Element",
+ "desc" : "The element"
}
]
},
{
- "name" : "invalidFields",
+ "name" : "getId",
"type" : "function",
- "desc" : "Returns array of invalid form fields.",
+ "desc" : "Returns the id of this component.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"returns" : [
{
"name" : "",
- "type" : "",
- "desc" : "Array"
+ "type" : "String",
+ "desc" : ""
}
]
},
{
- "name" : "isDirty",
+ "name" : "getPosition",
"type" : "function",
- "desc" : "DEPRICATED Returns true if any fields in this form have changed since their original load.",
- "sig" : "()\n{\n\n}",
+ "desc" : "Gets the current XY position of the component's underlying element.",
+ "sig" : "(local)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.BoxComponent",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
+ "params" : [
+ {
+ "name" : "local",
+ "type" : "Boolean",
+ "desc" : "(optional) If true the element's left and top are returned instead of page XY (defaults to false)",
+ "isOptional" : false
+ }
+ ],
"returns" : [
{
"name" : "",
- "type" : "",
- "desc" : "Boolean"
+ "type" : "Array",
+ "desc" : "The XY position of the element (e.g., [100, 200])"
}
]
},
{
- "name" : "isValid",
+ "name" : "getSize",
"type" : "function",
- "desc" : "Returns true if client-side validation on the form is successful.",
+ "desc" : "Gets the current size of the component's underlying element.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.BoxComponent",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"returns" : [
{
"name" : "",
- "type" : "",
- "desc" : "Boolean"
+ "type" : "Object",
+ "desc" : "An object containing the element's size {width: (element width), height: (element height)}"
}
]
},
{
- "name" : "load",
+ "name" : "hasListener",
"type" : "function",
- "desc" : "Shortcut to do a load action.",
- "sig" : "(options)",
+ "desc" : "Checks to see if this object has any listeners for a specified event",
+ "sig" : "(eventName)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.util.Observable",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "options",
- "type" : "Object",
- "desc" : "The options to pass to the action (see {@link #doAction} for details)",
+ "name" : "eventName",
+ "type" : "String",
+ "desc" : "The name of the event to check for",
"isOptional" : false
}
],
"returns" : [
{
"name" : "",
- "type" : "BasicForm",
- "desc" : "this"
+ "type" : "Boolean",
+ "desc" : "True if the event is being listened for, else false"
}
]
},
{
- "name" : "loadRecord",
+ "name" : "hide",
"type" : "function",
- "desc" : "Loads an Roo.data.Record into this form.",
- "sig" : "(record)",
+ "desc" : "Hide this component.",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "record",
- "type" : "Record",
- "desc" : "The record to load",
- "isOptional" : false
- }
- ],
+ "params" : [],
"returns" : [
{
"name" : "",
- "type" : "BasicForm",
+ "type" : "Roo.Component",
"desc" : "this"
}
]
},
{
- "name" : "markInvalid",
+ "name" : "isVisible",
"type" : "function",
- "desc" : "Mark fields in this form invalid in bulk.",
- "sig" : "(errors)",
+ "desc" : "Returns true if this component is visible.",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "errors",
- "type" : "Array/Object",
- "desc" : "Either an array in the form [{id:'fieldId', msg:'The message'},...] or an object hash of {id: msg, id2: msg2}",
- "isOptional" : false
- }
- ],
- "returns" : [
- {
- "name" : "",
- "type" : "BasicForm",
- "desc" : "this"
- }
- ]
+ "params" : [],
+ "returns" : []
},
{
"name" : "on",
"returns" : []
},
{
- "name" : "purgeListeners",
+ "name" : "onPosition",
"type" : "function",
- "desc" : "Removes all listeners for this object",
- "sig" : "()\n{\n\n}",
+ "desc" : "Called after the component is moved, this method is empty by default but can be implemented by any\nsubclass that needs to perform custom logic after a move occurs.",
+ "sig" : "(x, y)",
"static" : false,
- "memberOf" : "Roo.util.Observable",
+ "memberOf" : "Roo.BoxComponent",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
- "returns" : []
- },
- {
- "name" : "releaseCapture",
- "type" : "function",
- "desc" : "Removes <b>all</b> added captures from the Observable.",
- "sig" : "(o)",
- "static" : true,
- "memberOf" : "Roo.util.Observable",
- "isStatic" : true,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
"params" : [
{
- "name" : "o",
- "type" : "Observable",
- "desc" : "The Observable to release",
+ "name" : "x",
+ "type" : "Number",
+ "desc" : "The new x position",
+ "isOptional" : false
+ },
+ {
+ "name" : "y",
+ "type" : "Number",
+ "desc" : "The new y position",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "remove",
+ "name" : "onResize",
"type" : "function",
- "desc" : "Removes a field from the items collection (does NOT remove its markup).",
- "sig" : "(field)",
+ "desc" : "Called after the component is resized, this method is empty by default but can be implemented by any\nsubclass that needs to perform custom logic after a resize occurs.",
+ "sig" : "(adjWidth, adjHeight, rawWidth, rawHeight)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.BoxComponent",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "field",
- "type" : "Field",
- "desc" : "",
+ "name" : "adjWidth",
+ "type" : "Number",
+ "desc" : "The box-adjusted width that was set",
+ "isOptional" : false
+ },
+ {
+ "name" : "adjHeight",
+ "type" : "Number",
+ "desc" : "The box-adjusted height that was set",
+ "isOptional" : false
+ },
+ {
+ "name" : "rawWidth",
+ "type" : "Number",
+ "desc" : "The width that was originally specified",
+ "isOptional" : false
+ },
+ {
+ "name" : "rawHeight",
+ "type" : "Number",
+ "desc" : "The height that was originally specified",
"isOptional" : false
}
],
- "returns" : [
+ "returns" : []
+ },
+ {
+ "name" : "purgeListeners",
+ "type" : "function",
+ "desc" : "Removes all listeners for this object",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.util.Observable",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
+ {
+ "name" : "releaseCapture",
+ "type" : "function",
+ "desc" : "Removes <b>all</b> added captures from the Observable.",
+ "sig" : "(o)",
+ "static" : true,
+ "memberOf" : "Roo.util.Observable",
+ "isStatic" : true,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
{
- "name" : "",
- "type" : "BasicForm",
- "desc" : "this"
+ "name" : "o",
+ "type" : "Observable",
+ "desc" : "The Observable to release",
+ "isOptional" : false
}
- ]
+ ],
+ "returns" : []
},
{
"name" : "removeListener",
{
"name" : "render",
"type" : "function",
- "desc" : "Looks at the fields in this form, checks them for an id attribute,\nand calls applyTo on the existing dom element with that id.",
- "sig" : "()\n{\n\n}",
+ "desc" : "If this is a lazy rendering component, render it to its container element.",
+ "sig" : "(container)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
- "returns" : [
+ "params" : [
{
- "name" : "",
- "type" : "BasicForm",
- "desc" : "this"
+ "name" : "container",
+ "type" : "String/HTMLElement/Element",
+ "desc" : "(optional) The element this component should be rendered into. If it is being applied to existing markup, this should be left off.",
+ "isOptional" : false
}
- ]
+ ],
+ "returns" : []
},
{
- "name" : "reset",
+ "name" : "setDisabled",
"type" : "function",
- "desc" : "Resets this form.",
- "sig" : "()\n{\n\n}",
+ "desc" : "Convenience function for setting disabled/enabled by boolean.",
+ "sig" : "(disabled)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
- "returns" : [
+ "params" : [
{
- "name" : "",
- "type" : "BasicForm",
- "desc" : "this"
+ "name" : "disabled",
+ "type" : "Boolean",
+ "desc" : "",
+ "isOptional" : false
}
- ]
+ ],
+ "returns" : []
},
{
- "name" : "resetHasChanged",
+ "name" : "setPagePosition",
"type" : "function",
- "desc" : "Resets all hasChanged to 'false' -\nThe old 'isDirty' used 'original value..' however this breaks reset() and a few other things.\nSo hasChanged storage is only to be used for this purpose",
- "sig" : "()\n{\n\n}",
+ "desc" : "Sets the page XY position of the component. To set the left and top instead, use {@link #setPosition}.\nThis method fires the move event.",
+ "sig" : "(x, y)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.BoxComponent",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
- "returns" : [
+ "params" : [
{
- "name" : "",
- "type" : "",
- "desc" : "Boolean"
+ "name" : "x",
+ "type" : "Number",
+ "desc" : "The new x position",
+ "isOptional" : false
+ },
+ {
+ "name" : "y",
+ "type" : "Number",
+ "desc" : "The new y position",
+ "isOptional" : false
}
- ]
+ ],
+ "returns" : []
},
{
- "name" : "setValues",
+ "name" : "setPosition",
"type" : "function",
- "desc" : "Set values for fields in this form in bulk.",
- "sig" : "(values)",
+ "desc" : "Sets the left and top of the component. To set the page XY position instead, use {@link #setPagePosition}.\nThis method fires the move event.",
+ "sig" : "(left, top)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.BoxComponent",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "values",
- "type" : "Array/Object",
- "desc" : "Either an array in the form [{id:'fieldId', value:'foo'},...] or an object hash of {id: value, id2: value2}",
+ "name" : "left",
+ "type" : "Number",
+ "desc" : "The new left",
+ "isOptional" : false
+ },
+ {
+ "name" : "top",
+ "type" : "Number",
+ "desc" : "The new top",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "setSize",
+ "type" : "function",
+ "desc" : "Sets the width and height of the component. This method fires the resize event. This method can accept\neither width and height as separate numeric arguments, or you can pass a size object like {width:10, height:20}.",
+ "sig" : "(width, height)",
+ "static" : false,
+ "memberOf" : "Roo.BoxComponent",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "width",
+ "type" : "Number/Object",
+ "desc" : "The new width to set, or a size object in the format {width, height}",
+ "isOptional" : false
+ },
+ {
+ "name" : "height",
+ "type" : "Number",
+ "desc" : "The new height to set (not required if a size object is passed as the first arg)",
"isOptional" : false
}
],
"returns" : [
{
"name" : "",
- "type" : "BasicForm",
+ "type" : "Roo.BoxComponent",
"desc" : "this"
}
]
},
{
- "name" : "submit",
+ "name" : "setVisible",
"type" : "function",
- "desc" : "Shortcut to do a submit action.",
- "sig" : "(options)",
+ "desc" : "Convenience function to hide or show this component by boolean.",
+ "sig" : "(visible)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "options",
- "type" : "Object",
- "desc" : "The options to pass to the action (see {@link #doAction} for details)",
+ "name" : "visible",
+ "type" : "Boolean",
+ "desc" : "True to show, false to hide",
"isOptional" : false
}
],
"returns" : [
{
"name" : "",
- "type" : "BasicForm",
+ "type" : "Roo.Component",
+ "desc" : "this"
+ }
+ ]
+ },
+ {
+ "name" : "show",
+ "type" : "function",
+ "desc" : "Show this component.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.Component",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.Component",
"desc" : "this"
}
]
},
+ {
+ "name" : "syncSize",
+ "type" : "function",
+ "desc" : "Force the component's size to recalculate based on the underlying element's current height and width.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.BoxComponent",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
{
"name" : "un",
"type" : "function",
"returns" : []
},
{
- "name" : "updateRecord",
+ "name" : "updateBox",
"type" : "function",
- "desc" : "Persists the values in this form into the passed Roo.data.Record object in a beginEdit/endEdit block.",
- "sig" : "(record)",
+ "desc" : "Sets the current box measurements of the component's underlying element.",
+ "sig" : "(box)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.BoxComponent",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "record",
- "type" : "Record",
- "desc" : "The record to edit",
+ "name" : "box",
+ "type" : "Object",
+ "desc" : "An object in the format {x, y, width, height}",
"isOptional" : false
}
],
- "returns" : [
- {
- "name" : "",
- "type" : "BasicForm",
- "desc" : "this"
- }
- ]
+ "returns" : []
}
],
"isAbstract" : false,
"isBuilderTop" : false,
- "childClasses" : {
- "Roo.form.BasicForm" : [
- "Roo.form.Form"
- ]
- },
+ "implementations" : [],
"tree_children" : [],
"tree_parent" : []
},
- "Roo.form.Checkbox" : {
+ "Roo.form" : {
+ "props" : [],
+ "events" : [],
+ "methods" : [],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "implementations" : [],
+ "tree_children" : [],
+ "tree_parent" : []
+ },
+ "Roo.form.Action" : {
+ "props" : [],
+ "events" : [],
+ "methods" : [],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "implementations" : [],
+ "tree_children" : [],
+ "tree_parent" : []
+ },
+ "Roo.form.BasicForm" : {
"props" : [
{
- "name" : "actionMode",
- "type" : "String",
- "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el' for forms you probably want to set this to fieldEl",
- "memberOf" : "Roo.Component"
- },
- {
- "name" : "allowDomMove",
- "type" : "Boolean",
- "desc" : "Whether the component can move the Dom node when rendering (defaults to true).",
- "memberOf" : "Roo.Component"
- },
- {
- "name" : "autoCreate",
- "type" : "String/Object",
- "desc" : "A DomHelper element spec, or true for a default element spec (defaults to\n{tag: \"input\", type: \"checkbox\", autocomplete: \"off\"})",
- "memberOf" : ""
- },
- {
- "name" : "boxLabel",
- "type" : "String",
- "desc" : "The text that appears beside the checkbox",
- "memberOf" : ""
+ "name" : "baseParams",
+ "type" : "Object",
+ "desc" : "Parameters to pass with all requests. e.g. baseParams: {id: '123', foo: 'bar'}.",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
- "name" : "checked",
+ "name" : "errorMask",
"type" : "Boolean",
- "desc" : "True if the the checkbox should render already checked (defaults to false)",
- "memberOf" : ""
- },
- {
- "name" : "cls",
- "type" : "String",
- "desc" : "A CSS class to apply to the field's underlying element.",
- "memberOf" : "Roo.form.Field"
+ "desc" : "e) default fal",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : [
+ "true",
+ "false"
+ ]
},
{
- "name" : "disableClass",
- "type" : "String",
- "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").",
- "memberOf" : "Roo.Component"
+ "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" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
- "name" : "disabled",
+ "name" : "fileUpload",
"type" : "Boolean",
- "desc" : "True to disable the field (defaults to false).",
- "memberOf" : "Roo.form.Field"
- },
- {
- "name" : "fieldClass",
- "type" : "String",
- "desc" : "The default CSS class for the checkbox (defaults to \"x-form-field\")",
- "memberOf" : ""
- },
- {
- "name" : "fieldLabel",
- "type" : "String",
- "desc" : "Label to use when rendering a form.",
- "memberOf" : "Roo.form.Field"
- },
- {
- "name" : "focusClass",
- "type" : "String",
- "desc" : "The CSS class to use when the checkbox receives focus (defaults to undefined)",
- "memberOf" : ""
- },
- {
- "name" : "height",
- "type" : "Number",
- "desc" : "height (optional) size of component",
- "memberOf" : "Roo.BoxComponent"
- },
- {
- "name" : "hideMode",
- "type" : "String",
- "desc" : "y)\nHow this component 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" : "inputType",
- "type" : "String",
- "desc" : "The type attribute for input fields -- e.g. radio, text, password (defaults to \"text\").",
- "memberOf" : "Roo.form.Field"
- },
- {
- "name" : "inputValue",
- "type" : "String",
- "desc" : "The value that should go into the generated input element's value attribute",
- "memberOf" : ""
- },
- {
- "name" : "invalidClass",
- "type" : "String",
- "desc" : "The CSS class to use when marking a field invalid (defaults to \"x-form-invalid\")",
- "memberOf" : "Roo.form.Field"
- },
- {
- "name" : "invalidText",
- "type" : "String",
- "desc" : "The error text to use when marking a field invalid and no message is provided (defaults to \"The value in this field is invalid\")",
- "memberOf" : "Roo.form.Field"
+ "desc" : "Set to true if this form is a file upload.",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"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"
- },
- {
- "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" : "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"
+ "memberOf" : "Roo.util.Observable",
+ "isOptional" : false,
+ "optvals" : []
},
{
- "name" : "name",
- "type" : "String",
- "desc" : "The field's HTML name attribute.",
- "memberOf" : "Roo.form.Field"
+ "name" : "maskOffset",
+ "type" : "Number",
+ "desc" : "Default 100",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
- "name" : "qtip",
+ "name" : "method",
"type" : "String",
- "desc" : "Mouse over tip",
- "memberOf" : "Roo.form.Field"
+ "desc" : "The request method to use (GET or POST) for form actions if one isn't supplied in the action options.",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
- "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" : "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" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
- "name" : "tabIndex",
+ "name" : "timeout",
"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"
+ "desc" : "Timeout for form actions in seconds (default is 30 seconds).",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
- "name" : "validateOnBlur",
+ "name" : "trackResetOnLoad",
"type" : "Boolean",
- "desc" : "Whether the field should validate when it loses focus (defaults to true).",
- "memberOf" : "Roo.form.Field"
- },
- {
- "name" : "validationDelay",
- "type" : "Number",
- "desc" : "The length of time in milliseconds after user input begins until validation is initiated (defaults to 250)",
- "memberOf" : "Roo.form.Field"
- },
- {
- "name" : "validationEvent",
- "type" : "String/Boolean",
- "desc" : "The event that should initiate field validation. Set to false to disable\n automatic validation (defaults to \"keyup\").",
- "memberOf" : "Roo.form.Field"
- },
- {
- "name" : "value",
- "type" : "Mixed",
- "desc" : "A value to initialize this field with.",
- "memberOf" : "Roo.form.Field"
+ "desc" : "If set to true, form.reset() resets to the last loaded\nor setValues() data instead of when the form was first created.",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
- "name" : "valueOff",
+ "name" : "url",
"type" : "String",
- "desc" : "The value that should go into the generated input element's value when unchecked.",
- "memberOf" : ""
- },
- {
- "name" : "width",
- "type" : "Number",
- "desc" : "width (optional) size of component",
- "memberOf" : "Roo.BoxComponent"
+ "desc" : "The URL to use for form actions if one isn't supplied in the action options.",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
}
],
"events" : [
{
- "name" : "beforedestroy",
- "type" : "function",
- "desc" : "Fires before the component is destroyed. Return false to stop the destroy.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.Component",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "beforehide",
+ "name" : "actioncomplete",
"type" : "function",
- "desc" : "Fires before the component is hidden. Return false to stop the hide.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
+ "desc" : "Fires when an action is completed.",
+ "sig" : "function (_self, action)\n{\n\n}",
+ "memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.Component",
+ "type" : "Form",
"desc" : "",
"isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "beforerender",
- "type" : "function",
- "desc" : "Fires before the component is rendered. Return false to stop the render.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
+ },
{
- "name" : "this",
- "type" : "Roo.Component",
- "desc" : "",
+ "name" : "action",
+ "type" : "Action",
+ "desc" : "The action that completed",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "beforeshow",
+ "name" : "actionfailed",
"type" : "function",
- "desc" : "Fires before the component is shown. Return false to stop the show.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
+ "desc" : "Fires when an action fails.",
+ "sig" : "function (_self, action)\n{\n\n}",
+ "memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.Component",
+ "type" : "Form",
"desc" : "",
"isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "blur",
- "type" : "function",
- "desc" : "Fires when this field loses input focus.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.form.Field",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
+ },
{
- "name" : "this",
- "type" : "Roo.form.Field",
- "desc" : "",
+ "name" : "action",
+ "type" : "Action",
+ "desc" : "The action that failed",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "change",
+ "name" : "beforeaction",
"type" : "function",
- "desc" : "Fires just before the field blurs if the field value has changed.",
- "sig" : "function (_self, newValue, oldValue)\n{\n\n}",
- "memberOf" : "Roo.form.Field",
+ "desc" : "Fires before any action is performed. Return false to cancel the action.",
+ "sig" : "function (_self, action)\n{\n\n}",
+ "memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.form.Field",
+ "type" : "Form",
"desc" : "",
"isOptional" : false
},
{
- "name" : "newValue",
- "type" : "Mixed",
- "desc" : "The new value",
- "isOptional" : false
- },
- {
- "name" : "oldValue",
- "type" : "Mixed",
- "desc" : "The original value",
+ "name" : "action",
+ "type" : "Action",
+ "desc" : "The action to be performed",
"isOptional" : false
}
],
"returns" : []
- },
+ }
+ ],
+ "methods" : [
{
- "name" : "check",
+ "name" : "add",
"type" : "function",
- "desc" : "Fires when the checkbox is checked or unchecked.",
- "sig" : "function (_self, checked)\n{\n\n}",
+ "desc" : "Add Roo.form components to this form.",
+ "sig" : "(field1, field2, etc)",
+ "static" : false,
"memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
- "name" : "this",
- "type" : "Roo.form.Checkbox",
- "desc" : "This checkbox",
+ "name" : "field1",
+ "type" : "Field",
+ "desc" : "",
"isOptional" : false
},
{
- "name" : "checked",
- "type" : "Boolean",
- "desc" : "The new checked value",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "destroy",
- "type" : "function",
- "desc" : "Fires after the component is destroyed.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.Component",
- "desc" : "",
+ "name" : "field2",
+ "type" : "Field",
+ "desc" : "(optional)",
"isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "disable",
- "type" : "function",
- "desc" : "Fires after the component is disabled.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
+ },
{
- "name" : "this",
- "type" : "Roo.Component",
- "desc" : "",
+ "name" : "etc",
+ "type" : "Field",
+ "desc" : "(optional)",
"isOptional" : false
}
],
- "returns" : []
- },
- {
- "name" : "enable",
- "type" : "function",
- "desc" : "Fires after the component is enabled.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
+ "returns" : [
{
- "name" : "this",
- "type" : "Roo.Component",
- "desc" : "",
- "isOptional" : false
+ "name" : "",
+ "type" : "BasicForm",
+ "desc" : "this"
}
- ],
- "returns" : []
+ ]
},
{
- "name" : "focus",
+ "name" : "addEvents",
"type" : "function",
- "desc" : "Fires when this field receives input focus.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.form.Field",
+ "desc" : "Used to define events on this Observable",
+ "sig" : "(object)",
+ "static" : false,
+ "memberOf" : "Roo.util.Observable",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
- "name" : "this",
- "type" : "Roo.form.Field",
- "desc" : "",
+ "name" : "object",
+ "type" : "Object",
+ "desc" : "The object with the events defined",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "hide",
+ "name" : "addForm",
"type" : "function",
- "desc" : "Fires after the component is hidden.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
+ "desc" : "Add a secondary form to this one, \nUsed to provide tabbed forms. One form is primary, with hidden values \nwhich mirror the elements from the other forms.",
+ "sig" : "(form)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
- "name" : "this",
- "type" : "Roo.Component",
- "desc" : "",
+ "name" : "form",
+ "type" : "Roo.form.Form",
+ "desc" : "to add.",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "invalid",
+ "name" : "addListener",
"type" : "function",
- "desc" : "Fires after the field has been marked as invalid.",
- "sig" : "function (_self, msg)\n{\n\n}",
- "memberOf" : "Roo.form.Field",
+ "desc" : "Appends an event handler to this component",
+ "sig" : "(eventName, handler, scope, options)",
+ "static" : false,
+ "memberOf" : "Roo.util.Observable",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
- "name" : "this",
- "type" : "Roo.form.Field",
- "desc" : "",
+ "name" : "eventName",
+ "type" : "String",
+ "desc" : "The type of event to listen for",
"isOptional" : false
},
{
- "name" : "msg",
- "type" : "String",
- "desc" : "The validation message",
+ "name" : "handler",
+ "type" : "Function",
+ "desc" : "The method the event invokes",
"isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "keyup",
- "type" : "function",
- "desc" : "Fires after the key up",
- "sig" : "function (_self, e)\n{\n\n}",
- "memberOf" : "Roo.form.Field",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
+ },
{
- "name" : "this",
- "type" : "Roo.form.Field",
- "desc" : "",
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
"isOptional" : false
},
{
- "name" : "e",
- "type" : "Roo.EventObject",
- "desc" : "The event Object",
+ "name" : "options",
+ "type" : "Object",
+ "desc" : "(optional) An object containing handler configuration\nproperties. This may contain any of the following properties:<ul>\n<li>scope {Object} The scope in which to execute the handler function. The handler function's \"this\" context.</li>\n<li>delay {Number} The number of milliseconds to delay the invocation of the handler after te event fires.</li>\n<li>single {Boolean} True to add a handler to handle just the next firing of the event, and then remove itself.</li>\n<li>buffer {Number} Causes the handler to be scheduled to run in an {@link Roo.util.DelayedTask} delayed\nby the specified number of milliseconds. If the event fires again within that time, the original\nhandler is <em>not</em> invoked, but the new handler is scheduled in its place.</li>\n</ul><br>\n<p>\n<b>Combining Options</b><br>\nUsing the options argument, it is possible to combine different types of listeners:<br>\n<br>\nA normalized, delayed, one-time listener that auto stops the event and passes a custom argument (forumId)\n\t\t<pre><code>\n\t\tel.on('click', this.onClick, this, {\n \t\t\tsingle: true,\n \t\tdelay: 100,\n \t\tforumId: 4\n\t\t});\n\t\t</code></pre>\n<p>\n<b>Attaching multiple handlers in 1 call</b><br>\nThe method also allows for a single argument to be passed which is a config object containing properties\nwhich specify multiple handlers.\n<pre><code>\n\t\tel.on({\n\t\t\t'click': {\n \t\tfn: this.onClick,\n \t\tscope: this,\n \t\tdelay: 100\n \t\t}, \n \t\t'mouseover': {\n \t\tfn: this.onMouseOver,\n \t\tscope: this\n \t\t},\n \t\t'mouseout': {\n \t\tfn: this.onMouseOut,\n \t\tscope: this\n \t\t}\n\t\t});\n\t\t</code></pre>\n<p>\nOr a shorthand syntax which passes the same scope object to all handlers:\n \t<pre><code>\n\t\tel.on({\n\t\t\t'click': this.onClick,\n \t\t'mouseover': this.onMouseOver,\n \t\t'mouseout': this.onMouseOut,\n \t\tscope: this\n\t\t});\n\t\t</code></pre>",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "move",
+ "name" : "applyIfToFields",
"type" : "function",
- "desc" : "Fires after the component is moved.",
- "sig" : "function (_self, x, y)\n{\n\n}",
- "memberOf" : "Roo.BoxComponent",
+ "desc" : "Calls {@link Ext#applyIf} for all field in this form with the passed object.",
+ "sig" : "(values)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
- "name" : "this",
- "type" : "Roo.Component",
+ "name" : "values",
+ "type" : "Object",
"desc" : "",
"isOptional" : false
- },
- {
- "name" : "x",
- "type" : "Number",
- "desc" : "The new x position",
- "isOptional" : false
- },
- {
- "name" : "y",
- "type" : "Number",
- "desc" : "The new y position",
- "isOptional" : false
}
],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "BasicForm",
+ "desc" : "this"
+ }
+ ]
},
{
- "name" : "render",
+ "name" : "applyToFields",
"type" : "function",
- "desc" : "Fires after the component is rendered.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
+ "desc" : "Calls {@link Ext#apply} for all fields in this form with the passed object.",
+ "sig" : "(values)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
- "name" : "this",
- "type" : "Roo.Component",
+ "name" : "values",
+ "type" : "Object",
"desc" : "",
"isOptional" : false
}
],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "BasicForm",
+ "desc" : "this"
+ }
+ ]
},
{
- "name" : "resize",
+ "name" : "capture",
"type" : "function",
- "desc" : "Fires after the component is resized.",
- "sig" : "function (_self, adjWidth, adjHeight, rawWidth, rawHeight)\n{\n\n}",
- "memberOf" : "Roo.BoxComponent",
+ "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\n<b>before</b> the event is fired. If the supplied function returns false,\nthe event will not fire.",
+ "sig" : "(o, fn, scope)",
+ "static" : true,
+ "memberOf" : "Roo.util.Observable",
+ "isStatic" : true,
+ "isConstructor" : false,
+ "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
- "name" : "this",
- "type" : "Roo.Component",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "adjWidth",
- "type" : "Number",
- "desc" : "The box-adjusted width that was set",
- "isOptional" : false
- },
- {
- "name" : "adjHeight",
- "type" : "Number",
- "desc" : "The box-adjusted height that was set",
+ "name" : "o",
+ "type" : "Observable",
+ "desc" : "The Observable to capture",
"isOptional" : false
},
{
- "name" : "rawWidth",
- "type" : "Number",
- "desc" : "The width that was originally specified",
+ "name" : "fn",
+ "type" : "Function",
+ "desc" : "The function to call",
"isOptional" : false
},
{
- "name" : "rawHeight",
- "type" : "Number",
- "desc" : "The height that was originally specified",
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "(optional) The scope (this object) for the fn",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "show",
+ "name" : "clearInvalid",
"type" : "function",
- "desc" : "Fires after the component is shown.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
+ "desc" : "Clears all invalid messages in this form.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "params" : [
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : [
{
- "name" : "this",
- "type" : "Roo.Component",
- "desc" : "",
- "isOptional" : false
+ "name" : "",
+ "type" : "BasicForm",
+ "desc" : "this"
}
- ],
- "returns" : []
+ ]
},
{
- "name" : "specialkey",
+ "name" : "doAction",
"type" : "function",
- "desc" : "Fires when any key related to navigation (arrows, tab, enter, esc, etc.) is pressed. You can check\n{@link Roo.EventObject#getKey} to determine which key was pressed.",
- "sig" : "function (_self, e)\n{\n\n}",
- "memberOf" : "Roo.form.Field",
+ "desc" : "Performs a predefined action (submit or load) or custom actions you define on this form.",
+ "sig" : "(actionName, options)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
- "name" : "this",
- "type" : "Roo.form.Field",
- "desc" : "",
+ "name" : "actionName",
+ "type" : "String",
+ "desc" : "The name of the action type",
"isOptional" : false
},
{
- "name" : "e",
- "type" : "Roo.EventObject",
- "desc" : "The event object",
+ "name" : "options",
+ "type" : "Object",
+ "desc" : "(optional) The options to pass to the action. All of the config options listed\nbelow are supported by both the submit and load actions unless otherwise noted (custom actions could also\naccept other config options):\n<pre>\nProperty Type Description\n---------------- --------------- ----------------------------------------------------------------------------------\nurl String The url for the action (defaults to the form's url)\nmethod String The form method to use (defaults to the form's method, or POST if not defined)\nparams String/Object The params to pass (defaults to the form's baseParams, or none if not defined)\nclientValidation Boolean Applies to submit only. Pass true to call form.isValid() prior to posting to\n validate the form on the client (defaults to false)\n</pre>",
"isOptional" : false
}
],
- "returns" : []
- },
- {
- "name" : "valid",
- "type" : "function",
- "desc" : "Fires after the field has been validated with no errors.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.form.Field",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
+ "returns" : [
{
- "name" : "this",
- "type" : "Roo.form.Field",
- "desc" : "",
- "isOptional" : false
+ "name" : "",
+ "type" : "BasicForm",
+ "desc" : "this"
}
- ],
- "returns" : []
- }
- ],
- "methods" : [
+ ]
+ },
{
- "name" : "addEvents",
+ "name" : "findField",
"type" : "function",
- "desc" : "Used to define events on this Observable",
- "sig" : "(object)",
+ "desc" : "Find a Roo.form.Field in this form by id, dataIndex, name or hiddenName",
+ "sig" : "(id)",
"static" : false,
- "memberOf" : "Roo.util.Observable",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "object",
- "type" : "Object",
- "desc" : "The object with the events defined",
+ "name" : "id",
+ "type" : "String",
+ "desc" : "The value to search for",
"isOptional" : false
}
],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "",
+ "desc" : "Field"
+ }
+ ]
},
{
- "name" : "addListener",
+ "name" : "fireEvent",
"type" : "function",
- "desc" : "Appends an event handler to this component",
- "sig" : "(eventName, handler, scope, options)",
+ "desc" : "Fires the specified event with the passed parameters (minus the event name).",
+ "sig" : "(eventName, args)",
"static" : false,
"memberOf" : "Roo.util.Observable",
"isStatic" : false,
{
"name" : "eventName",
"type" : "String",
- "desc" : "The type of event to listen for",
- "isOptional" : false
- },
- {
- "name" : "handler",
- "type" : "Function",
- "desc" : "The method the event invokes",
- "isOptional" : false
- },
- {
- "name" : "scope",
- "type" : "Object",
- "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
+ "desc" : "",
"isOptional" : false
},
{
- "name" : "options",
- "type" : "Object",
- "desc" : "(optional) An object containing handler configuration\nproperties. This may contain any of the following properties:<ul>\n<li>scope {Object} The scope in which to execute the handler function. The handler function's \"this\" context.</li>\n<li>delay {Number} The number of milliseconds to delay the invocation of the handler after te event fires.</li>\n<li>single {Boolean} True to add a handler to handle just the next firing of the event, and then remove itself.</li>\n<li>buffer {Number} Causes the handler to be scheduled to run in an {@link Roo.util.DelayedTask} delayed\nby the specified number of milliseconds. If the event fires again within that time, the original\nhandler is <em>not</em> invoked, but the new handler is scheduled in its place.</li>\n</ul><br>\n<p>\n<b>Combining Options</b><br>\nUsing the options argument, it is possible to combine different types of listeners:<br>\n<br>\nA normalized, delayed, one-time listener that auto stops the event and passes a custom argument (forumId)\n\t\t<pre><code>\n\t\tel.on('click', this.onClick, this, {\n \t\t\tsingle: true,\n \t\tdelay: 100,\n \t\tforumId: 4\n\t\t});\n\t\t</code></pre>\n<p>\n<b>Attaching multiple handlers in 1 call</b><br>\nThe method also allows for a single argument to be passed which is a config object containing properties\nwhich specify multiple handlers.\n<pre><code>\n\t\tel.on({\n\t\t\t'click': {\n \t\tfn: this.onClick,\n \t\tscope: this,\n \t\tdelay: 100\n \t\t}, \n \t\t'mouseover': {\n \t\tfn: this.onMouseOver,\n \t\tscope: this\n \t\t},\n \t\t'mouseout': {\n \t\tfn: this.onMouseOut,\n \t\tscope: this\n \t\t}\n\t\t});\n\t\t</code></pre>\n<p>\nOr a shorthand syntax which passes the same scope object to all handlers:\n \t<pre><code>\n\t\tel.on({\n\t\t\t'click': this.onClick,\n \t\t'mouseover': this.onMouseOver,\n \t\t'mouseout': this.onMouseOut,\n \t\tscope: this\n\t\t});\n\t\t</code></pre>",
+ "name" : "args",
+ "type" : "Object...",
+ "desc" : "Variable number of parameters are passed to handlers",
"isOptional" : false
}
],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Boolean",
+ "desc" : "returns false if any of the handlers return false otherwise it returns true"
+ }
+ ]
},
{
- "name" : "applyTo",
+ "name" : "getFieldValues",
"type" : "function",
- "desc" : "Apply the behaviors of this component to an existing element. <b>This is used instead of render().</b>",
- "sig" : "(el)",
+ "desc" : "Returns the fields in this form as an object with key/value pairs. \nThis differs from getValues as it calls getValue on each child item, rather than using dom data.\nNormally this will not return readOnly data",
+ "sig" : "(with_readonly)",
"static" : false,
- "memberOf" : "Roo.form.Field",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "el",
- "type" : "String/HTMLElement/Element",
- "desc" : "The id of the node, a DOM node or an existing Element",
+ "name" : "with_readonly",
+ "type" : "Boolean",
+ "desc" : "return readonly field data.",
"isOptional" : false
}
],
"returns" : [
{
"name" : "",
- "type" : "Roo.form.Field",
- "desc" : "this"
+ "type" : "Object",
+ "desc" : ""
}
]
},
{
- "name" : "capture",
+ "name" : "getValues",
"type" : "function",
- "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\n<b>before</b> the event is fired. If the supplied function returns false,\nthe event will not fire.",
- "sig" : "(o, fn, scope)",
- "static" : true,
- "memberOf" : "Roo.util.Observable",
- "isStatic" : true,
+ "desc" : "Returns the fields in this form as an object with key/value pairs. If multiple fields exist with the same name\nthey are returned as an array.",
+ "sig" : "(asString)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"example" : "",
"requires" : "",
"params" : [
{
- "name" : "o",
- "type" : "Observable",
- "desc" : "The Observable to capture",
- "isOptional" : false
- },
- {
- "name" : "fn",
- "type" : "Function",
- "desc" : "The function to call",
+ "name" : "asString",
+ "type" : "Boolean",
+ "desc" : "(def)",
"isOptional" : false
- },
- {
- "name" : "scope",
- "type" : "Object",
- "desc" : "(optional) The scope (this object) for the fn",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "clearInvalid",
- "type" : "function",
- "desc" : "Clear any invalid styles/messages for this field",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.form.Field",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
- {
- "name" : "destroy",
- "type" : "function",
- "desc" : "Destroys this component by purging any event listeners, removing the component's element from the DOM,\nremoving the component from its {@link Roo.Container} (if applicable) and unregistering it from {@link Roo.ComponentMgr}.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.Component",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
- {
- "name" : "disable",
- "type" : "function",
- "desc" : "Disable this component.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.Component",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : [
+ }
+ ],
+ "returns" : [
{
"name" : "",
- "type" : "Roo.Component",
- "desc" : "this"
+ "type" : "Object",
+ "desc" : ""
}
]
},
{
- "name" : "enable",
+ "name" : "hasChanged",
"type" : "function",
- "desc" : "Enable this component.",
+ "desc" : "Returns true if any fields in this form have changed since their original load. (New version)",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.Component",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"returns" : [
{
"name" : "",
- "type" : "Roo.Component",
- "desc" : "this"
+ "type" : "",
+ "desc" : "Boolean"
}
]
},
{
- "name" : "fireEvent",
+ "name" : "hasListener",
"type" : "function",
- "desc" : "Fires the specified event with the passed parameters (minus the event name).",
- "sig" : "(eventName, args)",
+ "desc" : "Checks to see if this object has any listeners for a specified event",
+ "sig" : "(eventName)",
"static" : false,
"memberOf" : "Roo.util.Observable",
"isStatic" : false,
{
"name" : "eventName",
"type" : "String",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "args",
- "type" : "Object...",
- "desc" : "Variable number of parameters are passed to handlers",
+ "desc" : "The name of the event to check for",
"isOptional" : false
}
],
{
"name" : "",
"type" : "Boolean",
- "desc" : "returns false if any of the handlers return false otherwise it returns true"
- }
- ]
- },
- {
- "name" : "focus",
- "type" : "function",
- "desc" : "Try to focus this component.",
- "sig" : "(selectText)",
- "static" : false,
- "memberOf" : "Roo.Component",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "selectText",
- "type" : "Boolean",
- "desc" : "True to also select the text in this component (if applicable)",
- "isOptional" : false
- }
- ],
- "returns" : [
- {
- "name" : "",
- "type" : "Roo.Component",
- "desc" : "this"
+ "desc" : "True if the event is being listened for, else false"
}
]
},
{
- "name" : "getBox",
- "type" : "function",
- "desc" : "Gets the current box measurements of the component's underlying element.",
- "sig" : "(local)",
- "static" : false,
- "memberOf" : "Roo.BoxComponent",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "local",
- "type" : "Boolean",
- "desc" : "(optional) If true the element's left and top are returned instead of page XY (defaults to false)",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "getEl",
+ "name" : "invalidFields",
"type" : "function",
- "desc" : "Returns the underlying {@link Roo.Element}.",
+ "desc" : "Returns array of invalid form fields.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.Component",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"returns" : [
{
"name" : "",
- "type" : "Roo.Element",
- "desc" : "The element"
+ "type" : "",
+ "desc" : "Array"
}
]
},
{
- "name" : "getId",
+ "name" : "isDirty",
"type" : "function",
- "desc" : "Returns the id of this component.",
+ "desc" : "DEPRICATED Returns true if any fields in this form have changed since their original load.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.Component",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"returns" : [
{
"name" : "",
- "type" : "String",
- "desc" : ""
+ "type" : "",
+ "desc" : "Boolean"
}
]
},
{
- "name" : "getName",
+ "name" : "isValid",
"type" : "function",
- "desc" : "Returns the name attribute of the field if available",
+ "desc" : "Returns true if client-side validation on the form is successful.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.form.Field",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"returns" : [
{
"name" : "",
- "type" : "String",
- "desc" : "name The field name"
+ "type" : "",
+ "desc" : "Boolean"
}
]
},
{
- "name" : "getPosition",
+ "name" : "load",
"type" : "function",
- "desc" : "Gets the current XY position of the component's underlying element.",
- "sig" : "(local)",
+ "desc" : "Shortcut to do a load action.",
+ "sig" : "(options)",
"static" : false,
- "memberOf" : "Roo.BoxComponent",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "local",
- "type" : "Boolean",
- "desc" : "(optional) If true the element's left and top are returned instead of page XY (defaults to false)",
+ "name" : "options",
+ "type" : "Object",
+ "desc" : "The options to pass to the action (see {@link #doAction} for details)",
"isOptional" : false
}
],
"returns" : [
{
"name" : "",
- "type" : "Array",
- "desc" : "The XY position of the element (e.g., [100, 200])"
- }
- ]
- },
- {
- "name" : "getRawValue",
- "type" : "function",
- "desc" : "Returns the raw data value which may or may not be a valid, defined value. To return a normalized value see {@link #getValue}.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.form.Field",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : [
- {
- "name" : "",
- "type" : "Mixed",
- "desc" : "value The field value"
- }
- ]
- },
- {
- "name" : "getSize",
- "type" : "function",
- "desc" : "Gets the current size of the component's underlying element.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.BoxComponent",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : [
- {
- "name" : "",
- "type" : "Object",
- "desc" : "An object containing the element's size {width: (element width), height: (element height)}"
+ "type" : "BasicForm",
+ "desc" : "this"
}
]
},
{
- "name" : "getValue",
+ "name" : "loadRecord",
"type" : "function",
- "desc" : "Returns the checked state of the checkbox.",
- "sig" : "()\n{\n\n}",
+ "desc" : "Loads an Roo.data.Record into this form.",
+ "sig" : "(record)",
"static" : false,
"memberOf" : "",
"isStatic" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
- "returns" : [
- {
- "name" : "",
- "type" : "Boolean",
- "desc" : "True if checked, else false"
- }
- ]
- },
- {
- "name" : "hasChanged",
- "type" : "function",
- "desc" : "checks the current value against the 'loaded' value.\nNote - will return false if 'resetHasChanged' has not been called first.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.form.Field",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
- {
- "name" : "hasListener",
- "type" : "function",
- "desc" : "Checks to see if this object has any listeners for a specified event",
- "sig" : "(eventName)",
- "static" : false,
- "memberOf" : "Roo.util.Observable",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
"params" : [
{
- "name" : "eventName",
- "type" : "String",
- "desc" : "The name of the event to check for",
+ "name" : "record",
+ "type" : "Record",
+ "desc" : "The record to load",
"isOptional" : false
}
],
"returns" : [
{
"name" : "",
- "type" : "Boolean",
- "desc" : "True if the event is being listened for, else false"
- }
- ]
- },
- {
- "name" : "hide",
- "type" : "function",
- "desc" : "Hide this component.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.Component",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : [
- {
- "name" : "",
- "type" : "Roo.Component",
+ "type" : "BasicForm",
"desc" : "this"
}
]
},
{
- "name" : "isDirty",
- "type" : "function",
- "desc" : "Returns true if this field has been changed since it was originally loaded and is not disabled.\nDEPRICATED - it never worked well - use hasChanged/resetHasChanged.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.form.Field",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
- {
- "name" : "isValid",
+ "name" : "markInvalid",
"type" : "function",
- "desc" : "Returns whether or not the field value is currently valid",
- "sig" : "(preventMark)",
+ "desc" : "Mark fields in this form invalid in bulk.",
+ "sig" : "(errors)",
"static" : false,
- "memberOf" : "Roo.form.Field",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "preventMark",
- "type" : "Boolean",
- "desc" : "True to disable marking the field invalid",
+ "name" : "errors",
+ "type" : "Array/Object",
+ "desc" : "Either an array in the form [{id:'fieldId', msg:'The message'},...] or an object hash of {id: msg, id2: msg2}",
"isOptional" : false
}
],
"returns" : [
{
"name" : "",
- "type" : "Boolean",
- "desc" : "True if the value is valid, else false"
+ "type" : "BasicForm",
+ "desc" : "this"
}
]
},
- {
- "name" : "isVisible",
- "type" : "function",
- "desc" : "Returns true if this component is visible.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.Component",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
- {
- "name" : "markInvalid",
- "type" : "function",
- "desc" : "Mark this field as invalid",
- "sig" : "(msg)",
- "static" : false,
- "memberOf" : "Roo.form.Field",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "msg",
- "type" : "String",
- "desc" : "The validation message",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
{
"name" : "on",
"type" : "function",
"returns" : []
},
{
- "name" : "onPosition",
+ "name" : "purgeListeners",
"type" : "function",
- "desc" : "Called after the component is moved, this method is empty by default but can be implemented by any\nsubclass that needs to perform custom logic after a move occurs.",
- "sig" : "(x, y)",
+ "desc" : "Removes all listeners for this object",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.BoxComponent",
+ "memberOf" : "Roo.util.Observable",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "x",
- "type" : "Number",
- "desc" : "The new x position",
- "isOptional" : false
- },
- {
- "name" : "y",
- "type" : "Number",
- "desc" : "The new y position",
- "isOptional" : false
- }
- ],
+ "params" : [],
"returns" : []
},
{
- "name" : "onResize",
+ "name" : "releaseCapture",
"type" : "function",
- "desc" : "Called after the component is resized, this method is empty by default but can be implemented by any\nsubclass that needs to perform custom logic after a resize occurs.",
- "sig" : "(adjWidth, adjHeight, rawWidth, rawHeight)",
- "static" : false,
- "memberOf" : "Roo.BoxComponent",
- "isStatic" : false,
+ "desc" : "Removes <b>all</b> added captures from the Observable.",
+ "sig" : "(o)",
+ "static" : true,
+ "memberOf" : "Roo.util.Observable",
+ "isStatic" : true,
"isConstructor" : false,
"isPrivate" : false,
"example" : "",
"requires" : "",
"params" : [
{
- "name" : "adjWidth",
- "type" : "Number",
- "desc" : "The box-adjusted width that was set",
- "isOptional" : false
- },
- {
- "name" : "adjHeight",
- "type" : "Number",
- "desc" : "The box-adjusted height that was set",
- "isOptional" : false
- },
- {
- "name" : "rawWidth",
- "type" : "Number",
- "desc" : "The width that was originally specified",
- "isOptional" : false
- },
- {
- "name" : "rawHeight",
- "type" : "Number",
- "desc" : "The height that was originally specified",
+ "name" : "o",
+ "type" : "Observable",
+ "desc" : "The Observable to release",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "purgeListeners",
+ "name" : "remove",
"type" : "function",
- "desc" : "Removes all listeners for this object",
- "sig" : "()\n{\n\n}",
+ "desc" : "Removes a field from the items collection (does NOT remove its markup).",
+ "sig" : "(field)",
"static" : false,
- "memberOf" : "Roo.util.Observable",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
- "returns" : []
- },
- {
- "name" : "releaseCapture",
- "type" : "function",
- "desc" : "Removes <b>all</b> added captures from the Observable.",
- "sig" : "(o)",
- "static" : true,
- "memberOf" : "Roo.util.Observable",
- "isStatic" : true,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
"params" : [
{
- "name" : "o",
- "type" : "Observable",
- "desc" : "The Observable to release",
+ "name" : "field",
+ "type" : "Field",
+ "desc" : "",
"isOptional" : false
}
],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "BasicForm",
+ "desc" : "this"
+ }
+ ]
},
{
"name" : "removeListener",
{
"name" : "render",
"type" : "function",
- "desc" : "If this is a lazy rendering component, render it to its container element.",
- "sig" : "(container)",
+ "desc" : "Looks at the fields in this form, checks them for an id attribute,\nand calls applyTo on the existing dom element with that id.",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.Component",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
+ "params" : [],
+ "returns" : [
{
- "name" : "container",
- "type" : "String/HTMLElement/Element",
- "desc" : "(optional) The element this component should be rendered into. If it is being applied to existing markup, this should be left off.",
- "isOptional" : false
+ "name" : "",
+ "type" : "BasicForm",
+ "desc" : "this"
}
- ],
- "returns" : []
+ ]
},
{
"name" : "reset",
"type" : "function",
- "desc" : "Resets the current field value to the originally loaded value and clears any validation messages",
+ "desc" : "Resets this form.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.form.Field",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"exceptions" : "",
"requires" : "",
"params" : [],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "BasicForm",
+ "desc" : "this"
+ }
+ ]
},
{
"name" : "resetHasChanged",
"type" : "function",
- "desc" : "stores the current value in loadedValue",
+ "desc" : "Resets all hasChanged to 'false' -\nThe old 'isDirty' used 'original value..' however this breaks reset() and a few other things.\nSo hasChanged storage is only to be used for this purpose",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.form.Field",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"exceptions" : "",
"requires" : "",
"params" : [],
- "returns" : []
- },
- {
- "name" : "setDisabled",
- "type" : "function",
- "desc" : "Convenience function for setting disabled/enabled by boolean.",
- "sig" : "(disabled)",
- "static" : false,
- "memberOf" : "Roo.Component",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "disabled",
- "type" : "Boolean",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "setPagePosition",
- "type" : "function",
- "desc" : "Sets the page XY position of the component. To set the left and top instead, use {@link #setPosition}.\nThis method fires the move event.",
- "sig" : "(x, y)",
- "static" : false,
- "memberOf" : "Roo.BoxComponent",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "x",
- "type" : "Number",
- "desc" : "The new x position",
- "isOptional" : false
- },
- {
- "name" : "y",
- "type" : "Number",
- "desc" : "The new y position",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "setPosition",
- "type" : "function",
- "desc" : "Sets the left and top of the component. To set the page XY position instead, use {@link #setPagePosition}.\nThis method fires the move event.",
- "sig" : "(left, top)",
- "static" : false,
- "memberOf" : "Roo.BoxComponent",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "left",
- "type" : "Number",
- "desc" : "The new left",
- "isOptional" : false
- },
- {
- "name" : "top",
- "type" : "Number",
- "desc" : "The new top",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "setRawValue",
- "type" : "function",
- "desc" : "Sets the underlying DOM field's value directly, bypassing validation. To set the value with validation see {@link #setValue}.",
- "sig" : "(value)",
- "static" : false,
- "memberOf" : "Roo.form.Field",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
+ "returns" : [
{
- "name" : "value",
- "type" : "Mixed",
- "desc" : "The value to set",
- "isOptional" : false
+ "name" : "",
+ "type" : "",
+ "desc" : "Boolean"
}
- ],
- "returns" : []
+ ]
},
{
- "name" : "setSize",
+ "name" : "setValues",
"type" : "function",
- "desc" : "Sets the width and height of the component. This method fires the resize event. This method can accept\neither width and height as separate numeric arguments, or you can pass a size object like {width:10, height:20}.",
- "sig" : "(width, height)",
+ "desc" : "Set values for fields in this form in bulk.",
+ "sig" : "(values)",
"static" : false,
- "memberOf" : "Roo.BoxComponent",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "width",
- "type" : "Number/Object",
- "desc" : "The new width to set, or a size object in the format {width, height}",
- "isOptional" : false
- },
- {
- "name" : "height",
- "type" : "Number",
- "desc" : "The new height to set (not required if a size object is passed as the first arg)",
+ "name" : "values",
+ "type" : "Array/Object",
+ "desc" : "Either an array in the form [{id:'fieldId', value:'foo'},...] or an object hash of {id: value, id2: value2}",
"isOptional" : false
}
],
"returns" : [
{
"name" : "",
- "type" : "Roo.BoxComponent",
+ "type" : "BasicForm",
"desc" : "this"
}
]
},
{
- "name" : "setValue",
+ "name" : "submit",
"type" : "function",
- "desc" : "Sets the checked state of the checkbox.\nOn is always based on a string comparison between inputValue and the param.",
- "sig" : "(value, suppressEvent)",
+ "desc" : "Shortcut to do a submit action.",
+ "sig" : "(options)",
"static" : false,
"memberOf" : "",
"isStatic" : false,
"requires" : "",
"params" : [
{
- "name" : "value",
- "type" : "Boolean/String",
- "desc" : "- the value to set",
- "isOptional" : false
- },
- {
- "name" : "suppressEvent",
- "type" : "Boolean/String",
- "desc" : "- whether to suppress the checkchange event.",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "setVisible",
- "type" : "function",
- "desc" : "Convenience function to hide or show this component by boolean.",
- "sig" : "(visible)",
- "static" : false,
- "memberOf" : "Roo.Component",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "visible",
- "type" : "Boolean",
- "desc" : "True to show, false to hide",
+ "name" : "options",
+ "type" : "Object",
+ "desc" : "The options to pass to the action (see {@link #doAction} for details)",
"isOptional" : false
}
],
"returns" : [
{
"name" : "",
- "type" : "Roo.Component",
- "desc" : "this"
- }
- ]
- },
- {
- "name" : "show",
- "type" : "function",
- "desc" : "Show this component.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.Component",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : [
- {
- "name" : "",
- "type" : "Roo.Component",
+ "type" : "BasicForm",
"desc" : "this"
}
]
},
- {
- "name" : "syncSize",
- "type" : "function",
- "desc" : "Force the component's size to recalculate based on the underlying element's current height and width.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.BoxComponent",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
{
"name" : "un",
"type" : "function",
"returns" : []
},
{
- "name" : "updateBox",
+ "name" : "updateRecord",
"type" : "function",
- "desc" : "Sets the current box measurements of the component's underlying element.",
- "sig" : "(box)",
+ "desc" : "Persists the values in this form into the passed Roo.data.Record object in a beginEdit/endEdit block.",
+ "sig" : "(record)",
"static" : false,
- "memberOf" : "Roo.BoxComponent",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "box",
- "type" : "Object",
- "desc" : "An object in the format {x, y, width, height}",
+ "name" : "record",
+ "type" : "Record",
+ "desc" : "The record to edit",
"isOptional" : false
}
],
- "returns" : []
- },
- {
- "name" : "validate",
- "type" : "function",
- "desc" : "Validates the field value",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.form.Field",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
"returns" : [
{
"name" : "",
- "type" : "Boolean",
- "desc" : "True if the value is valid, else false"
+ "type" : "BasicForm",
+ "desc" : "this"
}
]
}
],
"isAbstract" : false,
"isBuilderTop" : false,
- "childClasses" : {
- "Roo.form.Checkbox" : [
- "Roo.form.Radio"
- ]
- },
+ "implementations" : [
+ "Roo.form.Form"
+ ],
"tree_children" : [],
"tree_parent" : []
},
- "Roo.form.Column" : {
+ "Roo.form.Checkbox" : {
"props" : [
{
"name" : "actionMode",
"type" : "String",
"desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el' for forms you probably want to set this to fieldEl",
- "memberOf" : "Roo.Component"
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "allowDomMove",
"type" : "Boolean",
"desc" : "Whether the component can move the Dom node when rendering (defaults to true).",
- "memberOf" : "Roo.Component"
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"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" : ""
+ "desc" : "A DomHelper element spec, or true for a default element spec (defaults to\n{tag: \"input\", type: \"checkbox\", autocomplete: \"off\"})",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
- "name" : "clear",
+ "name" : "boxLabel",
+ "type" : "String",
+ "desc" : "The text that appears beside the checkbox",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "checked",
"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"
+ "desc" : "True if the the checkbox should render already checked (defaults to false)",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "cls",
+ "type" : "String",
+ "desc" : "A CSS class to apply to the field's underlying element.",
+ "memberOf" : "Roo.form.Field",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "disableClass",
"type" : "String",
"desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").",
- "memberOf" : "Roo.Component"
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
- "name" : "hideLabels",
+ "name" : "disabled",
"type" : "Boolean",
- "desc" : "True to suppress the display of field labels in this layout (defaults to false)",
- "memberOf" : "Roo.form.Layout"
+ "desc" : "True to disable the field (defaults to false).",
+ "memberOf" : "Roo.form.Field",
+ "isOptional" : false,
+ "optvals" : []
},
{
- "name" : "hideMode",
+ "name" : "fieldClass",
"type" : "String",
- "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".",
- "memberOf" : "Roo.Component"
+ "desc" : "The default CSS class for the checkbox (defaults to \"x-form-field\")",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
- "name" : "labelAlign",
+ "name" : "fieldLabel",
"type" : "String",
- "desc" : "Valid values are \"left,\" \"top\" and \"right\" (defaults to \"left\")",
- "memberOf" : "Roo.form.Layout"
+ "desc" : "Label to use when rendering a form.",
+ "memberOf" : "Roo.form.Field",
+ "isOptional" : false,
+ "optvals" : []
},
{
- "name" : "labelSeparator",
+ "name" : "focusClass",
"type" : "String",
- "desc" : "The separator to use after field labels (defaults to ':')",
- "memberOf" : "Roo.form.Layout"
+ "desc" : "The CSS class to use when the checkbox receives focus (defaults to undefined)",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
- "name" : "labelWidth",
+ "name" : "height",
"type" : "Number",
- "desc" : "Fixed width in pixels of all field labels (defaults to undefined)",
- "memberOf" : "Roo.form.Layout"
+ "desc" : "height (optional) size of component",
+ "memberOf" : "Roo.BoxComponent",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "hideMode",
+ "type" : "String",
+ "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display",
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : [
+ "display",
+ "visibility"
+ ]
+ },
+ {
+ "name" : "inputType",
+ "type" : "String",
+ "desc" : "The type attribute for input fields -- e.g. radio, text, password (defaults to \"text\").",
+ "memberOf" : "Roo.form.Field",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "inputValue",
+ "type" : "String",
+ "desc" : "The value that should go into the generated input element's value attribute",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "invalidClass",
+ "type" : "String",
+ "desc" : "The CSS class to use when marking a field invalid (defaults to \"x-form-invalid\")",
+ "memberOf" : "Roo.form.Field",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "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",
+ "isOptional" : false,
+ "optvals" : []
},
{
"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"
+ "memberOf" : "Roo.util.Observable",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "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",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "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",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "name",
+ "type" : "String",
+ "desc" : "The field's HTML name attribute.",
+ "memberOf" : "Roo.form.Field",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "qtip",
+ "type" : "String",
+ "desc" : "Mouse over tip",
+ "memberOf" : "Roo.form.Field",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "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",
+ "isOptional" : false,
+ "optvals" : []
},
{
"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"
+ "type" : "String",
+ "desc" : "css styles to add to component\neg. text-align:right;",
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "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",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "validateOnBlur",
+ "type" : "Boolean",
+ "desc" : "Whether the field should validate when it loses focus (defaults to true).",
+ "memberOf" : "Roo.form.Field",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "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",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "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",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "value",
+ "type" : "Mixed",
+ "desc" : "A value to initialize this field with.",
+ "memberOf" : "Roo.form.Field",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "valueOff",
+ "type" : "String",
+ "desc" : "The value that should go into the generated input element's value when unchecked.",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "width",
- "type" : "Number/String",
- "desc" : "The fixed width of the column in pixels or CSS value (defaults to \"auto\")",
- "memberOf" : ""
+ "type" : "Number",
+ "desc" : "width (optional) size of component",
+ "memberOf" : "Roo.BoxComponent",
+ "isOptional" : false,
+ "optvals" : []
}
],
"events" : [
"returns" : []
},
{
- "name" : "destroy",
+ "name" : "blur",
"type" : "function",
- "desc" : "Fires after the component is destroyed.",
+ "desc" : "Fires when this field loses input focus.",
"sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
+ "memberOf" : "Roo.form.Field",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.Component",
+ "type" : "Roo.form.Field",
"desc" : "",
"isOptional" : false
}
"returns" : []
},
{
- "name" : "disable",
+ "name" : "change",
"type" : "function",
- "desc" : "Fires after the component is disabled.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
+ "desc" : "Fires just before the field blurs if the field value has changed.",
+ "sig" : "function (_self, newValue, oldValue)\n{\n\n}",
+ "memberOf" : "Roo.form.Field",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.Component",
+ "type" : "Roo.form.Field",
"desc" : "",
"isOptional" : false
+ },
+ {
+ "name" : "newValue",
+ "type" : "Mixed",
+ "desc" : "The new value",
+ "isOptional" : false
+ },
+ {
+ "name" : "oldValue",
+ "type" : "Mixed",
+ "desc" : "The original value",
+ "isOptional" : false
}
],
"returns" : []
},
{
- "name" : "enable",
+ "name" : "check",
"type" : "function",
- "desc" : "Fires after the component is enabled.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
+ "desc" : "Fires when the checkbox is checked or unchecked.",
+ "sig" : "function (_self, checked)\n{\n\n}",
+ "memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.Component",
- "desc" : "",
+ "type" : "Roo.form.Checkbox",
+ "desc" : "This checkbox",
+ "isOptional" : false
+ },
+ {
+ "name" : "checked",
+ "type" : "Boolean",
+ "desc" : "The new checked value",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "hide",
+ "name" : "destroy",
+ "type" : "function",
+ "desc" : "Fires after the component is destroyed.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.Component",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "disable",
+ "type" : "function",
+ "desc" : "Fires after the component is disabled.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.Component",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "enable",
+ "type" : "function",
+ "desc" : "Fires after the component is enabled.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.Component",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "focus",
+ "type" : "function",
+ "desc" : "Fires when this field receives input focus.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.form.Field",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.form.Field",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "hide",
"type" : "function",
"desc" : "Fires after the component is hidden.",
"sig" : "function (_self)\n{\n\n}",
],
"returns" : []
},
+ {
+ "name" : "invalid",
+ "type" : "function",
+ "desc" : "Fires after the field has been marked as invalid.",
+ "sig" : "function (_self, msg)\n{\n\n}",
+ "memberOf" : "Roo.form.Field",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.form.Field",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "msg",
+ "type" : "String",
+ "desc" : "The validation message",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "keyup",
+ "type" : "function",
+ "desc" : "Fires after the key up",
+ "sig" : "function (_self, e)\n{\n\n}",
+ "memberOf" : "Roo.form.Field",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.form.Field",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "e",
+ "type" : "Roo.EventObject",
+ "desc" : "The event Object",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "move",
+ "type" : "function",
+ "desc" : "Fires after the component is moved.",
+ "sig" : "function (_self, x, y)\n{\n\n}",
+ "memberOf" : "Roo.BoxComponent",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.Component",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "x",
+ "type" : "Number",
+ "desc" : "The new x position",
+ "isOptional" : false
+ },
+ {
+ "name" : "y",
+ "type" : "Number",
+ "desc" : "The new y position",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
{
"name" : "render",
"type" : "function",
],
"returns" : []
},
+ {
+ "name" : "resize",
+ "type" : "function",
+ "desc" : "Fires after the component is resized.",
+ "sig" : "function (_self, adjWidth, adjHeight, rawWidth, rawHeight)\n{\n\n}",
+ "memberOf" : "Roo.BoxComponent",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.Component",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "adjWidth",
+ "type" : "Number",
+ "desc" : "The box-adjusted width that was set",
+ "isOptional" : false
+ },
+ {
+ "name" : "adjHeight",
+ "type" : "Number",
+ "desc" : "The box-adjusted height that was set",
+ "isOptional" : false
+ },
+ {
+ "name" : "rawWidth",
+ "type" : "Number",
+ "desc" : "The width that was originally specified",
+ "isOptional" : false
+ },
+ {
+ "name" : "rawHeight",
+ "type" : "Number",
+ "desc" : "The height that was originally specified",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
{
"name" : "show",
"type" : "function",
}
],
"returns" : []
+ },
+ {
+ "name" : "specialkey",
+ "type" : "function",
+ "desc" : "Fires when any key related to navigation (arrows, tab, enter, esc, etc.) is pressed. You can check\n{@link Roo.EventObject#getKey} to determine which key was pressed.",
+ "sig" : "function (_self, e)\n{\n\n}",
+ "memberOf" : "Roo.form.Field",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.form.Field",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "e",
+ "type" : "Roo.EventObject",
+ "desc" : "The event object",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "valid",
+ "type" : "function",
+ "desc" : "Fires after the field has been validated with no errors.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.form.Field",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.form.Field",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
}
],
"methods" : [
"returns" : []
},
{
- "name" : "addxtype",
+ "name" : "applyTo",
"type" : "function",
- "desc" : "Adds a object form elements (using the xtype property as the factory method.)\nValid xtypes are: TextField, TextArea .... Button, Layout, FieldSet, Column",
- "sig" : "(config)",
+ "desc" : "Apply the behaviors of this component to an existing element. <b>This is used instead of render().</b>",
+ "sig" : "(el)",
"static" : false,
- "memberOf" : "Roo.form.Layout",
+ "memberOf" : "Roo.form.Field",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "config",
- "type" : "Object",
- "desc" : "",
+ "name" : "el",
+ "type" : "String/HTMLElement/Element",
+ "desc" : "The id of the node, a DOM node or an existing Element",
"isOptional" : false
}
],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.form.Field",
+ "desc" : "this"
+ }
+ ]
},
{
"name" : "capture",
],
"returns" : []
},
+ {
+ "name" : "clearInvalid",
+ "type" : "function",
+ "desc" : "Clear any invalid styles/messages for this field",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.form.Field",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
{
"name" : "destroy",
"type" : "function",
}
]
},
+ {
+ "name" : "getBox",
+ "type" : "function",
+ "desc" : "Gets the current box measurements of the component's underlying element.",
+ "sig" : "(local)",
+ "static" : false,
+ "memberOf" : "Roo.BoxComponent",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "local",
+ "type" : "Boolean",
+ "desc" : "(optional) If true the element's left and top are returned instead of page XY (defaults to false)",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
{
"name" : "getEl",
"type" : "function",
}
]
},
+ {
+ "name" : "getName",
+ "type" : "function",
+ "desc" : "Returns the name attribute of the field if available",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.form.Field",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "String",
+ "desc" : "name The field name"
+ }
+ ]
+ },
+ {
+ "name" : "getPosition",
+ "type" : "function",
+ "desc" : "Gets the current XY position of the component's underlying element.",
+ "sig" : "(local)",
+ "static" : false,
+ "memberOf" : "Roo.BoxComponent",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "local",
+ "type" : "Boolean",
+ "desc" : "(optional) If true the element's left and top are returned instead of page XY (defaults to false)",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Array",
+ "desc" : "The XY position of the element (e.g., [100, 200])"
+ }
+ ]
+ },
+ {
+ "name" : "getRawValue",
+ "type" : "function",
+ "desc" : "Returns the raw data value which may or may not be a valid, defined value. To return a normalized value see {@link #getValue}.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.form.Field",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Mixed",
+ "desc" : "value The field value"
+ }
+ ]
+ },
+ {
+ "name" : "getSize",
+ "type" : "function",
+ "desc" : "Gets the current size of the component's underlying element.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.BoxComponent",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Object",
+ "desc" : "An object containing the element's size {width: (element width), height: (element height)}"
+ }
+ ]
+ },
+ {
+ "name" : "getValue",
+ "type" : "function",
+ "desc" : "Returns the checked state of the checkbox.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Boolean",
+ "desc" : "True if checked, else false"
+ }
+ ]
+ },
+ {
+ "name" : "hasChanged",
+ "type" : "function",
+ "desc" : "checks the current value against the 'loaded' value.\nNote - will return false if 'resetHasChanged' has not been called first.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.form.Field",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
{
"name" : "hasListener",
"type" : "function",
}
]
},
+ {
+ "name" : "isDirty",
+ "type" : "function",
+ "desc" : "Returns true if this field has been changed since it was originally loaded and is not disabled.\nDEPRICATED - it never worked well - use hasChanged/resetHasChanged.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.form.Field",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
+ {
+ "name" : "isValid",
+ "type" : "function",
+ "desc" : "Returns whether or not the field value is currently valid",
+ "sig" : "(preventMark)",
+ "static" : false,
+ "memberOf" : "Roo.form.Field",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "preventMark",
+ "type" : "Boolean",
+ "desc" : "True to disable marking the field invalid",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Boolean",
+ "desc" : "True if the value is valid, else false"
+ }
+ ]
+ },
{
"name" : "isVisible",
"type" : "function",
"params" : [],
"returns" : []
},
+ {
+ "name" : "markInvalid",
+ "type" : "function",
+ "desc" : "Mark this field as invalid",
+ "sig" : "(msg)",
+ "static" : false,
+ "memberOf" : "Roo.form.Field",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "msg",
+ "type" : "String",
+ "desc" : "The validation message",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
{
"name" : "on",
"type" : "function",
],
"returns" : []
},
+ {
+ "name" : "onPosition",
+ "type" : "function",
+ "desc" : "Called after the component is moved, this method is empty by default but can be implemented by any\nsubclass that needs to perform custom logic after a move occurs.",
+ "sig" : "(x, y)",
+ "static" : false,
+ "memberOf" : "Roo.BoxComponent",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "x",
+ "type" : "Number",
+ "desc" : "The new x position",
+ "isOptional" : false
+ },
+ {
+ "name" : "y",
+ "type" : "Number",
+ "desc" : "The new y position",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "onResize",
+ "type" : "function",
+ "desc" : "Called after the component is resized, this method is empty by default but can be implemented by any\nsubclass that needs to perform custom logic after a resize occurs.",
+ "sig" : "(adjWidth, adjHeight, rawWidth, rawHeight)",
+ "static" : false,
+ "memberOf" : "Roo.BoxComponent",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "adjWidth",
+ "type" : "Number",
+ "desc" : "The box-adjusted width that was set",
+ "isOptional" : false
+ },
+ {
+ "name" : "adjHeight",
+ "type" : "Number",
+ "desc" : "The box-adjusted height that was set",
+ "isOptional" : false
+ },
+ {
+ "name" : "rawWidth",
+ "type" : "Number",
+ "desc" : "The width that was originally specified",
+ "isOptional" : false
+ },
+ {
+ "name" : "rawHeight",
+ "type" : "Number",
+ "desc" : "The height that was originally specified",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
{
"name" : "purgeListeners",
"type" : "function",
],
"returns" : []
},
+ {
+ "name" : "reset",
+ "type" : "function",
+ "desc" : "Resets the current field value to the originally loaded value and clears any validation messages",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.form.Field",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
+ {
+ "name" : "resetHasChanged",
+ "type" : "function",
+ "desc" : "stores the current value in loadedValue",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.form.Field",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
{
"name" : "setDisabled",
"type" : "function",
],
"returns" : []
},
+ {
+ "name" : "setPagePosition",
+ "type" : "function",
+ "desc" : "Sets the page XY position of the component. To set the left and top instead, use {@link #setPosition}.\nThis method fires the move event.",
+ "sig" : "(x, y)",
+ "static" : false,
+ "memberOf" : "Roo.BoxComponent",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "x",
+ "type" : "Number",
+ "desc" : "The new x position",
+ "isOptional" : false
+ },
+ {
+ "name" : "y",
+ "type" : "Number",
+ "desc" : "The new y position",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "setPosition",
+ "type" : "function",
+ "desc" : "Sets the left and top of the component. To set the page XY position instead, use {@link #setPagePosition}.\nThis method fires the move event.",
+ "sig" : "(left, top)",
+ "static" : false,
+ "memberOf" : "Roo.BoxComponent",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "left",
+ "type" : "Number",
+ "desc" : "The new left",
+ "isOptional" : false
+ },
+ {
+ "name" : "top",
+ "type" : "Number",
+ "desc" : "The new top",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "setRawValue",
+ "type" : "function",
+ "desc" : "Sets the underlying DOM field's value directly, bypassing validation. To set the value with validation see {@link #setValue}.",
+ "sig" : "(value)",
+ "static" : false,
+ "memberOf" : "Roo.form.Field",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "value",
+ "type" : "Mixed",
+ "desc" : "The value to set",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "setSize",
+ "type" : "function",
+ "desc" : "Sets the width and height of the component. This method fires the resize event. This method can accept\neither width and height as separate numeric arguments, or you can pass a size object like {width:10, height:20}.",
+ "sig" : "(width, height)",
+ "static" : false,
+ "memberOf" : "Roo.BoxComponent",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "width",
+ "type" : "Number/Object",
+ "desc" : "The new width to set, or a size object in the format {width, height}",
+ "isOptional" : false
+ },
+ {
+ "name" : "height",
+ "type" : "Number",
+ "desc" : "The new height to set (not required if a size object is passed as the first arg)",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.BoxComponent",
+ "desc" : "this"
+ }
+ ]
+ },
+ {
+ "name" : "setValue",
+ "type" : "function",
+ "desc" : "Sets the checked state of the checkbox.\nOn is always based on a string comparison between inputValue and the param.",
+ "sig" : "(value, suppressEvent)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "value",
+ "type" : "Boolean/String",
+ "desc" : "- the value to set",
+ "isOptional" : false
+ },
+ {
+ "name" : "suppressEvent",
+ "type" : "Boolean/String",
+ "desc" : "- whether to suppress the checkchange event.",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
{
"name" : "setVisible",
"type" : "function",
}
]
},
+ {
+ "name" : "syncSize",
+ "type" : "function",
+ "desc" : "Force the component's size to recalculate based on the underlying element's current height and width.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.BoxComponent",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
{
"name" : "un",
"type" : "function",
}
],
"returns" : []
+ },
+ {
+ "name" : "updateBox",
+ "type" : "function",
+ "desc" : "Sets the current box measurements of the component's underlying element.",
+ "sig" : "(box)",
+ "static" : false,
+ "memberOf" : "Roo.BoxComponent",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "box",
+ "type" : "Object",
+ "desc" : "An object in the format {x, y, width, height}",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "validate",
+ "type" : "function",
+ "desc" : "Validates the field value",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.form.Field",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Boolean",
+ "desc" : "True if the value is valid, else false"
+ }
+ ]
}
],
"isAbstract" : false,
"isBuilderTop" : false,
- "childClasses" : { },
+ "implementations" : [
+ "Roo.form.Radio"
+ ],
"tree_children" : [],
"tree_parent" : []
},
- "Roo.form.ComboBox" : {
+ "Roo.form.Column" : {
"props" : [
{
"name" : "actionMode",
"type" : "String",
"desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el' for forms you probably want to set this to fieldEl",
- "memberOf" : "Roo.Component"
- },
- {
- "name" : "allQuery",
- "type" : "String",
- "desc" : "The text query to send to the server to return all records for the list with no filtering (defaults to '')",
- "memberOf" : ""
- },
- {
- "name" : "allowBlank",
- "type" : "Boolean",
- "desc" : "False to validate that the value length > 0 (defaults to true)",
- "memberOf" : "Roo.form.TextField"
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "allowDomMove",
"type" : "Boolean",
"desc" : "Whether the component can move the Dom node when rendering (defaults to true).",
- "memberOf" : "Roo.Component"
- },
- {
- "name" : "allowLeadingSpace",
- "type" : "Boolean",
- "desc" : "True to prevent the stripping of leading white space",
- "memberOf" : "Roo.form.TextField"
- },
- {
- "name" : "alwaysQuery",
- "type" : "Boolean",
- "desc" : "Disable caching of results, and always send query",
- "memberOf" : ""
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "autoCreate",
- "type" : "Boolean/Object",
- "desc" : "A DomHelper element spec, or true for a default element spec (defaults to:\n{tag: \"input\", type: \"text\", size: \"24\", autocomplete: \"off\"})",
- "memberOf" : ""
- },
- {
- "name" : "blankText",
- "type" : "String",
- "desc" : "Error text to display if the allow blank validation fails (defaults to \"This field is required\")",
- "memberOf" : "Roo.form.TextField"
+ "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" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
- "name" : "blockFocus",
+ "name" : "clear",
"type" : "Boolean",
- "desc" : "Prevents all focus calls, so it can work with things like HTML edtor bar",
- "memberOf" : ""
- },
- {
- "name" : "cls",
- "type" : "String",
- "desc" : "A CSS class to apply to the field's underlying element.",
- "memberOf" : "Roo.form.Field"
+ "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",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "disableClass",
"type" : "String",
"desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").",
- "memberOf" : "Roo.Component"
- },
- {
- "name" : "disableClear",
- "type" : "Boolean",
- "desc" : "Disable showing of clear button.",
- "memberOf" : ""
- },
- {
- "name" : "disableKeyFilter",
- "type" : "Boolean",
- "desc" : "True to disable input keystroke filtering (defaults to false)",
- "memberOf" : "Roo.form.TextField"
- },
- {
- "name" : "disabled",
- "type" : "Boolean",
- "desc" : "True to disable the field (defaults to false).",
- "memberOf" : "Roo.form.Field"
- },
- {
- "name" : "displayField",
- "type" : "String",
- "desc" : "The underlying data field name to bind to this CombBox (defaults to undefined if\nmode = 'remote' or 'text' if mode = 'local')",
- "memberOf" : ""
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
- "name" : "editable",
+ "name" : "hideLabels",
"type" : "Boolean",
- "desc" : "False to prevent the user from typing text directly into the field, just like a\ntraditional select (defaults to true)",
- "memberOf" : ""
- },
- {
- "name" : "emptyText",
- "type" : "String",
- "desc" : "The default text to display in an empty field - placeholder... (defaults to null).",
- "memberOf" : "Roo.form.TextField"
+ "desc" : "True to suppress the display of field labels in this layout (defaults to false)",
+ "memberOf" : "Roo.form.Layout",
+ "isOptional" : false,
+ "optvals" : []
},
{
- "name" : "fieldClass",
+ "name" : "hideMode",
"type" : "String",
- "desc" : "The default CSS class for the field (defaults to \"x-form-field\")",
- "memberOf" : "Roo.form.Field"
+ "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display",
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : [
+ "display",
+ "visibility"
+ ]
},
{
- "name" : "fieldLabel",
+ "name" : "labelAlign",
"type" : "String",
- "desc" : "Label to use when rendering a form.",
- "memberOf" : "Roo.form.Field"
+ "desc" : "t)\nValid values are \"left,\" \"top\" and \"right\" (defaults to \"left",
+ "memberOf" : "Roo.form.Layout",
+ "isOptional" : false,
+ "optvals" : [
+ "left",
+ "top",
+ "right"
+ ]
},
{
- "name" : "focusClass",
+ "name" : "labelSeparator",
"type" : "String",
- "desc" : "The CSS class to use when the field receives focus (defaults to \"x-form-focus\")",
- "memberOf" : "Roo.form.Field"
- },
- {
- "name" : "forceSelection",
- "type" : "Boolean",
- "desc" : "True to restrict the selected value to one of the values in the list, false to\nallow the user to set arbitrary text into the field (defaults to false)",
- "memberOf" : ""
- },
- {
- "name" : "grow",
- "type" : "Boolean",
- "desc" : "",
- "memberOf" : ""
+ "desc" : "The separator to use after field labels (defaults to ':')",
+ "memberOf" : "Roo.form.Layout",
+ "isOptional" : false,
+ "optvals" : []
},
{
- "name" : "growMax",
+ "name" : "labelWidth",
"type" : "Number",
- "desc" : "",
- "memberOf" : ""
+ "desc" : "Fixed width in pixels of all field labels (defaults to undefined)",
+ "memberOf" : "Roo.form.Layout",
+ "isOptional" : false,
+ "optvals" : []
},
{
- "name" : "growMin",
- "type" : "Number",
- "desc" : "",
- "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",
+ "isOptional" : false,
+ "optvals" : []
},
{
- "name" : "handleHeight",
- "type" : "Number",
- "desc" : "The height in pixels of the dropdown list resize handle if resizable = true (defaults to 8)",
- "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",
+ "isOptional" : false,
+ "optvals" : []
},
{
- "name" : "height",
- "type" : "Number",
- "desc" : "height (optional) size of component",
- "memberOf" : "Roo.BoxComponent"
- },
- {
- "name" : "hiddenName",
- "type" : "String",
- "desc" : "If specified, a hidden form field with this name is dynamically generated to store the\nfield's data value (defaults to the underlying DOM element's name)",
- "memberOf" : ""
- },
- {
- "name" : "hideMode",
- "type" : "String",
- "desc" : "y)\nHow this component 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" : "hideTrigger",
- "type" : "Boolean",
- "desc" : "True to hide the trigger element and display only the base text field (defaults to false)",
- "memberOf" : "Roo.form.TriggerField"
- },
- {
- "name" : "inputType",
- "type" : "String",
- "desc" : "The type attribute for input fields -- e.g. radio, text, password (defaults to \"text\").",
- "memberOf" : "Roo.form.Field"
- },
- {
- "name" : "invalidClass",
- "type" : "String",
- "desc" : "The CSS class to use when marking a field invalid (defaults to \"x-form-invalid\")",
- "memberOf" : "Roo.form.Field"
- },
- {
- "name" : "invalidText",
- "type" : "String",
- "desc" : "The error text to use when marking a field invalid and no message is provided (defaults to \"The value in this field is invalid\")",
- "memberOf" : "Roo.form.Field"
- },
- {
- "name" : "lazyRender",
- "type" : "Boolean",
- "desc" : "True to prevent the ComboBox from rendering until requested (should always be used when\nrendering into an Roo.Editor, defaults to false)",
- "memberOf" : ""
- },
- {
- "name" : "listAlign",
- "type" : "String",
- "desc" : "A valid anchor position value. See {@link Roo.Element#alignTo} for details on supported\nanchor positions (defaults to 'tl-bl')",
- "memberOf" : ""
- },
- {
- "name" : "listClass",
- "type" : "String",
- "desc" : "CSS class to apply to the dropdown list element (defaults to '')",
- "memberOf" : ""
- },
- {
- "name" : "listWidth",
- "type" : "Number",
- "desc" : "The width in pixels of the dropdown list (defaults to the width of the ComboBox field)",
- "memberOf" : ""
- },
- {
- "name" : "listeners",
- "type" : "Object",
- "desc" : "list of events and functions to call for this object, \nFor example :\n<pre><code>\n listeners : { \n 'click' : function(e) {\n ..... \n } ,\n .... \n } \n </code></pre>",
- "memberOf" : "Roo.util.Observable"
- },
- {
- "name" : "loadingText",
- "type" : "String",
- "desc" : "The text to display in the dropdown list while data is loading. Only applies\nwhen mode = 'remote' (defaults to 'Loading...')",
- "memberOf" : ""
- },
- {
- "name" : "maskRe",
- "type" : "String",
- "desc" : "An input mask regular expression that will be used to filter keystrokes that don't match (defaults to null)",
- "memberOf" : "Roo.form.TextField"
- },
- {
- "name" : "maxHeight",
- "type" : "Number",
- "desc" : "The maximum height in pixels of the dropdown list before scrollbars are shown (defaults to 300)",
- "memberOf" : ""
- },
- {
- "name" : "maxLength",
- "type" : "Number",
- "desc" : "Maximum input field length allowed (defaults to Number.MAX_VALUE)",
- "memberOf" : "Roo.form.TextField"
- },
- {
- "name" : "maxLengthText",
- "type" : "String",
- "desc" : "Error text to display if the maximum length validation fails (defaults to \"The maximum length for this field is {maxLength}\")",
- "memberOf" : "Roo.form.TextField"
- },
- {
- "name" : "minChars",
- "type" : "Number",
- "desc" : "The minimum number of characters the user must type before autocomplete and typeahead activate\n(defaults to 4, does not apply if editable = false)",
- "memberOf" : ""
- },
- {
- "name" : "minLength",
- "type" : "Number",
- "desc" : "Minimum input field length required (defaults to 0)",
- "memberOf" : "Roo.form.TextField"
- },
- {
- "name" : "minLengthText",
- "type" : "String",
- "desc" : "Error text to display if the minimum length validation fails (defaults to \"The minimum length for this field is {minLength}\")",
- "memberOf" : "Roo.form.TextField"
- },
- {
- "name" : "minListWidth",
- "type" : "Number",
- "desc" : "The minimum width of the dropdown list in pixels (defaults to 70, will be ignored if\nlistWidth has a higher value)",
- "memberOf" : ""
- },
- {
- "name" : "mode",
- "type" : "String",
- "desc" : "Set to 'local' if the ComboBox loads local data (defaults to 'remote' which loads from the server)",
- "memberOf" : ""
- },
- {
- "name" : "msgFx",
- "type" : "String",
- "desc" : "<b>Experimental</b> The effect used when displaying a validation message under the field (defaults to 'normal').",
- "memberOf" : "Roo.form.Field"
- },
- {
- "name" : "msgTarget",
- "type" : "String",
- "desc" : "The location where error text should display. Should be one of the following values (defaults to 'qtip'):\n<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" : "name",
- "type" : "String",
- "desc" : "The field's HTML name attribute.",
- "memberOf" : "Roo.form.Field"
- },
- {
- "name" : "pageSize",
- "type" : "Number",
- "desc" : "If greater than 0, a paging toolbar is displayed in the footer of the dropdown list and the\nfilter queries will execute with page start and limit parameters. Only applies when mode = 'remote' (defaults to 0)",
- "memberOf" : ""
- },
- {
- "name" : "qtip",
- "type" : "String",
- "desc" : "Mouse over tip",
- "memberOf" : "Roo.form.Field"
- },
- {
- "name" : "queryDelay",
- "type" : "Number",
- "desc" : "The length of time in milliseconds to delay between the start of typing and sending the\nquery to filter the dropdown list (defaults to 500 if mode = 'remote' or 10 if mode = 'local')",
- "memberOf" : ""
- },
- {
- "name" : "queryParam",
- "type" : "String",
- "desc" : "Name of the query as it will be passed on the querystring (defaults to 'query')",
- "memberOf" : ""
- },
- {
- "name" : "readOnly",
- "type" : "Boolean",
- "desc" : "True to mark the field as readOnly in HTML (defaults to false) -- Note: this only sets the element's readOnly DOM attribute.",
- "memberOf" : "Roo.form.Field"
- },
- {
- "name" : "regex",
- "type" : "RegExp",
- "desc" : "A JavaScript RegExp object to be tested against the field value during validation (defaults to null).\nIf available, this regex will be evaluated only after the basic validators all return true, and will be passed the\ncurrent field value. If the test fails, the field will be marked invalid using {@link #regexText}.",
- "memberOf" : "Roo.form.TextField"
- },
- {
- "name" : "regexText",
- "type" : "String",
- "desc" : "The error text to display if {@link #regex} is used and the test fails during validation (defaults to \"\")",
- "memberOf" : "Roo.form.TextField"
- },
- {
- "name" : "resizable",
- "type" : "Boolean",
- "desc" : "True to add a resize handle to the bottom of the dropdown list (defaults to false)",
- "memberOf" : ""
- },
- {
- "name" : "selectOnFocus",
- "type" : "Boolean",
- "desc" : "True to select any existing text in the field immediately on focus. Only applies\nwhen editable = true (defaults to false)",
- "memberOf" : ""
- },
- {
- "name" : "selectedClass",
- "type" : "String",
- "desc" : "CSS class to apply to the selected item in the dropdown list (defaults to 'x-combo-selected')",
- "memberOf" : ""
- },
- {
- "name" : "shadow",
- "type" : "Boolean/String",
- "desc" : "True or \"sides\" for the default effect, \"frame\" for 4-way shadow, and \"drop\" for bottom-right",
- "memberOf" : ""
- },
- {
- "name" : "store",
- "type" : "Roo.data.Store",
- "desc" : "The data store to which this combo is bound (defaults to undefined)",
- "memberOf" : ""
- },
- {
- "name" : "tabIndex",
- "type" : "Number",
- "desc" : "The tabIndex for this field. Note this only applies to fields that are rendered, not those which are built via applyTo (defaults to undefined).",
- "memberOf" : "Roo.form.Field"
- },
- {
- "name" : "title",
- "type" : "String",
- "desc" : "If supplied, a header element is created containing this text and added into the top of\nthe dropdown list (defaults to undefined, with no header element)",
- "memberOf" : ""
- },
- {
- "name" : "tpl",
- "type" : "String/Roo.Template",
- "desc" : "The template to use to render the output",
- "memberOf" : ""
- },
- {
- "name" : "transform",
- "type" : "String/HTMLElement/Element",
- "desc" : "The id, DOM node or element of an existing select to convert to a ComboBox",
- "memberOf" : ""
- },
- {
- "name" : "triggerAction",
- "type" : "String",
- "desc" : "The action to execute when the trigger field is activated. Use 'all' to run the\nquery specified by the allQuery config option (defaults to 'query')",
- "memberOf" : ""
- },
- {
- "name" : "triggerClass",
- "type" : "String",
- "desc" : "An additional CSS class used to style the trigger button. The trigger will always get the\nclass 'x-form-trigger' and triggerClass will be <b>appended</b> if specified (defaults to 'x-form-arrow-trigger'\nwhich displays a downward arrow icon).",
- "memberOf" : ""
- },
- {
- "name" : "typeAhead",
- "type" : "Boolean",
- "desc" : "True to populate and autoselect the remainder of the text being typed after a configurable\ndelay (typeAheadDelay) if it matches a known value (defaults to false)",
- "memberOf" : ""
- },
- {
- "name" : "typeAheadDelay",
- "type" : "Number",
- "desc" : "The length of time in milliseconds to wait until the typeahead text is displayed\nif typeAhead = true (defaults to 250)",
- "memberOf" : ""
- },
- {
- "name" : "validateOnBlur",
- "type" : "Boolean",
- "desc" : "Whether the field should validate when it loses focus (defaults to true).",
- "memberOf" : "Roo.form.Field"
- },
- {
- "name" : "validationDelay",
- "type" : "Number",
- "desc" : "The length of time in milliseconds after user input begins until validation is initiated (defaults to 250)",
- "memberOf" : "Roo.form.Field"
- },
- {
- "name" : "validationEvent",
- "type" : "String/Boolean",
- "desc" : "The event that should initiate field validation. Set to false to disable\n automatic validation (defaults to \"keyup\").",
- "memberOf" : "Roo.form.Field"
- },
- {
- "name" : "validator",
- "type" : "Function",
- "desc" : "A custom validation function to be called during field validation (defaults to null).\nIf available, this function will be called only after the basic validators all return true, and will be passed the\ncurrent field value and expected to return boolean true if the value is valid or a string error message if invalid.",
- "memberOf" : "Roo.form.TextField"
- },
- {
- "name" : "value",
- "type" : "Mixed",
- "desc" : "A value to initialize this field with.",
- "memberOf" : "Roo.form.Field"
- },
- {
- "name" : "valueField",
- "type" : "String",
- "desc" : "The underlying data value name to bind to this CombBox (defaults to undefined if\nmode = 'remote' or 'value' if mode = 'local'). \nNote: use of a valueField requires the user make a selection\nin order for a value to be mapped.",
- "memberOf" : ""
- },
- {
- "name" : "valueNotFoundText",
- "type" : "String",
- "desc" : "When using a name/value combo, if the value passed to setValue is not found in\nthe store, valueNotFoundText will be displayed as the field text if defined (defaults to undefined)",
- "memberOf" : ""
- },
- {
- "name" : "vtype",
- "type" : "String",
- "desc" : "A validation type name as defined in {@link Roo.form.VTypes} (defaults to null)",
- "memberOf" : "Roo.form.TextField"
- },
- {
- "name" : "width",
- "type" : "Number",
- "desc" : "width (optional) size of component",
- "memberOf" : "Roo.BoxComponent"
- }
- ],
- "events" : [
- {
- "name" : "add",
- "type" : "function",
- "desc" : "Fires when the 'add' icon is pressed (add a listener to enable add button)",
- "sig" : "function (combo)\n{\n\n}",
- "memberOf" : "",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "combo",
- "type" : "Roo.form.ComboBox",
- "desc" : "This combo box",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "autosize",
- "type" : "function",
- "desc" : "Fires when the autosize function is triggered. The field may or may not have actually changed size\naccording to the default logic, but this event provides a hook for the developer to apply additional\nlogic at runtime to resize the field if needed.",
- "sig" : "function (_self, width)\n{\n\n}",
- "memberOf" : "Roo.form.TextField",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.form.Field",
- "desc" : "This text field",
- "isOptional" : false
- },
- {
- "name" : "width",
- "type" : "Number",
- "desc" : "The new field width",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
+ "name" : "width",
+ "type" : "Number/String",
+ "desc" : "The fixed width of the column in pixels or CSS value (defaults to \"auto\")",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ }
+ ],
+ "events" : [
{
"name" : "beforedestroy",
"type" : "function",
],
"returns" : []
},
- {
- "name" : "beforequery",
- "type" : "function",
- "desc" : "Fires before all queries are processed. Return false to cancel the query or set cancel to true.\nThe event object passed has these properties:",
- "sig" : "function (combo, query, forceAll, cancel, e)\n{\n\n}",
- "memberOf" : "",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "combo",
- "type" : "Roo.form.ComboBox",
- "desc" : "This combo box",
- "isOptional" : false
- },
- {
- "name" : "query",
- "type" : "String",
- "desc" : "The query",
- "isOptional" : false
- },
- {
- "name" : "forceAll",
- "type" : "Boolean",
- "desc" : "true to force \"all\" query",
- "isOptional" : false
- },
- {
- "name" : "cancel",
- "type" : "Boolean",
- "desc" : "true to cancel the query",
- "isOptional" : false
- },
- {
- "name" : "e",
- "type" : "Object",
- "desc" : "The query event object",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
{
"name" : "beforerender",
"type" : "function",
],
"returns" : []
},
- {
- "name" : "beforeselect",
- "type" : "function",
- "desc" : "Fires before a list item is selected. Return false to cancel the selection.",
- "sig" : "function (combo, record, index)\n{\n\n}",
- "memberOf" : "",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "combo",
- "type" : "Roo.form.ComboBox",
- "desc" : "This combo box",
- "isOptional" : false
- },
- {
- "name" : "record",
- "type" : "Roo.data.Record",
- "desc" : "The data record returned from the underlying store",
- "isOptional" : false
- },
- {
- "name" : "index",
- "type" : "Number",
- "desc" : "The index of the selected item in the dropdown list",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
{
"name" : "beforeshow",
"type" : "function",
],
"returns" : []
},
- {
- "name" : "blur",
- "type" : "function",
- "desc" : "Fires when this field loses input focus.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.form.Field",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.form.Field",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "change",
- "type" : "function",
- "desc" : "Fires just before the field blurs if the field value has changed.",
- "sig" : "function (_self, newValue, oldValue)\n{\n\n}",
- "memberOf" : "Roo.form.Field",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.form.Field",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "newValue",
- "type" : "Mixed",
- "desc" : "The new value",
- "isOptional" : false
- },
- {
- "name" : "oldValue",
- "type" : "Mixed",
- "desc" : "The original value",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "collapse",
- "type" : "function",
- "desc" : "Fires when the dropdown list is collapsed",
- "sig" : "function (combo)\n{\n\n}",
- "memberOf" : "",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "combo",
- "type" : "Roo.form.ComboBox",
- "desc" : "This combo box",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
{
"name" : "destroy",
"type" : "function",
],
"returns" : []
},
- {
- "name" : "edit",
- "type" : "function",
- "desc" : "Fires when the 'edit' icon is pressed (add a listener to enable add button)",
- "sig" : "function (combo, record)\n{\n\n}",
- "memberOf" : "",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "combo",
- "type" : "Roo.form.ComboBox",
- "desc" : "This combo box",
- "isOptional" : false
- },
- {
- "name" : "record",
- "type" : "Roo.data.Record|false",
- "desc" : "The data record returned from the underlying store (or false on nothing selected)",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
{
"name" : "enable",
"type" : "function",
],
"returns" : []
},
- {
- "name" : "expand",
- "type" : "function",
- "desc" : "Fires when the dropdown list is expanded",
- "sig" : "function (combo)\n{\n\n}",
- "memberOf" : "",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "combo",
- "type" : "Roo.form.ComboBox",
- "desc" : "This combo box",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "focus",
- "type" : "function",
- "desc" : "Fires when this field receives input focus.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.form.Field",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.form.Field",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
{
"name" : "hide",
"type" : "function",
],
"returns" : []
},
- {
- "name" : "invalid",
- "type" : "function",
- "desc" : "Fires after the field has been marked as invalid.",
- "sig" : "function (_self, msg)\n{\n\n}",
- "memberOf" : "Roo.form.Field",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.form.Field",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "msg",
- "type" : "String",
- "desc" : "The validation message",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "keyup",
- "type" : "function",
- "desc" : "Fires after the key up",
- "sig" : "function (_self, e)\n{\n\n}",
- "memberOf" : "Roo.form.Field",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.form.Field",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "e",
- "type" : "Roo.EventObject",
- "desc" : "The event Object",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "move",
- "type" : "function",
- "desc" : "Fires after the component is moved.",
- "sig" : "function (_self, x, y)\n{\n\n}",
- "memberOf" : "Roo.BoxComponent",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.Component",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "x",
- "type" : "Number",
- "desc" : "The new x position",
- "isOptional" : false
- },
- {
- "name" : "y",
- "type" : "Number",
- "desc" : "The new y position",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
{
"name" : "render",
"type" : "function",
],
"returns" : []
},
- {
- "name" : "resize",
- "type" : "function",
- "desc" : "Fires after the component is resized.",
- "sig" : "function (_self, adjWidth, adjHeight, rawWidth, rawHeight)\n{\n\n}",
- "memberOf" : "Roo.BoxComponent",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.Component",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "adjWidth",
- "type" : "Number",
- "desc" : "The box-adjusted width that was set",
- "isOptional" : false
- },
- {
- "name" : "adjHeight",
- "type" : "Number",
- "desc" : "The box-adjusted height that was set",
- "isOptional" : false
- },
- {
- "name" : "rawWidth",
- "type" : "Number",
- "desc" : "The width that was originally specified",
- "isOptional" : false
- },
- {
- "name" : "rawHeight",
- "type" : "Number",
- "desc" : "The height that was originally specified",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "select",
- "type" : "function",
- "desc" : "Fires when a list item is selected",
- "sig" : "function (combo, record, index)\n{\n\n}",
- "memberOf" : "",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "combo",
- "type" : "Roo.form.ComboBox",
- "desc" : "This combo box",
- "isOptional" : false
- },
- {
- "name" : "record",
- "type" : "Roo.data.Record",
- "desc" : "The data record returned from the underlying store (or false on clear)",
- "isOptional" : false
- },
- {
- "name" : "index",
- "type" : "Number",
- "desc" : "The index of the selected item in the dropdown list",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
{
"name" : "show",
"type" : "function",
}
],
"returns" : []
- },
- {
- "name" : "specialkey",
- "type" : "function",
- "desc" : "Fires when any key related to navigation (arrows, tab, enter, esc, etc.) is pressed. You can check\n{@link Roo.EventObject#getKey} to determine which key was pressed.",
- "sig" : "function (_self, e)\n{\n\n}",
- "memberOf" : "Roo.form.Field",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.form.Field",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "e",
- "type" : "Roo.EventObject",
- "desc" : "The event object",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "valid",
- "type" : "function",
- "desc" : "Fires after the field has been validated with no errors.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.form.Field",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.form.Field",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
}
],
"methods" : [
"returns" : []
},
{
- "name" : "applyTo",
+ "name" : "addxtype",
"type" : "function",
- "desc" : "Apply the behaviors of this component to an existing element. <b>This is used instead of render().</b>",
- "sig" : "(el)",
+ "desc" : "Adds a object form elements (using the xtype property as the factory method.)\nValid xtypes are: TextField, TextArea .... Button, Layout, FieldSet, Column",
+ "sig" : "(config)",
"static" : false,
- "memberOf" : "Roo.form.Field",
+ "memberOf" : "Roo.form.Layout",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "el",
- "type" : "String/HTMLElement/Element",
- "desc" : "The id of the node, a DOM node or an existing Element",
+ "name" : "config",
+ "type" : "Object",
+ "desc" : "",
"isOptional" : false
}
],
- "returns" : [
- {
- "name" : "",
- "type" : "Roo.form.Field",
- "desc" : "this"
- }
- ]
- },
- {
- "name" : "autoSize",
- "type" : "function",
- "desc" : "",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.form.TriggerField",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
"returns" : []
},
{
],
"returns" : []
},
- {
- "name" : "clearInvalid",
- "type" : "function",
- "desc" : "Clear any invalid styles/messages for this field",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.form.Field",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
- {
- "name" : "clearValue",
- "type" : "function",
- "desc" : "Clears any text/value currently set in the field",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
- {
- "name" : "collapse",
- "type" : "function",
- "desc" : "Hides the dropdown list if it is currently expanded. Fires the 'collapse' event on completion.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
{
"name" : "destroy",
"type" : "function",
}
]
},
- {
- "name" : "doQuery",
- "type" : "function",
- "desc" : "Execute a query to filter the dropdown list. Fires the beforequery event prior to performing the\nquery allowing the query action to be canceled if needed.",
- "sig" : "(query, forceAll)",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "query",
- "type" : "String",
- "desc" : "The SQL query to execute",
- "isOptional" : false
- },
- {
- "name" : "forceAll",
- "type" : "Boolean",
- "desc" : "True to force the query to execute even if there are currently fewer characters\nin the field than the minimum specified by the minChars config option. It also clears any filter previously\nsaved in the current store (defaults to false)",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
{
"name" : "enable",
"type" : "function",
}
]
},
- {
- "name" : "expand",
- "type" : "function",
- "desc" : "Expands the dropdown list if it is currently hidden. Fires the 'expand' event on completion.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
{
"name" : "fireEvent",
"type" : "function",
}
]
},
- {
- "name" : "getBox",
- "type" : "function",
- "desc" : "Gets the current box measurements of the component's underlying element.",
- "sig" : "(local)",
- "static" : false,
- "memberOf" : "Roo.BoxComponent",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "local",
- "type" : "Boolean",
- "desc" : "(optional) If true the element's left and top are returned instead of page XY (defaults to false)",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
{
"name" : "getEl",
"type" : "function",
]
},
{
- "name" : "getName",
- "type" : "function",
- "desc" : "Returns the name attribute of the field if available",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.form.Field",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : [
- {
- "name" : "",
- "type" : "String",
- "desc" : "name The field name"
- }
- ]
- },
- {
- "name" : "getPosition",
+ "name" : "hasListener",
"type" : "function",
- "desc" : "Gets the current XY position of the component's underlying element.",
- "sig" : "(local)",
+ "desc" : "Checks to see if this object has any listeners for a specified event",
+ "sig" : "(eventName)",
"static" : false,
- "memberOf" : "Roo.BoxComponent",
+ "memberOf" : "Roo.util.Observable",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "local",
- "type" : "Boolean",
- "desc" : "(optional) If true the element's left and top are returned instead of page XY (defaults to false)",
+ "name" : "eventName",
+ "type" : "String",
+ "desc" : "The name of the event to check for",
"isOptional" : false
}
],
"returns" : [
{
"name" : "",
- "type" : "Array",
- "desc" : "The XY position of the element (e.g., [100, 200])"
+ "type" : "Boolean",
+ "desc" : "True if the event is being listened for, else false"
}
]
},
{
- "name" : "getRawValue",
+ "name" : "hide",
"type" : "function",
- "desc" : "Returns the raw data value which may or may not be a valid, defined value. To return a normalized value see {@link #getValue}.",
+ "desc" : "Hide this component.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.form.Field",
+ "memberOf" : "Roo.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"returns" : [
{
"name" : "",
- "type" : "Mixed",
- "desc" : "value The field value"
+ "type" : "Roo.Component",
+ "desc" : "this"
}
]
},
{
- "name" : "getSize",
+ "name" : "isVisible",
"type" : "function",
- "desc" : "Gets the current size of the component's underlying element.",
+ "desc" : "Returns true if this component is visible.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.BoxComponent",
+ "memberOf" : "Roo.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"exceptions" : "",
"requires" : "",
"params" : [],
- "returns" : [
- {
- "name" : "",
- "type" : "Object",
- "desc" : "An object containing the element's size {width: (element width), height: (element height)}"
- }
- ]
+ "returns" : []
},
{
- "name" : "getValue",
+ "name" : "on",
"type" : "function",
- "desc" : "Returns the currently selected field value or empty string if no value is set.",
- "sig" : "()\n{\n\n}",
+ "desc" : "Appends an event handler to this element (shorthand for addListener)",
+ "sig" : "(eventName, handler, scope, options)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.util.Observable",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
- "returns" : [
+ "params" : [
{
- "name" : "",
+ "name" : "eventName",
"type" : "String",
- "desc" : "value The selected value"
+ "desc" : "The type of event to listen for",
+ "isOptional" : false
+ },
+ {
+ "name" : "handler",
+ "type" : "Function",
+ "desc" : "The method the event invokes",
+ "isOptional" : false
+ },
+ {
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
+ "isOptional" : false
+ },
+ {
+ "name" : "options",
+ "type" : "Object",
+ "desc" : "(optional)",
+ "isOptional" : false
}
- ]
+ ],
+ "returns" : []
},
{
- "name" : "hasChanged",
+ "name" : "purgeListeners",
"type" : "function",
- "desc" : "checks the current value against the 'loaded' value.\nNote - will return false if 'resetHasChanged' has not been called first.",
+ "desc" : "Removes all listeners for this object",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.form.Field",
+ "memberOf" : "Roo.util.Observable",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"returns" : []
},
{
- "name" : "hasListener",
+ "name" : "releaseCapture",
"type" : "function",
- "desc" : "Checks to see if this object has any listeners for a specified event",
- "sig" : "(eventName)",
- "static" : false,
+ "desc" : "Removes <b>all</b> added captures from the Observable.",
+ "sig" : "(o)",
+ "static" : true,
"memberOf" : "Roo.util.Observable",
- "isStatic" : false,
+ "isStatic" : true,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "o",
+ "type" : "Observable",
+ "desc" : "The Observable to release",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "removeListener",
+ "type" : "function",
+ "desc" : "Removes a listener",
+ "sig" : "(eventName, handler, scope)",
+ "static" : false,
+ "memberOf" : "Roo.util.Observable",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "eventName",
+ "type" : "String",
+ "desc" : "The type of event to listen for",
+ "isOptional" : false
+ },
+ {
+ "name" : "handler",
+ "type" : "Function",
+ "desc" : "The handler to remove",
+ "isOptional" : false
+ },
+ {
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "(optional) The scope (this object) for the handler",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "render",
+ "type" : "function",
+ "desc" : "If this is a lazy rendering component, render it to its container element.",
+ "sig" : "(container)",
+ "static" : false,
+ "memberOf" : "Roo.Component",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "container",
+ "type" : "String/HTMLElement/Element",
+ "desc" : "(optional) The element this component should be rendered into. If it is being applied to existing markup, this should be left off.",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "setDisabled",
+ "type" : "function",
+ "desc" : "Convenience function for setting disabled/enabled by boolean.",
+ "sig" : "(disabled)",
+ "static" : false,
+ "memberOf" : "Roo.Component",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "disabled",
+ "type" : "Boolean",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "setVisible",
+ "type" : "function",
+ "desc" : "Convenience function to hide or show this component by boolean.",
+ "sig" : "(visible)",
+ "static" : false,
+ "memberOf" : "Roo.Component",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "visible",
+ "type" : "Boolean",
+ "desc" : "True to show, false to hide",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.Component",
+ "desc" : "this"
+ }
+ ]
+ },
+ {
+ "name" : "show",
+ "type" : "function",
+ "desc" : "Show this component.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.Component",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.Component",
+ "desc" : "this"
+ }
+ ]
+ },
+ {
+ "name" : "un",
+ "type" : "function",
+ "desc" : "Removes a listener (shorthand for removeListener)",
+ "sig" : "(eventName, handler, scope)",
+ "static" : false,
+ "memberOf" : "Roo.util.Observable",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "eventName",
+ "type" : "String",
+ "desc" : "The type of event to listen for",
+ "isOptional" : false
+ },
+ {
+ "name" : "handler",
+ "type" : "Function",
+ "desc" : "The handler to remove",
+ "isOptional" : false
+ },
+ {
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "(optional) The scope (this object) for the handler",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ }
+ ],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "implementations" : [],
+ "tree_children" : [
+ "Roo.form.Row",
+ "Roo.form.Field",
+ "Roo.form.Checkbox",
+ "Roo.form.ComboBox",
+ "Roo.form.ComboBoxArray",
+ "Roo.form.ComboCheck",
+ "Roo.form.ComboNested",
+ "Roo.form.DateField",
+ "Roo.form.DayPicker",
+ "Roo.form.DisplayField",
+ "Roo.form.FCKeditor",
+ "Roo.form.GridField",
+ "Roo.form.Hidden",
+ "Roo.form.HtmlEditor",
+ "Roo.form.MonthField",
+ "Roo.form.NumberField",
+ "Roo.form.Radio",
+ "Roo.form.Select",
+ "Roo.form.Signature",
+ "Roo.form.TextArea",
+ "Roo.form.TextField",
+ "Roo.form.TriggerField",
+ "Roo.Button",
+ "Roo.SplitButton",
+ "Roo.Toolbar.Button",
+ "Roo.Toolbar.SplitButton",
+ "Roo.form.TextItem",
+ "Roo.form.FieldSet"
+ ],
+ "tree_parent" : []
+ },
+ "Roo.form.ComboBox" : {
+ "props" : [
+ {
+ "name" : "actionMode",
+ "type" : "String",
+ "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el' for forms you probably want to set this to fieldEl",
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "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" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "allowBlank",
+ "type" : "Boolean",
+ "desc" : "False to validate that the value length > 0 (defaults to true)",
+ "memberOf" : "Roo.form.TextField",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "allowDomMove",
+ "type" : "Boolean",
+ "desc" : "Whether the component can move the Dom node when rendering (defaults to true).",
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "allowLeadingSpace",
+ "type" : "Boolean",
+ "desc" : "True to prevent the stripping of leading white space",
+ "memberOf" : "Roo.form.TextField",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "alwaysQuery",
+ "type" : "Boolean",
+ "desc" : "Disable caching of results, and always send query",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "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" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "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",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "blockFocus",
+ "type" : "Boolean",
+ "desc" : "Prevents all focus calls, so it can work with things like HTML edtor bar",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "cls",
+ "type" : "String",
+ "desc" : "A CSS class to apply to the field's underlying element.",
+ "memberOf" : "Roo.form.Field",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "disableClass",
+ "type" : "String",
+ "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").",
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "disableClear",
+ "type" : "Boolean",
+ "desc" : "Disable showing of clear button.",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "disableKeyFilter",
+ "type" : "Boolean",
+ "desc" : "True to disable input keystroke filtering (defaults to false)",
+ "memberOf" : "Roo.form.TextField",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "disabled",
+ "type" : "Boolean",
+ "desc" : "True to disable the field (defaults to false).",
+ "memberOf" : "Roo.form.Field",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "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" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "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" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "emptyText",
+ "type" : "String",
+ "desc" : "The default text to display in an empty field - placeholder... (defaults to null).",
+ "memberOf" : "Roo.form.TextField",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "fieldClass",
+ "type" : "String",
+ "desc" : "The default CSS class for the field (defaults to \"x-form-field\")",
+ "memberOf" : "Roo.form.Field",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "fieldLabel",
+ "type" : "String",
+ "desc" : "Label to use when rendering a form.",
+ "memberOf" : "Roo.form.Field",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "focusClass",
+ "type" : "String",
+ "desc" : "The CSS class to use when the field receives focus (defaults to \"x-form-focus\")",
+ "memberOf" : "Roo.form.Field",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "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" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "grow",
+ "type" : "Boolean",
+ "desc" : "",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "growMax",
+ "type" : "Number",
+ "desc" : "",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "growMin",
+ "type" : "Number",
+ "desc" : "",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "handleHeight",
+ "type" : "Number",
+ "desc" : "The height in pixels of the dropdown list resize handle if resizable = true (defaults to 8)",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "height",
+ "type" : "Number",
+ "desc" : "height (optional) size of component",
+ "memberOf" : "Roo.BoxComponent",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "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" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "hideMode",
+ "type" : "String",
+ "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display",
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : [
+ "display",
+ "visibility"
+ ]
+ },
+ {
+ "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",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "inputType",
+ "type" : "String",
+ "desc" : "The type attribute for input fields -- e.g. radio, text, password (defaults to \"text\").",
+ "memberOf" : "Roo.form.Field",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "invalidClass",
+ "type" : "String",
+ "desc" : "The CSS class to use when marking a field invalid (defaults to \"x-form-invalid\")",
+ "memberOf" : "Roo.form.Field",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "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",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "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" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "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" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "listClass",
+ "type" : "String",
+ "desc" : "CSS class to apply to the dropdown list element (defaults to '')",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "listWidth",
+ "type" : "Number",
+ "desc" : "The width in pixels of the dropdown list (defaults to the width of the ComboBox field)",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "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",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "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" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "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",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "maxHeight",
+ "type" : "Number",
+ "desc" : "The maximum height in pixels of the dropdown list before scrollbars are shown (defaults to 300)",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "maxLength",
+ "type" : "Number",
+ "desc" : "Maximum input field length allowed (defaults to Number.MAX_VALUE)",
+ "memberOf" : "Roo.form.TextField",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "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",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "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" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "minLength",
+ "type" : "Number",
+ "desc" : "Minimum input field length required (defaults to 0)",
+ "memberOf" : "Roo.form.TextField",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "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",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "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" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "mode",
+ "type" : "String",
+ "desc" : "Set to 'local' if the ComboBox loads local data (defaults to 'remote' which loads from the server)",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "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",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "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",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "name",
+ "type" : "String",
+ "desc" : "The field's HTML name attribute.",
+ "memberOf" : "Roo.form.Field",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "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" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "qtip",
+ "type" : "String",
+ "desc" : "Mouse over tip",
+ "memberOf" : "Roo.form.Field",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "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" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "queryParam",
+ "type" : "String",
+ "desc" : "Name of the query as it will be passed on the querystring (defaults to 'query')",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "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",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "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",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "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",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "resizable",
+ "type" : "Boolean",
+ "desc" : "True to add a resize handle to the bottom of the dropdown list (defaults to false)",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "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" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "selectedClass",
+ "type" : "String",
+ "desc" : "CSS class to apply to the selected item in the dropdown list (defaults to 'x-combo-selected')",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "shadow",
+ "type" : "Boolean/String",
+ "desc" : "True or \"sides\" for the default effect, \"frame\" for 4-way shadow, and \"drop\" for bottom-right",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "store",
+ "type" : "Roo.data.Store",
+ "desc" : "The data store to which this combo is bound (defaults to undefined)",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "style",
+ "type" : "String",
+ "desc" : "css styles to add to component\neg. text-align:right;",
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "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",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "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" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "tpl",
+ "type" : "String/Roo.Template",
+ "desc" : "The template to use to render the output",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "transform",
+ "type" : "String/HTMLElement/Element",
+ "desc" : "The id, DOM node or element of an existing select to convert to a ComboBox",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "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" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "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" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "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" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "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" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "validateOnBlur",
+ "type" : "Boolean",
+ "desc" : "Whether the field should validate when it loses focus (defaults to true).",
+ "memberOf" : "Roo.form.Field",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "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",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "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",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "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",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "value",
+ "type" : "Mixed",
+ "desc" : "A value to initialize this field with.",
+ "memberOf" : "Roo.form.Field",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "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" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "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" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "vtype",
+ "type" : "String",
+ "desc" : "A validation type name as defined in {@link Roo.form.VTypes} (defaults to null)",
+ "memberOf" : "Roo.form.TextField",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "width",
+ "type" : "Number",
+ "desc" : "width (optional) size of component",
+ "memberOf" : "Roo.BoxComponent",
+ "isOptional" : false,
+ "optvals" : []
+ }
+ ],
+ "events" : [
+ {
+ "name" : "add",
+ "type" : "function",
+ "desc" : "Fires when the 'add' icon is pressed (add a listener to enable add button)",
+ "sig" : "function (combo)\n{\n\n}",
+ "memberOf" : "",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "combo",
+ "type" : "Roo.form.ComboBox",
+ "desc" : "This combo box",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "autosize",
+ "type" : "function",
+ "desc" : "Fires when the autosize function is triggered. The field may or may not have actually changed size\naccording to the default logic, but this event provides a hook for the developer to apply additional\nlogic at runtime to resize the field if needed.",
+ "sig" : "function (_self, width)\n{\n\n}",
+ "memberOf" : "Roo.form.TextField",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.form.Field",
+ "desc" : "This text field",
+ "isOptional" : false
+ },
+ {
+ "name" : "width",
+ "type" : "Number",
+ "desc" : "The new field width",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "beforedestroy",
+ "type" : "function",
+ "desc" : "Fires before the component is destroyed. Return false to stop the destroy.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.Component",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "beforehide",
+ "type" : "function",
+ "desc" : "Fires before the component is hidden. Return false to stop the hide.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.Component",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "beforequery",
+ "type" : "function",
+ "desc" : "Fires before all queries are processed. Return false to cancel the query or set cancel to true.\nThe event object passed has these properties:",
+ "sig" : "function (combo, query, forceAll, cancel, e)\n{\n\n}",
+ "memberOf" : "",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "combo",
+ "type" : "Roo.form.ComboBox",
+ "desc" : "This combo box",
+ "isOptional" : false
+ },
+ {
+ "name" : "query",
+ "type" : "String",
+ "desc" : "The query",
+ "isOptional" : false
+ },
+ {
+ "name" : "forceAll",
+ "type" : "Boolean",
+ "desc" : "true to force \"all\" query",
+ "isOptional" : false
+ },
+ {
+ "name" : "cancel",
+ "type" : "Boolean",
+ "desc" : "true to cancel the query",
+ "isOptional" : false
+ },
+ {
+ "name" : "e",
+ "type" : "Object",
+ "desc" : "The query event object",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "beforerender",
+ "type" : "function",
+ "desc" : "Fires before the component is rendered. Return false to stop the render.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.Component",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "beforeselect",
+ "type" : "function",
+ "desc" : "Fires before a list item is selected. Return false to cancel the selection.",
+ "sig" : "function (combo, record, index)\n{\n\n}",
+ "memberOf" : "",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "combo",
+ "type" : "Roo.form.ComboBox",
+ "desc" : "This combo box",
+ "isOptional" : false
+ },
+ {
+ "name" : "record",
+ "type" : "Roo.data.Record",
+ "desc" : "The data record returned from the underlying store",
+ "isOptional" : false
+ },
+ {
+ "name" : "index",
+ "type" : "Number",
+ "desc" : "The index of the selected item in the dropdown list",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "beforeshow",
+ "type" : "function",
+ "desc" : "Fires before the component is shown. Return false to stop the show.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.Component",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "blur",
+ "type" : "function",
+ "desc" : "Fires when this field loses input focus.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.form.Field",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.form.Field",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "change",
+ "type" : "function",
+ "desc" : "Fires just before the field blurs if the field value has changed.",
+ "sig" : "function (_self, newValue, oldValue)\n{\n\n}",
+ "memberOf" : "Roo.form.Field",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.form.Field",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "newValue",
+ "type" : "Mixed",
+ "desc" : "The new value",
+ "isOptional" : false
+ },
+ {
+ "name" : "oldValue",
+ "type" : "Mixed",
+ "desc" : "The original value",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "collapse",
+ "type" : "function",
+ "desc" : "Fires when the dropdown list is collapsed",
+ "sig" : "function (combo)\n{\n\n}",
+ "memberOf" : "",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "combo",
+ "type" : "Roo.form.ComboBox",
+ "desc" : "This combo box",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "destroy",
+ "type" : "function",
+ "desc" : "Fires after the component is destroyed.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.Component",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "disable",
+ "type" : "function",
+ "desc" : "Fires after the component is disabled.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.Component",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "edit",
+ "type" : "function",
+ "desc" : "Fires when the 'edit' icon is pressed (add a listener to enable add button)",
+ "sig" : "function (combo, record)\n{\n\n}",
+ "memberOf" : "",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "combo",
+ "type" : "Roo.form.ComboBox",
+ "desc" : "This combo box",
+ "isOptional" : false
+ },
+ {
+ "name" : "record",
+ "type" : "Roo.data.Record|false",
+ "desc" : "The data record returned from the underlying store (or false on nothing selected)",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "enable",
+ "type" : "function",
+ "desc" : "Fires after the component is enabled.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.Component",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "expand",
+ "type" : "function",
+ "desc" : "Fires when the dropdown list is expanded",
+ "sig" : "function (combo)\n{\n\n}",
+ "memberOf" : "",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "combo",
+ "type" : "Roo.form.ComboBox",
+ "desc" : "This combo box",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "focus",
+ "type" : "function",
+ "desc" : "Fires when this field receives input focus.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.form.Field",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.form.Field",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "hide",
+ "type" : "function",
+ "desc" : "Fires after the component is hidden.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.Component",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "invalid",
+ "type" : "function",
+ "desc" : "Fires after the field has been marked as invalid.",
+ "sig" : "function (_self, msg)\n{\n\n}",
+ "memberOf" : "Roo.form.Field",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.form.Field",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "msg",
+ "type" : "String",
+ "desc" : "The validation message",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "keyup",
+ "type" : "function",
+ "desc" : "Fires after the key up",
+ "sig" : "function (_self, e)\n{\n\n}",
+ "memberOf" : "Roo.form.Field",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.form.Field",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "e",
+ "type" : "Roo.EventObject",
+ "desc" : "The event Object",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "move",
+ "type" : "function",
+ "desc" : "Fires after the component is moved.",
+ "sig" : "function (_self, x, y)\n{\n\n}",
+ "memberOf" : "Roo.BoxComponent",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.Component",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "x",
+ "type" : "Number",
+ "desc" : "The new x position",
+ "isOptional" : false
+ },
+ {
+ "name" : "y",
+ "type" : "Number",
+ "desc" : "The new y position",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "render",
+ "type" : "function",
+ "desc" : "Fires after the component is rendered.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.Component",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "resize",
+ "type" : "function",
+ "desc" : "Fires after the component is resized.",
+ "sig" : "function (_self, adjWidth, adjHeight, rawWidth, rawHeight)\n{\n\n}",
+ "memberOf" : "Roo.BoxComponent",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.Component",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "adjWidth",
+ "type" : "Number",
+ "desc" : "The box-adjusted width that was set",
+ "isOptional" : false
+ },
+ {
+ "name" : "adjHeight",
+ "type" : "Number",
+ "desc" : "The box-adjusted height that was set",
+ "isOptional" : false
+ },
+ {
+ "name" : "rawWidth",
+ "type" : "Number",
+ "desc" : "The width that was originally specified",
+ "isOptional" : false
+ },
+ {
+ "name" : "rawHeight",
+ "type" : "Number",
+ "desc" : "The height that was originally specified",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "select",
+ "type" : "function",
+ "desc" : "Fires when a list item is selected",
+ "sig" : "function (combo, record, index)\n{\n\n}",
+ "memberOf" : "",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "combo",
+ "type" : "Roo.form.ComboBox",
+ "desc" : "This combo box",
+ "isOptional" : false
+ },
+ {
+ "name" : "record",
+ "type" : "Roo.data.Record",
+ "desc" : "The data record returned from the underlying store (or false on clear)",
+ "isOptional" : false
+ },
+ {
+ "name" : "index",
+ "type" : "Number",
+ "desc" : "The index of the selected item in the dropdown list",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "show",
+ "type" : "function",
+ "desc" : "Fires after the component is shown.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.Component",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "specialkey",
+ "type" : "function",
+ "desc" : "Fires when any key related to navigation (arrows, tab, enter, esc, etc.) is pressed. You can check\n{@link Roo.EventObject#getKey} to determine which key was pressed.",
+ "sig" : "function (_self, e)\n{\n\n}",
+ "memberOf" : "Roo.form.Field",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.form.Field",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "e",
+ "type" : "Roo.EventObject",
+ "desc" : "The event object",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "valid",
+ "type" : "function",
+ "desc" : "Fires after the field has been validated with no errors.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.form.Field",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.form.Field",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ }
+ ],
+ "methods" : [
+ {
+ "name" : "addEvents",
+ "type" : "function",
+ "desc" : "Used to define events on this Observable",
+ "sig" : "(object)",
+ "static" : false,
+ "memberOf" : "Roo.util.Observable",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "object",
+ "type" : "Object",
+ "desc" : "The object with the events defined",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "addListener",
+ "type" : "function",
+ "desc" : "Appends an event handler to this component",
+ "sig" : "(eventName, handler, scope, options)",
+ "static" : false,
+ "memberOf" : "Roo.util.Observable",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "eventName",
+ "type" : "String",
+ "desc" : "The type of event to listen for",
+ "isOptional" : false
+ },
+ {
+ "name" : "handler",
+ "type" : "Function",
+ "desc" : "The method the event invokes",
+ "isOptional" : false
+ },
+ {
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
+ "isOptional" : false
+ },
+ {
+ "name" : "options",
+ "type" : "Object",
+ "desc" : "(optional) An object containing handler configuration\nproperties. This may contain any of the following properties:<ul>\n<li>scope {Object} The scope in which to execute the handler function. The handler function's \"this\" context.</li>\n<li>delay {Number} The number of milliseconds to delay the invocation of the handler after te event fires.</li>\n<li>single {Boolean} True to add a handler to handle just the next firing of the event, and then remove itself.</li>\n<li>buffer {Number} Causes the handler to be scheduled to run in an {@link Roo.util.DelayedTask} delayed\nby the specified number of milliseconds. If the event fires again within that time, the original\nhandler is <em>not</em> invoked, but the new handler is scheduled in its place.</li>\n</ul><br>\n<p>\n<b>Combining Options</b><br>\nUsing the options argument, it is possible to combine different types of listeners:<br>\n<br>\nA normalized, delayed, one-time listener that auto stops the event and passes a custom argument (forumId)\n\t\t<pre><code>\n\t\tel.on('click', this.onClick, this, {\n \t\t\tsingle: true,\n \t\tdelay: 100,\n \t\tforumId: 4\n\t\t});\n\t\t</code></pre>\n<p>\n<b>Attaching multiple handlers in 1 call</b><br>\nThe method also allows for a single argument to be passed which is a config object containing properties\nwhich specify multiple handlers.\n<pre><code>\n\t\tel.on({\n\t\t\t'click': {\n \t\tfn: this.onClick,\n \t\tscope: this,\n \t\tdelay: 100\n \t\t}, \n \t\t'mouseover': {\n \t\tfn: this.onMouseOver,\n \t\tscope: this\n \t\t},\n \t\t'mouseout': {\n \t\tfn: this.onMouseOut,\n \t\tscope: this\n \t\t}\n\t\t});\n\t\t</code></pre>\n<p>\nOr a shorthand syntax which passes the same scope object to all handlers:\n \t<pre><code>\n\t\tel.on({\n\t\t\t'click': this.onClick,\n \t\t'mouseover': this.onMouseOver,\n \t\t'mouseout': this.onMouseOut,\n \t\tscope: this\n\t\t});\n\t\t</code></pre>",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "applyTo",
+ "type" : "function",
+ "desc" : "Apply the behaviors of this component to an existing element. <b>This is used instead of render().</b>",
+ "sig" : "(el)",
+ "static" : false,
+ "memberOf" : "Roo.form.Field",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "el",
+ "type" : "String/HTMLElement/Element",
+ "desc" : "The id of the node, a DOM node or an existing Element",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.form.Field",
+ "desc" : "this"
+ }
+ ]
+ },
+ {
+ "name" : "autoSize",
+ "type" : "function",
+ "desc" : "",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.form.TriggerField",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
+ {
+ "name" : "capture",
+ "type" : "function",
+ "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\n<b>before</b> the event is fired. If the supplied function returns false,\nthe event will not fire.",
+ "sig" : "(o, fn, scope)",
+ "static" : true,
+ "memberOf" : "Roo.util.Observable",
+ "isStatic" : true,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "o",
+ "type" : "Observable",
+ "desc" : "The Observable to capture",
+ "isOptional" : false
+ },
+ {
+ "name" : "fn",
+ "type" : "Function",
+ "desc" : "The function to call",
+ "isOptional" : false
+ },
+ {
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "(optional) The scope (this object) for the fn",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "clearInvalid",
+ "type" : "function",
+ "desc" : "Clear any invalid styles/messages for this field",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.form.Field",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
+ {
+ "name" : "clearValue",
+ "type" : "function",
+ "desc" : "Clears any text/value currently set in the field",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
+ {
+ "name" : "collapse",
+ "type" : "function",
+ "desc" : "Hides the dropdown list if it is currently expanded. Fires the 'collapse' event on completion.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
+ {
+ "name" : "destroy",
+ "type" : "function",
+ "desc" : "Destroys this component by purging any event listeners, removing the component's element from the DOM,\nremoving the component from its {@link Roo.Container} (if applicable) and unregistering it from {@link Roo.ComponentMgr}.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.Component",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
+ {
+ "name" : "disable",
+ "type" : "function",
+ "desc" : "Disable this component.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.Component",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.Component",
+ "desc" : "this"
+ }
+ ]
+ },
+ {
+ "name" : "doQuery",
+ "type" : "function",
+ "desc" : "Execute a query to filter the dropdown list. Fires the beforequery event prior to performing the\nquery allowing the query action to be canceled if needed.",
+ "sig" : "(query, forceAll)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "query",
+ "type" : "String",
+ "desc" : "The SQL query to execute",
+ "isOptional" : false
+ },
+ {
+ "name" : "forceAll",
+ "type" : "Boolean",
+ "desc" : "True to force the query to execute even if there are currently fewer characters\nin the field than the minimum specified by the minChars config option. It also clears any filter previously\nsaved in the current store (defaults to false)",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "enable",
+ "type" : "function",
+ "desc" : "Enable this component.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.Component",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.Component",
+ "desc" : "this"
+ }
+ ]
+ },
+ {
+ "name" : "expand",
+ "type" : "function",
+ "desc" : "Expands the dropdown list if it is currently hidden. Fires the 'expand' event on completion.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
+ {
+ "name" : "fireEvent",
+ "type" : "function",
+ "desc" : "Fires the specified event with the passed parameters (minus the event name).",
+ "sig" : "(eventName, args)",
+ "static" : false,
+ "memberOf" : "Roo.util.Observable",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "eventName",
+ "type" : "String",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "args",
+ "type" : "Object...",
+ "desc" : "Variable number of parameters are passed to handlers",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Boolean",
+ "desc" : "returns false if any of the handlers return false otherwise it returns true"
+ }
+ ]
+ },
+ {
+ "name" : "focus",
+ "type" : "function",
+ "desc" : "Try to focus this component.",
+ "sig" : "(selectText)",
+ "static" : false,
+ "memberOf" : "Roo.Component",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "selectText",
+ "type" : "Boolean",
+ "desc" : "True to also select the text in this component (if applicable)",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.Component",
+ "desc" : "this"
+ }
+ ]
+ },
+ {
+ "name" : "getBox",
+ "type" : "function",
+ "desc" : "Gets the current box measurements of the component's underlying element.",
+ "sig" : "(local)",
+ "static" : false,
+ "memberOf" : "Roo.BoxComponent",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "local",
+ "type" : "Boolean",
+ "desc" : "(optional) If true the element's left and top are returned instead of page XY (defaults to false)",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "getEl",
+ "type" : "function",
+ "desc" : "Returns the underlying {@link Roo.Element}.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.Component",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.Element",
+ "desc" : "The element"
+ }
+ ]
+ },
+ {
+ "name" : "getId",
+ "type" : "function",
+ "desc" : "Returns the id of this component.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.Component",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "String",
+ "desc" : ""
+ }
+ ]
+ },
+ {
+ "name" : "getName",
+ "type" : "function",
+ "desc" : "Returns the name attribute of the field if available",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.form.Field",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "String",
+ "desc" : "name The field name"
+ }
+ ]
+ },
+ {
+ "name" : "getPosition",
+ "type" : "function",
+ "desc" : "Gets the current XY position of the component's underlying element.",
+ "sig" : "(local)",
+ "static" : false,
+ "memberOf" : "Roo.BoxComponent",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "local",
+ "type" : "Boolean",
+ "desc" : "(optional) If true the element's left and top are returned instead of page XY (defaults to false)",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Array",
+ "desc" : "The XY position of the element (e.g., [100, 200])"
+ }
+ ]
+ },
+ {
+ "name" : "getRawValue",
+ "type" : "function",
+ "desc" : "Returns the raw data value which may or may not be a valid, defined value. To return a normalized value see {@link #getValue}.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.form.Field",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Mixed",
+ "desc" : "value The field value"
+ }
+ ]
+ },
+ {
+ "name" : "getSize",
+ "type" : "function",
+ "desc" : "Gets the current size of the component's underlying element.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.BoxComponent",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Object",
+ "desc" : "An object containing the element's size {width: (element width), height: (element height)}"
+ }
+ ]
+ },
+ {
+ "name" : "getValue",
+ "type" : "function",
+ "desc" : "Returns the currently selected field value or empty string if no value is set.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "String",
+ "desc" : "value The selected value"
+ }
+ ]
+ },
+ {
+ "name" : "hasChanged",
+ "type" : "function",
+ "desc" : "checks the current value against the 'loaded' value.\nNote - will return false if 'resetHasChanged' has not been called first.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.form.Field",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
+ {
+ "name" : "hasListener",
+ "type" : "function",
+ "desc" : "Checks to see if this object has any listeners for a specified event",
+ "sig" : "(eventName)",
+ "static" : false,
+ "memberOf" : "Roo.util.Observable",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "eventName",
+ "type" : "String",
+ "desc" : "The name of the event to check for",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Boolean",
+ "desc" : "True if the event is being listened for, else false"
+ }
+ ]
+ },
+ {
+ "name" : "hide",
+ "type" : "function",
+ "desc" : "Hide this component.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.Component",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.Component",
+ "desc" : "this"
+ }
+ ]
+ },
+ {
+ "name" : "isDirty",
+ "type" : "function",
+ "desc" : "Returns true if this field has been changed since it was originally loaded and is not disabled.\nDEPRICATED - it never worked well - use hasChanged/resetHasChanged.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.form.Field",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
+ {
+ "name" : "isExpanded",
+ "type" : "function",
+ "desc" : "Returns true if the dropdown list is expanded, else false.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
+ {
+ "name" : "isValid",
+ "type" : "function",
+ "desc" : "Returns whether or not the field value is currently valid",
+ "sig" : "(preventMark)",
+ "static" : false,
+ "memberOf" : "Roo.form.Field",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "preventMark",
+ "type" : "Boolean",
+ "desc" : "True to disable marking the field invalid",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Boolean",
+ "desc" : "True if the value is valid, else false"
+ }
+ ]
+ },
+ {
+ "name" : "isVisible",
+ "type" : "function",
+ "desc" : "Returns true if this component is visible.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.Component",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
+ {
+ "name" : "markInvalid",
+ "type" : "function",
+ "desc" : "Mark this field as invalid",
+ "sig" : "(msg)",
+ "static" : false,
+ "memberOf" : "Roo.form.Field",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "msg",
+ "type" : "String",
+ "desc" : "The validation message",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "on",
+ "type" : "function",
+ "desc" : "Appends an event handler to this element (shorthand for addListener)",
+ "sig" : "(eventName, handler, scope, options)",
+ "static" : false,
+ "memberOf" : "Roo.util.Observable",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "eventName",
+ "type" : "String",
+ "desc" : "The type of event to listen for",
+ "isOptional" : false
+ },
+ {
+ "name" : "handler",
+ "type" : "Function",
+ "desc" : "The method the event invokes",
+ "isOptional" : false
+ },
+ {
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
+ "isOptional" : false
+ },
+ {
+ "name" : "options",
+ "type" : "Object",
+ "desc" : "(optional)",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "onPosition",
+ "type" : "function",
+ "desc" : "Called after the component is moved, this method is empty by default but can be implemented by any\nsubclass that needs to perform custom logic after a move occurs.",
+ "sig" : "(x, y)",
+ "static" : false,
+ "memberOf" : "Roo.BoxComponent",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "x",
+ "type" : "Number",
+ "desc" : "The new x position",
+ "isOptional" : false
+ },
+ {
+ "name" : "y",
+ "type" : "Number",
+ "desc" : "The new y position",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "onResize",
+ "type" : "function",
+ "desc" : "Called after the component is resized, this method is empty by default but can be implemented by any\nsubclass that needs to perform custom logic after a resize occurs.",
+ "sig" : "(adjWidth, adjHeight, rawWidth, rawHeight)",
+ "static" : false,
+ "memberOf" : "Roo.BoxComponent",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "adjWidth",
+ "type" : "Number",
+ "desc" : "The box-adjusted width that was set",
+ "isOptional" : false
+ },
+ {
+ "name" : "adjHeight",
+ "type" : "Number",
+ "desc" : "The box-adjusted height that was set",
+ "isOptional" : false
+ },
+ {
+ "name" : "rawWidth",
+ "type" : "Number",
+ "desc" : "The width that was originally specified",
+ "isOptional" : false
+ },
+ {
+ "name" : "rawHeight",
+ "type" : "Number",
+ "desc" : "The height that was originally specified",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "onTriggerClick",
+ "type" : "function",
+ "desc" : "The function that should handle the trigger's click event. This method does nothing by default until overridden\nby an implementing function.",
+ "sig" : "(e)",
+ "static" : false,
+ "memberOf" : "Roo.form.TriggerField",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "e",
+ "type" : "EventObject",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "purgeListeners",
+ "type" : "function",
+ "desc" : "Removes all listeners for this object",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.util.Observable",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
+ {
+ "name" : "releaseCapture",
+ "type" : "function",
+ "desc" : "Removes <b>all</b> added captures from the Observable.",
+ "sig" : "(o)",
+ "static" : true,
+ "memberOf" : "Roo.util.Observable",
+ "isStatic" : true,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "o",
+ "type" : "Observable",
+ "desc" : "The Observable to release",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "removeListener",
+ "type" : "function",
+ "desc" : "Removes a listener",
+ "sig" : "(eventName, handler, scope)",
+ "static" : false,
+ "memberOf" : "Roo.util.Observable",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "eventName",
+ "type" : "String",
+ "desc" : "The type of event to listen for",
+ "isOptional" : false
+ },
+ {
+ "name" : "handler",
+ "type" : "Function",
+ "desc" : "The handler to remove",
+ "isOptional" : false
+ },
+ {
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "(optional) The scope (this object) for the handler",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "render",
+ "type" : "function",
+ "desc" : "If this is a lazy rendering component, render it to its container element.",
+ "sig" : "(container)",
+ "static" : false,
+ "memberOf" : "Roo.Component",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "container",
+ "type" : "String/HTMLElement/Element",
+ "desc" : "(optional) The element this component should be rendered into. If it is being applied to existing markup, this should be left off.",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "reset",
+ "type" : "function",
+ "desc" : "Resets the current field value to the originally-loaded value and clears any validation messages.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.form.TextField",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
+ {
+ "name" : "resetHasChanged",
+ "type" : "function",
+ "desc" : "stores the current value in loadedValue",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.form.Field",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
+ {
+ "name" : "select",
+ "type" : "function",
+ "desc" : "Select an item in the dropdown list by its numeric index in the list. This function does NOT cause the select event to fire.\nThe store must be loaded and the list expanded for this function to work, otherwise use setValue.",
+ "sig" : "(index, scrollIntoView)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "index",
+ "type" : "Number",
+ "desc" : "The zero-based index of the list item to select",
+ "isOptional" : false
+ },
+ {
+ "name" : "scrollIntoView",
+ "type" : "Boolean",
+ "desc" : "False to prevent the dropdown list from autoscrolling to display the\nselected item if it is not currently in view (defaults to true)",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "selectByValue",
+ "type" : "function",
+ "desc" : "Select an item in the dropdown list by its data value. This function does NOT cause the select event to fire.\nThe store must be loaded and the list expanded for this function to work, otherwise use setValue.",
+ "sig" : "(value, scrollIntoView)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "value",
+ "type" : "String",
+ "desc" : "The data value of the item to select",
+ "isOptional" : false
+ },
+ {
+ "name" : "scrollIntoView",
+ "type" : "Boolean",
+ "desc" : "False to prevent the dropdown list from autoscrolling to display the\nselected item if it is not currently in view (defaults to true)",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Boolean",
+ "desc" : "True if the value matched an item in the list, else false"
+ }
+ ]
+ },
+ {
+ "name" : "selectText",
+ "type" : "function",
+ "desc" : "Selects text in this field",
+ "sig" : "(start, end)",
+ "static" : false,
+ "memberOf" : "Roo.form.TextField",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "start",
+ "type" : "Number",
+ "desc" : "(optional) The index where the selection should start (defaults to 0)",
+ "isOptional" : false
+ },
+ {
+ "name" : "end",
+ "type" : "Number",
+ "desc" : "(optional) The index where the selection should end (defaults to the text length)",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "setDisabled",
+ "type" : "function",
+ "desc" : "Convenience function for setting disabled/enabled by boolean.",
+ "sig" : "(disabled)",
+ "static" : false,
+ "memberOf" : "Roo.Component",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "disabled",
+ "type" : "Boolean",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "setEditable",
+ "type" : "function",
+ "desc" : "Allow or prevent the user from directly editing the field text. If false is passed,\nthe user will only be able to select from the items defined in the dropdown list. This method\nis the runtime equivalent of setting the 'editable' config option at config time.",
+ "sig" : "(value)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "value",
+ "type" : "Boolean",
+ "desc" : "True to allow the user to directly edit the field text",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "setFromData",
+ "type" : "function",
+ "desc" : "Sets the value of the field based on a object which is related to the record format for the store.",
+ "sig" : "(value)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "value",
+ "type" : "Object",
+ "desc" : "the value to set as. or false on reset?",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "setPagePosition",
+ "type" : "function",
+ "desc" : "Sets the page XY position of the component. To set the left and top instead, use {@link #setPosition}.\nThis method fires the move event.",
+ "sig" : "(x, y)",
+ "static" : false,
+ "memberOf" : "Roo.BoxComponent",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "x",
+ "type" : "Number",
+ "desc" : "The new x position",
+ "isOptional" : false
+ },
+ {
+ "name" : "y",
+ "type" : "Number",
+ "desc" : "The new y position",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "setPosition",
+ "type" : "function",
+ "desc" : "Sets the left and top of the component. To set the page XY position instead, use {@link #setPagePosition}.\nThis method fires the move event.",
+ "sig" : "(left, top)",
+ "static" : false,
+ "memberOf" : "Roo.BoxComponent",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "left",
+ "type" : "Number",
+ "desc" : "The new left",
+ "isOptional" : false
+ },
+ {
+ "name" : "top",
+ "type" : "Number",
+ "desc" : "The new top",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "setRawValue",
+ "type" : "function",
+ "desc" : "Sets the underlying DOM field's value directly, bypassing validation. To set the value with validation see {@link #setValue}.",
+ "sig" : "(value)",
+ "static" : false,
+ "memberOf" : "Roo.form.Field",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "value",
+ "type" : "Mixed",
+ "desc" : "The value to set",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "setSize",
+ "type" : "function",
+ "desc" : "Sets the width and height of the component. This method fires the resize event. This method can accept\neither width and height as separate numeric arguments, or you can pass a size object like {width:10, height:20}.",
+ "sig" : "(width, height)",
+ "static" : false,
+ "memberOf" : "Roo.BoxComponent",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "width",
+ "type" : "Number/Object",
+ "desc" : "The new width to set, or a size object in the format {width, height}",
+ "isOptional" : false
+ },
+ {
+ "name" : "height",
+ "type" : "Number",
+ "desc" : "The new height to set (not required if a size object is passed as the first arg)",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.BoxComponent",
+ "desc" : "this"
+ }
+ ]
+ },
+ {
+ "name" : "setValue",
+ "type" : "function",
+ "desc" : "Sets the specified value into the field. If the value finds a match, the corresponding record text\nwill be displayed in the field. If the value does not match the data value of an existing item,\nand the valueNotFoundText config option is defined, it will be displayed as the default field text.\nOtherwise the field will be blank (although the value will still be set).",
+ "sig" : "(value)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "value",
+ "type" : "String",
+ "desc" : "The value to match",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "setVisible",
+ "type" : "function",
+ "desc" : "Convenience function to hide or show this component by boolean.",
+ "sig" : "(visible)",
+ "static" : false,
+ "memberOf" : "Roo.Component",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "visible",
+ "type" : "Boolean",
+ "desc" : "True to show, false to hide",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.Component",
+ "desc" : "this"
+ }
+ ]
+ },
+ {
+ "name" : "show",
+ "type" : "function",
+ "desc" : "Show this component.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.Component",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.Component",
+ "desc" : "this"
+ }
+ ]
+ },
+ {
+ "name" : "syncSize",
+ "type" : "function",
+ "desc" : "Force the component's size to recalculate based on the underlying element's current height and width.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.BoxComponent",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
+ {
+ "name" : "un",
+ "type" : "function",
+ "desc" : "Removes a listener (shorthand for removeListener)",
+ "sig" : "(eventName, handler, scope)",
+ "static" : false,
+ "memberOf" : "Roo.util.Observable",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "eventName",
+ "type" : "String",
+ "desc" : "The type of event to listen for",
+ "isOptional" : false
+ },
+ {
+ "name" : "handler",
+ "type" : "Function",
+ "desc" : "The handler to remove",
+ "isOptional" : false
+ },
+ {
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "(optional) The scope (this object) for the handler",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "updateBox",
+ "type" : "function",
+ "desc" : "Sets the current box measurements of the component's underlying element.",
+ "sig" : "(box)",
+ "static" : false,
+ "memberOf" : "Roo.BoxComponent",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "box",
+ "type" : "Object",
+ "desc" : "An object in the format {x, y, width, height}",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "validate",
+ "type" : "function",
+ "desc" : "Validates the field value",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.form.Field",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Boolean",
+ "desc" : "True if the value is valid, else false"
+ }
+ ]
+ },
+ {
+ "name" : "validateValue",
+ "type" : "function",
+ "desc" : "Validates a value according to the field's validation rules and marks the field as invalid\nif the validation fails",
+ "sig" : "(value)",
+ "static" : false,
+ "memberOf" : "Roo.form.TextField",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "value",
+ "type" : "Mixed",
+ "desc" : "The value to validate",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Boolean",
+ "desc" : "True if the value is valid, else false"
+ }
+ ]
+ }
+ ],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "implementations" : [
+ "Roo.form.ComboCheck",
+ "Roo.form.ComboNested"
+ ],
+ "tree_children" : [],
+ "tree_parent" : []
+ },
+ "Roo.form.ComboBoxArray" : {
+ "props" : [
+ {
+ "name" : "actionMode",
+ "type" : "String",
+ "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el' for forms you probably want to set this to fieldEl",
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "allowBlank",
+ "type" : "Boolean",
+ "desc" : "False to validate that the value length > 0 (defaults to true)",
+ "memberOf" : "Roo.form.TextField",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "allowDomMove",
+ "type" : "Boolean",
+ "desc" : "Whether the component can move the Dom node when rendering (defaults to true).",
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "allowLeadingSpace",
+ "type" : "Boolean",
+ "desc" : "True to prevent the stripping of leading white space",
+ "memberOf" : "Roo.form.TextField",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "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",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "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",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "cls",
+ "type" : "String",
+ "desc" : "A CSS class to apply to the field's underlying element.",
+ "memberOf" : "Roo.form.Field",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "combo",
+ "type" : "Roo.form.ComboBox",
+ "desc" : "The combo box that is wrapped",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "disableClass",
+ "type" : "String",
+ "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").",
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "disableKeyFilter",
+ "type" : "Boolean",
+ "desc" : "True to disable input keystroke filtering (defaults to false)",
+ "memberOf" : "Roo.form.TextField",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "disabled",
+ "type" : "Boolean",
+ "desc" : "True to disable the field (defaults to false).",
+ "memberOf" : "Roo.form.Field",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "emptyText",
+ "type" : "String",
+ "desc" : "The default text to display in an empty field - placeholder... (defaults to null).",
+ "memberOf" : "Roo.form.TextField",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "fieldClass",
+ "type" : "String",
+ "desc" : "The default CSS class for the field (defaults to \"x-form-field\")",
+ "memberOf" : "Roo.form.Field",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "fieldLabel",
+ "type" : "String",
+ "desc" : "Label to use when rendering a form.",
+ "memberOf" : "Roo.form.Field",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "focusClass",
+ "type" : "String",
+ "desc" : "The CSS class to use when the field receives focus (defaults to \"x-form-focus\")",
+ "memberOf" : "Roo.form.Field",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "grow",
+ "type" : "Boolean",
+ "desc" : "True if this field should automatically grow and shrink to its content",
+ "memberOf" : "Roo.form.TextField",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "growMax",
+ "type" : "Number",
+ "desc" : "The maximum width to allow when grow = true (defaults to 800)",
+ "memberOf" : "Roo.form.TextField",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "growMin",
+ "type" : "Number",
+ "desc" : "The minimum width to allow when grow = true (defaults to 30)",
+ "memberOf" : "Roo.form.TextField",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "height",
+ "type" : "Number",
+ "desc" : "height (optional) size of component",
+ "memberOf" : "Roo.BoxComponent",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "hiddenName",
+ "type" : "String",
+ "desc" : "The hidden name of the field, often contains an comma seperated list of names",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "hideMode",
+ "type" : "String",
+ "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display",
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : [
+ "display",
+ "visibility"
+ ]
+ },
+ {
+ "name" : "inputType",
+ "type" : "String",
+ "desc" : "The type attribute for input fields -- e.g. radio, text, password (defaults to \"text\").",
+ "memberOf" : "Roo.form.Field",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "invalidClass",
+ "type" : "String",
+ "desc" : "The CSS class to use when marking a field invalid (defaults to \"x-form-invalid\")",
+ "memberOf" : "Roo.form.Field",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "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",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "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",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "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",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "maxLength",
+ "type" : "Number",
+ "desc" : "Maximum input field length allowed (defaults to Number.MAX_VALUE)",
+ "memberOf" : "Roo.form.TextField",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "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",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "minLength",
+ "type" : "Number",
+ "desc" : "Minimum input field length required (defaults to 0)",
+ "memberOf" : "Roo.form.TextField",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "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",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "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",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "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",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "name",
+ "type" : "String",
+ "desc" : "The name of the visable items on this form (eg. titles not ids)",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "qtip",
+ "type" : "String",
+ "desc" : "Mouse over tip",
+ "memberOf" : "Roo.form.Field",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "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",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "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",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "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",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "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",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "seperator",
+ "type" : "String",
+ "desc" : "The value seperator normally ','",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "style",
+ "type" : "String",
+ "desc" : "css styles to add to component\neg. text-align:right;",
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "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",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "validateOnBlur",
+ "type" : "Boolean",
+ "desc" : "Whether the field should validate when it loses focus (defaults to true).",
+ "memberOf" : "Roo.form.Field",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "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",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "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",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "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",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "value",
+ "type" : "Mixed",
+ "desc" : "A value to initialize this field with.",
+ "memberOf" : "Roo.form.Field",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "vtype",
+ "type" : "String",
+ "desc" : "A validation type name as defined in {@link Roo.form.VTypes} (defaults to null)",
+ "memberOf" : "Roo.form.TextField",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "width",
+ "type" : "Number",
+ "desc" : "The width of the box that displays the selected element",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ }
+ ],
+ "events" : [
+ {
+ "name" : "autosize",
+ "type" : "function",
+ "desc" : "Fires when the autosize function is triggered. The field may or may not have actually changed size\naccording to the default logic, but this event provides a hook for the developer to apply additional\nlogic at runtime to resize the field if needed.",
+ "sig" : "function (_self, width)\n{\n\n}",
+ "memberOf" : "Roo.form.TextField",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.form.Field",
+ "desc" : "This text field",
+ "isOptional" : false
+ },
+ {
+ "name" : "width",
+ "type" : "Number",
+ "desc" : "The new field width",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "beforedestroy",
+ "type" : "function",
+ "desc" : "Fires before the component is destroyed. Return false to stop the destroy.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.Component",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "beforehide",
+ "type" : "function",
+ "desc" : "Fires before the component is hidden. Return false to stop the hide.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.Component",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "beforeremove",
+ "type" : "function",
+ "desc" : "Fires before remove the value from the list",
+ "sig" : "function (_self, item)\n{\n\n}",
+ "memberOf" : "",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "_self",
+ "type" : "Roo.form.ComboBoxArray",
+ "desc" : "This combo box array",
+ "isOptional" : false
+ },
+ {
+ "name" : "item",
+ "type" : "Roo.form.ComboBoxArray.Item",
+ "desc" : "removed item",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "beforerender",
+ "type" : "function",
+ "desc" : "Fires before the component is rendered. Return false to stop the render.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.Component",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "beforeshow",
+ "type" : "function",
+ "desc" : "Fires before the component is shown. Return false to stop the show.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.Component",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "blur",
+ "type" : "function",
+ "desc" : "Fires when this field loses input focus.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.form.Field",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.form.Field",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "change",
+ "type" : "function",
+ "desc" : "Fires just before the field blurs if the field value has changed.",
+ "sig" : "function (_self, newValue, oldValue)\n{\n\n}",
+ "memberOf" : "Roo.form.Field",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.form.Field",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "newValue",
+ "type" : "Mixed",
+ "desc" : "The new value",
+ "isOptional" : false
+ },
+ {
+ "name" : "oldValue",
+ "type" : "Mixed",
+ "desc" : "The original value",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "destroy",
+ "type" : "function",
+ "desc" : "Fires after the component is destroyed.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.Component",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "disable",
+ "type" : "function",
+ "desc" : "Fires after the component is disabled.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.Component",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "enable",
+ "type" : "function",
+ "desc" : "Fires after the component is enabled.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.Component",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "focus",
+ "type" : "function",
+ "desc" : "Fires when this field receives input focus.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.form.Field",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.form.Field",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "hide",
+ "type" : "function",
+ "desc" : "Fires after the component is hidden.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.Component",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "invalid",
+ "type" : "function",
+ "desc" : "Fires after the field has been marked as invalid.",
+ "sig" : "function (_self, msg)\n{\n\n}",
+ "memberOf" : "Roo.form.Field",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.form.Field",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "msg",
+ "type" : "String",
+ "desc" : "The validation message",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "keyup",
+ "type" : "function",
+ "desc" : "Fires after the key up",
+ "sig" : "function (_self, e)\n{\n\n}",
+ "memberOf" : "Roo.form.Field",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.form.Field",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "e",
+ "type" : "Roo.EventObject",
+ "desc" : "The event Object",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "move",
+ "type" : "function",
+ "desc" : "Fires after the component is moved.",
+ "sig" : "function (_self, x, y)\n{\n\n}",
+ "memberOf" : "Roo.BoxComponent",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.Component",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "x",
+ "type" : "Number",
+ "desc" : "The new x position",
+ "isOptional" : false
+ },
+ {
+ "name" : "y",
+ "type" : "Number",
+ "desc" : "The new y position",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "remove",
+ "type" : "function",
+ "desc" : "Fires when remove the value from the list",
+ "sig" : "function (_self, item)\n{\n\n}",
+ "memberOf" : "",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "_self",
+ "type" : "Roo.form.ComboBoxArray",
+ "desc" : "This combo box array",
+ "isOptional" : false
+ },
+ {
+ "name" : "item",
+ "type" : "Roo.form.ComboBoxArray.Item",
+ "desc" : "removed item",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "render",
+ "type" : "function",
+ "desc" : "Fires after the component is rendered.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.Component",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "resize",
+ "type" : "function",
+ "desc" : "Fires after the component is resized.",
+ "sig" : "function (_self, adjWidth, adjHeight, rawWidth, rawHeight)\n{\n\n}",
+ "memberOf" : "Roo.BoxComponent",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.Component",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "adjWidth",
+ "type" : "Number",
+ "desc" : "The box-adjusted width that was set",
+ "isOptional" : false
+ },
+ {
+ "name" : "adjHeight",
+ "type" : "Number",
+ "desc" : "The box-adjusted height that was set",
+ "isOptional" : false
+ },
+ {
+ "name" : "rawWidth",
+ "type" : "Number",
+ "desc" : "The width that was originally specified",
+ "isOptional" : false
+ },
+ {
+ "name" : "rawHeight",
+ "type" : "Number",
+ "desc" : "The height that was originally specified",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "show",
+ "type" : "function",
+ "desc" : "Fires after the component is shown.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.Component",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "specialkey",
+ "type" : "function",
+ "desc" : "Fires when any key related to navigation (arrows, tab, enter, esc, etc.) is pressed. You can check\n{@link Roo.EventObject#getKey} to determine which key was pressed.",
+ "sig" : "function (_self, e)\n{\n\n}",
+ "memberOf" : "Roo.form.Field",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.form.Field",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "e",
+ "type" : "Roo.EventObject",
+ "desc" : "The event object",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "valid",
+ "type" : "function",
+ "desc" : "Fires after the field has been validated with no errors.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.form.Field",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.form.Field",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ }
+ ],
+ "methods" : [
+ {
+ "name" : "addEvents",
+ "type" : "function",
+ "desc" : "Used to define events on this Observable",
+ "sig" : "(object)",
+ "static" : false,
+ "memberOf" : "Roo.util.Observable",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "object",
+ "type" : "Object",
+ "desc" : "The object with the events defined",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "addListener",
+ "type" : "function",
+ "desc" : "Appends an event handler to this component",
+ "sig" : "(eventName, handler, scope, options)",
+ "static" : false,
+ "memberOf" : "Roo.util.Observable",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "eventName",
+ "type" : "String",
+ "desc" : "The type of event to listen for",
+ "isOptional" : false
+ },
+ {
+ "name" : "handler",
+ "type" : "Function",
+ "desc" : "The method the event invokes",
+ "isOptional" : false
+ },
+ {
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
+ "isOptional" : false
+ },
+ {
+ "name" : "options",
+ "type" : "Object",
+ "desc" : "(optional) An object containing handler configuration\nproperties. This may contain any of the following properties:<ul>\n<li>scope {Object} The scope in which to execute the handler function. The handler function's \"this\" context.</li>\n<li>delay {Number} The number of milliseconds to delay the invocation of the handler after te event fires.</li>\n<li>single {Boolean} True to add a handler to handle just the next firing of the event, and then remove itself.</li>\n<li>buffer {Number} Causes the handler to be scheduled to run in an {@link Roo.util.DelayedTask} delayed\nby the specified number of milliseconds. If the event fires again within that time, the original\nhandler is <em>not</em> invoked, but the new handler is scheduled in its place.</li>\n</ul><br>\n<p>\n<b>Combining Options</b><br>\nUsing the options argument, it is possible to combine different types of listeners:<br>\n<br>\nA normalized, delayed, one-time listener that auto stops the event and passes a custom argument (forumId)\n\t\t<pre><code>\n\t\tel.on('click', this.onClick, this, {\n \t\t\tsingle: true,\n \t\tdelay: 100,\n \t\tforumId: 4\n\t\t});\n\t\t</code></pre>\n<p>\n<b>Attaching multiple handlers in 1 call</b><br>\nThe method also allows for a single argument to be passed which is a config object containing properties\nwhich specify multiple handlers.\n<pre><code>\n\t\tel.on({\n\t\t\t'click': {\n \t\tfn: this.onClick,\n \t\tscope: this,\n \t\tdelay: 100\n \t\t}, \n \t\t'mouseover': {\n \t\tfn: this.onMouseOver,\n \t\tscope: this\n \t\t},\n \t\t'mouseout': {\n \t\tfn: this.onMouseOut,\n \t\tscope: this\n \t\t}\n\t\t});\n\t\t</code></pre>\n<p>\nOr a shorthand syntax which passes the same scope object to all handlers:\n \t<pre><code>\n\t\tel.on({\n\t\t\t'click': this.onClick,\n \t\t'mouseover': this.onMouseOver,\n \t\t'mouseout': this.onMouseOut,\n \t\tscope: this\n\t\t});\n\t\t</code></pre>",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "applyTo",
+ "type" : "function",
+ "desc" : "Apply the behaviors of this component to an existing element. <b>This is used instead of render().</b>",
+ "sig" : "(el)",
+ "static" : false,
+ "memberOf" : "Roo.form.Field",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "el",
+ "type" : "String/HTMLElement/Element",
+ "desc" : "The id of the node, a DOM node or an existing Element",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.form.Field",
+ "desc" : "this"
+ }
+ ]
+ },
+ {
+ "name" : "autoSize",
+ "type" : "function",
+ "desc" : "Automatically grows the field to accomodate the width of the text up to the maximum field width allowed.\nThis only takes effect if grow = true, and fires the autosize event.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.form.TextField",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
+ {
+ "name" : "capture",
+ "type" : "function",
+ "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\n<b>before</b> the event is fired. If the supplied function returns false,\nthe event will not fire.",
+ "sig" : "(o, fn, scope)",
+ "static" : true,
+ "memberOf" : "Roo.util.Observable",
+ "isStatic" : true,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "o",
+ "type" : "Observable",
+ "desc" : "The Observable to capture",
+ "isOptional" : false
+ },
+ {
+ "name" : "fn",
+ "type" : "Function",
+ "desc" : "The function to call",
+ "isOptional" : false
+ },
+ {
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "(optional) The scope (this object) for the fn",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "clearInvalid",
+ "type" : "function",
+ "desc" : "Clear any invalid styles/messages for this field",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.form.Field",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
+ {
+ "name" : "destroy",
+ "type" : "function",
+ "desc" : "Destroys this component by purging any event listeners, removing the component's element from the DOM,\nremoving the component from its {@link Roo.Container} (if applicable) and unregistering it from {@link Roo.ComponentMgr}.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.Component",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
+ {
+ "name" : "disable",
+ "type" : "function",
+ "desc" : "Disable this component.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.Component",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.Component",
+ "desc" : "this"
+ }
+ ]
+ },
+ {
+ "name" : "enable",
+ "type" : "function",
+ "desc" : "Enable this component.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.Component",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.Component",
+ "desc" : "this"
+ }
+ ]
+ },
+ {
+ "name" : "fireEvent",
+ "type" : "function",
+ "desc" : "Fires the specified event with the passed parameters (minus the event name).",
+ "sig" : "(eventName, args)",
+ "static" : false,
+ "memberOf" : "Roo.util.Observable",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "eventName",
+ "type" : "String",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "args",
+ "type" : "Object...",
+ "desc" : "Variable number of parameters are passed to handlers",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Boolean",
+ "desc" : "returns false if any of the handlers return false otherwise it returns true"
+ }
+ ]
+ },
+ {
+ "name" : "focus",
+ "type" : "function",
+ "desc" : "Try to focus this component.",
+ "sig" : "(selectText)",
+ "static" : false,
+ "memberOf" : "Roo.Component",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "selectText",
+ "type" : "Boolean",
+ "desc" : "True to also select the text in this component (if applicable)",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.Component",
+ "desc" : "this"
+ }
+ ]
+ },
+ {
+ "name" : "getBox",
+ "type" : "function",
+ "desc" : "Gets the current box measurements of the component's underlying element.",
+ "sig" : "(local)",
+ "static" : false,
+ "memberOf" : "Roo.BoxComponent",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "local",
+ "type" : "Boolean",
+ "desc" : "(optional) If true the element's left and top are returned instead of page XY (defaults to false)",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "getEl",
+ "type" : "function",
+ "desc" : "Returns the underlying {@link Roo.Element}.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.Component",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.Element",
+ "desc" : "The element"
+ }
+ ]
+ },
+ {
+ "name" : "getId",
+ "type" : "function",
+ "desc" : "Returns the id of this component.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.Component",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "String",
+ "desc" : ""
+ }
+ ]
+ },
+ {
+ "name" : "getName",
+ "type" : "function",
+ "desc" : "Returns the name attribute of the field if available",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.form.Field",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "String",
+ "desc" : "name The field name"
+ }
+ ]
+ },
+ {
+ "name" : "getPosition",
+ "type" : "function",
+ "desc" : "Gets the current XY position of the component's underlying element.",
+ "sig" : "(local)",
+ "static" : false,
+ "memberOf" : "Roo.BoxComponent",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "local",
+ "type" : "Boolean",
+ "desc" : "(optional) If true the element's left and top are returned instead of page XY (defaults to false)",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Array",
+ "desc" : "The XY position of the element (e.g., [100, 200])"
+ }
+ ]
+ },
+ {
+ "name" : "getRawValue",
+ "type" : "function",
+ "desc" : "Returns the raw data value which may or may not be a valid, defined value. To return a normalized value see {@link #getValue}.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.form.Field",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Mixed",
+ "desc" : "value The field value"
+ }
+ ]
+ },
+ {
+ "name" : "getSize",
+ "type" : "function",
+ "desc" : "Gets the current size of the component's underlying element.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.BoxComponent",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Object",
+ "desc" : "An object containing the element's size {width: (element width), height: (element height)}"
+ }
+ ]
+ },
+ {
+ "name" : "getValue",
+ "type" : "function",
+ "desc" : "Returns the normalized data value (undefined or emptyText will be returned as ''). To return the raw value see {@link #getRawValue}.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.form.Field",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Mixed",
+ "desc" : "value The field value"
+ }
+ ]
+ },
+ {
+ "name" : "hasChanged",
+ "type" : "function",
+ "desc" : "checks the current value against the 'loaded' value.\nNote - will return false if 'resetHasChanged' has not been called first.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.form.Field",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
+ {
+ "name" : "hasListener",
+ "type" : "function",
+ "desc" : "Checks to see if this object has any listeners for a specified event",
+ "sig" : "(eventName)",
+ "static" : false,
+ "memberOf" : "Roo.util.Observable",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "eventName",
+ "type" : "String",
+ "desc" : "The name of the event to check for",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Boolean",
+ "desc" : "True if the event is being listened for, else false"
+ }
+ ]
+ },
+ {
+ "name" : "hide",
+ "type" : "function",
+ "desc" : "Hide this component.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.Component",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.Component",
+ "desc" : "this"
+ }
+ ]
+ },
+ {
+ "name" : "isDirty",
+ "type" : "function",
+ "desc" : "Returns true if this field has been changed since it was originally loaded and is not disabled.\nDEPRICATED - it never worked well - use hasChanged/resetHasChanged.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.form.Field",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
+ {
+ "name" : "isValid",
+ "type" : "function",
+ "desc" : "Returns whether or not the field value is currently valid",
+ "sig" : "(preventMark)",
+ "static" : false,
+ "memberOf" : "Roo.form.Field",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "preventMark",
+ "type" : "Boolean",
+ "desc" : "True to disable marking the field invalid",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Boolean",
+ "desc" : "True if the value is valid, else false"
+ }
+ ]
+ },
+ {
+ "name" : "isVisible",
+ "type" : "function",
+ "desc" : "Returns true if this component is visible.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.Component",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
+ {
+ "name" : "markInvalid",
+ "type" : "function",
+ "desc" : "Mark this field as invalid",
+ "sig" : "(msg)",
+ "static" : false,
+ "memberOf" : "Roo.form.Field",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "msg",
+ "type" : "String",
+ "desc" : "The validation message",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "on",
+ "type" : "function",
+ "desc" : "Appends an event handler to this element (shorthand for addListener)",
+ "sig" : "(eventName, handler, scope, options)",
+ "static" : false,
+ "memberOf" : "Roo.util.Observable",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "eventName",
+ "type" : "String",
+ "desc" : "The type of event to listen for",
+ "isOptional" : false
+ },
+ {
+ "name" : "handler",
+ "type" : "Function",
+ "desc" : "The method the event invokes",
+ "isOptional" : false
+ },
+ {
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
+ "isOptional" : false
+ },
+ {
+ "name" : "options",
+ "type" : "Object",
+ "desc" : "(optional)",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "onPosition",
+ "type" : "function",
+ "desc" : "Called after the component is moved, this method is empty by default but can be implemented by any\nsubclass that needs to perform custom logic after a move occurs.",
+ "sig" : "(x, y)",
+ "static" : false,
+ "memberOf" : "Roo.BoxComponent",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "x",
+ "type" : "Number",
+ "desc" : "The new x position",
+ "isOptional" : false
+ },
+ {
+ "name" : "y",
+ "type" : "Number",
+ "desc" : "The new y position",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "onResize",
+ "type" : "function",
+ "desc" : "Called after the component is resized, this method is empty by default but can be implemented by any\nsubclass that needs to perform custom logic after a resize occurs.",
+ "sig" : "(adjWidth, adjHeight, rawWidth, rawHeight)",
+ "static" : false,
+ "memberOf" : "Roo.BoxComponent",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "adjWidth",
+ "type" : "Number",
+ "desc" : "The box-adjusted width that was set",
+ "isOptional" : false
+ },
+ {
+ "name" : "adjHeight",
+ "type" : "Number",
+ "desc" : "The box-adjusted height that was set",
+ "isOptional" : false
+ },
+ {
+ "name" : "rawWidth",
+ "type" : "Number",
+ "desc" : "The width that was originally specified",
+ "isOptional" : false
+ },
+ {
+ "name" : "rawHeight",
+ "type" : "Number",
+ "desc" : "The height that was originally specified",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "purgeListeners",
+ "type" : "function",
+ "desc" : "Removes all listeners for this object",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.util.Observable",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
+ {
+ "name" : "releaseCapture",
+ "type" : "function",
+ "desc" : "Removes <b>all</b> added captures from the Observable.",
+ "sig" : "(o)",
+ "static" : true,
+ "memberOf" : "Roo.util.Observable",
+ "isStatic" : true,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "o",
+ "type" : "Observable",
+ "desc" : "The Observable to release",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "removeListener",
+ "type" : "function",
+ "desc" : "Removes a listener",
+ "sig" : "(eventName, handler, scope)",
+ "static" : false,
+ "memberOf" : "Roo.util.Observable",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "eventName",
+ "type" : "String",
+ "desc" : "The type of event to listen for",
+ "isOptional" : false
+ },
+ {
+ "name" : "handler",
+ "type" : "Function",
+ "desc" : "The handler to remove",
+ "isOptional" : false
+ },
+ {
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "(optional) The scope (this object) for the handler",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "render",
+ "type" : "function",
+ "desc" : "If this is a lazy rendering component, render it to its container element.",
+ "sig" : "(container)",
+ "static" : false,
+ "memberOf" : "Roo.Component",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "container",
+ "type" : "String/HTMLElement/Element",
+ "desc" : "(optional) The element this component should be rendered into. If it is being applied to existing markup, this should be left off.",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "reset",
+ "type" : "function",
+ "desc" : "Resets the current field value to the originally-loaded value and clears any validation messages.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.form.TextField",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
+ {
+ "name" : "resetHasChanged",
+ "type" : "function",
+ "desc" : "stores the current value in loadedValue",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.form.Field",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
+ {
+ "name" : "selectText",
+ "type" : "function",
+ "desc" : "Selects text in this field",
+ "sig" : "(start, end)",
+ "static" : false,
+ "memberOf" : "Roo.form.TextField",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "start",
+ "type" : "Number",
+ "desc" : "(optional) The index where the selection should start (defaults to 0)",
+ "isOptional" : false
+ },
+ {
+ "name" : "end",
+ "type" : "Number",
+ "desc" : "(optional) The index where the selection should end (defaults to the text length)",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "setDisabled",
+ "type" : "function",
+ "desc" : "Convenience function for setting disabled/enabled by boolean.",
+ "sig" : "(disabled)",
+ "static" : false,
+ "memberOf" : "Roo.Component",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "disabled",
+ "type" : "Boolean",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "setPagePosition",
+ "type" : "function",
+ "desc" : "Sets the page XY position of the component. To set the left and top instead, use {@link #setPosition}.\nThis method fires the move event.",
+ "sig" : "(x, y)",
+ "static" : false,
+ "memberOf" : "Roo.BoxComponent",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "x",
+ "type" : "Number",
+ "desc" : "The new x position",
+ "isOptional" : false
+ },
+ {
+ "name" : "y",
+ "type" : "Number",
+ "desc" : "The new y position",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "setPosition",
+ "type" : "function",
+ "desc" : "Sets the left and top of the component. To set the page XY position instead, use {@link #setPagePosition}.\nThis method fires the move event.",
+ "sig" : "(left, top)",
+ "static" : false,
+ "memberOf" : "Roo.BoxComponent",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "left",
+ "type" : "Number",
+ "desc" : "The new left",
+ "isOptional" : false
+ },
+ {
+ "name" : "top",
+ "type" : "Number",
+ "desc" : "The new top",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "setRawValue",
+ "type" : "function",
+ "desc" : "Sets the underlying DOM field's value directly, bypassing validation. To set the value with validation see {@link #setValue}.",
+ "sig" : "(value)",
+ "static" : false,
+ "memberOf" : "Roo.form.Field",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "value",
+ "type" : "Mixed",
+ "desc" : "The value to set",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "setSize",
+ "type" : "function",
+ "desc" : "Sets the width and height of the component. This method fires the resize event. This method can accept\neither width and height as separate numeric arguments, or you can pass a size object like {width:10, height:20}.",
+ "sig" : "(width, height)",
+ "static" : false,
+ "memberOf" : "Roo.BoxComponent",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "width",
+ "type" : "Number/Object",
+ "desc" : "The new width to set, or a size object in the format {width, height}",
+ "isOptional" : false
+ },
+ {
+ "name" : "height",
+ "type" : "Number",
+ "desc" : "The new height to set (not required if a size object is passed as the first arg)",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.BoxComponent",
+ "desc" : "this"
+ }
+ ]
+ },
+ {
+ "name" : "setValue",
+ "type" : "function",
+ "desc" : "Sets a data value into the field and validates it. To set the value directly without validation see {@link #setRawValue}.",
+ "sig" : "(value)",
+ "static" : false,
+ "memberOf" : "Roo.form.Field",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "value",
+ "type" : "Mixed",
+ "desc" : "The value to set",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "setVisible",
+ "type" : "function",
+ "desc" : "Convenience function to hide or show this component by boolean.",
+ "sig" : "(visible)",
+ "static" : false,
+ "memberOf" : "Roo.Component",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "visible",
+ "type" : "Boolean",
+ "desc" : "True to show, false to hide",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.Component",
+ "desc" : "this"
+ }
+ ]
+ },
+ {
+ "name" : "show",
+ "type" : "function",
+ "desc" : "Show this component.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.Component",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.Component",
+ "desc" : "this"
+ }
+ ]
+ },
+ {
+ "name" : "syncSize",
+ "type" : "function",
+ "desc" : "Force the component's size to recalculate based on the underlying element's current height and width.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.BoxComponent",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
+ {
+ "name" : "un",
+ "type" : "function",
+ "desc" : "Removes a listener (shorthand for removeListener)",
+ "sig" : "(eventName, handler, scope)",
+ "static" : false,
+ "memberOf" : "Roo.util.Observable",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "eventName",
+ "type" : "String",
+ "desc" : "The type of event to listen for",
+ "isOptional" : false
+ },
+ {
+ "name" : "handler",
+ "type" : "Function",
+ "desc" : "The handler to remove",
+ "isOptional" : false
+ },
+ {
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "(optional) The scope (this object) for the handler",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "updateBox",
+ "type" : "function",
+ "desc" : "Sets the current box measurements of the component's underlying element.",
+ "sig" : "(box)",
+ "static" : false,
+ "memberOf" : "Roo.BoxComponent",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "box",
+ "type" : "Object",
+ "desc" : "An object in the format {x, y, width, height}",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "validate",
+ "type" : "function",
+ "desc" : "Validates the combox array value",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Boolean",
+ "desc" : "True if the value is valid, else false"
+ }
+ ]
+ },
+ {
+ "name" : "validateValue",
+ "type" : "function",
+ "desc" : "Validates a value according to the field's validation rules and marks the field as invalid\nif the validation fails",
+ "sig" : "(value)",
+ "static" : false,
+ "memberOf" : "Roo.form.TextField",
+ "isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "value",
+ "type" : "Mixed",
+ "desc" : "The value to validate",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Boolean",
+ "desc" : "True if the value is valid, else false"
+ }
+ ]
+ }
+ ],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "implementations" : [],
+ "tree_children" : [],
+ "tree_parent" : []
+ },
+ "Roo.form.ComboBoxArray.Item" : {
+ "props" : [
+ {
+ "name" : "actionMode",
+ "type" : "String",
+ "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el' for forms you probably want to set this to fieldEl",
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "allowDomMove",
+ "type" : "Boolean",
+ "desc" : "Whether the component can move the Dom node when rendering (defaults to true).",
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "disableClass",
+ "type" : "String",
+ "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").",
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "height",
+ "type" : "Number",
+ "desc" : "height (optional) size of component",
+ "memberOf" : "Roo.BoxComponent",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "hideMode",
+ "type" : "String",
+ "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display",
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : [
+ "display",
+ "visibility"
+ ]
+ },
+ {
+ "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",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "style",
+ "type" : "String",
+ "desc" : "css styles to add to component\neg. text-align:right;",
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "width",
+ "type" : "Number",
+ "desc" : "width (optional) size of component",
+ "memberOf" : "Roo.BoxComponent",
+ "isOptional" : false,
+ "optvals" : []
+ }
+ ],
+ "events" : [
+ {
+ "name" : "beforedestroy",
+ "type" : "function",
+ "desc" : "Fires before the component is destroyed. Return false to stop the destroy.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.Component",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "beforehide",
+ "type" : "function",
+ "desc" : "Fires before the component is hidden. Return false to stop the hide.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.Component",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "beforerender",
+ "type" : "function",
+ "desc" : "Fires before the component is rendered. Return false to stop the render.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.Component",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "beforeshow",
+ "type" : "function",
+ "desc" : "Fires before the component is shown. Return false to stop the show.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.Component",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "destroy",
+ "type" : "function",
+ "desc" : "Fires after the component is destroyed.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.Component",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "disable",
+ "type" : "function",
+ "desc" : "Fires after the component is disabled.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.Component",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "enable",
+ "type" : "function",
+ "desc" : "Fires after the component is enabled.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.Component",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "hide",
+ "type" : "function",
+ "desc" : "Fires after the component is hidden.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.Component",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "move",
+ "type" : "function",
+ "desc" : "Fires after the component is moved.",
+ "sig" : "function (_self, x, y)\n{\n\n}",
+ "memberOf" : "Roo.BoxComponent",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.Component",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "x",
+ "type" : "Number",
+ "desc" : "The new x position",
+ "isOptional" : false
+ },
+ {
+ "name" : "y",
+ "type" : "Number",
+ "desc" : "The new y position",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "render",
+ "type" : "function",
+ "desc" : "Fires after the component is rendered.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.Component",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "resize",
+ "type" : "function",
+ "desc" : "Fires after the component is resized.",
+ "sig" : "function (_self, adjWidth, adjHeight, rawWidth, rawHeight)\n{\n\n}",
+ "memberOf" : "Roo.BoxComponent",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.Component",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "adjWidth",
+ "type" : "Number",
+ "desc" : "The box-adjusted width that was set",
+ "isOptional" : false
+ },
+ {
+ "name" : "adjHeight",
+ "type" : "Number",
+ "desc" : "The box-adjusted height that was set",
+ "isOptional" : false
+ },
+ {
+ "name" : "rawWidth",
+ "type" : "Number",
+ "desc" : "The width that was originally specified",
+ "isOptional" : false
+ },
+ {
+ "name" : "rawHeight",
+ "type" : "Number",
+ "desc" : "The height that was originally specified",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "show",
+ "type" : "function",
+ "desc" : "Fires after the component is shown.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
"params" : [
{
- "name" : "eventName",
- "type" : "String",
- "desc" : "The name of the event to check for",
+ "name" : "this",
+ "type" : "Roo.Component",
+ "desc" : "",
"isOptional" : false
}
],
- "returns" : [
- {
- "name" : "",
- "type" : "Boolean",
- "desc" : "True if the event is being listened for, else false"
- }
- ]
- },
+ "returns" : []
+ }
+ ],
+ "methods" : [
{
- "name" : "hide",
+ "name" : "addEvents",
"type" : "function",
- "desc" : "Hide this component.",
- "sig" : "()\n{\n\n}",
+ "desc" : "Used to define events on this Observable",
+ "sig" : "(object)",
"static" : false,
- "memberOf" : "Roo.Component",
+ "memberOf" : "Roo.util.Observable",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
- "returns" : [
+ "params" : [
{
- "name" : "",
- "type" : "Roo.Component",
- "desc" : "this"
+ "name" : "object",
+ "type" : "Object",
+ "desc" : "The object with the events defined",
+ "isOptional" : false
}
- ]
+ ],
+ "returns" : []
},
{
- "name" : "isDirty",
+ "name" : "addListener",
"type" : "function",
- "desc" : "Returns true if this field has been changed since it was originally loaded and is not disabled.\nDEPRICATED - it never worked well - use hasChanged/resetHasChanged.",
- "sig" : "()\n{\n\n}",
+ "desc" : "Appends an event handler to this component",
+ "sig" : "(eventName, handler, scope, options)",
"static" : false,
- "memberOf" : "Roo.form.Field",
+ "memberOf" : "Roo.util.Observable",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
+ "params" : [
+ {
+ "name" : "eventName",
+ "type" : "String",
+ "desc" : "The type of event to listen for",
+ "isOptional" : false
+ },
+ {
+ "name" : "handler",
+ "type" : "Function",
+ "desc" : "The method the event invokes",
+ "isOptional" : false
+ },
+ {
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
+ "isOptional" : false
+ },
+ {
+ "name" : "options",
+ "type" : "Object",
+ "desc" : "(optional) An object containing handler configuration\nproperties. This may contain any of the following properties:<ul>\n<li>scope {Object} The scope in which to execute the handler function. The handler function's \"this\" context.</li>\n<li>delay {Number} The number of milliseconds to delay the invocation of the handler after te event fires.</li>\n<li>single {Boolean} True to add a handler to handle just the next firing of the event, and then remove itself.</li>\n<li>buffer {Number} Causes the handler to be scheduled to run in an {@link Roo.util.DelayedTask} delayed\nby the specified number of milliseconds. If the event fires again within that time, the original\nhandler is <em>not</em> invoked, but the new handler is scheduled in its place.</li>\n</ul><br>\n<p>\n<b>Combining Options</b><br>\nUsing the options argument, it is possible to combine different types of listeners:<br>\n<br>\nA normalized, delayed, one-time listener that auto stops the event and passes a custom argument (forumId)\n\t\t<pre><code>\n\t\tel.on('click', this.onClick, this, {\n \t\t\tsingle: true,\n \t\tdelay: 100,\n \t\tforumId: 4\n\t\t});\n\t\t</code></pre>\n<p>\n<b>Attaching multiple handlers in 1 call</b><br>\nThe method also allows for a single argument to be passed which is a config object containing properties\nwhich specify multiple handlers.\n<pre><code>\n\t\tel.on({\n\t\t\t'click': {\n \t\tfn: this.onClick,\n \t\tscope: this,\n \t\tdelay: 100\n \t\t}, \n \t\t'mouseover': {\n \t\tfn: this.onMouseOver,\n \t\tscope: this\n \t\t},\n \t\t'mouseout': {\n \t\tfn: this.onMouseOut,\n \t\tscope: this\n \t\t}\n\t\t});\n\t\t</code></pre>\n<p>\nOr a shorthand syntax which passes the same scope object to all handlers:\n \t<pre><code>\n\t\tel.on({\n\t\t\t'click': this.onClick,\n \t\t'mouseover': this.onMouseOver,\n \t\t'mouseout': this.onMouseOut,\n \t\tscope: this\n\t\t});\n\t\t</code></pre>",
+ "isOptional" : false
+ }
+ ],
"returns" : []
},
{
- "name" : "isExpanded",
+ "name" : "capture",
"type" : "function",
- "desc" : "Returns true if the dropdown list is expanded, else false.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
+ "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\n<b>before</b> the event is fired. If the supplied function returns false,\nthe event will not fire.",
+ "sig" : "(o, fn, scope)",
+ "static" : true,
+ "memberOf" : "Roo.util.Observable",
+ "isStatic" : true,
"isConstructor" : false,
"isPrivate" : false,
"example" : "",
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
+ "params" : [
+ {
+ "name" : "o",
+ "type" : "Observable",
+ "desc" : "The Observable to capture",
+ "isOptional" : false
+ },
+ {
+ "name" : "fn",
+ "type" : "Function",
+ "desc" : "The function to call",
+ "isOptional" : false
+ },
+ {
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "(optional) The scope (this object) for the fn",
+ "isOptional" : false
+ }
+ ],
"returns" : []
},
{
- "name" : "isValid",
+ "name" : "destroy",
"type" : "function",
- "desc" : "Returns whether or not the field value is currently valid",
- "sig" : "(preventMark)",
+ "desc" : "Destroys this component by purging any event listeners, removing the component's element from the DOM,\nremoving the component from its {@link Roo.Container} (if applicable) and unregistering it from {@link Roo.ComponentMgr}.",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.form.Field",
+ "memberOf" : "Roo.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "preventMark",
- "type" : "Boolean",
- "desc" : "True to disable marking the field invalid",
- "isOptional" : false
- }
- ],
- "returns" : [
- {
- "name" : "",
- "type" : "Boolean",
- "desc" : "True if the value is valid, else false"
- }
- ]
+ "params" : [],
+ "returns" : []
},
{
- "name" : "isVisible",
+ "name" : "disable",
"type" : "function",
- "desc" : "Returns true if this component is visible.",
+ "desc" : "Disable this component.",
"sig" : "()\n{\n\n}",
"static" : false,
"memberOf" : "Roo.Component",
"exceptions" : "",
"requires" : "",
"params" : [],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.Component",
+ "desc" : "this"
+ }
+ ]
},
{
- "name" : "markInvalid",
+ "name" : "enable",
"type" : "function",
- "desc" : "Mark this field as invalid",
- "sig" : "(msg)",
+ "desc" : "Enable this component.",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.form.Field",
+ "memberOf" : "Roo.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
+ "params" : [],
+ "returns" : [
{
- "name" : "msg",
- "type" : "String",
- "desc" : "The validation message",
- "isOptional" : false
+ "name" : "",
+ "type" : "Roo.Component",
+ "desc" : "this"
}
- ],
- "returns" : []
+ ]
},
{
- "name" : "on",
+ "name" : "fireEvent",
"type" : "function",
- "desc" : "Appends an event handler to this element (shorthand for addListener)",
- "sig" : "(eventName, handler, scope, options)",
+ "desc" : "Fires the specified event with the passed parameters (minus the event name).",
+ "sig" : "(eventName, args)",
"static" : false,
"memberOf" : "Roo.util.Observable",
"isStatic" : false,
{
"name" : "eventName",
"type" : "String",
- "desc" : "The type of event to listen for",
- "isOptional" : false
- },
- {
- "name" : "handler",
- "type" : "Function",
- "desc" : "The method the event invokes",
- "isOptional" : false
- },
- {
- "name" : "scope",
- "type" : "Object",
- "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
+ "desc" : "",
"isOptional" : false
},
{
- "name" : "options",
- "type" : "Object",
- "desc" : "(optional)",
+ "name" : "args",
+ "type" : "Object...",
+ "desc" : "Variable number of parameters are passed to handlers",
"isOptional" : false
}
],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Boolean",
+ "desc" : "returns false if any of the handlers return false otherwise it returns true"
+ }
+ ]
},
{
- "name" : "onPosition",
+ "name" : "focus",
"type" : "function",
- "desc" : "Called after the component is moved, this method is empty by default but can be implemented by any\nsubclass that needs to perform custom logic after a move occurs.",
- "sig" : "(x, y)",
+ "desc" : "Try to focus this component.",
+ "sig" : "(selectText)",
"static" : false,
- "memberOf" : "Roo.BoxComponent",
+ "memberOf" : "Roo.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "x",
- "type" : "Number",
- "desc" : "The new x position",
- "isOptional" : false
- },
- {
- "name" : "y",
- "type" : "Number",
- "desc" : "The new y position",
+ "name" : "selectText",
+ "type" : "Boolean",
+ "desc" : "True to also select the text in this component (if applicable)",
"isOptional" : false
}
],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.Component",
+ "desc" : "this"
+ }
+ ]
},
{
- "name" : "onResize",
+ "name" : "getBox",
"type" : "function",
- "desc" : "Called after the component is resized, this method is empty by default but can be implemented by any\nsubclass that needs to perform custom logic after a resize occurs.",
- "sig" : "(adjWidth, adjHeight, rawWidth, rawHeight)",
+ "desc" : "Gets the current box measurements of the component's underlying element.",
+ "sig" : "(local)",
"static" : false,
"memberOf" : "Roo.BoxComponent",
"isStatic" : false,
"requires" : "",
"params" : [
{
- "name" : "adjWidth",
- "type" : "Number",
- "desc" : "The box-adjusted width that was set",
- "isOptional" : false
- },
- {
- "name" : "adjHeight",
- "type" : "Number",
- "desc" : "The box-adjusted height that was set",
- "isOptional" : false
- },
- {
- "name" : "rawWidth",
- "type" : "Number",
- "desc" : "The width that was originally specified",
- "isOptional" : false
- },
- {
- "name" : "rawHeight",
- "type" : "Number",
- "desc" : "The height that was originally specified",
+ "name" : "local",
+ "type" : "Boolean",
+ "desc" : "(optional) If true the element's left and top are returned instead of page XY (defaults to false)",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "onTriggerClick",
+ "name" : "getEl",
"type" : "function",
- "desc" : "The function that should handle the trigger's click event. This method does nothing by default until overridden\nby an implementing function.",
- "sig" : "(e)",
+ "desc" : "Returns the underlying {@link Roo.Element}.",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.form.TriggerField",
+ "memberOf" : "Roo.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
+ "params" : [],
+ "returns" : [
{
- "name" : "e",
- "type" : "EventObject",
- "desc" : "",
- "isOptional" : false
+ "name" : "",
+ "type" : "Roo.Element",
+ "desc" : "The element"
}
- ],
- "returns" : []
+ ]
},
{
- "name" : "purgeListeners",
+ "name" : "getId",
"type" : "function",
- "desc" : "Removes all listeners for this object",
+ "desc" : "Returns the id of this component.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.util.Observable",
+ "memberOf" : "Roo.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"exceptions" : "",
"requires" : "",
"params" : [],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "String",
+ "desc" : ""
+ }
+ ]
},
{
- "name" : "releaseCapture",
+ "name" : "getPosition",
"type" : "function",
- "desc" : "Removes <b>all</b> added captures from the Observable.",
- "sig" : "(o)",
- "static" : true,
- "memberOf" : "Roo.util.Observable",
- "isStatic" : true,
+ "desc" : "Gets the current XY position of the component's underlying element.",
+ "sig" : "(local)",
+ "static" : false,
+ "memberOf" : "Roo.BoxComponent",
+ "isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"example" : "",
"requires" : "",
"params" : [
{
- "name" : "o",
- "type" : "Observable",
- "desc" : "The Observable to release",
+ "name" : "local",
+ "type" : "Boolean",
+ "desc" : "(optional) If true the element's left and top are returned instead of page XY (defaults to false)",
"isOptional" : false
}
],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Array",
+ "desc" : "The XY position of the element (e.g., [100, 200])"
+ }
+ ]
},
{
- "name" : "removeListener",
+ "name" : "getSize",
"type" : "function",
- "desc" : "Removes a listener",
- "sig" : "(eventName, handler, scope)",
+ "desc" : "Gets the current size of the component's underlying element.",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.util.Observable",
+ "memberOf" : "Roo.BoxComponent",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "eventName",
- "type" : "String",
- "desc" : "The type of event to listen for",
- "isOptional" : false
- },
- {
- "name" : "handler",
- "type" : "Function",
- "desc" : "The handler to remove",
- "isOptional" : false
- },
+ "params" : [],
+ "returns" : [
{
- "name" : "scope",
+ "name" : "",
"type" : "Object",
- "desc" : "(optional) The scope (this object) for the handler",
- "isOptional" : false
+ "desc" : "An object containing the element's size {width: (element width), height: (element height)}"
}
- ],
- "returns" : []
+ ]
},
{
- "name" : "render",
+ "name" : "hasListener",
"type" : "function",
- "desc" : "If this is a lazy rendering component, render it to its container element.",
- "sig" : "(container)",
+ "desc" : "Checks to see if this object has any listeners for a specified event",
+ "sig" : "(eventName)",
"static" : false,
- "memberOf" : "Roo.Component",
+ "memberOf" : "Roo.util.Observable",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "container",
- "type" : "String/HTMLElement/Element",
- "desc" : "(optional) The element this component should be rendered into. If it is being applied to existing markup, this should be left off.",
+ "name" : "eventName",
+ "type" : "String",
+ "desc" : "The name of the event to check for",
"isOptional" : false
}
],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Boolean",
+ "desc" : "True if the event is being listened for, else false"
+ }
+ ]
},
{
- "name" : "reset",
+ "name" : "hide",
"type" : "function",
- "desc" : "Resets the current field value to the originally-loaded value and clears any validation messages.",
+ "desc" : "Hide this component.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.form.TextField",
+ "memberOf" : "Roo.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"exceptions" : "",
"requires" : "",
"params" : [],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.Component",
+ "desc" : "this"
+ }
+ ]
},
{
- "name" : "resetHasChanged",
+ "name" : "isVisible",
"type" : "function",
- "desc" : "stores the current value in loadedValue",
+ "desc" : "Returns true if this component is visible.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.form.Field",
+ "memberOf" : "Roo.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"returns" : []
},
{
- "name" : "select",
+ "name" : "on",
"type" : "function",
- "desc" : "Select an item in the dropdown list by its numeric index in the list. This function does NOT cause the select event to fire.\nThe store must be loaded and the list expanded for this function to work, otherwise use setValue.",
- "sig" : "(index, scrollIntoView)",
+ "desc" : "Appends an event handler to this element (shorthand for addListener)",
+ "sig" : "(eventName, handler, scope, options)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.util.Observable",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "index",
- "type" : "Number",
- "desc" : "The zero-based index of the list item to select",
+ "name" : "eventName",
+ "type" : "String",
+ "desc" : "The type of event to listen for",
"isOptional" : false
},
{
- "name" : "scrollIntoView",
- "type" : "Boolean",
- "desc" : "False to prevent the dropdown list from autoscrolling to display the\nselected item if it is not currently in view (defaults to true)",
+ "name" : "handler",
+ "type" : "Function",
+ "desc" : "The method the event invokes",
+ "isOptional" : false
+ },
+ {
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
+ "isOptional" : false
+ },
+ {
+ "name" : "options",
+ "type" : "Object",
+ "desc" : "(optional)",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "selectByValue",
+ "name" : "onPosition",
"type" : "function",
- "desc" : "Select an item in the dropdown list by its data value. This function does NOT cause the select event to fire.\nThe store must be loaded and the list expanded for this function to work, otherwise use setValue.",
- "sig" : "(value, scrollIntoView)",
+ "desc" : "Called after the component is moved, this method is empty by default but can be implemented by any\nsubclass that needs to perform custom logic after a move occurs.",
+ "sig" : "(x, y)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.BoxComponent",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "value",
- "type" : "String",
- "desc" : "The data value of the item to select",
+ "name" : "x",
+ "type" : "Number",
+ "desc" : "The new x position",
"isOptional" : false
},
{
- "name" : "scrollIntoView",
- "type" : "Boolean",
- "desc" : "False to prevent the dropdown list from autoscrolling to display the\nselected item if it is not currently in view (defaults to true)",
+ "name" : "y",
+ "type" : "Number",
+ "desc" : "The new y position",
"isOptional" : false
}
],
- "returns" : [
- {
- "name" : "",
- "type" : "Boolean",
- "desc" : "True if the value matched an item in the list, else false"
- }
- ]
+ "returns" : []
},
{
- "name" : "selectText",
+ "name" : "onResize",
"type" : "function",
- "desc" : "Selects text in this field",
- "sig" : "(start, end)",
+ "desc" : "Called after the component is resized, this method is empty by default but can be implemented by any\nsubclass that needs to perform custom logic after a resize occurs.",
+ "sig" : "(adjWidth, adjHeight, rawWidth, rawHeight)",
"static" : false,
- "memberOf" : "Roo.form.TextField",
+ "memberOf" : "Roo.BoxComponent",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "start",
+ "name" : "adjWidth",
"type" : "Number",
- "desc" : "(optional) The index where the selection should start (defaults to 0)",
+ "desc" : "The box-adjusted width that was set",
"isOptional" : false
},
{
- "name" : "end",
+ "name" : "adjHeight",
"type" : "Number",
- "desc" : "(optional) The index where the selection should end (defaults to the text length)",
+ "desc" : "The box-adjusted height that was set",
+ "isOptional" : false
+ },
+ {
+ "name" : "rawWidth",
+ "type" : "Number",
+ "desc" : "The width that was originally specified",
+ "isOptional" : false
+ },
+ {
+ "name" : "rawHeight",
+ "type" : "Number",
+ "desc" : "The height that was originally specified",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "setDisabled",
+ "name" : "purgeListeners",
"type" : "function",
- "desc" : "Convenience function for setting disabled/enabled by boolean.",
- "sig" : "(disabled)",
+ "desc" : "Removes all listeners for this object",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.Component",
+ "memberOf" : "Roo.util.Observable",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
+ "params" : [],
+ "returns" : []
+ },
+ {
+ "name" : "releaseCapture",
+ "type" : "function",
+ "desc" : "Removes <b>all</b> added captures from the Observable.",
+ "sig" : "(o)",
+ "static" : true,
+ "memberOf" : "Roo.util.Observable",
+ "isStatic" : true,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
- "name" : "disabled",
- "type" : "Boolean",
- "desc" : "",
+ "name" : "o",
+ "type" : "Observable",
+ "desc" : "The Observable to release",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "setEditable",
+ "name" : "removeListener",
"type" : "function",
- "desc" : "Allow or prevent the user from directly editing the field text. If false is passed,\nthe user will only be able to select from the items defined in the dropdown list. This method\nis the runtime equivalent of setting the 'editable' config option at config time.",
- "sig" : "(value)",
+ "desc" : "Removes a listener",
+ "sig" : "(eventName, handler, scope)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.util.Observable",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "value",
- "type" : "Boolean",
- "desc" : "True to allow the user to directly edit the field text",
+ "name" : "eventName",
+ "type" : "String",
+ "desc" : "The type of event to listen for",
+ "isOptional" : false
+ },
+ {
+ "name" : "handler",
+ "type" : "Function",
+ "desc" : "The handler to remove",
+ "isOptional" : false
+ },
+ {
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "(optional) The scope (this object) for the handler",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "setFromData",
+ "name" : "render",
"type" : "function",
- "desc" : "Sets the value of the field based on a object which is related to the record format for the store.",
- "sig" : "(value)",
+ "desc" : "If this is a lazy rendering component, render it to its container element.",
+ "sig" : "(container)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "value",
- "type" : "Object",
- "desc" : "the value to set as. or false on reset?",
+ "name" : "container",
+ "type" : "String/HTMLElement/Element",
+ "desc" : "(optional) The element this component should be rendered into. If it is being applied to existing markup, this should be left off.",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "setDisabled",
+ "type" : "function",
+ "desc" : "Convenience function for setting disabled/enabled by boolean.",
+ "sig" : "(disabled)",
+ "static" : false,
+ "memberOf" : "Roo.Component",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "disabled",
+ "type" : "Boolean",
+ "desc" : "",
"isOptional" : false
}
],
],
"returns" : []
},
- {
- "name" : "setRawValue",
- "type" : "function",
- "desc" : "Sets the underlying DOM field's value directly, bypassing validation. To set the value with validation see {@link #setValue}.",
- "sig" : "(value)",
- "static" : false,
- "memberOf" : "Roo.form.Field",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "value",
- "type" : "Mixed",
- "desc" : "The value to set",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
{
"name" : "setSize",
"type" : "function",
}
]
},
- {
- "name" : "setValue",
- "type" : "function",
- "desc" : "Sets the specified value into the field. If the value finds a match, the corresponding record text\nwill be displayed in the field. If the value does not match the data value of an existing item,\nand the valueNotFoundText config option is defined, it will be displayed as the default field text.\nOtherwise the field will be blank (although the value will still be set).",
- "sig" : "(value)",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "value",
- "type" : "String",
- "desc" : "The value to match",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
{
"name" : "setVisible",
"type" : "function",
}
],
"returns" : []
- },
- {
- "name" : "validate",
- "type" : "function",
- "desc" : "Validates the field value",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.form.Field",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : [
- {
- "name" : "",
- "type" : "Boolean",
- "desc" : "True if the value is valid, else false"
- }
- ]
- },
- {
- "name" : "validateValue",
- "type" : "function",
- "desc" : "Validates a value according to the field's validation rules and marks the field as invalid\nif the validation fails",
- "sig" : "(value)",
- "static" : false,
- "memberOf" : "Roo.form.TextField",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "value",
- "type" : "Mixed",
- "desc" : "The value to validate",
- "isOptional" : false
- }
- ],
- "returns" : [
- {
- "name" : "",
- "type" : "Boolean",
- "desc" : "True if the value is valid, else false"
- }
- ]
}
],
"isAbstract" : false,
"isBuilderTop" : false,
- "childClasses" : {
- "Roo.form.ComboBox" : [
- "Roo.form.ComboCheck",
- "Roo.form.ComboNested"
- ]
- },
+ "implementations" : [],
"tree_children" : [],
"tree_parent" : []
},
- "Roo.form.ComboBoxArray" : {
+ "Roo.form.ComboCheck" : {
"props" : [
{
"name" : "actionMode",
"type" : "String",
"desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el' for forms you probably want to set this to fieldEl",
- "memberOf" : "Roo.Component"
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "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",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "allowBlank",
"type" : "Boolean",
"desc" : "False to validate that the value length > 0 (defaults to true)",
- "memberOf" : "Roo.form.TextField"
+ "memberOf" : "Roo.form.TextField",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "allowDomMove",
"type" : "Boolean",
"desc" : "Whether the component can move the Dom node when rendering (defaults to true).",
- "memberOf" : "Roo.Component"
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "allowLeadingSpace",
"type" : "Boolean",
"desc" : "True to prevent the stripping of leading white space",
- "memberOf" : "Roo.form.TextField"
+ "memberOf" : "Roo.form.TextField",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "alwaysQuery",
+ "type" : "Boolean",
+ "desc" : "Disable caching of results, and always send query",
+ "memberOf" : "Roo.form.ComboBox",
+ "isOptional" : false,
+ "optvals" : []
},
{
"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"
+ "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",
+ "isOptional" : false,
+ "optvals" : []
},
{
"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"
+ "memberOf" : "Roo.form.TextField",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "blockFocus",
+ "type" : "Boolean",
+ "desc" : "Prevents all focus calls, so it can work with things like HTML edtor bar",
+ "memberOf" : "Roo.form.ComboBox",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "cls",
"type" : "String",
"desc" : "A CSS class to apply to the field's underlying element.",
- "memberOf" : "Roo.form.Field"
- },
- {
- "name" : "combo",
- "type" : "Roo.form.ComboBox",
- "desc" : "[required] The combo box that is wrapped",
- "memberOf" : ""
+ "memberOf" : "Roo.form.Field",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "disableClass",
"type" : "String",
"desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").",
- "memberOf" : "Roo.Component"
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "disableClear",
+ "type" : "Boolean",
+ "desc" : "Disable showing of clear button.",
+ "memberOf" : "Roo.form.ComboBox",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "disableKeyFilter",
"type" : "Boolean",
"desc" : "True to disable input keystroke filtering (defaults to false)",
- "memberOf" : "Roo.form.TextField"
+ "memberOf" : "Roo.form.TextField",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "disabled",
"type" : "Boolean",
"desc" : "True to disable the field (defaults to false).",
- "memberOf" : "Roo.form.Field"
+ "memberOf" : "Roo.form.Field",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "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",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "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",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "emptyText",
"type" : "String",
"desc" : "The default text to display in an empty field - placeholder... (defaults to null).",
- "memberOf" : "Roo.form.TextField"
+ "memberOf" : "Roo.form.TextField",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "fieldClass",
"type" : "String",
"desc" : "The default CSS class for the field (defaults to \"x-form-field\")",
- "memberOf" : "Roo.form.Field"
+ "memberOf" : "Roo.form.Field",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "fieldLabel",
"type" : "String",
"desc" : "Label to use when rendering a form.",
- "memberOf" : "Roo.form.Field"
+ "memberOf" : "Roo.form.Field",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "focusClass",
"type" : "String",
"desc" : "The CSS class to use when the field receives focus (defaults to \"x-form-focus\")",
- "memberOf" : "Roo.form.Field"
+ "memberOf" : "Roo.form.Field",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "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",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "grow",
"type" : "Boolean",
- "desc" : "True if this field should automatically grow and shrink to its content",
- "memberOf" : "Roo.form.TextField"
+ "desc" : "",
+ "memberOf" : "Roo.form.ComboBox",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "growMax",
"type" : "Number",
- "desc" : "The maximum width to allow when grow = true (defaults to 800)",
- "memberOf" : "Roo.form.TextField"
+ "desc" : "",
+ "memberOf" : "Roo.form.ComboBox",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "growMin",
"type" : "Number",
- "desc" : "The minimum width to allow when grow = true (defaults to 30)",
- "memberOf" : "Roo.form.TextField"
+ "desc" : "",
+ "memberOf" : "Roo.form.ComboBox",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "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",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "height",
"type" : "Number",
"desc" : "height (optional) size of component",
- "memberOf" : "Roo.BoxComponent"
+ "memberOf" : "Roo.BoxComponent",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "hiddenName",
"type" : "String",
- "desc" : "The hidden name of the field, often contains an comma seperated list of names",
- "memberOf" : ""
+ "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",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "hideMode",
"type" : "String",
- "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".",
- "memberOf" : "Roo.Component"
+ "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display",
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : [
+ "display",
+ "visibility"
+ ]
+ },
+ {
+ "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",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "inputType",
"type" : "String",
"desc" : "The type attribute for input fields -- e.g. radio, text, password (defaults to \"text\").",
- "memberOf" : "Roo.form.Field"
+ "memberOf" : "Roo.form.Field",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "invalidClass",
"type" : "String",
"desc" : "The CSS class to use when marking a field invalid (defaults to \"x-form-invalid\")",
- "memberOf" : "Roo.form.Field"
+ "memberOf" : "Roo.form.Field",
+ "isOptional" : false,
+ "optvals" : []
},
{
"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"
+ "memberOf" : "Roo.form.Field",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "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",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "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",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "listClass",
+ "type" : "String",
+ "desc" : "CSS class to apply to the dropdown list element (defaults to '')",
+ "memberOf" : "Roo.form.ComboBox",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "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",
+ "isOptional" : false,
+ "optvals" : []
},
{
"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"
+ "memberOf" : "Roo.util.Observable",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "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",
+ "isOptional" : false,
+ "optvals" : []
},
{
"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"
+ "memberOf" : "Roo.form.TextField",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "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",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "maxLength",
"type" : "Number",
"desc" : "Maximum input field length allowed (defaults to Number.MAX_VALUE)",
- "memberOf" : "Roo.form.TextField"
+ "memberOf" : "Roo.form.TextField",
+ "isOptional" : false,
+ "optvals" : []
},
{
"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"
+ "memberOf" : "Roo.form.TextField",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "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",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "minLength",
"type" : "Number",
"desc" : "Minimum input field length required (defaults to 0)",
- "memberOf" : "Roo.form.TextField"
+ "memberOf" : "Roo.form.TextField",
+ "isOptional" : false,
+ "optvals" : []
},
{
"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"
+ "memberOf" : "Roo.form.TextField",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "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",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "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",
+ "isOptional" : false,
+ "optvals" : []
},
{
"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"
+ "memberOf" : "Roo.form.Field",
+ "isOptional" : false,
+ "optvals" : []
},
{
"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"
+ "memberOf" : "Roo.form.Field",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "name",
"type" : "String",
- "desc" : "The name of the visable items on this form (eg. titles not ids)",
- "memberOf" : ""
+ "desc" : "The field's HTML name attribute.",
+ "memberOf" : "Roo.form.Field",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "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",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "qtip",
"type" : "String",
"desc" : "Mouse over tip",
- "memberOf" : "Roo.form.Field"
+ "memberOf" : "Roo.form.Field",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "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",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "queryParam",
+ "type" : "String",
+ "desc" : "Name of the query as it will be passed on the querystring (defaults to 'query')",
+ "memberOf" : "Roo.form.ComboBox",
+ "isOptional" : false,
+ "optvals" : []
},
{
"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"
+ "memberOf" : "Roo.form.Field",
+ "isOptional" : false,
+ "optvals" : []
},
{
"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"
+ "memberOf" : "Roo.form.TextField",
+ "isOptional" : false,
+ "optvals" : []
},
{
"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"
+ "memberOf" : "Roo.form.TextField",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "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",
+ "isOptional" : false,
+ "optvals" : []
},
{
"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"
+ "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",
+ "isOptional" : false,
+ "optvals" : []
},
{
- "name" : "seperator",
+ "name" : "selectedClass",
"type" : "String",
- "desc" : "The value seperator normally ','",
- "memberOf" : ""
+ "desc" : "CSS class to apply to the selected item in the dropdown list (defaults to 'x-combo-selected')",
+ "memberOf" : "Roo.form.ComboBox",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "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",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "store",
+ "type" : "Roo.data.Store",
+ "desc" : "The data store to which this combo is bound (defaults to undefined)",
+ "memberOf" : "Roo.form.ComboBox",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "style",
+ "type" : "String",
+ "desc" : "css styles to add to component\neg. text-align:right;",
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"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"
+ "memberOf" : "Roo.form.Field",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "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",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "tpl",
+ "type" : "String/Roo.Template",
+ "desc" : "The template to use to render the output",
+ "memberOf" : "Roo.form.ComboBox",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "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",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "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",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "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",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "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",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "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",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "validateOnBlur",
"type" : "Boolean",
"desc" : "Whether the field should validate when it loses focus (defaults to true).",
- "memberOf" : "Roo.form.Field"
+ "memberOf" : "Roo.form.Field",
+ "isOptional" : false,
+ "optvals" : []
},
{
"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"
+ "memberOf" : "Roo.form.Field",
+ "isOptional" : false,
+ "optvals" : []
},
{
"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"
+ "memberOf" : "Roo.form.Field",
+ "isOptional" : false,
+ "optvals" : []
},
{
"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"
+ "memberOf" : "Roo.form.TextField",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "value",
"type" : "Mixed",
"desc" : "A value to initialize this field with.",
- "memberOf" : "Roo.form.Field"
+ "memberOf" : "Roo.form.Field",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "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",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "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",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "vtype",
"type" : "String",
"desc" : "A validation type name as defined in {@link Roo.form.VTypes} (defaults to null)",
- "memberOf" : "Roo.form.TextField"
+ "memberOf" : "Roo.form.TextField",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "width",
"type" : "Number",
- "desc" : "The width of the box that displays the selected element",
- "memberOf" : ""
+ "desc" : "width (optional) size of component",
+ "memberOf" : "Roo.BoxComponent",
+ "isOptional" : false,
+ "optvals" : []
}
],
"events" : [
+ {
+ "name" : "add",
+ "type" : "function",
+ "desc" : "Fires when the 'add' icon is pressed (add a listener to enable add button)",
+ "sig" : "function (combo)\n{\n\n}",
+ "memberOf" : "Roo.form.ComboBox",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "combo",
+ "type" : "Roo.form.ComboBox",
+ "desc" : "This combo box",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
{
"name" : "autosize",
"type" : "function",
"returns" : []
},
{
- "name" : "beforeremove",
+ "name" : "beforequery",
"type" : "function",
- "desc" : "Fires before remove the value from the list",
- "sig" : "function (_self, item)\n{\n\n}",
- "memberOf" : "",
+ "desc" : "Fires before all queries are processed. Return false to cancel the query or set cancel to true.\nThe event object passed has these properties:",
+ "sig" : "function (combo, query, forceAll, cancel, e)\n{\n\n}",
+ "memberOf" : "Roo.form.ComboBox",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
"params" : [
{
- "name" : "_self",
- "type" : "Roo.form.ComboBoxArray",
- "desc" : "This combo box array",
+ "name" : "combo",
+ "type" : "Roo.form.ComboBox",
+ "desc" : "This combo box",
"isOptional" : false
},
{
- "name" : "item",
- "type" : "Roo.form.ComboBoxArray.Item",
- "desc" : "removed item",
+ "name" : "query",
+ "type" : "String",
+ "desc" : "The query",
+ "isOptional" : false
+ },
+ {
+ "name" : "forceAll",
+ "type" : "Boolean",
+ "desc" : "true to force \"all\" query",
+ "isOptional" : false
+ },
+ {
+ "name" : "cancel",
+ "type" : "Boolean",
+ "desc" : "true to cancel the query",
+ "isOptional" : false
+ },
+ {
+ "name" : "e",
+ "type" : "Object",
+ "desc" : "The query event object",
"isOptional" : false
}
],
],
"returns" : []
},
+ {
+ "name" : "beforeselect",
+ "type" : "function",
+ "desc" : "Fires before a list item is selected. Return false to cancel the selection.",
+ "sig" : "function (combo, record, index)\n{\n\n}",
+ "memberOf" : "Roo.form.ComboBox",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "combo",
+ "type" : "Roo.form.ComboBox",
+ "desc" : "This combo box",
+ "isOptional" : false
+ },
+ {
+ "name" : "record",
+ "type" : "Roo.data.Record",
+ "desc" : "The data record returned from the underlying store",
+ "isOptional" : false
+ },
+ {
+ "name" : "index",
+ "type" : "Number",
+ "desc" : "The index of the selected item in the dropdown list",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
{
"name" : "beforeshow",
"type" : "function",
],
"returns" : []
},
+ {
+ "name" : "collapse",
+ "type" : "function",
+ "desc" : "Fires when the dropdown list is collapsed",
+ "sig" : "function (combo)\n{\n\n}",
+ "memberOf" : "Roo.form.ComboBox",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "combo",
+ "type" : "Roo.form.ComboBox",
+ "desc" : "This combo box",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
{
"name" : "destroy",
"type" : "function",
],
"returns" : []
},
+ {
+ "name" : "edit",
+ "type" : "function",
+ "desc" : "Fires when the 'edit' icon is pressed (add a listener to enable add button)",
+ "sig" : "function (combo, record)\n{\n\n}",
+ "memberOf" : "Roo.form.ComboBox",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "combo",
+ "type" : "Roo.form.ComboBox",
+ "desc" : "This combo box",
+ "isOptional" : false
+ },
+ {
+ "name" : "record",
+ "type" : "Roo.data.Record|false",
+ "desc" : "The data record returned from the underlying store (or false on nothing selected)",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
{
"name" : "enable",
"type" : "function",
],
"returns" : []
},
+ {
+ "name" : "expand",
+ "type" : "function",
+ "desc" : "Fires when the dropdown list is expanded",
+ "sig" : "function (combo)\n{\n\n}",
+ "memberOf" : "Roo.form.ComboBox",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "combo",
+ "type" : "Roo.form.ComboBox",
+ "desc" : "This combo box",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
{
"name" : "focus",
"type" : "function",
],
"returns" : []
},
- {
- "name" : "remove",
- "type" : "function",
- "desc" : "Fires when remove the value from the list",
- "sig" : "function (_self, item)\n{\n\n}",
- "memberOf" : "",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "_self",
- "type" : "Roo.form.ComboBoxArray",
- "desc" : "This combo box array",
- "isOptional" : false
- },
- {
- "name" : "item",
- "type" : "Roo.form.ComboBoxArray.Item",
- "desc" : "removed item",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
{
"name" : "render",
"type" : "function",
],
"returns" : []
},
+ {
+ "name" : "select",
+ "type" : "function",
+ "desc" : "Fires when a list item is selected",
+ "sig" : "function (combo, record, index)\n{\n\n}",
+ "memberOf" : "Roo.form.ComboBox",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "combo",
+ "type" : "Roo.form.ComboBox",
+ "desc" : "This combo box",
+ "isOptional" : false
+ },
+ {
+ "name" : "record",
+ "type" : "Roo.data.Record",
+ "desc" : "The data record returned from the underlying store (or false on clear)",
+ "isOptional" : false
+ },
+ {
+ "name" : "index",
+ "type" : "Number",
+ "desc" : "The index of the selected item in the dropdown list",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
{
"name" : "show",
"type" : "function",
{
"name" : "autoSize",
"type" : "function",
- "desc" : "Automatically grows the field to accomodate the width of the text up to the maximum field width allowed.\nThis only takes effect if grow = true, and fires the autosize event.",
+ "desc" : "",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.form.TextField",
+ "memberOf" : "Roo.form.TriggerField",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"params" : [],
"returns" : []
},
+ {
+ "name" : "clearValue",
+ "type" : "function",
+ "desc" : "Clears any text/value currently set in the field",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.form.ComboBox",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
+ {
+ "name" : "collapse",
+ "type" : "function",
+ "desc" : "Hides the dropdown list if it is currently expanded. Fires the 'collapse' event on completion.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.form.ComboBox",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
{
"name" : "destroy",
"type" : "function",
}
]
},
+ {
+ "name" : "doQuery",
+ "type" : "function",
+ "desc" : "Execute a query to filter the dropdown list. Fires the beforequery event prior to performing the\nquery allowing the query action to be canceled if needed.",
+ "sig" : "(query, forceAll)",
+ "static" : false,
+ "memberOf" : "Roo.form.ComboBox",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "query",
+ "type" : "String",
+ "desc" : "The SQL query to execute",
+ "isOptional" : false
+ },
+ {
+ "name" : "forceAll",
+ "type" : "Boolean",
+ "desc" : "True to force the query to execute even if there are currently fewer characters\nin the field than the minimum specified by the minChars config option. It also clears any filter previously\nsaved in the current store (defaults to false)",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
{
"name" : "enable",
"type" : "function",
}
]
},
+ {
+ "name" : "expand",
+ "type" : "function",
+ "desc" : "Expands the dropdown list if it is currently hidden. Fires the 'expand' event on completion.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.form.ComboBox",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
{
"name" : "fireEvent",
"type" : "function",
{
"name" : "getValue",
"type" : "function",
- "desc" : "Returns the normalized data value (undefined or emptyText will be returned as ''). To return the raw value see {@link #getRawValue}.",
+ "desc" : "Returns the currently selected field value or empty string if no value is set.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.form.Field",
+ "memberOf" : "Roo.form.ComboBox",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"returns" : [
{
"name" : "",
- "type" : "Mixed",
- "desc" : "value The field value"
+ "type" : "String",
+ "desc" : "value The selected value"
}
]
},
]
},
{
- "name" : "isDirty",
+ "name" : "isDirty",
+ "type" : "function",
+ "desc" : "Returns true if this field has been changed since it was originally loaded and is not disabled.\nDEPRICATED - it never worked well - use hasChanged/resetHasChanged.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.form.Field",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
+ {
+ "name" : "isExpanded",
"type" : "function",
- "desc" : "Returns true if this field has been changed since it was originally loaded and is not disabled.\nDEPRICATED - it never worked well - use hasChanged/resetHasChanged.",
+ "desc" : "Returns true if the dropdown list is expanded, else false.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.form.Field",
+ "memberOf" : "Roo.form.ComboBox",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
],
"returns" : []
},
+ {
+ "name" : "onTriggerClick",
+ "type" : "function",
+ "desc" : "The function that should handle the trigger's click event. This method does nothing by default until overridden\nby an implementing function.",
+ "sig" : "(e)",
+ "static" : false,
+ "memberOf" : "Roo.form.TriggerField",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "e",
+ "type" : "EventObject",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
{
"name" : "purgeListeners",
"type" : "function",
"params" : [],
"returns" : []
},
+ {
+ "name" : "select",
+ "type" : "function",
+ "desc" : "Select an item in the dropdown list by its numeric index in the list. This function does NOT cause the select event to fire.\nThe store must be loaded and the list expanded for this function to work, otherwise use setValue.",
+ "sig" : "(index, scrollIntoView)",
+ "static" : false,
+ "memberOf" : "Roo.form.ComboBox",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "index",
+ "type" : "Number",
+ "desc" : "The zero-based index of the list item to select",
+ "isOptional" : false
+ },
+ {
+ "name" : "scrollIntoView",
+ "type" : "Boolean",
+ "desc" : "False to prevent the dropdown list from autoscrolling to display the\nselected item if it is not currently in view (defaults to true)",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "selectByValue",
+ "type" : "function",
+ "desc" : "Select an item in the dropdown list by its data value. This function does NOT cause the select event to fire.\nThe store must be loaded and the list expanded for this function to work, otherwise use setValue.",
+ "sig" : "(value, scrollIntoView)",
+ "static" : false,
+ "memberOf" : "Roo.form.ComboBox",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "value",
+ "type" : "String",
+ "desc" : "The data value of the item to select",
+ "isOptional" : false
+ },
+ {
+ "name" : "scrollIntoView",
+ "type" : "Boolean",
+ "desc" : "False to prevent the dropdown list from autoscrolling to display the\nselected item if it is not currently in view (defaults to true)",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Boolean",
+ "desc" : "True if the value matched an item in the list, else false"
+ }
+ ]
+ },
{
"name" : "selectText",
"type" : "function",
],
"returns" : []
},
+ {
+ "name" : "setEditable",
+ "type" : "function",
+ "desc" : "Allow or prevent the user from directly editing the field text. If false is passed,\nthe user will only be able to select from the items defined in the dropdown list. This method\nis the runtime equivalent of setting the 'editable' config option at config time.",
+ "sig" : "(value)",
+ "static" : false,
+ "memberOf" : "Roo.form.ComboBox",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "value",
+ "type" : "Boolean",
+ "desc" : "True to allow the user to directly edit the field text",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "setFromData",
+ "type" : "function",
+ "desc" : "Sets the value of the field based on a object which is related to the record format for the store.",
+ "sig" : "(value)",
+ "static" : false,
+ "memberOf" : "Roo.form.ComboBox",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "value",
+ "type" : "Object",
+ "desc" : "the value to set as. or false on reset?",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
{
"name" : "setPagePosition",
"type" : "function",
{
"name" : "setValue",
"type" : "function",
- "desc" : "Sets a data value into the field and validates it. To set the value directly without validation see {@link #setRawValue}.",
+ "desc" : "Sets the specified value into the field. If the value finds a match, the corresponding record text\nwill be displayed in the field. If the value does not match the data value of an existing item,\nand the valueNotFoundText config option is defined, it will be displayed as the default field text.\nOtherwise the field will be blank (although the value will still be set).",
"sig" : "(value)",
"static" : false,
- "memberOf" : "Roo.form.Field",
+ "memberOf" : "Roo.form.ComboBox",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"params" : [
{
"name" : "value",
- "type" : "Mixed",
- "desc" : "The value to set",
+ "type" : "String",
+ "desc" : "The value to match",
"isOptional" : false
}
],
{
"name" : "validate",
"type" : "function",
- "desc" : "Validates the combox array value",
+ "desc" : "Validates the field value",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.form.Field",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
],
"isAbstract" : false,
"isBuilderTop" : false,
- "childClasses" : { },
+ "implementations" : [],
"tree_children" : [],
"tree_parent" : []
},
- "Roo.form.ComboBoxArray.Item" : {
+ "Roo.form.ComboNested" : {
"props" : [
{
"name" : "actionMode",
"type" : "String",
"desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el' for forms you probably want to set this to fieldEl",
- "memberOf" : "Roo.Component"
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "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",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "allowBlank",
+ "type" : "Boolean",
+ "desc" : "False to validate that the value length > 0 (defaults to true)",
+ "memberOf" : "Roo.form.TextField",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "allowDomMove",
"type" : "Boolean",
"desc" : "Whether the component can move the Dom node when rendering (defaults to true).",
- "memberOf" : "Roo.Component"
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "allowLeadingSpace",
+ "type" : "Boolean",
+ "desc" : "True to prevent the stripping of leading white space",
+ "memberOf" : "Roo.form.TextField",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "alwaysQuery",
+ "type" : "Boolean",
+ "desc" : "Disable caching of results, and always send query",
+ "memberOf" : "Roo.form.ComboBox",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "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",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "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",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "blockFocus",
+ "type" : "Boolean",
+ "desc" : "Prevents all focus calls, so it can work with things like HTML edtor bar",
+ "memberOf" : "Roo.form.ComboBox",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "cls",
+ "type" : "String",
+ "desc" : "A CSS class to apply to the field's underlying element.",
+ "memberOf" : "Roo.form.Field",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "disableClass",
"type" : "String",
"desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").",
- "memberOf" : "Roo.Component"
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "disableClear",
+ "type" : "Boolean",
+ "desc" : "Disable showing of clear button.",
+ "memberOf" : "Roo.form.ComboBox",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "disableKeyFilter",
+ "type" : "Boolean",
+ "desc" : "True to disable input keystroke filtering (defaults to false)",
+ "memberOf" : "Roo.form.TextField",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "disabled",
+ "type" : "Boolean",
+ "desc" : "True to disable the field (defaults to false).",
+ "memberOf" : "Roo.form.Field",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "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",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "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",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "emptyText",
+ "type" : "String",
+ "desc" : "The default text to display in an empty field - placeholder... (defaults to null).",
+ "memberOf" : "Roo.form.TextField",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "fieldClass",
+ "type" : "String",
+ "desc" : "The default CSS class for the field (defaults to \"x-form-field\")",
+ "memberOf" : "Roo.form.Field",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "fieldLabel",
+ "type" : "String",
+ "desc" : "Label to use when rendering a form.",
+ "memberOf" : "Roo.form.Field",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "focusClass",
+ "type" : "String",
+ "desc" : "The CSS class to use when the field receives focus (defaults to \"x-form-focus\")",
+ "memberOf" : "Roo.form.Field",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "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",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "grow",
+ "type" : "Boolean",
+ "desc" : "",
+ "memberOf" : "Roo.form.ComboBox",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "growMax",
+ "type" : "Number",
+ "desc" : "",
+ "memberOf" : "Roo.form.ComboBox",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "growMin",
+ "type" : "Number",
+ "desc" : "",
+ "memberOf" : "Roo.form.ComboBox",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "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",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "height",
"type" : "Number",
"desc" : "height (optional) size of component",
- "memberOf" : "Roo.BoxComponent"
+ "memberOf" : "Roo.BoxComponent",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "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",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "hideMode",
"type" : "String",
- "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".",
- "memberOf" : "Roo.Component"
+ "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display",
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : [
+ "display",
+ "visibility"
+ ]
+ },
+ {
+ "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",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "inputType",
+ "type" : "String",
+ "desc" : "The type attribute for input fields -- e.g. radio, text, password (defaults to \"text\").",
+ "memberOf" : "Roo.form.Field",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "invalidClass",
+ "type" : "String",
+ "desc" : "The CSS class to use when marking a field invalid (defaults to \"x-form-invalid\")",
+ "memberOf" : "Roo.form.Field",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "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",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "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",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "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",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "listClass",
+ "type" : "String",
+ "desc" : "CSS class to apply to the dropdown list element (defaults to '')",
+ "memberOf" : "Roo.form.ComboBox",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "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",
+ "isOptional" : false,
+ "optvals" : []
},
{
"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"
+ "memberOf" : "Roo.util.Observable",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "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",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "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",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "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",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "maxLength",
+ "type" : "Number",
+ "desc" : "Maximum input field length allowed (defaults to Number.MAX_VALUE)",
+ "memberOf" : "Roo.form.TextField",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "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",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "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",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "minLength",
+ "type" : "Number",
+ "desc" : "Minimum input field length required (defaults to 0)",
+ "memberOf" : "Roo.form.TextField",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "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",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "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",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "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",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "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",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "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",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "name",
+ "type" : "String",
+ "desc" : "The field's HTML name attribute.",
+ "memberOf" : "Roo.form.Field",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "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",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "qtip",
+ "type" : "String",
+ "desc" : "Mouse over tip",
+ "memberOf" : "Roo.form.Field",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "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",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "queryParam",
+ "type" : "String",
+ "desc" : "Name of the query as it will be passed on the querystring (defaults to 'query')",
+ "memberOf" : "Roo.form.ComboBox",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "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",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "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",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "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",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "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",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "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",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "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",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "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",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "store",
+ "type" : "Roo.data.Store",
+ "desc" : "The data store to which this combo is bound (defaults to undefined)",
+ "memberOf" : "Roo.form.ComboBox",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "style",
+ "type" : "String",
+ "desc" : "css styles to add to component\neg. text-align:right;",
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "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",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "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",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "tpl",
+ "type" : "String/Roo.Template",
+ "desc" : "The template to use to render the output",
+ "memberOf" : "Roo.form.ComboBox",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "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",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "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",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "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",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "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",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "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",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "validateOnBlur",
+ "type" : "Boolean",
+ "desc" : "Whether the field should validate when it loses focus (defaults to true).",
+ "memberOf" : "Roo.form.Field",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "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",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "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",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "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",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "value",
+ "type" : "Mixed",
+ "desc" : "A value to initialize this field with.",
+ "memberOf" : "Roo.form.Field",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "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",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "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",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "vtype",
+ "type" : "String",
+ "desc" : "A validation type name as defined in {@link Roo.form.VTypes} (defaults to null)",
+ "memberOf" : "Roo.form.TextField",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "width",
"type" : "Number",
"desc" : "width (optional) size of component",
- "memberOf" : "Roo.BoxComponent"
+ "memberOf" : "Roo.BoxComponent",
+ "isOptional" : false,
+ "optvals" : []
}
],
"events" : [
+ {
+ "name" : "add",
+ "type" : "function",
+ "desc" : "Fires when the 'add' icon is pressed (add a listener to enable add button)",
+ "sig" : "function (combo)\n{\n\n}",
+ "memberOf" : "Roo.form.ComboBox",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "combo",
+ "type" : "Roo.form.ComboBox",
+ "desc" : "This combo box",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "autosize",
+ "type" : "function",
+ "desc" : "Fires when the autosize function is triggered. The field may or may not have actually changed size\naccording to the default logic, but this event provides a hook for the developer to apply additional\nlogic at runtime to resize the field if needed.",
+ "sig" : "function (_self, width)\n{\n\n}",
+ "memberOf" : "Roo.form.TextField",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.form.Field",
+ "desc" : "This text field",
+ "isOptional" : false
+ },
+ {
+ "name" : "width",
+ "type" : "Number",
+ "desc" : "The new field width",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
{
"name" : "beforedestroy",
"type" : "function",
],
"returns" : []
},
+ {
+ "name" : "beforequery",
+ "type" : "function",
+ "desc" : "Fires before all queries are processed. Return false to cancel the query or set cancel to true.\nThe event object passed has these properties:",
+ "sig" : "function (combo, query, forceAll, cancel, e)\n{\n\n}",
+ "memberOf" : "Roo.form.ComboBox",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "combo",
+ "type" : "Roo.form.ComboBox",
+ "desc" : "This combo box",
+ "isOptional" : false
+ },
+ {
+ "name" : "query",
+ "type" : "String",
+ "desc" : "The query",
+ "isOptional" : false
+ },
+ {
+ "name" : "forceAll",
+ "type" : "Boolean",
+ "desc" : "true to force \"all\" query",
+ "isOptional" : false
+ },
+ {
+ "name" : "cancel",
+ "type" : "Boolean",
+ "desc" : "true to cancel the query",
+ "isOptional" : false
+ },
+ {
+ "name" : "e",
+ "type" : "Object",
+ "desc" : "The query event object",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
{
"name" : "beforerender",
"type" : "function",
],
"returns" : []
},
+ {
+ "name" : "beforeselect",
+ "type" : "function",
+ "desc" : "Fires before a list item is selected. Return false to cancel the selection.",
+ "sig" : "function (combo, record, index)\n{\n\n}",
+ "memberOf" : "Roo.form.ComboBox",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "combo",
+ "type" : "Roo.form.ComboBox",
+ "desc" : "This combo box",
+ "isOptional" : false
+ },
+ {
+ "name" : "record",
+ "type" : "Roo.data.Record",
+ "desc" : "The data record returned from the underlying store",
+ "isOptional" : false
+ },
+ {
+ "name" : "index",
+ "type" : "Number",
+ "desc" : "The index of the selected item in the dropdown list",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
{
"name" : "beforeshow",
"type" : "function",
],
"returns" : []
},
+ {
+ "name" : "blur",
+ "type" : "function",
+ "desc" : "Fires when this field loses input focus.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.form.Field",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.form.Field",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "change",
+ "type" : "function",
+ "desc" : "Fires just before the field blurs if the field value has changed.",
+ "sig" : "function (_self, newValue, oldValue)\n{\n\n}",
+ "memberOf" : "Roo.form.Field",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.form.Field",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "newValue",
+ "type" : "Mixed",
+ "desc" : "The new value",
+ "isOptional" : false
+ },
+ {
+ "name" : "oldValue",
+ "type" : "Mixed",
+ "desc" : "The original value",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "collapse",
+ "type" : "function",
+ "desc" : "Fires when the dropdown list is collapsed",
+ "sig" : "function (combo)\n{\n\n}",
+ "memberOf" : "Roo.form.ComboBox",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "combo",
+ "type" : "Roo.form.ComboBox",
+ "desc" : "This combo box",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
{
"name" : "destroy",
"type" : "function",
],
"returns" : []
},
+ {
+ "name" : "edit",
+ "type" : "function",
+ "desc" : "Fires when the 'edit' icon is pressed (add a listener to enable add button)",
+ "sig" : "function (combo, record)\n{\n\n}",
+ "memberOf" : "Roo.form.ComboBox",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "combo",
+ "type" : "Roo.form.ComboBox",
+ "desc" : "This combo box",
+ "isOptional" : false
+ },
+ {
+ "name" : "record",
+ "type" : "Roo.data.Record|false",
+ "desc" : "The data record returned from the underlying store (or false on nothing selected)",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
{
"name" : "enable",
"type" : "function",
],
"returns" : []
},
+ {
+ "name" : "expand",
+ "type" : "function",
+ "desc" : "Fires when the dropdown list is expanded",
+ "sig" : "function (combo)\n{\n\n}",
+ "memberOf" : "Roo.form.ComboBox",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "combo",
+ "type" : "Roo.form.ComboBox",
+ "desc" : "This combo box",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "focus",
+ "type" : "function",
+ "desc" : "Fires when this field receives input focus.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.form.Field",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.form.Field",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
{
"name" : "hide",
"type" : "function",
],
"returns" : []
},
+ {
+ "name" : "invalid",
+ "type" : "function",
+ "desc" : "Fires after the field has been marked as invalid.",
+ "sig" : "function (_self, msg)\n{\n\n}",
+ "memberOf" : "Roo.form.Field",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.form.Field",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "msg",
+ "type" : "String",
+ "desc" : "The validation message",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "keyup",
+ "type" : "function",
+ "desc" : "Fires after the key up",
+ "sig" : "function (_self, e)\n{\n\n}",
+ "memberOf" : "Roo.form.Field",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.form.Field",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "e",
+ "type" : "Roo.EventObject",
+ "desc" : "The event Object",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
{
"name" : "move",
"type" : "function",
"isOptional" : false
},
{
- "name" : "x",
- "type" : "Number",
- "desc" : "The new x position",
+ "name" : "x",
+ "type" : "Number",
+ "desc" : "The new x position",
+ "isOptional" : false
+ },
+ {
+ "name" : "y",
+ "type" : "Number",
+ "desc" : "The new y position",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "render",
+ "type" : "function",
+ "desc" : "Fires after the component is rendered.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.Component",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "resize",
+ "type" : "function",
+ "desc" : "Fires after the component is resized.",
+ "sig" : "function (_self, adjWidth, adjHeight, rawWidth, rawHeight)\n{\n\n}",
+ "memberOf" : "Roo.BoxComponent",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.Component",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "adjWidth",
+ "type" : "Number",
+ "desc" : "The box-adjusted width that was set",
+ "isOptional" : false
+ },
+ {
+ "name" : "adjHeight",
+ "type" : "Number",
+ "desc" : "The box-adjusted height that was set",
+ "isOptional" : false
+ },
+ {
+ "name" : "rawWidth",
+ "type" : "Number",
+ "desc" : "The width that was originally specified",
+ "isOptional" : false
+ },
+ {
+ "name" : "rawHeight",
+ "type" : "Number",
+ "desc" : "The height that was originally specified",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "select",
+ "type" : "function",
+ "desc" : "Fires when a list item is selected",
+ "sig" : "function (combo, record, index)\n{\n\n}",
+ "memberOf" : "Roo.form.ComboBox",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "combo",
+ "type" : "Roo.form.ComboBox",
+ "desc" : "This combo box",
+ "isOptional" : false
+ },
+ {
+ "name" : "record",
+ "type" : "Roo.data.Record",
+ "desc" : "The data record returned from the underlying store (or false on clear)",
"isOptional" : false
},
{
- "name" : "y",
+ "name" : "index",
"type" : "Number",
- "desc" : "The new y position",
+ "desc" : "The index of the selected item in the dropdown list",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "render",
+ "name" : "show",
"type" : "function",
- "desc" : "Fires after the component is rendered.",
+ "desc" : "Fires after the component is shown.",
"sig" : "function (_self)\n{\n\n}",
"memberOf" : "Roo.Component",
"example" : "",
"returns" : []
},
{
- "name" : "resize",
+ "name" : "specialkey",
"type" : "function",
- "desc" : "Fires after the component is resized.",
- "sig" : "function (_self, adjWidth, adjHeight, rawWidth, rawHeight)\n{\n\n}",
- "memberOf" : "Roo.BoxComponent",
+ "desc" : "Fires when any key related to navigation (arrows, tab, enter, esc, etc.) is pressed. You can check\n{@link Roo.EventObject#getKey} to determine which key was pressed.",
+ "sig" : "function (_self, e)\n{\n\n}",
+ "memberOf" : "Roo.form.Field",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.Component",
+ "type" : "Roo.form.Field",
"desc" : "",
"isOptional" : false
},
{
- "name" : "adjWidth",
- "type" : "Number",
- "desc" : "The box-adjusted width that was set",
- "isOptional" : false
- },
- {
- "name" : "adjHeight",
- "type" : "Number",
- "desc" : "The box-adjusted height that was set",
- "isOptional" : false
- },
- {
- "name" : "rawWidth",
- "type" : "Number",
- "desc" : "The width that was originally specified",
- "isOptional" : false
- },
- {
- "name" : "rawHeight",
- "type" : "Number",
- "desc" : "The height that was originally specified",
+ "name" : "e",
+ "type" : "Roo.EventObject",
+ "desc" : "The event object",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "show",
+ "name" : "valid",
"type" : "function",
- "desc" : "Fires after the component is shown.",
+ "desc" : "Fires after the field has been validated with no errors.",
"sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
+ "memberOf" : "Roo.form.Field",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.Component",
+ "type" : "Roo.form.Field",
"desc" : "",
"isOptional" : false
}
],
"returns" : []
},
+ {
+ "name" : "applyTo",
+ "type" : "function",
+ "desc" : "Apply the behaviors of this component to an existing element. <b>This is used instead of render().</b>",
+ "sig" : "(el)",
+ "static" : false,
+ "memberOf" : "Roo.form.Field",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "el",
+ "type" : "String/HTMLElement/Element",
+ "desc" : "The id of the node, a DOM node or an existing Element",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.form.Field",
+ "desc" : "this"
+ }
+ ]
+ },
+ {
+ "name" : "autoSize",
+ "type" : "function",
+ "desc" : "",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.form.TriggerField",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
{
"name" : "capture",
"type" : "function",
],
"returns" : []
},
+ {
+ "name" : "clearInvalid",
+ "type" : "function",
+ "desc" : "Clear any invalid styles/messages for this field",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.form.Field",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
+ {
+ "name" : "clearValue",
+ "type" : "function",
+ "desc" : "Clears any text/value currently set in the field",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.form.ComboBox",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
+ {
+ "name" : "collapse",
+ "type" : "function",
+ "desc" : "Hides the dropdown list if it is currently expanded. Fires the 'collapse' event on completion.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.form.ComboBox",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
{
"name" : "destroy",
"type" : "function",
}
]
},
+ {
+ "name" : "doQuery",
+ "type" : "function",
+ "desc" : "Execute a query to filter the dropdown list. Fires the beforequery event prior to performing the\nquery allowing the query action to be canceled if needed.",
+ "sig" : "(query, forceAll)",
+ "static" : false,
+ "memberOf" : "Roo.form.ComboBox",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "query",
+ "type" : "String",
+ "desc" : "The SQL query to execute",
+ "isOptional" : false
+ },
+ {
+ "name" : "forceAll",
+ "type" : "Boolean",
+ "desc" : "True to force the query to execute even if there are currently fewer characters\nin the field than the minimum specified by the minChars config option. It also clears any filter previously\nsaved in the current store (defaults to false)",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
{
"name" : "enable",
"type" : "function",
}
]
},
+ {
+ "name" : "expand",
+ "type" : "function",
+ "desc" : "Expands the dropdown list if it is currently hidden. Fires the 'expand' event on completion.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.form.ComboBox",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
{
"name" : "fireEvent",
"type" : "function",
}
]
},
+ {
+ "name" : "getName",
+ "type" : "function",
+ "desc" : "Returns the name attribute of the field if available",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.form.Field",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "String",
+ "desc" : "name The field name"
+ }
+ ]
+ },
{
"name" : "getPosition",
"type" : "function",
}
]
},
+ {
+ "name" : "getRawValue",
+ "type" : "function",
+ "desc" : "Returns the raw data value which may or may not be a valid, defined value. To return a normalized value see {@link #getValue}.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.form.Field",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Mixed",
+ "desc" : "value The field value"
+ }
+ ]
+ },
{
"name" : "getSize",
"type" : "function",
}
]
},
+ {
+ "name" : "getValue",
+ "type" : "function",
+ "desc" : "Returns the currently selected field value or empty string if no value is set.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.form.ComboBox",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "String",
+ "desc" : "value The selected value"
+ }
+ ]
+ },
+ {
+ "name" : "hasChanged",
+ "type" : "function",
+ "desc" : "checks the current value against the 'loaded' value.\nNote - will return false if 'resetHasChanged' has not been called first.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.form.Field",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
{
"name" : "hasListener",
"type" : "function",
}
]
},
+ {
+ "name" : "isDirty",
+ "type" : "function",
+ "desc" : "Returns true if this field has been changed since it was originally loaded and is not disabled.\nDEPRICATED - it never worked well - use hasChanged/resetHasChanged.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.form.Field",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
+ {
+ "name" : "isExpanded",
+ "type" : "function",
+ "desc" : "Returns true if the dropdown list is expanded, else false.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.form.ComboBox",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
+ {
+ "name" : "isValid",
+ "type" : "function",
+ "desc" : "Returns whether or not the field value is currently valid",
+ "sig" : "(preventMark)",
+ "static" : false,
+ "memberOf" : "Roo.form.Field",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "preventMark",
+ "type" : "Boolean",
+ "desc" : "True to disable marking the field invalid",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Boolean",
+ "desc" : "True if the value is valid, else false"
+ }
+ ]
+ },
{
"name" : "isVisible",
"type" : "function",
"params" : [],
"returns" : []
},
+ {
+ "name" : "markInvalid",
+ "type" : "function",
+ "desc" : "Mark this field as invalid",
+ "sig" : "(msg)",
+ "static" : false,
+ "memberOf" : "Roo.form.Field",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "msg",
+ "type" : "String",
+ "desc" : "The validation message",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
{
"name" : "on",
"type" : "function",
],
"returns" : []
},
+ {
+ "name" : "onTriggerClick",
+ "type" : "function",
+ "desc" : "The function that should handle the trigger's click event. This method does nothing by default until overridden\nby an implementing function.",
+ "sig" : "(e)",
+ "static" : false,
+ "memberOf" : "Roo.form.TriggerField",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "e",
+ "type" : "EventObject",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
{
"name" : "purgeListeners",
"type" : "function",
],
"returns" : []
},
+ {
+ "name" : "reset",
+ "type" : "function",
+ "desc" : "Resets the current field value to the originally-loaded value and clears any validation messages.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.form.TextField",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
+ {
+ "name" : "resetHasChanged",
+ "type" : "function",
+ "desc" : "stores the current value in loadedValue",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.form.Field",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
+ {
+ "name" : "select",
+ "type" : "function",
+ "desc" : "Select an item in the dropdown list by its numeric index in the list. This function does NOT cause the select event to fire.\nThe store must be loaded and the list expanded for this function to work, otherwise use setValue.",
+ "sig" : "(index, scrollIntoView)",
+ "static" : false,
+ "memberOf" : "Roo.form.ComboBox",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "index",
+ "type" : "Number",
+ "desc" : "The zero-based index of the list item to select",
+ "isOptional" : false
+ },
+ {
+ "name" : "scrollIntoView",
+ "type" : "Boolean",
+ "desc" : "False to prevent the dropdown list from autoscrolling to display the\nselected item if it is not currently in view (defaults to true)",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "selectByValue",
+ "type" : "function",
+ "desc" : "Select an item in the dropdown list by its data value. This function does NOT cause the select event to fire.\nThe store must be loaded and the list expanded for this function to work, otherwise use setValue.",
+ "sig" : "(value, scrollIntoView)",
+ "static" : false,
+ "memberOf" : "Roo.form.ComboBox",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "value",
+ "type" : "String",
+ "desc" : "The data value of the item to select",
+ "isOptional" : false
+ },
+ {
+ "name" : "scrollIntoView",
+ "type" : "Boolean",
+ "desc" : "False to prevent the dropdown list from autoscrolling to display the\nselected item if it is not currently in view (defaults to true)",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Boolean",
+ "desc" : "True if the value matched an item in the list, else false"
+ }
+ ]
+ },
+ {
+ "name" : "selectText",
+ "type" : "function",
+ "desc" : "Selects text in this field",
+ "sig" : "(start, end)",
+ "static" : false,
+ "memberOf" : "Roo.form.TextField",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "start",
+ "type" : "Number",
+ "desc" : "(optional) The index where the selection should start (defaults to 0)",
+ "isOptional" : false
+ },
+ {
+ "name" : "end",
+ "type" : "Number",
+ "desc" : "(optional) The index where the selection should end (defaults to the text length)",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
{
"name" : "setDisabled",
"type" : "function",
],
"returns" : []
},
+ {
+ "name" : "setEditable",
+ "type" : "function",
+ "desc" : "Allow or prevent the user from directly editing the field text. If false is passed,\nthe user will only be able to select from the items defined in the dropdown list. This method\nis the runtime equivalent of setting the 'editable' config option at config time.",
+ "sig" : "(value)",
+ "static" : false,
+ "memberOf" : "Roo.form.ComboBox",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "value",
+ "type" : "Boolean",
+ "desc" : "True to allow the user to directly edit the field text",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "setFromData",
+ "type" : "function",
+ "desc" : "Sets the value of the field based on a object which is related to the record format for the store.",
+ "sig" : "(value)",
+ "static" : false,
+ "memberOf" : "Roo.form.ComboBox",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "value",
+ "type" : "Object",
+ "desc" : "the value to set as. or false on reset?",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
{
"name" : "setPagePosition",
"type" : "function",
],
"returns" : []
},
+ {
+ "name" : "setRawValue",
+ "type" : "function",
+ "desc" : "Sets the underlying DOM field's value directly, bypassing validation. To set the value with validation see {@link #setValue}.",
+ "sig" : "(value)",
+ "static" : false,
+ "memberOf" : "Roo.form.Field",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "value",
+ "type" : "Mixed",
+ "desc" : "The value to set",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
{
"name" : "setSize",
"type" : "function",
}
]
},
+ {
+ "name" : "setValue",
+ "type" : "function",
+ "desc" : "Sets the specified value into the field. If the value finds a match, the corresponding record text\nwill be displayed in the field. If the value does not match the data value of an existing item,\nand the valueNotFoundText config option is defined, it will be displayed as the default field text.\nOtherwise the field will be blank (although the value will still be set).",
+ "sig" : "(value)",
+ "static" : false,
+ "memberOf" : "Roo.form.ComboBox",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "value",
+ "type" : "String",
+ "desc" : "The value to match",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
{
"name" : "setVisible",
"type" : "function",
}
],
"returns" : []
+ },
+ {
+ "name" : "validate",
+ "type" : "function",
+ "desc" : "Validates the field value",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.form.Field",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Boolean",
+ "desc" : "True if the value is valid, else false"
+ }
+ ]
+ },
+ {
+ "name" : "validateValue",
+ "type" : "function",
+ "desc" : "Validates a value according to the field's validation rules and marks the field as invalid\nif the validation fails",
+ "sig" : "(value)",
+ "static" : false,
+ "memberOf" : "Roo.form.TextField",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "value",
+ "type" : "Mixed",
+ "desc" : "The value to validate",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Boolean",
+ "desc" : "True if the value is valid, else false"
+ }
+ ]
}
],
"isAbstract" : false,
"isBuilderTop" : false,
- "childClasses" : { },
+ "implementations" : [],
"tree_children" : [],
"tree_parent" : []
},
- "Roo.form.ComboCheck" : {
+ "Roo.form.DateField" : {
"props" : [
{
"name" : "actionMode",
"type" : "String",
"desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el' for forms you probably want to set this to fieldEl",
- "memberOf" : "Roo.Component"
- },
- {
- "name" : "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"
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "allowBlank",
"type" : "Boolean",
"desc" : "False to validate that the value length > 0 (defaults to true)",
- "memberOf" : "Roo.form.TextField"
+ "memberOf" : "Roo.form.TextField",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "allowDomMove",
"type" : "Boolean",
"desc" : "Whether the component can move the Dom node when rendering (defaults to true).",
- "memberOf" : "Roo.Component"
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "allowLeadingSpace",
"type" : "Boolean",
"desc" : "True to prevent the stripping of leading white space",
- "memberOf" : "Roo.form.TextField"
+ "memberOf" : "Roo.form.TextField",
+ "isOptional" : false,
+ "optvals" : []
},
{
- "name" : "alwaysQuery",
- "type" : "Boolean",
- "desc" : "Disable caching of results, and always send query",
- "memberOf" : "Roo.form.ComboBox"
+ "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" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"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"
+ "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" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "blankText",
"type" : "String",
"desc" : "Error text to display if the allow blank validation fails (defaults to \"This field is required\")",
- "memberOf" : "Roo.form.TextField"
- },
- {
- "name" : "blockFocus",
- "type" : "Boolean",
- "desc" : "Prevents all focus calls, so it can work with things like HTML edtor bar",
- "memberOf" : "Roo.form.ComboBox"
+ "memberOf" : "Roo.form.TextField",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "cls",
"type" : "String",
"desc" : "A CSS class to apply to the field's underlying element.",
- "memberOf" : "Roo.form.Field"
+ "memberOf" : "Roo.form.Field",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "disableClass",
"type" : "String",
"desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").",
- "memberOf" : "Roo.Component"
- },
- {
- "name" : "disableClear",
- "type" : "Boolean",
- "desc" : "Disable showing of clear button.",
- "memberOf" : "Roo.form.ComboBox"
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "disableKeyFilter",
"type" : "Boolean",
"desc" : "True to disable input keystroke filtering (defaults to false)",
- "memberOf" : "Roo.form.TextField"
+ "memberOf" : "Roo.form.TextField",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "disabled",
"type" : "Boolean",
"desc" : "True to disable the field (defaults to false).",
- "memberOf" : "Roo.form.Field"
+ "memberOf" : "Roo.form.Field",
+ "isOptional" : false,
+ "optvals" : []
},
{
- "name" : "displayField",
+ "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" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "disabledDatesText",
"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"
+ "desc" : "The tooltip text to display when the date falls on a disabled date (defaults to 'Disabled')",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
- "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" : "disabledDays",
+ "type" : "Array",
+ "desc" : "An array of days to disable, 0 based. For example, [0, 6] disables Sunday and Saturday (defaults to null).",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "disabledDaysText",
+ "type" : "String",
+ "desc" : "The tooltip to display when the date falls on a disabled day (defaults to 'Disabled')",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "emptyText",
"type" : "String",
"desc" : "The default text to display in an empty field - placeholder... (defaults to null).",
- "memberOf" : "Roo.form.TextField"
+ "memberOf" : "Roo.form.TextField",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "fieldClass",
"type" : "String",
"desc" : "The default CSS class for the field (defaults to \"x-form-field\")",
- "memberOf" : "Roo.form.Field"
+ "memberOf" : "Roo.form.Field",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "fieldLabel",
"type" : "String",
"desc" : "Label to use when rendering a form.",
- "memberOf" : "Roo.form.Field"
+ "memberOf" : "Roo.form.Field",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "focusClass",
"type" : "String",
"desc" : "The CSS class to use when the field receives focus (defaults to \"x-form-focus\")",
- "memberOf" : "Roo.form.Field"
- },
- {
- "name" : "forceSelection",
- "type" : "Boolean",
- "desc" : "True to restrict the selected value to one of the values in the list, false to\nallow the user to set arbitrary text into the field (defaults to false)",
- "memberOf" : "Roo.form.ComboBox"
- },
- {
- "name" : "grow",
- "type" : "Boolean",
- "desc" : "",
- "memberOf" : "Roo.form.ComboBox"
- },
- {
- "name" : "growMax",
- "type" : "Number",
- "desc" : "",
- "memberOf" : "Roo.form.ComboBox"
- },
- {
- "name" : "growMin",
- "type" : "Number",
- "desc" : "",
- "memberOf" : "Roo.form.ComboBox"
+ "memberOf" : "Roo.form.Field",
+ "isOptional" : false,
+ "optvals" : []
},
{
- "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" : "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" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "height",
"type" : "Number",
"desc" : "height (optional) size of component",
- "memberOf" : "Roo.BoxComponent"
- },
- {
- "name" : "hiddenName",
- "type" : "String",
- "desc" : "If specified, a hidden form field with this name is dynamically generated to store the\nfield's data value (defaults to the underlying DOM element's name)",
- "memberOf" : "Roo.form.ComboBox"
+ "memberOf" : "Roo.BoxComponent",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "hideMode",
"type" : "String",
- "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".",
- "memberOf" : "Roo.Component"
+ "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display",
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : [
+ "display",
+ "visibility"
+ ]
},
{
"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"
+ "memberOf" : "Roo.form.TriggerField",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "inputType",
"type" : "String",
"desc" : "The type attribute for input fields -- e.g. radio, text, password (defaults to \"text\").",
- "memberOf" : "Roo.form.Field"
+ "memberOf" : "Roo.form.Field",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "invalidClass",
"type" : "String",
"desc" : "The CSS class to use when marking a field invalid (defaults to \"x-form-invalid\")",
- "memberOf" : "Roo.form.Field"
+ "memberOf" : "Roo.form.Field",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "invalidText",
"type" : "String",
- "desc" : "The error text to use when marking a field invalid and no message is provided (defaults to \"The value in this field is invalid\")",
- "memberOf" : "Roo.form.Field"
- },
- {
- "name" : "lazyRender",
- "type" : "Boolean",
- "desc" : "True to prevent the ComboBox from rendering until requested (should always be used when\nrendering into an Roo.Editor, defaults to false)",
- "memberOf" : "Roo.form.ComboBox"
- },
- {
- "name" : "listAlign",
- "type" : "String",
- "desc" : "A valid anchor position value. See {@link Roo.Element#alignTo} for details on supported\nanchor positions (defaults to 'tl-bl')",
- "memberOf" : "Roo.form.ComboBox"
- },
- {
- "name" : "listClass",
- "type" : "String",
- "desc" : "CSS class to apply to the dropdown list element (defaults to '')",
- "memberOf" : "Roo.form.ComboBox"
- },
- {
- "name" : "listWidth",
- "type" : "Number",
- "desc" : "The width in pixels of the dropdown list (defaults to the width of the ComboBox field)",
- "memberOf" : "Roo.form.ComboBox"
+ "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" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"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"
- },
- {
- "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"
+ "memberOf" : "Roo.util.Observable",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "maskRe",
"type" : "String",
"desc" : "An input mask regular expression that will be used to filter keystrokes that don't match (defaults to null)",
- "memberOf" : "Roo.form.TextField"
- },
- {
- "name" : "maxHeight",
- "type" : "Number",
- "desc" : "The maximum height in pixels of the dropdown list before scrollbars are shown (defaults to 300)",
- "memberOf" : "Roo.form.ComboBox"
+ "memberOf" : "Roo.form.TextField",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "maxLength",
"type" : "Number",
"desc" : "Maximum input field length allowed (defaults to Number.MAX_VALUE)",
- "memberOf" : "Roo.form.TextField"
+ "memberOf" : "Roo.form.TextField",
+ "isOptional" : false,
+ "optvals" : []
},
{
"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"
+ "memberOf" : "Roo.form.TextField",
+ "isOptional" : false,
+ "optvals" : []
},
{
- "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" : "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" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "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" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "minLength",
"type" : "Number",
"desc" : "Minimum input field length required (defaults to 0)",
- "memberOf" : "Roo.form.TextField"
+ "memberOf" : "Roo.form.TextField",
+ "isOptional" : false,
+ "optvals" : []
},
{
"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"
+ "memberOf" : "Roo.form.TextField",
+ "isOptional" : false,
+ "optvals" : []
},
{
- "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" : "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" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
- "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" : "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" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"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"
+ "memberOf" : "Roo.form.Field",
+ "isOptional" : false,
+ "optvals" : []
},
{
"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"
+ "memberOf" : "Roo.form.Field",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "name",
"type" : "String",
"desc" : "The field's HTML name attribute.",
- "memberOf" : "Roo.form.Field"
- },
- {
- "name" : "pageSize",
- "type" : "Number",
- "desc" : "If greater than 0, a paging toolbar is displayed in the footer of the dropdown list and the\nfilter queries will execute with page start and limit parameters. Only applies when mode = 'remote' (defaults to 0)",
- "memberOf" : "Roo.form.ComboBox"
+ "memberOf" : "Roo.form.Field",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "qtip",
"type" : "String",
"desc" : "Mouse over tip",
- "memberOf" : "Roo.form.Field"
- },
- {
- "name" : "queryDelay",
- "type" : "Number",
- "desc" : "The length of time in milliseconds to delay between the start of typing and sending the\nquery to filter the dropdown list (defaults to 500 if mode = 'remote' or 10 if mode = 'local')",
- "memberOf" : "Roo.form.ComboBox"
- },
- {
- "name" : "queryParam",
- "type" : "String",
- "desc" : "Name of the query as it will be passed on the querystring (defaults to 'query')",
- "memberOf" : "Roo.form.ComboBox"
+ "memberOf" : "Roo.form.Field",
+ "isOptional" : false,
+ "optvals" : []
},
{
"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"
+ "memberOf" : "Roo.form.Field",
+ "isOptional" : false,
+ "optvals" : []
},
{
"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"
+ "memberOf" : "Roo.form.TextField",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "regexText",
"type" : "String",
"desc" : "The error text to display if {@link #regex} is used and the test fails during validation (defaults to \"\")",
- "memberOf" : "Roo.form.TextField"
- },
- {
- "name" : "resizable",
- "type" : "Boolean",
- "desc" : "True to add a resize handle to the bottom of the dropdown list (defaults to false)",
- "memberOf" : "Roo.form.ComboBox"
+ "memberOf" : "Roo.form.TextField",
+ "isOptional" : false,
+ "optvals" : []
},
{
"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"
+ "desc" : "True to automatically select any existing field text when the field receives input focus (defaults to false)",
+ "memberOf" : "Roo.form.TextField",
+ "isOptional" : false,
+ "optvals" : []
},
{
- "name" : "selectedClass",
+ "name" : "style",
"type" : "String",
- "desc" : "CSS class to apply to the selected item in the dropdown list (defaults to 'x-combo-selected')",
- "memberOf" : "Roo.form.ComboBox"
- },
- {
- "name" : "shadow",
- "type" : "Boolean/String",
- "desc" : "True or \"sides\" for the default effect, \"frame\" for 4-way shadow, and \"drop\" for bottom-right",
- "memberOf" : "Roo.form.ComboBox"
- },
- {
- "name" : "store",
- "type" : "Roo.data.Store",
- "desc" : "The data store to which this combo is bound (defaults to undefined)",
- "memberOf" : "Roo.form.ComboBox"
+ "desc" : "css styles to add to component\neg. text-align:right;",
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "tabIndex",
"type" : "Number",
"desc" : "The tabIndex for this field. Note this only applies to fields that are rendered, not those which are built via applyTo (defaults to undefined).",
- "memberOf" : "Roo.form.Field"
- },
- {
- "name" : "title",
- "type" : "String",
- "desc" : "If supplied, a header element is created containing this text and added into the top of\nthe dropdown list (defaults to undefined, with no header element)",
- "memberOf" : "Roo.form.ComboBox"
- },
- {
- "name" : "tpl",
- "type" : "String/Roo.Template",
- "desc" : "The template to use to render the output",
- "memberOf" : "Roo.form.ComboBox"
- },
- {
- "name" : "transform",
- "type" : "String/HTMLElement/Element",
- "desc" : "The id, DOM node or element of an existing select to convert to a ComboBox",
- "memberOf" : "Roo.form.ComboBox"
- },
- {
- "name" : "triggerAction",
- "type" : "String",
- "desc" : "The action to execute when the trigger field is activated. Use 'all' to run the\nquery specified by the allQuery config option (defaults to 'query')",
- "memberOf" : "Roo.form.ComboBox"
+ "memberOf" : "Roo.form.Field",
+ "isOptional" : false,
+ "optvals" : []
},
{
"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"
+ "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" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
- "name" : "typeAhead",
+ "name" : "useIso",
"type" : "Boolean",
- "desc" : "True to populate and autoselect the remainder of the text being typed after a configurable\ndelay (typeAheadDelay) if it matches a known value (defaults to false)",
- "memberOf" : "Roo.form.ComboBox"
- },
- {
- "name" : "typeAheadDelay",
- "type" : "Number",
- "desc" : "The length of time in milliseconds to wait until the typeahead text is displayed\nif typeAhead = true (defaults to 250)",
- "memberOf" : "Roo.form.ComboBox"
+ "desc" : "if enabled, then the date field will use a hidden field to store the \nreal value as iso formated date. default (false)",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "validateOnBlur",
"type" : "Boolean",
"desc" : "Whether the field should validate when it loses focus (defaults to true).",
- "memberOf" : "Roo.form.Field"
+ "memberOf" : "Roo.form.Field",
+ "isOptional" : false,
+ "optvals" : []
},
{
"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"
+ "memberOf" : "Roo.form.Field",
+ "isOptional" : false,
+ "optvals" : []
},
{
"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"
+ "memberOf" : "Roo.form.Field",
+ "isOptional" : false,
+ "optvals" : []
},
{
"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"
+ "memberOf" : "Roo.form.TextField",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "value",
"type" : "Mixed",
"desc" : "A value to initialize this field with.",
- "memberOf" : "Roo.form.Field"
- },
- {
- "name" : "valueField",
- "type" : "String",
- "desc" : "The underlying data value name to bind to this CombBox (defaults to undefined if\nmode = 'remote' or 'value' if mode = 'local'). \nNote: use of a valueField requires the user make a selection\nin order for a value to be mapped.",
- "memberOf" : "Roo.form.ComboBox"
- },
- {
- "name" : "valueNotFoundText",
- "type" : "String",
- "desc" : "When using a name/value combo, if the value passed to setValue is not found in\nthe store, valueNotFoundText will be displayed as the field text if defined (defaults to undefined)",
- "memberOf" : "Roo.form.ComboBox"
+ "memberOf" : "Roo.form.Field",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "vtype",
"type" : "String",
"desc" : "A validation type name as defined in {@link Roo.form.VTypes} (defaults to null)",
- "memberOf" : "Roo.form.TextField"
+ "memberOf" : "Roo.form.TextField",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "width",
"type" : "Number",
"desc" : "width (optional) size of component",
- "memberOf" : "Roo.BoxComponent"
+ "memberOf" : "Roo.BoxComponent",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "zeroValue",
+ "type" : "Date/String",
+ "desc" : "if the date is less that this number, then the field is rendered as empty\ndefault is 1800",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
}
],
"events" : [
- {
- "name" : "add",
- "type" : "function",
- "desc" : "Fires when the 'add' icon is pressed (add a listener to enable add button)",
- "sig" : "function (combo)\n{\n\n}",
- "memberOf" : "Roo.form.ComboBox",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "combo",
- "type" : "Roo.form.ComboBox",
- "desc" : "This combo box",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
{
"name" : "autosize",
"type" : "function",
],
"returns" : []
},
- {
- "name" : "beforequery",
- "type" : "function",
- "desc" : "Fires before all queries are processed. Return false to cancel the query or set cancel to true.\nThe event object passed has these properties:",
- "sig" : "function (combo, query, forceAll, cancel, e)\n{\n\n}",
- "memberOf" : "Roo.form.ComboBox",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "combo",
- "type" : "Roo.form.ComboBox",
- "desc" : "This combo box",
- "isOptional" : false
- },
- {
- "name" : "query",
- "type" : "String",
- "desc" : "The query",
- "isOptional" : false
- },
- {
- "name" : "forceAll",
- "type" : "Boolean",
- "desc" : "true to force \"all\" query",
- "isOptional" : false
- },
- {
- "name" : "cancel",
- "type" : "Boolean",
- "desc" : "true to cancel the query",
- "isOptional" : false
- },
- {
- "name" : "e",
- "type" : "Object",
- "desc" : "The query event object",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
{
"name" : "beforerender",
"type" : "function",
],
"returns" : []
},
- {
- "name" : "beforeselect",
- "type" : "function",
- "desc" : "Fires before a list item is selected. Return false to cancel the selection.",
- "sig" : "function (combo, record, index)\n{\n\n}",
- "memberOf" : "Roo.form.ComboBox",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "combo",
- "type" : "Roo.form.ComboBox",
- "desc" : "This combo box",
- "isOptional" : false
- },
- {
- "name" : "record",
- "type" : "Roo.data.Record",
- "desc" : "The data record returned from the underlying store",
- "isOptional" : false
- },
- {
- "name" : "index",
- "type" : "Number",
- "desc" : "The index of the selected item in the dropdown list",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
{
"name" : "beforeshow",
"type" : "function",
],
"returns" : []
},
- {
- "name" : "collapse",
- "type" : "function",
- "desc" : "Fires when the dropdown list is collapsed",
- "sig" : "function (combo)\n{\n\n}",
- "memberOf" : "Roo.form.ComboBox",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "combo",
- "type" : "Roo.form.ComboBox",
- "desc" : "This combo box",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
{
"name" : "destroy",
"type" : "function",
],
"returns" : []
},
- {
- "name" : "edit",
- "type" : "function",
- "desc" : "Fires when the 'edit' icon is pressed (add a listener to enable add button)",
- "sig" : "function (combo, record)\n{\n\n}",
- "memberOf" : "Roo.form.ComboBox",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "combo",
- "type" : "Roo.form.ComboBox",
- "desc" : "This combo box",
- "isOptional" : false
- },
- {
- "name" : "record",
- "type" : "Roo.data.Record|false",
- "desc" : "The data record returned from the underlying store (or false on nothing selected)",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
{
"name" : "enable",
"type" : "function",
],
"returns" : []
},
- {
- "name" : "expand",
- "type" : "function",
- "desc" : "Fires when the dropdown list is expanded",
- "sig" : "function (combo)\n{\n\n}",
- "memberOf" : "Roo.form.ComboBox",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "combo",
- "type" : "Roo.form.ComboBox",
- "desc" : "This combo box",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
{
"name" : "focus",
"type" : "function",
{
"name" : "select",
"type" : "function",
- "desc" : "Fires when a list item is selected",
- "sig" : "function (combo, record, index)\n{\n\n}",
- "memberOf" : "Roo.form.ComboBox",
+ "desc" : "Fires when a date is selected",
+ "sig" : "function (combo, date)\n{\n\n}",
+ "memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "combo",
- "type" : "Roo.form.ComboBox",
+ "type" : "Roo.form.DateField",
"desc" : "This combo box",
"isOptional" : false
},
{
- "name" : "record",
- "type" : "Roo.data.Record",
- "desc" : "The data record returned from the underlying store (or false on clear)",
- "isOptional" : false
- },
- {
- "name" : "index",
- "type" : "Number",
- "desc" : "The index of the selected item in the dropdown list",
+ "name" : "date",
+ "type" : "Date",
+ "desc" : "The date selected",
"isOptional" : false
}
],
"params" : [],
"returns" : []
},
- {
- "name" : "clearValue",
- "type" : "function",
- "desc" : "Clears any text/value currently set in the field",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.form.ComboBox",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
- {
- "name" : "collapse",
- "type" : "function",
- "desc" : "Hides the dropdown list if it is currently expanded. Fires the 'collapse' event on completion.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.form.ComboBox",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
{
"name" : "destroy",
"type" : "function",
}
]
},
- {
- "name" : "doQuery",
- "type" : "function",
- "desc" : "Execute a query to filter the dropdown list. Fires the beforequery event prior to performing the\nquery allowing the query action to be canceled if needed.",
- "sig" : "(query, forceAll)",
- "static" : false,
- "memberOf" : "Roo.form.ComboBox",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "query",
- "type" : "String",
- "desc" : "The SQL query to execute",
- "isOptional" : false
- },
- {
- "name" : "forceAll",
- "type" : "Boolean",
- "desc" : "True to force the query to execute even if there are currently fewer characters\nin the field than the minimum specified by the minChars config option. It also clears any filter previously\nsaved in the current store (defaults to false)",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
{
"name" : "enable",
"type" : "function",
}
]
},
- {
- "name" : "expand",
- "type" : "function",
- "desc" : "Expands the dropdown list if it is currently hidden. Fires the 'expand' event on completion.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.form.ComboBox",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
{
"name" : "fireEvent",
"type" : "function",
{
"name" : "getValue",
"type" : "function",
- "desc" : "Returns the currently selected field value or empty string if no value is set.",
+ "desc" : "Returns the current date value of the date field.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.form.ComboBox",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"returns" : [
{
"name" : "",
- "type" : "String",
- "desc" : "value The selected value"
+ "type" : "Date",
+ "desc" : "The date value"
}
]
},
"params" : [],
"returns" : []
},
- {
- "name" : "isExpanded",
- "type" : "function",
- "desc" : "Returns true if the dropdown list is expanded, else false.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.form.ComboBox",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
{
"name" : "isValid",
"type" : "function",
"params" : [],
"returns" : []
},
- {
- "name" : "select",
- "type" : "function",
- "desc" : "Select an item in the dropdown list by its numeric index in the list. This function does NOT cause the select event to fire.\nThe store must be loaded and the list expanded for this function to work, otherwise use setValue.",
- "sig" : "(index, scrollIntoView)",
- "static" : false,
- "memberOf" : "Roo.form.ComboBox",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "index",
- "type" : "Number",
- "desc" : "The zero-based index of the list item to select",
- "isOptional" : false
- },
- {
- "name" : "scrollIntoView",
- "type" : "Boolean",
- "desc" : "False to prevent the dropdown list from autoscrolling to display the\nselected item if it is not currently in view (defaults to true)",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "selectByValue",
- "type" : "function",
- "desc" : "Select an item in the dropdown list by its data value. This function does NOT cause the select event to fire.\nThe store must be loaded and the list expanded for this function to work, otherwise use setValue.",
- "sig" : "(value, scrollIntoView)",
- "static" : false,
- "memberOf" : "Roo.form.ComboBox",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "value",
- "type" : "String",
- "desc" : "The data value of the item to select",
- "isOptional" : false
- },
- {
- "name" : "scrollIntoView",
- "type" : "Boolean",
- "desc" : "False to prevent the dropdown list from autoscrolling to display the\nselected item if it is not currently in view (defaults to true)",
- "isOptional" : false
- }
- ],
- "returns" : [
- {
- "name" : "",
- "type" : "Boolean",
- "desc" : "True if the value matched an item in the list, else false"
- }
- ]
- },
{
"name" : "selectText",
"type" : "function",
],
"returns" : []
},
- {
- "name" : "setEditable",
- "type" : "function",
- "desc" : "Allow or prevent the user from directly editing the field text. If false is passed,\nthe user will only be able to select from the items defined in the dropdown list. This method\nis the runtime equivalent of setting the 'editable' config option at config time.",
- "sig" : "(value)",
- "static" : false,
- "memberOf" : "Roo.form.ComboBox",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "value",
- "type" : "Boolean",
- "desc" : "True to allow the user to directly edit the field text",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "setFromData",
- "type" : "function",
- "desc" : "Sets the value of the field based on a object which is related to the record format for the store.",
- "sig" : "(value)",
- "static" : false,
- "memberOf" : "Roo.form.ComboBox",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "value",
- "type" : "Object",
- "desc" : "the value to set as. or false on reset?",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
{
"name" : "setPagePosition",
"type" : "function",
{
"name" : "setValue",
"type" : "function",
- "desc" : "Sets the specified value into the field. If the value finds a match, the corresponding record text\nwill be displayed in the field. If the value does not match the data value of an existing item,\nand the valueNotFoundText config option is defined, it will be displayed as the default field text.\nOtherwise the field will be blank (although the value will still be set).",
- "sig" : "(value)",
+ "desc" : "Sets the value of the date field. You can pass a date object or any string that can be parsed into a valid\ndate, using DateField.format as the date format, according to the same rules as {@link Date#parseDate}\n(the default format used is \"m/d/y\").\n<br />Usage:\n<pre><code>\n//All of these calls set the same date value (May 4, 2006)\n\n//Pass a date object:\nvar dt = new Date('5/4/06');\ndateField.setValue(dt);\n\n//Pass a date string (default format):\ndateField.setValue('5/4/06');\n\n//Pass a date string (custom format):\ndateField.format = 'Y-m-d';\ndateField.setValue('2006-5-4');\n</code></pre>",
+ "sig" : "(date)",
"static" : false,
- "memberOf" : "Roo.form.ComboBox",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "value",
- "type" : "String",
- "desc" : "The value to match",
+ "name" : "date",
+ "type" : "String/Date",
+ "desc" : "The date or valid date string",
"isOptional" : false
}
],
],
"isAbstract" : false,
"isBuilderTop" : false,
- "childClasses" : { },
+ "implementations" : [],
"tree_children" : [],
"tree_parent" : []
},
- "Roo.form.ComboNested" : {
+ "Roo.form.DayPicker" : {
"props" : [
{
"name" : "actionMode",
"type" : "String",
"desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el' for forms you probably want to set this to fieldEl",
- "memberOf" : "Roo.Component"
- },
- {
- "name" : "allQuery",
- "type" : "String",
- "desc" : "The text query to send to the server to return all records for the list with no filtering (defaults to '')",
- "memberOf" : "Roo.form.ComboBox"
- },
- {
- "name" : "allowBlank",
- "type" : "Boolean",
- "desc" : "False to validate that the value length > 0 (defaults to true)",
- "memberOf" : "Roo.form.TextField"
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "allowDomMove",
"type" : "Boolean",
"desc" : "Whether the component can move the Dom node when rendering (defaults to true).",
- "memberOf" : "Roo.Component"
- },
- {
- "name" : "allowLeadingSpace",
- "type" : "Boolean",
- "desc" : "True to prevent the stripping of leading white space",
- "memberOf" : "Roo.form.TextField"
- },
- {
- "name" : "alwaysQuery",
- "type" : "Boolean",
- "desc" : "Disable caching of results, and always send query",
- "memberOf" : "Roo.form.ComboBox"
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "autoCreate",
- "type" : "Boolean/Object",
- "desc" : "A DomHelper element spec, or true for a default element spec (defaults to:\n{tag: \"input\", type: \"text\", size: \"24\", autocomplete: \"off\"})",
- "memberOf" : "Roo.form.ComboBox"
- },
- {
- "name" : "blankText",
- "type" : "String",
- "desc" : "Error text to display if the allow blank validation fails (defaults to \"This field is required\")",
- "memberOf" : "Roo.form.TextField"
- },
- {
- "name" : "blockFocus",
- "type" : "Boolean",
- "desc" : "Prevents all focus calls, so it can work with things like HTML edtor bar",
- "memberOf" : "Roo.form.ComboBox"
+ "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" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "cls",
"type" : "String",
"desc" : "A CSS class to apply to the field's underlying element.",
- "memberOf" : "Roo.form.Field"
+ "memberOf" : "Roo.form.Field",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "disableClass",
"type" : "String",
"desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").",
- "memberOf" : "Roo.Component"
- },
- {
- "name" : "disableClear",
- "type" : "Boolean",
- "desc" : "Disable showing of clear button.",
- "memberOf" : "Roo.form.ComboBox"
- },
- {
- "name" : "disableKeyFilter",
- "type" : "Boolean",
- "desc" : "True to disable input keystroke filtering (defaults to false)",
- "memberOf" : "Roo.form.TextField"
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "disabled",
"type" : "Boolean",
"desc" : "True to disable the field (defaults to false).",
- "memberOf" : "Roo.form.Field"
- },
- {
- "name" : "displayField",
- "type" : "String",
- "desc" : "The underlying data field name to bind to this CombBox (defaults to undefined if\nmode = 'remote' or 'text' if mode = 'local')",
- "memberOf" : "Roo.form.ComboBox"
- },
- {
- "name" : "editable",
- "type" : "Boolean",
- "desc" : "False to prevent the user from typing text directly into the field, just like a\ntraditional select (defaults to true)",
- "memberOf" : "Roo.form.ComboBox"
- },
- {
- "name" : "emptyText",
- "type" : "String",
- "desc" : "The default text to display in an empty field - placeholder... (defaults to null).",
- "memberOf" : "Roo.form.TextField"
+ "memberOf" : "Roo.form.Field",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "fieldClass",
"type" : "String",
- "desc" : "The default CSS class for the field (defaults to \"x-form-field\")",
- "memberOf" : "Roo.form.Field"
+ "desc" : "The default CSS class for the checkbox (defaults to \"x-form-field\")",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "fieldLabel",
"type" : "String",
"desc" : "Label to use when rendering a form.",
- "memberOf" : "Roo.form.Field"
+ "memberOf" : "Roo.form.Field",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "focusClass",
"type" : "String",
- "desc" : "The CSS class to use when the field receives focus (defaults to \"x-form-focus\")",
- "memberOf" : "Roo.form.Field"
- },
- {
- "name" : "forceSelection",
- "type" : "Boolean",
- "desc" : "True to restrict the selected value to one of the values in the list, false to\nallow the user to set arbitrary text into the field (defaults to false)",
- "memberOf" : "Roo.form.ComboBox"
- },
- {
- "name" : "grow",
- "type" : "Boolean",
- "desc" : "",
- "memberOf" : "Roo.form.ComboBox"
- },
- {
- "name" : "growMax",
- "type" : "Number",
- "desc" : "",
- "memberOf" : "Roo.form.ComboBox"
- },
- {
- "name" : "growMin",
- "type" : "Number",
- "desc" : "",
- "memberOf" : "Roo.form.ComboBox"
- },
- {
- "name" : "handleHeight",
- "type" : "Number",
- "desc" : "The height in pixels of the dropdown list resize handle if resizable = true (defaults to 8)",
- "memberOf" : "Roo.form.ComboBox"
+ "desc" : "The CSS class to use when the checkbox receives focus (defaults to undefined)",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "height",
"type" : "Number",
"desc" : "height (optional) size of component",
- "memberOf" : "Roo.BoxComponent"
- },
- {
- "name" : "hiddenName",
- "type" : "String",
- "desc" : "If specified, a hidden form field with this name is dynamically generated to store the\nfield's data value (defaults to the underlying DOM element's name)",
- "memberOf" : "Roo.form.ComboBox"
+ "memberOf" : "Roo.BoxComponent",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "hideMode",
"type" : "String",
- "desc" : "y)\nHow this component 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" : "hideTrigger",
- "type" : "Boolean",
- "desc" : "True to hide the trigger element and display only the base text field (defaults to false)",
- "memberOf" : "Roo.form.TriggerField"
+ "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display",
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : [
+ "display",
+ "visibility"
+ ]
},
{
"name" : "inputType",
"type" : "String",
"desc" : "The type attribute for input fields -- e.g. radio, text, password (defaults to \"text\").",
- "memberOf" : "Roo.form.Field"
+ "memberOf" : "Roo.form.Field",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "invalidClass",
"type" : "String",
"desc" : "The CSS class to use when marking a field invalid (defaults to \"x-form-invalid\")",
- "memberOf" : "Roo.form.Field"
+ "memberOf" : "Roo.form.Field",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "invalidText",
"type" : "String",
"desc" : "The error text to use when marking a field invalid and no message is provided (defaults to \"The value in this field is invalid\")",
- "memberOf" : "Roo.form.Field"
- },
- {
- "name" : "lazyRender",
- "type" : "Boolean",
- "desc" : "True to prevent the ComboBox from rendering until requested (should always be used when\nrendering into an Roo.Editor, defaults to false)",
- "memberOf" : "Roo.form.ComboBox"
- },
- {
- "name" : "listAlign",
- "type" : "String",
- "desc" : "A valid anchor position value. See {@link Roo.Element#alignTo} for details on supported\nanchor positions (defaults to 'tl-bl')",
- "memberOf" : "Roo.form.ComboBox"
- },
- {
- "name" : "listClass",
- "type" : "String",
- "desc" : "CSS class to apply to the dropdown list element (defaults to '')",
- "memberOf" : "Roo.form.ComboBox"
- },
- {
- "name" : "listWidth",
- "type" : "Number",
- "desc" : "The width in pixels of the dropdown list (defaults to the width of the ComboBox field)",
- "memberOf" : "Roo.form.ComboBox"
+ "memberOf" : "Roo.form.Field",
+ "isOptional" : false,
+ "optvals" : []
},
{
"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"
- },
- {
- "name" : "loadingText",
- "type" : "String",
- "desc" : "The text to display in the dropdown list while data is loading. Only applies\nwhen mode = 'remote' (defaults to 'Loading...')",
- "memberOf" : "Roo.form.ComboBox"
- },
- {
- "name" : "maskRe",
- "type" : "String",
- "desc" : "An input mask regular expression that will be used to filter keystrokes that don't match (defaults to null)",
- "memberOf" : "Roo.form.TextField"
- },
- {
- "name" : "maxHeight",
- "type" : "Number",
- "desc" : "The maximum height in pixels of the dropdown list before scrollbars are shown (defaults to 300)",
- "memberOf" : "Roo.form.ComboBox"
- },
- {
- "name" : "maxLength",
- "type" : "Number",
- "desc" : "Maximum input field length allowed (defaults to Number.MAX_VALUE)",
- "memberOf" : "Roo.form.TextField"
- },
- {
- "name" : "maxLengthText",
- "type" : "String",
- "desc" : "Error text to display if the maximum length validation fails (defaults to \"The maximum length for this field is {maxLength}\")",
- "memberOf" : "Roo.form.TextField"
- },
- {
- "name" : "minChars",
- "type" : "Number",
- "desc" : "The minimum number of characters the user must type before autocomplete and typeahead activate\n(defaults to 4, does not apply if editable = false)",
- "memberOf" : "Roo.form.ComboBox"
- },
- {
- "name" : "minLength",
- "type" : "Number",
- "desc" : "Minimum input field length required (defaults to 0)",
- "memberOf" : "Roo.form.TextField"
- },
- {
- "name" : "minLengthText",
- "type" : "String",
- "desc" : "Error text to display if the minimum length validation fails (defaults to \"The minimum length for this field is {minLength}\")",
- "memberOf" : "Roo.form.TextField"
- },
- {
- "name" : "minListWidth",
- "type" : "Number",
- "desc" : "The minimum width of the dropdown list in pixels (defaults to 70, will be ignored if\nlistWidth has a higher value)",
- "memberOf" : "Roo.form.ComboBox"
- },
- {
- "name" : "mode",
- "type" : "String",
- "desc" : "Set to 'local' if the ComboBox loads local data (defaults to 'remote' which loads from the server)",
- "memberOf" : "Roo.form.ComboBox"
+ "memberOf" : "Roo.util.Observable",
+ "isOptional" : false,
+ "optvals" : []
},
{
"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"
+ "memberOf" : "Roo.form.Field",
+ "isOptional" : false,
+ "optvals" : []
},
{
"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"
+ "memberOf" : "Roo.form.Field",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "name",
"type" : "String",
"desc" : "The field's HTML name attribute.",
- "memberOf" : "Roo.form.Field"
- },
- {
- "name" : "pageSize",
- "type" : "Number",
- "desc" : "If greater than 0, a paging toolbar is displayed in the footer of the dropdown list and the\nfilter queries will execute with page start and limit parameters. Only applies when mode = 'remote' (defaults to 0)",
- "memberOf" : "Roo.form.ComboBox"
+ "memberOf" : "Roo.form.Field",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "qtip",
"type" : "String",
"desc" : "Mouse over tip",
- "memberOf" : "Roo.form.Field"
- },
- {
- "name" : "queryDelay",
- "type" : "Number",
- "desc" : "The length of time in milliseconds to delay between the start of typing and sending the\nquery to filter the dropdown list (defaults to 500 if mode = 'remote' or 10 if mode = 'local')",
- "memberOf" : "Roo.form.ComboBox"
- },
- {
- "name" : "queryParam",
- "type" : "String",
- "desc" : "Name of the query as it will be passed on the querystring (defaults to 'query')",
- "memberOf" : "Roo.form.ComboBox"
+ "memberOf" : "Roo.form.Field",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "readOnly",
"type" : "Boolean",
"desc" : "True to mark the field as readOnly in HTML (defaults to false) -- Note: this only sets the element's readOnly DOM attribute.",
- "memberOf" : "Roo.form.Field"
- },
- {
- "name" : "regex",
- "type" : "RegExp",
- "desc" : "A JavaScript RegExp object to be tested against the field value during validation (defaults to null).\nIf available, this regex will be evaluated only after the basic validators all return true, and will be passed the\ncurrent field value. If the test fails, the field will be marked invalid using {@link #regexText}.",
- "memberOf" : "Roo.form.TextField"
- },
- {
- "name" : "regexText",
- "type" : "String",
- "desc" : "The error text to display if {@link #regex} is used and the test fails during validation (defaults to \"\")",
- "memberOf" : "Roo.form.TextField"
- },
- {
- "name" : "resizable",
- "type" : "Boolean",
- "desc" : "True to add a resize handle to the bottom of the dropdown list (defaults to false)",
- "memberOf" : "Roo.form.ComboBox"
- },
- {
- "name" : "selectOnFocus",
- "type" : "Boolean",
- "desc" : "True to select any existing text in the field immediately on focus. Only applies\nwhen editable = true (defaults to false)",
- "memberOf" : "Roo.form.ComboBox"
+ "memberOf" : "Roo.form.Field",
+ "isOptional" : false,
+ "optvals" : []
},
{
- "name" : "selectedClass",
+ "name" : "style",
"type" : "String",
- "desc" : "CSS class to apply to the selected item in the dropdown list (defaults to 'x-combo-selected')",
- "memberOf" : "Roo.form.ComboBox"
- },
- {
- "name" : "shadow",
- "type" : "Boolean/String",
- "desc" : "True or \"sides\" for the default effect, \"frame\" for 4-way shadow, and \"drop\" for bottom-right",
- "memberOf" : "Roo.form.ComboBox"
- },
- {
- "name" : "store",
- "type" : "Roo.data.Store",
- "desc" : "The data store to which this combo is bound (defaults to undefined)",
- "memberOf" : "Roo.form.ComboBox"
+ "desc" : "css styles to add to component\neg. text-align:right;",
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "tabIndex",
"type" : "Number",
"desc" : "The tabIndex for this field. Note this only applies to fields that are rendered, not those which are built via applyTo (defaults to undefined).",
- "memberOf" : "Roo.form.Field"
- },
- {
- "name" : "title",
- "type" : "String",
- "desc" : "If supplied, a header element is created containing this text and added into the top of\nthe dropdown list (defaults to undefined, with no header element)",
- "memberOf" : "Roo.form.ComboBox"
- },
- {
- "name" : "tpl",
- "type" : "String/Roo.Template",
- "desc" : "The template to use to render the output",
- "memberOf" : "Roo.form.ComboBox"
- },
- {
- "name" : "transform",
- "type" : "String/HTMLElement/Element",
- "desc" : "The id, DOM node or element of an existing select to convert to a ComboBox",
- "memberOf" : "Roo.form.ComboBox"
- },
- {
- "name" : "triggerAction",
- "type" : "String",
- "desc" : "The action to execute when the trigger field is activated. Use 'all' to run the\nquery specified by the allQuery config option (defaults to 'query')",
- "memberOf" : "Roo.form.ComboBox"
- },
- {
- "name" : "triggerClass",
- "type" : "String",
- "desc" : "An additional CSS class used to style the trigger button. The trigger will always get the\nclass 'x-form-trigger' and triggerClass will be <b>appended</b> if specified (defaults to 'x-form-arrow-trigger'\nwhich displays a downward arrow icon).",
- "memberOf" : "Roo.form.ComboBox"
- },
- {
- "name" : "typeAhead",
- "type" : "Boolean",
- "desc" : "True to populate and autoselect the remainder of the text being typed after a configurable\ndelay (typeAheadDelay) if it matches a known value (defaults to false)",
- "memberOf" : "Roo.form.ComboBox"
- },
- {
- "name" : "typeAheadDelay",
- "type" : "Number",
- "desc" : "The length of time in milliseconds to wait until the typeahead text is displayed\nif typeAhead = true (defaults to 250)",
- "memberOf" : "Roo.form.ComboBox"
+ "memberOf" : "Roo.form.Field",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "validateOnBlur",
"type" : "Boolean",
"desc" : "Whether the field should validate when it loses focus (defaults to true).",
- "memberOf" : "Roo.form.Field"
+ "memberOf" : "Roo.form.Field",
+ "isOptional" : false,
+ "optvals" : []
},
{
"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"
+ "memberOf" : "Roo.form.Field",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "validationEvent",
"type" : "String/Boolean",
"desc" : "The event that should initiate field validation. Set to false to disable\n automatic validation (defaults to \"keyup\").",
- "memberOf" : "Roo.form.Field"
- },
- {
- "name" : "validator",
- "type" : "Function",
- "desc" : "A custom validation function to be called during field validation (defaults to null).\nIf available, this function will be called only after the basic validators all return true, and will be passed the\ncurrent field value and expected to return boolean true if the value is valid or a string error message if invalid.",
- "memberOf" : "Roo.form.TextField"
+ "memberOf" : "Roo.form.Field",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "value",
"type" : "Mixed",
"desc" : "A value to initialize this field with.",
- "memberOf" : "Roo.form.Field"
- },
- {
- "name" : "valueField",
- "type" : "String",
- "desc" : "The underlying data value name to bind to this CombBox (defaults to undefined if\nmode = 'remote' or 'value' if mode = 'local'). \nNote: use of a valueField requires the user make a selection\nin order for a value to be mapped.",
- "memberOf" : "Roo.form.ComboBox"
- },
- {
- "name" : "valueNotFoundText",
- "type" : "String",
- "desc" : "When using a name/value combo, if the value passed to setValue is not found in\nthe store, valueNotFoundText will be displayed as the field text if defined (defaults to undefined)",
- "memberOf" : "Roo.form.ComboBox"
- },
- {
- "name" : "vtype",
- "type" : "String",
- "desc" : "A validation type name as defined in {@link Roo.form.VTypes} (defaults to null)",
- "memberOf" : "Roo.form.TextField"
+ "memberOf" : "Roo.form.Field",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "width",
"type" : "Number",
"desc" : "width (optional) size of component",
- "memberOf" : "Roo.BoxComponent"
+ "memberOf" : "Roo.BoxComponent",
+ "isOptional" : false,
+ "optvals" : []
}
],
"events" : [
- {
- "name" : "add",
- "type" : "function",
- "desc" : "Fires when the 'add' icon is pressed (add a listener to enable add button)",
- "sig" : "function (combo)\n{\n\n}",
- "memberOf" : "Roo.form.ComboBox",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "combo",
- "type" : "Roo.form.ComboBox",
- "desc" : "This combo box",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "autosize",
- "type" : "function",
- "desc" : "Fires when the autosize function is triggered. The field may or may not have actually changed size\naccording to the default logic, but this event provides a hook for the developer to apply additional\nlogic at runtime to resize the field if needed.",
- "sig" : "function (_self, width)\n{\n\n}",
- "memberOf" : "Roo.form.TextField",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.form.Field",
- "desc" : "This text field",
- "isOptional" : false
- },
- {
- "name" : "width",
- "type" : "Number",
- "desc" : "The new field width",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
{
"name" : "beforedestroy",
"type" : "function",
],
"returns" : []
},
- {
- "name" : "beforequery",
- "type" : "function",
- "desc" : "Fires before all queries are processed. Return false to cancel the query or set cancel to true.\nThe event object passed has these properties:",
- "sig" : "function (combo, query, forceAll, cancel, e)\n{\n\n}",
- "memberOf" : "Roo.form.ComboBox",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "combo",
- "type" : "Roo.form.ComboBox",
- "desc" : "This combo box",
- "isOptional" : false
- },
- {
- "name" : "query",
- "type" : "String",
- "desc" : "The query",
- "isOptional" : false
- },
- {
- "name" : "forceAll",
- "type" : "Boolean",
- "desc" : "true to force \"all\" query",
- "isOptional" : false
- },
- {
- "name" : "cancel",
- "type" : "Boolean",
- "desc" : "true to cancel the query",
- "isOptional" : false
- },
- {
- "name" : "e",
- "type" : "Object",
- "desc" : "The query event object",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
{
"name" : "beforerender",
"type" : "function",
],
"returns" : []
},
- {
- "name" : "beforeselect",
- "type" : "function",
- "desc" : "Fires before a list item is selected. Return false to cancel the selection.",
- "sig" : "function (combo, record, index)\n{\n\n}",
- "memberOf" : "Roo.form.ComboBox",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "combo",
- "type" : "Roo.form.ComboBox",
- "desc" : "This combo box",
- "isOptional" : false
- },
- {
- "name" : "record",
- "type" : "Roo.data.Record",
- "desc" : "The data record returned from the underlying store",
- "isOptional" : false
- },
- {
- "name" : "index",
- "type" : "Number",
- "desc" : "The index of the selected item in the dropdown list",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
{
"name" : "beforeshow",
"type" : "function",
],
"returns" : []
},
- {
- "name" : "collapse",
- "type" : "function",
- "desc" : "Fires when the dropdown list is collapsed",
- "sig" : "function (combo)\n{\n\n}",
- "memberOf" : "Roo.form.ComboBox",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "combo",
- "type" : "Roo.form.ComboBox",
- "desc" : "This combo box",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
{
"name" : "destroy",
"type" : "function",
],
"returns" : []
},
- {
- "name" : "edit",
- "type" : "function",
- "desc" : "Fires when the 'edit' icon is pressed (add a listener to enable add button)",
- "sig" : "function (combo, record)\n{\n\n}",
- "memberOf" : "Roo.form.ComboBox",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "combo",
- "type" : "Roo.form.ComboBox",
- "desc" : "This combo box",
- "isOptional" : false
- },
- {
- "name" : "record",
- "type" : "Roo.data.Record|false",
- "desc" : "The data record returned from the underlying store (or false on nothing selected)",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
{
"name" : "enable",
"type" : "function",
],
"returns" : []
},
- {
- "name" : "expand",
- "type" : "function",
- "desc" : "Fires when the dropdown list is expanded",
- "sig" : "function (combo)\n{\n\n}",
- "memberOf" : "Roo.form.ComboBox",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "combo",
- "type" : "Roo.form.ComboBox",
- "desc" : "This combo box",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
{
"name" : "focus",
"type" : "function",
],
"returns" : []
},
- {
- "name" : "select",
- "type" : "function",
- "desc" : "Fires when a list item is selected",
- "sig" : "function (combo, record, index)\n{\n\n}",
- "memberOf" : "Roo.form.ComboBox",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "combo",
- "type" : "Roo.form.ComboBox",
- "desc" : "This combo box",
- "isOptional" : false
- },
- {
- "name" : "record",
- "type" : "Roo.data.Record",
- "desc" : "The data record returned from the underlying store (or false on clear)",
- "isOptional" : false
- },
- {
- "name" : "index",
- "type" : "Number",
- "desc" : "The index of the selected item in the dropdown list",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
{
"name" : "show",
"type" : "function",
}
]
},
- {
- "name" : "autoSize",
- "type" : "function",
- "desc" : "",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.form.TriggerField",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
{
"name" : "capture",
"type" : "function",
"params" : [],
"returns" : []
},
- {
- "name" : "clearValue",
- "type" : "function",
- "desc" : "Clears any text/value currently set in the field",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.form.ComboBox",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
- {
- "name" : "collapse",
- "type" : "function",
- "desc" : "Hides the dropdown list if it is currently expanded. Fires the 'collapse' event on completion.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.form.ComboBox",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
{
"name" : "destroy",
"type" : "function",
}
]
},
- {
- "name" : "doQuery",
- "type" : "function",
- "desc" : "Execute a query to filter the dropdown list. Fires the beforequery event prior to performing the\nquery allowing the query action to be canceled if needed.",
- "sig" : "(query, forceAll)",
- "static" : false,
- "memberOf" : "Roo.form.ComboBox",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "query",
- "type" : "String",
- "desc" : "The SQL query to execute",
- "isOptional" : false
- },
- {
- "name" : "forceAll",
- "type" : "Boolean",
- "desc" : "True to force the query to execute even if there are currently fewer characters\nin the field than the minimum specified by the minChars config option. It also clears any filter previously\nsaved in the current store (defaults to false)",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
{
"name" : "enable",
"type" : "function",
}
]
},
- {
- "name" : "expand",
- "type" : "function",
- "desc" : "Expands the dropdown list if it is currently hidden. Fires the 'expand' event on completion.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.form.ComboBox",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
{
"name" : "fireEvent",
"type" : "function",
{
"name" : "getValue",
"type" : "function",
- "desc" : "Returns the currently selected field value or empty string if no value is set.",
+ "desc" : "Returns the checked state of the checkbox.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.form.ComboBox",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"returns" : [
{
"name" : "",
- "type" : "String",
- "desc" : "value The selected value"
+ "type" : "Boolean",
+ "desc" : "True if checked, else false"
}
]
},
"params" : [],
"returns" : []
},
- {
- "name" : "isExpanded",
- "type" : "function",
- "desc" : "Returns true if the dropdown list is expanded, else false.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.form.ComboBox",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
{
"name" : "isValid",
"type" : "function",
],
"returns" : []
},
- {
- "name" : "onTriggerClick",
- "type" : "function",
- "desc" : "The function that should handle the trigger's click event. This method does nothing by default until overridden\nby an implementing function.",
- "sig" : "(e)",
- "static" : false,
- "memberOf" : "Roo.form.TriggerField",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "e",
- "type" : "EventObject",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
{
"name" : "purgeListeners",
"type" : "function",
{
"name" : "reset",
"type" : "function",
- "desc" : "Resets the current field value to the originally-loaded value and clears any validation messages.",
+ "desc" : "Resets the current field value to the originally loaded value and clears any validation messages",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.form.TextField",
+ "memberOf" : "Roo.form.Field",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"params" : [],
"returns" : []
},
- {
- "name" : "select",
- "type" : "function",
- "desc" : "Select an item in the dropdown list by its numeric index in the list. This function does NOT cause the select event to fire.\nThe store must be loaded and the list expanded for this function to work, otherwise use setValue.",
- "sig" : "(index, scrollIntoView)",
- "static" : false,
- "memberOf" : "Roo.form.ComboBox",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "index",
- "type" : "Number",
- "desc" : "The zero-based index of the list item to select",
- "isOptional" : false
- },
- {
- "name" : "scrollIntoView",
- "type" : "Boolean",
- "desc" : "False to prevent the dropdown list from autoscrolling to display the\nselected item if it is not currently in view (defaults to true)",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "selectByValue",
- "type" : "function",
- "desc" : "Select an item in the dropdown list by its data value. This function does NOT cause the select event to fire.\nThe store must be loaded and the list expanded for this function to work, otherwise use setValue.",
- "sig" : "(value, scrollIntoView)",
- "static" : false,
- "memberOf" : "Roo.form.ComboBox",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "value",
- "type" : "String",
- "desc" : "The data value of the item to select",
- "isOptional" : false
- },
- {
- "name" : "scrollIntoView",
- "type" : "Boolean",
- "desc" : "False to prevent the dropdown list from autoscrolling to display the\nselected item if it is not currently in view (defaults to true)",
- "isOptional" : false
- }
- ],
- "returns" : [
- {
- "name" : "",
- "type" : "Boolean",
- "desc" : "True if the value matched an item in the list, else false"
- }
- ]
- },
- {
- "name" : "selectText",
- "type" : "function",
- "desc" : "Selects text in this field",
- "sig" : "(start, end)",
- "static" : false,
- "memberOf" : "Roo.form.TextField",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "start",
- "type" : "Number",
- "desc" : "(optional) The index where the selection should start (defaults to 0)",
- "isOptional" : false
- },
- {
- "name" : "end",
- "type" : "Number",
- "desc" : "(optional) The index where the selection should end (defaults to the text length)",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
{
"name" : "setDisabled",
"type" : "function",
],
"returns" : []
},
- {
- "name" : "setEditable",
- "type" : "function",
- "desc" : "Allow or prevent the user from directly editing the field text. If false is passed,\nthe user will only be able to select from the items defined in the dropdown list. This method\nis the runtime equivalent of setting the 'editable' config option at config time.",
- "sig" : "(value)",
- "static" : false,
- "memberOf" : "Roo.form.ComboBox",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "value",
- "type" : "Boolean",
- "desc" : "True to allow the user to directly edit the field text",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "setFromData",
- "type" : "function",
- "desc" : "Sets the value of the field based on a object which is related to the record format for the store.",
- "sig" : "(value)",
- "static" : false,
- "memberOf" : "Roo.form.ComboBox",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "value",
- "type" : "Object",
- "desc" : "the value to set as. or false on reset?",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
{
"name" : "setPagePosition",
"type" : "function",
{
"name" : "setValue",
"type" : "function",
- "desc" : "Sets the specified value into the field. If the value finds a match, the corresponding record text\nwill be displayed in the field. If the value does not match the data value of an existing item,\nand the valueNotFoundText config option is defined, it will be displayed as the default field text.\nOtherwise the field will be blank (although the value will still be set).",
- "sig" : "(value)",
+ "desc" : "Sets the checked state of the checkbox.\nOn is always based on a string comparison between inputValue and the param.",
+ "sig" : "(value, suppressEvent)",
"static" : false,
- "memberOf" : "Roo.form.ComboBox",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"params" : [
{
"name" : "value",
- "type" : "String",
- "desc" : "The value to match",
+ "type" : "Boolean/String",
+ "desc" : "- the value to set",
+ "isOptional" : false
+ },
+ {
+ "name" : "suppressEvent",
+ "type" : "Boolean/String",
+ "desc" : "- whether to suppress the checkchange event.",
"isOptional" : false
}
],
"desc" : "True if the value is valid, else false"
}
]
- },
- {
- "name" : "validateValue",
- "type" : "function",
- "desc" : "Validates a value according to the field's validation rules and marks the field as invalid\nif the validation fails",
- "sig" : "(value)",
- "static" : false,
- "memberOf" : "Roo.form.TextField",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "value",
- "type" : "Mixed",
- "desc" : "The value to validate",
- "isOptional" : false
- }
- ],
- "returns" : [
- {
- "name" : "",
- "type" : "Boolean",
- "desc" : "True if the value is valid, else false"
- }
- ]
}
],
"isAbstract" : false,
"isBuilderTop" : false,
- "childClasses" : { },
+ "implementations" : [],
"tree_children" : [],
"tree_parent" : []
},
- "Roo.form.DateField" : {
+ "Roo.form.DisplayField" : {
"props" : [
{
"name" : "actionMode",
"type" : "String",
"desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el' for forms you probably want to set this to fieldEl",
- "memberOf" : "Roo.Component"
- },
- {
- "name" : "allowBlank",
- "type" : "Boolean",
- "desc" : "False to validate that the value length > 0 (defaults to true)",
- "memberOf" : "Roo.form.TextField"
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "allowDomMove",
"type" : "Boolean",
"desc" : "Whether the component can move the Dom node when rendering (defaults to true).",
- "memberOf" : "Roo.Component"
- },
- {
- "name" : "allowLeadingSpace",
- "type" : "Boolean",
- "desc" : "True to prevent the stripping of leading white space",
- "memberOf" : "Roo.form.TextField"
- },
- {
- "name" : "altFormats",
- "type" : "String",
- "desc" : "Multiple date formats separated by \"|\" to try when parsing a user input value and it doesn't match the defined\nformat (defaults to 'm/d/Y|m-d-y|m-d-Y|m/d|m-d|d').",
- "memberOf" : ""
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"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" : ""
+ "desc" : "A DomHelper element spec, or true for a default element spec (defaults to\n{tag: \"input\", type: \"checkbox\", autocomplete: \"off\"})",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
- "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" : "closable",
+ "type" : "Boolean",
+ "desc" : "e) default fal",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : [
+ "true",
+ "false"
+ ]
},
{
"name" : "cls",
"type" : "String",
"desc" : "A CSS class to apply to the field's underlying element.",
- "memberOf" : "Roo.form.Field"
+ "memberOf" : "Roo.form.Field",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "disableClass",
"type" : "String",
"desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").",
- "memberOf" : "Roo.Component"
- },
- {
- "name" : "disableKeyFilter",
- "type" : "Boolean",
- "desc" : "True to disable input keystroke filtering (defaults to false)",
- "memberOf" : "Roo.form.TextField"
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "disabled",
"type" : "Boolean",
"desc" : "True to disable the field (defaults to false).",
- "memberOf" : "Roo.form.Field"
- },
- {
- "name" : "disabledDates",
- "type" : "Array",
- "desc" : "An array of \"dates\" to disable, as strings. These strings will be used to build a dynamic regular\nexpression so they are very powerful. Some examples:\n<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" : "disabledDays",
- "type" : "Array",
- "desc" : "An array of days to disable, 0 based. For example, [0, 6] disables Sunday and Saturday (defaults to null).",
- "memberOf" : ""
- },
- {
- "name" : "disabledDaysText",
- "type" : "String",
- "desc" : "The tooltip to display when the date falls on a disabled day (defaults to 'Disabled')",
- "memberOf" : ""
- },
- {
- "name" : "emptyText",
- "type" : "String",
- "desc" : "The default text to display in an empty field - placeholder... (defaults to null).",
- "memberOf" : "Roo.form.TextField"
+ "memberOf" : "Roo.form.Field",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "fieldClass",
"type" : "String",
- "desc" : "The default CSS class for the field (defaults to \"x-form-field\")",
- "memberOf" : "Roo.form.Field"
+ "desc" : "The default CSS class for the checkbox (defaults to \"x-form-field\")",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "fieldLabel",
"type" : "String",
"desc" : "Label to use when rendering a form.",
- "memberOf" : "Roo.form.Field"
+ "memberOf" : "Roo.form.Field",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "focusClass",
"type" : "String",
- "desc" : "The CSS class to use when the field receives focus (defaults to \"x-form-focus\")",
- "memberOf" : "Roo.form.Field"
- },
- {
- "name" : "format",
- "type" : "String",
- "desc" : "The default date format string which can be overriden for localization support. The format must be\nvalid according to {@link Date#parseDate} (defaults to 'm/d/y').",
- "memberOf" : ""
+ "desc" : "The CSS class to use when the checkbox receives focus (defaults to undefined)",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "height",
"type" : "Number",
"desc" : "height (optional) size of component",
- "memberOf" : "Roo.BoxComponent"
+ "memberOf" : "Roo.BoxComponent",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "hideMode",
"type" : "String",
- "desc" : "y)\nHow this component 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" : "hideTrigger",
- "type" : "Boolean",
- "desc" : "True to hide the trigger element and display only the base text field (defaults to false)",
- "memberOf" : "Roo.form.TriggerField"
+ "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display",
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : [
+ "display",
+ "visibility"
+ ]
},
{
"name" : "inputType",
"type" : "String",
"desc" : "The type attribute for input fields -- e.g. radio, text, password (defaults to \"text\").",
- "memberOf" : "Roo.form.Field"
+ "memberOf" : "Roo.form.Field",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "invalidClass",
"type" : "String",
"desc" : "The CSS class to use when marking a field invalid (defaults to \"x-form-invalid\")",
- "memberOf" : "Roo.form.Field"
+ "memberOf" : "Roo.form.Field",
+ "isOptional" : false,
+ "optvals" : []
},
{
"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" : ""
+ "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",
+ "isOptional" : false,
+ "optvals" : []
},
{
"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"
- },
- {
- "name" : "maskRe",
- "type" : "String",
- "desc" : "An input mask regular expression that will be used to filter keystrokes that don't match (defaults to null)",
- "memberOf" : "Roo.form.TextField"
- },
- {
- "name" : "maxLength",
- "type" : "Number",
- "desc" : "Maximum input field length allowed (defaults to Number.MAX_VALUE)",
- "memberOf" : "Roo.form.TextField"
- },
- {
- "name" : "maxLengthText",
- "type" : "String",
- "desc" : "Error text to display if the maximum length validation fails (defaults to \"The maximum length for this field is {maxLength}\")",
- "memberOf" : "Roo.form.TextField"
- },
- {
- "name" : "maxText",
- "type" : "String",
- "desc" : "The error text to display when the date in the cell is after maxValue (defaults to\n'The date in this field must be before {maxValue}').",
- "memberOf" : ""
- },
- {
- "name" : "maxValue",
- "type" : "Date/String",
- "desc" : "The maximum allowed date. Can be either a Javascript date object or a string date in a\nvalid format (defaults to null).",
- "memberOf" : ""
- },
- {
- "name" : "minLength",
- "type" : "Number",
- "desc" : "Minimum input field length required (defaults to 0)",
- "memberOf" : "Roo.form.TextField"
- },
- {
- "name" : "minLengthText",
- "type" : "String",
- "desc" : "Error text to display if the minimum length validation fails (defaults to \"The minimum length for this field is {minLength}\")",
- "memberOf" : "Roo.form.TextField"
- },
- {
- "name" : "minText",
- "type" : "String",
- "desc" : "The error text to display when the date in the cell is before minValue (defaults to\n'The date in this field must be after {minValue}').",
- "memberOf" : ""
- },
- {
- "name" : "minValue",
- "type" : "Date/String",
- "desc" : "The minimum allowed date. Can be either a Javascript date object or a string date in a\nvalid format (defaults to null).",
- "memberOf" : ""
+ "memberOf" : "Roo.util.Observable",
+ "isOptional" : false,
+ "optvals" : []
},
{
"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"
+ "memberOf" : "Roo.form.Field",
+ "isOptional" : false,
+ "optvals" : []
},
{
"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"
+ "memberOf" : "Roo.form.Field",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "name",
"type" : "String",
"desc" : "The field's HTML name attribute.",
- "memberOf" : "Roo.form.Field"
+ "memberOf" : "Roo.form.Field",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "qtip",
"type" : "String",
"desc" : "Mouse over tip",
- "memberOf" : "Roo.form.Field"
+ "memberOf" : "Roo.form.Field",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "readOnly",
"type" : "Boolean",
"desc" : "True to mark the field as readOnly in HTML (defaults to false) -- Note: this only sets the element's readOnly DOM attribute.",
- "memberOf" : "Roo.form.Field"
- },
- {
- "name" : "regex",
- "type" : "RegExp",
- "desc" : "A JavaScript RegExp object to be tested against the field value during validation (defaults to null).\nIf available, this regex will be evaluated only after the basic validators all return true, and will be passed the\ncurrent field value. If the test fails, the field will be marked invalid using {@link #regexText}.",
- "memberOf" : "Roo.form.TextField"
+ "memberOf" : "Roo.form.Field",
+ "isOptional" : false,
+ "optvals" : []
},
{
- "name" : "regexText",
+ "name" : "style",
"type" : "String",
- "desc" : "The error text to display if {@link #regex} is used and the test fails during validation (defaults to \"\")",
- "memberOf" : "Roo.form.TextField"
- },
- {
- "name" : "selectOnFocus",
- "type" : "Boolean",
- "desc" : "True to automatically select any existing field text when the field receives input focus (defaults to false)",
- "memberOf" : "Roo.form.TextField"
+ "desc" : "css styles to add to component\neg. text-align:right;",
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "tabIndex",
"type" : "Number",
"desc" : "The tabIndex for this field. Note this only applies to fields that are rendered, not those which are built via applyTo (defaults to undefined).",
- "memberOf" : "Roo.form.Field"
- },
- {
- "name" : "triggerClass",
- "type" : "String",
- "desc" : "An additional CSS class used to style the trigger button. The trigger will always get the\nclass 'x-form-trigger' and triggerClass will be <b>appended</b> if specified (defaults to 'x-form-date-trigger'\nwhich displays a calendar icon).",
- "memberOf" : ""
- },
- {
- "name" : "useIso",
- "type" : "Boolean",
- "desc" : "if enabled, then the date field will use a hidden field to store the \nreal value as iso formated date. default (false)",
- "memberOf" : ""
+ "memberOf" : "Roo.form.Field",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "validateOnBlur",
"type" : "Boolean",
"desc" : "Whether the field should validate when it loses focus (defaults to true).",
- "memberOf" : "Roo.form.Field"
+ "memberOf" : "Roo.form.Field",
+ "isOptional" : false,
+ "optvals" : []
},
{
"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"
+ "memberOf" : "Roo.form.Field",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "validationEvent",
"type" : "String/Boolean",
"desc" : "The event that should initiate field validation. Set to false to disable\n automatic validation (defaults to \"keyup\").",
- "memberOf" : "Roo.form.Field"
- },
- {
- "name" : "validator",
- "type" : "Function",
- "desc" : "A custom validation function to be called during field validation (defaults to null).\nIf available, this function will be called only after the basic validators all return true, and will be passed the\ncurrent field value and expected to return boolean true if the value is valid or a string error message if invalid.",
- "memberOf" : "Roo.form.TextField"
+ "memberOf" : "Roo.form.Field",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "value",
"type" : "Mixed",
"desc" : "A value to initialize this field with.",
- "memberOf" : "Roo.form.Field"
+ "memberOf" : "Roo.form.Field",
+ "isOptional" : false,
+ "optvals" : []
},
{
- "name" : "vtype",
- "type" : "String",
- "desc" : "A validation type name as defined in {@link Roo.form.VTypes} (defaults to null)",
- "memberOf" : "Roo.form.TextField"
+ "name" : "valueRenderer",
+ "type" : "Function",
+ "desc" : "The renderer for the field (so you can reformat output). should return raw HTML",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "width",
"type" : "Number",
"desc" : "width (optional) size of component",
- "memberOf" : "Roo.BoxComponent"
+ "memberOf" : "Roo.BoxComponent",
+ "isOptional" : false,
+ "optvals" : []
}
],
"events" : [
- {
- "name" : "autosize",
- "type" : "function",
- "desc" : "Fires when the autosize function is triggered. The field may or may not have actually changed size\naccording to the default logic, but this event provides a hook for the developer to apply additional\nlogic at runtime to resize the field if needed.",
- "sig" : "function (_self, width)\n{\n\n}",
- "memberOf" : "Roo.form.TextField",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.form.Field",
- "desc" : "This text field",
- "isOptional" : false
- },
- {
- "name" : "width",
- "type" : "Number",
- "desc" : "The new field width",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
{
"name" : "beforedestroy",
"type" : "function",
],
"returns" : []
},
+ {
+ "name" : "close",
+ "type" : "function",
+ "desc" : "Fires after the click the close btn",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.form.DisplayField",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
{
"name" : "destroy",
"type" : "function",
],
"returns" : []
},
- {
- "name" : "select",
- "type" : "function",
- "desc" : "Fires when a date is selected",
- "sig" : "function (combo, date)\n{\n\n}",
- "memberOf" : "",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "combo",
- "type" : "Roo.form.DateField",
- "desc" : "This combo box",
- "isOptional" : false
- },
- {
- "name" : "date",
- "type" : "Date",
- "desc" : "The date selected",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
{
"name" : "show",
"type" : "function",
}
]
},
- {
- "name" : "autoSize",
- "type" : "function",
- "desc" : "",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.form.TriggerField",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
{
"name" : "capture",
"type" : "function",
{
"name" : "getValue",
"type" : "function",
- "desc" : "Returns the current date value of the date field.",
+ "desc" : "Returns the normalized data value (undefined or emptyText will be returned as ''). To return the raw value see {@link #getRawValue}.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.form.Field",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"returns" : [
{
"name" : "",
- "type" : "Date",
- "desc" : "The date value"
+ "type" : "Mixed",
+ "desc" : "value The field value"
}
]
},
],
"returns" : []
},
- {
- "name" : "onTriggerClick",
- "type" : "function",
- "desc" : "The function that should handle the trigger's click event. This method does nothing by default until overridden\nby an implementing function.",
- "sig" : "(e)",
- "static" : false,
- "memberOf" : "Roo.form.TriggerField",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "e",
- "type" : "EventObject",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
{
"name" : "purgeListeners",
"type" : "function",
{
"name" : "reset",
"type" : "function",
- "desc" : "Resets the current field value to the originally-loaded value and clears any validation messages.",
+ "desc" : "Resets the current field value to the originally loaded value and clears any validation messages",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.form.TextField",
+ "memberOf" : "Roo.form.Field",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"params" : [],
"returns" : []
},
- {
- "name" : "selectText",
- "type" : "function",
- "desc" : "Selects text in this field",
- "sig" : "(start, end)",
- "static" : false,
- "memberOf" : "Roo.form.TextField",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "start",
- "type" : "Number",
- "desc" : "(optional) The index where the selection should start (defaults to 0)",
- "isOptional" : false
- },
- {
- "name" : "end",
- "type" : "Number",
- "desc" : "(optional) The index where the selection should end (defaults to the text length)",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
{
"name" : "setDisabled",
"type" : "function",
{
"name" : "setValue",
"type" : "function",
- "desc" : "Sets the value of the date field. You can pass a date object or any string that can be parsed into a valid\ndate, using DateField.format as the date format, according to the same rules as {@link Date#parseDate}\n(the default format used is \"m/d/y\").\n<br />Usage:\n<pre><code>\n//All of these calls set the same date value (May 4, 2006)\n\n//Pass a date object:\nvar dt = new Date('5/4/06');\ndateField.setValue(dt);\n\n//Pass a date string (default format):\ndateField.setValue('5/4/06');\n\n//Pass a date string (custom format):\ndateField.format = 'Y-m-d';\ndateField.setValue('2006-5-4');\n</code></pre>",
- "sig" : "(date)",
+ "desc" : "Sets the checked state of the checkbox.",
+ "sig" : "(checked)",
"static" : false,
"memberOf" : "",
"isStatic" : false,
"requires" : "",
"params" : [
{
- "name" : "date",
- "type" : "String/Date",
- "desc" : "The date or valid date string",
+ "name" : "checked",
+ "type" : "Boolean/String",
+ "desc" : "True, 'true', '1', or 'on' to check the checkbox, any other value will uncheck it.",
"isOptional" : false
}
],
"desc" : "True if the value is valid, else false"
}
]
- },
- {
- "name" : "validateValue",
- "type" : "function",
- "desc" : "Validates a value according to the field's validation rules and marks the field as invalid\nif the validation fails",
- "sig" : "(value)",
- "static" : false,
- "memberOf" : "Roo.form.TextField",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "value",
- "type" : "Mixed",
- "desc" : "The value to validate",
- "isOptional" : false
- }
- ],
- "returns" : [
- {
- "name" : "",
- "type" : "Boolean",
- "desc" : "True if the value is valid, else false"
- }
- ]
}
],
"isAbstract" : false,
"isBuilderTop" : false,
- "childClasses" : { },
+ "implementations" : [],
"tree_children" : [],
"tree_parent" : []
},
- "Roo.form.DayPicker" : {
+ "Roo.form.FCKeditor" : {
"props" : [
{
"name" : "actionMode",
"type" : "String",
"desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el' for forms you probably want to set this to fieldEl",
- "memberOf" : "Roo.Component"
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "allowBlank",
+ "type" : "Boolean",
+ "desc" : "False to validate that the value length > 0 (defaults to true)",
+ "memberOf" : "Roo.form.TextField",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "allowDomMove",
"type" : "Boolean",
"desc" : "Whether the component can move the Dom node when rendering (defaults to true).",
- "memberOf" : "Roo.Component"
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "allowLeadingSpace",
+ "type" : "Boolean",
+ "desc" : "True to prevent the stripping of leading white space",
+ "memberOf" : "Roo.form.TextField",
+ "isOptional" : false,
+ "optvals" : []
},
{
"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" : ""
+ "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",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "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",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "cls",
"type" : "String",
"desc" : "A CSS class to apply to the field's underlying element.",
- "memberOf" : "Roo.form.Field"
+ "memberOf" : "Roo.form.Field",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "disableClass",
"type" : "String",
"desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").",
- "memberOf" : "Roo.Component"
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "disableKeyFilter",
+ "type" : "Boolean",
+ "desc" : "True to disable input keystroke filtering (defaults to false)",
+ "memberOf" : "Roo.form.TextField",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "disabled",
"type" : "Boolean",
"desc" : "True to disable the field (defaults to false).",
- "memberOf" : "Roo.form.Field"
+ "memberOf" : "Roo.form.Field",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "emptyText",
+ "type" : "String",
+ "desc" : "The default text to display in an empty field - placeholder... (defaults to null).",
+ "memberOf" : "Roo.form.TextField",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "fck",
+ "type" : "Object",
+ "desc" : "BasePath",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "fieldClass",
"type" : "String",
- "desc" : "The default CSS class for the checkbox (defaults to \"x-form-field\")",
- "memberOf" : ""
+ "desc" : "The default CSS class for the field (defaults to \"x-form-field\")",
+ "memberOf" : "Roo.form.Field",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "fieldLabel",
"type" : "String",
"desc" : "Label to use when rendering a form.",
- "memberOf" : "Roo.form.Field"
+ "memberOf" : "Roo.form.Field",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "focusClass",
"type" : "String",
- "desc" : "The CSS class to use when the checkbox receives focus (defaults to undefined)",
- "memberOf" : ""
+ "desc" : "The CSS class to use when the field receives focus (defaults to \"x-form-focus\")",
+ "memberOf" : "Roo.form.Field",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "grow",
+ "type" : "Boolean",
+ "desc" : "True if this field should automatically grow and shrink to its content",
+ "memberOf" : "Roo.form.TextField",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "growMax",
+ "type" : "Number",
+ "desc" : "The maximum height to allow when grow = true (defaults to 1000)",
+ "memberOf" : "Roo.form.TextArea",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "growMin",
+ "type" : "Number",
+ "desc" : "The minimum height to allow when grow = true (defaults to 60)",
+ "memberOf" : "Roo.form.TextArea",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "height",
"type" : "Number",
"desc" : "height (optional) size of component",
- "memberOf" : "Roo.BoxComponent"
+ "memberOf" : "Roo.BoxComponent",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "hideMode",
"type" : "String",
- "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".",
- "memberOf" : "Roo.Component"
+ "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display",
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : [
+ "display",
+ "visibility"
+ ]
},
{
"name" : "inputType",
"type" : "String",
"desc" : "The type attribute for input fields -- e.g. radio, text, password (defaults to \"text\").",
- "memberOf" : "Roo.form.Field"
+ "memberOf" : "Roo.form.Field",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "invalidClass",
"type" : "String",
"desc" : "The CSS class to use when marking a field invalid (defaults to \"x-form-invalid\")",
- "memberOf" : "Roo.form.Field"
+ "memberOf" : "Roo.form.Field",
+ "isOptional" : false,
+ "optvals" : []
},
{
"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"
+ "memberOf" : "Roo.form.Field",
+ "isOptional" : false,
+ "optvals" : []
},
{
"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"
+ "memberOf" : "Roo.util.Observable",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "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",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "maxLength",
+ "type" : "Number",
+ "desc" : "Maximum input field length allowed (defaults to Number.MAX_VALUE)",
+ "memberOf" : "Roo.form.TextField",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "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",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "minLength",
+ "type" : "Number",
+ "desc" : "Minimum input field length required (defaults to 0)",
+ "memberOf" : "Roo.form.TextField",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "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",
+ "isOptional" : false,
+ "optvals" : []
},
{
"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"
+ "memberOf" : "Roo.form.Field",
+ "isOptional" : false,
+ "optvals" : []
},
{
"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"
+ "memberOf" : "Roo.form.Field",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "name",
"type" : "String",
"desc" : "The field's HTML name attribute.",
- "memberOf" : "Roo.form.Field"
+ "memberOf" : "Roo.form.Field",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "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",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "qtip",
"type" : "String",
"desc" : "Mouse over tip",
- "memberOf" : "Roo.form.Field"
+ "memberOf" : "Roo.form.Field",
+ "isOptional" : false,
+ "optvals" : []
},
{
"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"
+ "memberOf" : "Roo.form.Field",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "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",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "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",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "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",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "style",
+ "type" : "String",
+ "desc" : "css styles to add to component\neg. text-align:right;",
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"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"
+ "memberOf" : "Roo.form.Field",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "validateOnBlur",
"type" : "Boolean",
"desc" : "Whether the field should validate when it loses focus (defaults to true).",
- "memberOf" : "Roo.form.Field"
+ "memberOf" : "Roo.form.Field",
+ "isOptional" : false,
+ "optvals" : []
},
{
"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"
+ "memberOf" : "Roo.form.Field",
+ "isOptional" : false,
+ "optvals" : []
},
{
"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"
+ "memberOf" : "Roo.form.Field",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "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",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "value",
"type" : "Mixed",
"desc" : "A value to initialize this field with.",
- "memberOf" : "Roo.form.Field"
+ "memberOf" : "Roo.form.Field",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "vtype",
+ "type" : "String",
+ "desc" : "A validation type name as defined in {@link Roo.form.VTypes} (defaults to null)",
+ "memberOf" : "Roo.form.TextField",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "width",
"type" : "Number",
"desc" : "width (optional) size of component",
- "memberOf" : "Roo.BoxComponent"
+ "memberOf" : "Roo.BoxComponent",
+ "isOptional" : false,
+ "optvals" : []
}
],
"events" : [
+ {
+ "name" : "autosize",
+ "type" : "function",
+ "desc" : "Fires when the autosize function is triggered. The field may or may not have actually changed size\naccording to the default logic, but this event provides a hook for the developer to apply additional\nlogic at runtime to resize the field if needed.",
+ "sig" : "function (_self, width)\n{\n\n}",
+ "memberOf" : "Roo.form.TextField",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.form.Field",
+ "desc" : "This text field",
+ "isOptional" : false
+ },
+ {
+ "name" : "width",
+ "type" : "Number",
+ "desc" : "The new field width",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
{
"name" : "beforedestroy",
"type" : "function",
],
"returns" : []
},
+ {
+ "name" : "editorinit",
+ "type" : "function",
+ "desc" : "Fired when the editor is initialized - you can add extra handlers here..",
+ "sig" : "function (_self, the)\n{\n\n}",
+ "memberOf" : "",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "FCKeditor",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "the",
+ "type" : "Object",
+ "desc" : "FCK object.",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
{
"name" : "enable",
"type" : "function",
}
]
},
+ {
+ "name" : "autoSize",
+ "type" : "function",
+ "desc" : "Automatically grows the field to accomodate the height of the text up to the maximum field height allowed.\nThis only takes effect if grow = true, and fires the autosize event if the height changes.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.form.TextArea",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
{
"name" : "capture",
"type" : "function",
"desc" : "Returns the raw data value which may or may not be a valid, defined value. To return a normalized value see {@link #getValue}.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.form.Field",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
{
"name" : "getValue",
"type" : "function",
- "desc" : "Returns the checked state of the checkbox.",
+ "desc" : "Returns the normalized data value (undefined or emptyText will be returned as ''). To return the raw value see {@link #getRawValue}.",
"sig" : "()\n{\n\n}",
"static" : false,
"memberOf" : "",
"returns" : [
{
"name" : "",
- "type" : "Boolean",
- "desc" : "True if checked, else false"
+ "type" : "Mixed",
+ "desc" : "value The field value"
}
]
},
{
"name" : "handler",
"type" : "Function",
- "desc" : "The method the event invokes",
+ "desc" : "The method the event invokes",
+ "isOptional" : false
+ },
+ {
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
+ "isOptional" : false
+ },
+ {
+ "name" : "options",
+ "type" : "Object",
+ "desc" : "(optional)",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "onPosition",
+ "type" : "function",
+ "desc" : "Called after the component is moved, this method is empty by default but can be implemented by any\nsubclass that needs to perform custom logic after a move occurs.",
+ "sig" : "(x, y)",
+ "static" : false,
+ "memberOf" : "Roo.BoxComponent",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "x",
+ "type" : "Number",
+ "desc" : "The new x position",
+ "isOptional" : false
+ },
+ {
+ "name" : "y",
+ "type" : "Number",
+ "desc" : "The new y position",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "onResize",
+ "type" : "function",
+ "desc" : "Called after the component is resized, this method is empty by default but can be implemented by any\nsubclass that needs to perform custom logic after a resize occurs.",
+ "sig" : "(adjWidth, adjHeight, rawWidth, rawHeight)",
+ "static" : false,
+ "memberOf" : "Roo.BoxComponent",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "adjWidth",
+ "type" : "Number",
+ "desc" : "The box-adjusted width that was set",
+ "isOptional" : false
+ },
+ {
+ "name" : "adjHeight",
+ "type" : "Number",
+ "desc" : "The box-adjusted height that was set",
+ "isOptional" : false
+ },
+ {
+ "name" : "rawWidth",
+ "type" : "Number",
+ "desc" : "The width that was originally specified",
+ "isOptional" : false
+ },
+ {
+ "name" : "rawHeight",
+ "type" : "Number",
+ "desc" : "The height that was originally specified",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "purgeListeners",
+ "type" : "function",
+ "desc" : "Removes all listeners for this object",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.util.Observable",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
+ {
+ "name" : "releaseCapture",
+ "type" : "function",
+ "desc" : "Removes <b>all</b> added captures from the Observable.",
+ "sig" : "(o)",
+ "static" : true,
+ "memberOf" : "Roo.util.Observable",
+ "isStatic" : true,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "o",
+ "type" : "Observable",
+ "desc" : "The Observable to release",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "removeListener",
+ "type" : "function",
+ "desc" : "Removes a listener",
+ "sig" : "(eventName, handler, scope)",
+ "static" : false,
+ "memberOf" : "Roo.util.Observable",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "eventName",
+ "type" : "String",
+ "desc" : "The type of event to listen for",
+ "isOptional" : false
+ },
+ {
+ "name" : "handler",
+ "type" : "Function",
+ "desc" : "The handler to remove",
"isOptional" : false
},
{
"name" : "scope",
"type" : "Object",
- "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
- "isOptional" : false
- },
- {
- "name" : "options",
- "type" : "Object",
- "desc" : "(optional)",
+ "desc" : "(optional) The scope (this object) for the handler",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "onPosition",
+ "name" : "render",
"type" : "function",
- "desc" : "Called after the component is moved, this method is empty by default but can be implemented by any\nsubclass that needs to perform custom logic after a move occurs.",
- "sig" : "(x, y)",
+ "desc" : "If this is a lazy rendering component, render it to its container element.",
+ "sig" : "(container)",
"static" : false,
- "memberOf" : "Roo.BoxComponent",
+ "memberOf" : "Roo.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "x",
- "type" : "Number",
- "desc" : "The new x position",
- "isOptional" : false
- },
- {
- "name" : "y",
- "type" : "Number",
- "desc" : "The new y position",
+ "name" : "container",
+ "type" : "String/HTMLElement/Element",
+ "desc" : "(optional) The element this component should be rendered into. If it is being applied to existing markup, this should be left off.",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "onResize",
+ "name" : "reset",
"type" : "function",
- "desc" : "Called after the component is resized, this method is empty by default but can be implemented by any\nsubclass that needs to perform custom logic after a resize occurs.",
- "sig" : "(adjWidth, adjHeight, rawWidth, rawHeight)",
+ "desc" : "Resets the current field value to the originally-loaded value and clears any validation messages.",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.BoxComponent",
+ "memberOf" : "Roo.form.TextField",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "adjWidth",
- "type" : "Number",
- "desc" : "The box-adjusted width that was set",
- "isOptional" : false
- },
- {
- "name" : "adjHeight",
- "type" : "Number",
- "desc" : "The box-adjusted height that was set",
- "isOptional" : false
- },
- {
- "name" : "rawWidth",
- "type" : "Number",
- "desc" : "The width that was originally specified",
- "isOptional" : false
- },
- {
- "name" : "rawHeight",
- "type" : "Number",
- "desc" : "The height that was originally specified",
- "isOptional" : false
- }
- ],
+ "params" : [],
"returns" : []
},
{
- "name" : "purgeListeners",
+ "name" : "resetHasChanged",
"type" : "function",
- "desc" : "Removes all listeners for this object",
+ "desc" : "stores the current value in loadedValue",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.util.Observable",
+ "memberOf" : "Roo.form.Field",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"returns" : []
},
{
- "name" : "releaseCapture",
- "type" : "function",
- "desc" : "Removes <b>all</b> added captures from the Observable.",
- "sig" : "(o)",
- "static" : true,
- "memberOf" : "Roo.util.Observable",
- "isStatic" : true,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "o",
- "type" : "Observable",
- "desc" : "The Observable to release",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "removeListener",
+ "name" : "selectText",
"type" : "function",
- "desc" : "Removes a listener",
- "sig" : "(eventName, handler, scope)",
+ "desc" : "Selects text in this field",
+ "sig" : "(start, end)",
"static" : false,
- "memberOf" : "Roo.util.Observable",
+ "memberOf" : "Roo.form.TextField",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "eventName",
- "type" : "String",
- "desc" : "The type of event to listen for",
- "isOptional" : false
- },
- {
- "name" : "handler",
- "type" : "Function",
- "desc" : "The handler to remove",
+ "name" : "start",
+ "type" : "Number",
+ "desc" : "(optional) The index where the selection should start (defaults to 0)",
"isOptional" : false
},
{
- "name" : "scope",
- "type" : "Object",
- "desc" : "(optional) The scope (this object) for the handler",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "render",
- "type" : "function",
- "desc" : "If this is a lazy rendering component, render it to its container element.",
- "sig" : "(container)",
- "static" : false,
- "memberOf" : "Roo.Component",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "container",
- "type" : "String/HTMLElement/Element",
- "desc" : "(optional) The element this component should be rendered into. If it is being applied to existing markup, this should be left off.",
+ "name" : "end",
+ "type" : "Number",
+ "desc" : "(optional) The index where the selection should end (defaults to the text length)",
"isOptional" : false
}
],
"returns" : []
},
- {
- "name" : "reset",
- "type" : "function",
- "desc" : "Resets the current field value to the originally loaded value and clears any validation messages",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.form.Field",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
- {
- "name" : "resetHasChanged",
- "type" : "function",
- "desc" : "stores the current value in loadedValue",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.form.Field",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
{
"name" : "setDisabled",
"type" : "function",
{
"name" : "setValue",
"type" : "function",
- "desc" : "Sets the checked state of the checkbox.\nOn is always based on a string comparison between inputValue and the param.",
- "sig" : "(value, suppressEvent)",
+ "desc" : "Sets a data value into the field and validates it. To set the value directly without validation see {@link #setRawValue}.",
+ "sig" : "(value)",
"static" : false,
"memberOf" : "",
"isStatic" : false,
"params" : [
{
"name" : "value",
- "type" : "Boolean/String",
- "desc" : "- the value to set",
- "isOptional" : false
- },
- {
- "name" : "suppressEvent",
- "type" : "Boolean/String",
- "desc" : "- whether to suppress the checkchange event.",
+ "type" : "Mixed",
+ "desc" : "The value to set",
"isOptional" : false
}
],
"desc" : "True if the value is valid, else false"
}
]
+ },
+ {
+ "name" : "validateValue",
+ "type" : "function",
+ "desc" : "Validates a value according to the field's validation rules and marks the field as invalid\nif the validation fails",
+ "sig" : "(value)",
+ "static" : false,
+ "memberOf" : "Roo.form.TextField",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "value",
+ "type" : "Mixed",
+ "desc" : "The value to validate",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Boolean",
+ "desc" : "True if the value is valid, else false"
+ }
+ ]
}
],
"isAbstract" : false,
"isBuilderTop" : false,
- "childClasses" : { },
+ "implementations" : [],
"tree_children" : [],
"tree_parent" : []
},
- "Roo.form.DisplayField" : {
+ "Roo.form.Field" : {
"props" : [
{
"name" : "actionMode",
"type" : "String",
"desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el' for forms you probably want to set this to fieldEl",
- "memberOf" : "Roo.Component"
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "allowDomMove",
"type" : "Boolean",
"desc" : "Whether the component can move the Dom node when rendering (defaults to true).",
- "memberOf" : "Roo.Component"
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "autoCreate",
"type" : "String/Object",
- "desc" : "A DomHelper element spec, or true for a default element spec (defaults to\n{tag: \"input\", type: \"checkbox\", autocomplete: \"off\"})",
- "memberOf" : ""
- },
- {
- "name" : "closable",
- "type" : "Boolean",
- "desc" : "e) default false",
- "memberOf" : ""
+ "desc" : "A DomHelper element spec, or true for a default element spec (defaults to\n{tag: \"input\", type: \"text\", size: \"20\", autocomplete: \"off\"})",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "cls",
"type" : "String",
"desc" : "A CSS class to apply to the field's underlying element.",
- "memberOf" : "Roo.form.Field"
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "disableClass",
"type" : "String",
"desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").",
- "memberOf" : "Roo.Component"
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "disabled",
"type" : "Boolean",
"desc" : "True to disable the field (defaults to false).",
- "memberOf" : "Roo.form.Field"
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "fieldClass",
"type" : "String",
- "desc" : "The default CSS class for the checkbox (defaults to \"x-form-field\")",
- "memberOf" : ""
+ "desc" : "The default CSS class for the field (defaults to \"x-form-field\")",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "fieldLabel",
"type" : "String",
"desc" : "Label to use when rendering a form.",
- "memberOf" : "Roo.form.Field"
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "focusClass",
"type" : "String",
- "desc" : "The CSS class to use when the checkbox receives focus (defaults to undefined)",
- "memberOf" : ""
+ "desc" : "The CSS class to use when the field receives focus (defaults to \"x-form-focus\")",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "height",
"type" : "Number",
"desc" : "height (optional) size of component",
- "memberOf" : "Roo.BoxComponent"
+ "memberOf" : "Roo.BoxComponent",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "hideMode",
"type" : "String",
- "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".",
- "memberOf" : "Roo.Component"
+ "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display",
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : [
+ "display",
+ "visibility"
+ ]
},
{
"name" : "inputType",
"type" : "String",
"desc" : "The type attribute for input fields -- e.g. radio, text, password (defaults to \"text\").",
- "memberOf" : "Roo.form.Field"
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "invalidClass",
"type" : "String",
"desc" : "The CSS class to use when marking a field invalid (defaults to \"x-form-invalid\")",
- "memberOf" : "Roo.form.Field"
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"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"
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"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"
+ "memberOf" : "Roo.util.Observable",
+ "isOptional" : false,
+ "optvals" : []
},
{
"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"
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"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"
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "name",
"type" : "String",
"desc" : "The field's HTML name attribute.",
- "memberOf" : "Roo.form.Field"
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "qtip",
"type" : "String",
"desc" : "Mouse over tip",
- "memberOf" : "Roo.form.Field"
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"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"
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "style",
+ "type" : "String",
+ "desc" : "css styles to add to component\neg. text-align:right;",
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"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"
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "validateOnBlur",
"type" : "Boolean",
"desc" : "Whether the field should validate when it loses focus (defaults to true).",
- "memberOf" : "Roo.form.Field"
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"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"
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"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"
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "value",
"type" : "Mixed",
"desc" : "A value to initialize this field with.",
- "memberOf" : "Roo.form.Field"
- },
- {
- "name" : "valueRenderer",
- "type" : "Function",
- "desc" : "The renderer for the field (so you can reformat output). should return raw HTML",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "width",
"type" : "Number",
"desc" : "width (optional) size of component",
- "memberOf" : "Roo.BoxComponent"
+ "memberOf" : "Roo.BoxComponent",
+ "isOptional" : false,
+ "optvals" : []
}
],
"events" : [
"type" : "function",
"desc" : "Fires when this field loses input focus.",
"sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.form.Field",
+ "memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
"type" : "function",
"desc" : "Fires just before the field blurs if the field value has changed.",
"sig" : "function (_self, newValue, oldValue)\n{\n\n}",
- "memberOf" : "Roo.form.Field",
+ "memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
],
"returns" : []
},
- {
- "name" : "close",
- "type" : "function",
- "desc" : "Fires after the click the close btn",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.form.DisplayField",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
{
"name" : "destroy",
"type" : "function",
"type" : "function",
"desc" : "Fires when this field receives input focus.",
"sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.form.Field",
+ "memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
"type" : "function",
"desc" : "Fires after the field has been marked as invalid.",
"sig" : "function (_self, msg)\n{\n\n}",
- "memberOf" : "Roo.form.Field",
+ "memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
"type" : "function",
"desc" : "Fires after the key up",
"sig" : "function (_self, e)\n{\n\n}",
- "memberOf" : "Roo.form.Field",
+ "memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
"type" : "function",
"desc" : "Fires when any key related to navigation (arrows, tab, enter, esc, etc.) is pressed. You can check\n{@link Roo.EventObject#getKey} to determine which key was pressed.",
"sig" : "function (_self, e)\n{\n\n}",
- "memberOf" : "Roo.form.Field",
+ "memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
"type" : "function",
"desc" : "Fires after the field has been validated with no errors.",
"sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.form.Field",
+ "memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
"desc" : "Apply the behaviors of this component to an existing element. <b>This is used instead of render().</b>",
"sig" : "(el)",
"static" : false,
- "memberOf" : "Roo.form.Field",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"desc" : "Clear any invalid styles/messages for this field",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.form.Field",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"desc" : "Returns the name attribute of the field if available",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.form.Field",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"desc" : "Returns the raw data value which may or may not be a valid, defined value. To return a normalized value see {@link #getValue}.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.form.Field",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"desc" : "Returns the normalized data value (undefined or emptyText will be returned as ''). To return the raw value see {@link #getRawValue}.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.form.Field",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"desc" : "checks the current value against the 'loaded' value.\nNote - will return false if 'resetHasChanged' has not been called first.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.form.Field",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"desc" : "Returns true if this field has been changed since it was originally loaded and is not disabled.\nDEPRICATED - it never worked well - use hasChanged/resetHasChanged.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.form.Field",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"desc" : "Returns whether or not the field value is currently valid",
"sig" : "(preventMark)",
"static" : false,
- "memberOf" : "Roo.form.Field",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"desc" : "Mark this field as invalid",
"sig" : "(msg)",
"static" : false,
- "memberOf" : "Roo.form.Field",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"desc" : "Resets the current field value to the originally loaded value and clears any validation messages",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.form.Field",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"desc" : "stores the current value in loadedValue",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.form.Field",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"desc" : "Sets the underlying DOM field's value directly, bypassing validation. To set the value with validation see {@link #setValue}.",
"sig" : "(value)",
"static" : false,
- "memberOf" : "Roo.form.Field",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
{
"name" : "setValue",
"type" : "function",
- "desc" : "Sets the checked state of the checkbox.",
- "sig" : "(checked)",
+ "desc" : "Sets a data value into the field and validates it. To set the value directly without validation see {@link #setRawValue}.",
+ "sig" : "(value)",
"static" : false,
"memberOf" : "",
"isStatic" : false,
"requires" : "",
"params" : [
{
- "name" : "checked",
- "type" : "Boolean/String",
- "desc" : "True, 'true', '1', or 'on' to check the checkbox, any other value will uncheck it.",
+ "name" : "value",
+ "type" : "Mixed",
+ "desc" : "The value to set",
"isOptional" : false
}
],
"desc" : "Validates the field value",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.form.Field",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
],
"isAbstract" : false,
"isBuilderTop" : false,
- "childClasses" : { },
+ "implementations" : [
+ "Roo.form.Checkbox",
+ "Roo.form.ComboBox",
+ "Roo.form.ComboBoxArray",
+ "Roo.form.ComboCheck",
+ "Roo.form.ComboNested",
+ "Roo.form.DateField",
+ "Roo.form.DayPicker",
+ "Roo.form.DisplayField",
+ "Roo.form.FCKeditor",
+ "Roo.form.GridField",
+ "Roo.form.Hidden",
+ "Roo.form.HtmlEditor",
+ "Roo.form.MonthField",
+ "Roo.form.NumberField",
+ "Roo.form.Radio",
+ "Roo.form.Select",
+ "Roo.form.Signature",
+ "Roo.form.TextArea",
+ "Roo.form.TextField",
+ "Roo.form.TriggerField"
+ ],
"tree_children" : [],
"tree_parent" : []
},
- "Roo.form.FCKeditor" : {
+ "Roo.form.FieldSet" : {
"props" : [
{
"name" : "actionMode",
"type" : "String",
"desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el' for forms you probably want to set this to fieldEl",
- "memberOf" : "Roo.Component"
- },
- {
- "name" : "allowBlank",
- "type" : "Boolean",
- "desc" : "False to validate that the value length > 0 (defaults to true)",
- "memberOf" : "Roo.form.TextField"
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "allowDomMove",
"type" : "Boolean",
"desc" : "Whether the component can move the Dom node when rendering (defaults to true).",
- "memberOf" : "Roo.Component"
- },
- {
- "name" : "allowLeadingSpace",
- "type" : "Boolean",
- "desc" : "True to prevent the stripping of leading white space",
- "memberOf" : "Roo.form.TextField"
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "autoCreate",
"type" : "String/Object",
- "desc" : "A DomHelper element spec, or true for a default element spec (defaults to\n{tag: \"textarea\", style: \"width:300px;height:60px;\", autocomplete: \"off\"})",
- "memberOf" : "Roo.form.TextArea"
- },
- {
- "name" : "blankText",
- "type" : "String",
- "desc" : "Error text to display if the allow blank validation fails (defaults to \"This field is required\")",
- "memberOf" : "Roo.form.TextField"
+ "desc" : "A DomHelper element spec used to autocreate the fieldset (defaults to {tag: 'fieldset', cn: {tag:'legend'}})",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
- "name" : "cls",
- "type" : "String",
- "desc" : "A CSS class to apply to the field's underlying element.",
- "memberOf" : "Roo.form.Field"
+ "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",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "disableClass",
"type" : "String",
"desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").",
- "memberOf" : "Roo.Component"
- },
- {
- "name" : "disableKeyFilter",
- "type" : "Boolean",
- "desc" : "True to disable input keystroke filtering (defaults to false)",
- "memberOf" : "Roo.form.TextField"
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
- "name" : "disabled",
+ "name" : "hideLabels",
"type" : "Boolean",
- "desc" : "True to disable the field (defaults to false).",
- "memberOf" : "Roo.form.Field"
- },
- {
- "name" : "emptyText",
- "type" : "String",
- "desc" : "The default text to display in an empty field - placeholder... (defaults to null).",
- "memberOf" : "Roo.form.TextField"
- },
- {
- "name" : "fck",
- "type" : "Object",
- "desc" : "BasePath",
- "memberOf" : ""
+ "desc" : "True to suppress the display of field labels in this layout (defaults to false)",
+ "memberOf" : "Roo.form.Layout",
+ "isOptional" : false,
+ "optvals" : []
},
{
- "name" : "fieldClass",
+ "name" : "hideMode",
"type" : "String",
- "desc" : "The default CSS class for the field (defaults to \"x-form-field\")",
- "memberOf" : "Roo.form.Field"
+ "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display",
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : [
+ "display",
+ "visibility"
+ ]
},
{
- "name" : "fieldLabel",
+ "name" : "labelAlign",
"type" : "String",
- "desc" : "Label to use when rendering a form.",
- "memberOf" : "Roo.form.Field"
+ "desc" : "t)\nValid values are \"left,\" \"top\" and \"right\" (defaults to \"left",
+ "memberOf" : "Roo.form.Layout",
+ "isOptional" : false,
+ "optvals" : [
+ "left",
+ "top",
+ "right"
+ ]
},
{
- "name" : "focusClass",
+ "name" : "labelSeparator",
"type" : "String",
- "desc" : "The CSS class to use when the field receives focus (defaults to \"x-form-focus\")",
- "memberOf" : "Roo.form.Field"
- },
- {
- "name" : "grow",
- "type" : "Boolean",
- "desc" : "True if this field should automatically grow and shrink to its content",
- "memberOf" : "Roo.form.TextField"
- },
- {
- "name" : "growMax",
- "type" : "Number",
- "desc" : "The maximum height to allow when grow = true (defaults to 1000)",
- "memberOf" : "Roo.form.TextArea"
- },
- {
- "name" : "growMin",
- "type" : "Number",
- "desc" : "The minimum height to allow when grow = true (defaults to 60)",
- "memberOf" : "Roo.form.TextArea"
+ "desc" : "The separator to use after field labels (defaults to ':')",
+ "memberOf" : "Roo.form.Layout",
+ "isOptional" : false,
+ "optvals" : []
},
{
- "name" : "height",
+ "name" : "labelWidth",
"type" : "Number",
- "desc" : "height (optional) size of component",
- "memberOf" : "Roo.BoxComponent"
- },
- {
- "name" : "hideMode",
- "type" : "String",
- "desc" : "y)\nHow this component 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" : "inputType",
- "type" : "String",
- "desc" : "The type attribute for input fields -- e.g. radio, text, password (defaults to \"text\").",
- "memberOf" : "Roo.form.Field"
- },
- {
- "name" : "invalidClass",
- "type" : "String",
- "desc" : "The CSS class to use when marking a field invalid (defaults to \"x-form-invalid\")",
- "memberOf" : "Roo.form.Field"
+ "desc" : "Fixed width in pixels of all field labels (defaults to undefined)",
+ "memberOf" : "Roo.form.Layout",
+ "isOptional" : false,
+ "optvals" : []
},
{
- "name" : "invalidText",
+ "name" : "legend",
"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"
+ "desc" : "The text to display as the legend for the FieldSet (defaults to '')",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"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"
- },
- {
- "name" : "maskRe",
- "type" : "String",
- "desc" : "An input mask regular expression that will be used to filter keystrokes that don't match (defaults to null)",
- "memberOf" : "Roo.form.TextField"
- },
- {
- "name" : "maxLength",
- "type" : "Number",
- "desc" : "Maximum input field length allowed (defaults to Number.MAX_VALUE)",
- "memberOf" : "Roo.form.TextField"
- },
- {
- "name" : "maxLengthText",
- "type" : "String",
- "desc" : "Error text to display if the maximum length validation fails (defaults to \"The maximum length for this field is {maxLength}\")",
- "memberOf" : "Roo.form.TextField"
- },
- {
- "name" : "minLength",
- "type" : "Number",
- "desc" : "Minimum input field length required (defaults to 0)",
- "memberOf" : "Roo.form.TextField"
- },
- {
- "name" : "minLengthText",
- "type" : "String",
- "desc" : "Error text to display if the minimum length validation fails (defaults to \"The minimum length for this field is {minLength}\")",
- "memberOf" : "Roo.form.TextField"
- },
- {
- "name" : "msgFx",
- "type" : "String",
- "desc" : "<b>Experimental</b> The effect used when displaying a validation message under the field (defaults to 'normal').",
- "memberOf" : "Roo.form.Field"
- },
- {
- "name" : "msgTarget",
- "type" : "String",
- "desc" : "The location where error text should display. Should be one of the following values (defaults to 'qtip'):\n<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" : "name",
- "type" : "String",
- "desc" : "The field's HTML name attribute.",
- "memberOf" : "Roo.form.Field"
- },
- {
- "name" : "preventScrollbars",
- "type" : "Boolean",
- "desc" : "True to prevent scrollbars from appearing regardless of how much text is\nin the field (equivalent to setting overflow: hidden, defaults to false)",
- "memberOf" : "Roo.form.TextArea"
- },
- {
- "name" : "qtip",
- "type" : "String",
- "desc" : "Mouse over tip",
- "memberOf" : "Roo.form.Field"
- },
- {
- "name" : "readOnly",
- "type" : "Boolean",
- "desc" : "True to mark the field as readOnly in HTML (defaults to false) -- Note: this only sets the element's readOnly DOM attribute.",
- "memberOf" : "Roo.form.Field"
- },
- {
- "name" : "regex",
- "type" : "RegExp",
- "desc" : "A JavaScript RegExp object to be tested against the field value during validation (defaults to null).\nIf available, this regex will be evaluated only after the basic validators all return true, and will be passed the\ncurrent field value. If the test fails, the field will be marked invalid using {@link #regexText}.",
- "memberOf" : "Roo.form.TextField"
- },
- {
- "name" : "regexText",
- "type" : "String",
- "desc" : "The error text to display if {@link #regex} is used and the test fails during validation (defaults to \"\")",
- "memberOf" : "Roo.form.TextField"
- },
- {
- "name" : "selectOnFocus",
- "type" : "Boolean",
- "desc" : "True to automatically select any existing field text when the field receives input focus (defaults to false)",
- "memberOf" : "Roo.form.TextField"
- },
- {
- "name" : "tabIndex",
- "type" : "Number",
- "desc" : "The tabIndex for this field. Note this only applies to fields that are rendered, not those which are built via applyTo (defaults to undefined).",
- "memberOf" : "Roo.form.Field"
- },
- {
- "name" : "validateOnBlur",
- "type" : "Boolean",
- "desc" : "Whether the field should validate when it loses focus (defaults to true).",
- "memberOf" : "Roo.form.Field"
- },
- {
- "name" : "validationDelay",
- "type" : "Number",
- "desc" : "The length of time in milliseconds after user input begins until validation is initiated (defaults to 250)",
- "memberOf" : "Roo.form.Field"
- },
- {
- "name" : "validationEvent",
- "type" : "String/Boolean",
- "desc" : "The event that should initiate field validation. Set to false to disable\n automatic validation (defaults to \"keyup\").",
- "memberOf" : "Roo.form.Field"
- },
- {
- "name" : "validator",
- "type" : "Function",
- "desc" : "A custom validation function to be called during field validation (defaults to null).\nIf available, this function will be called only after the basic validators all return true, and will be passed the\ncurrent field value and expected to return boolean true if the value is valid or a string error message if invalid.",
- "memberOf" : "Roo.form.TextField"
- },
- {
- "name" : "value",
- "type" : "Mixed",
- "desc" : "A value to initialize this field with.",
- "memberOf" : "Roo.form.Field"
- },
- {
- "name" : "vtype",
- "type" : "String",
- "desc" : "A validation type name as defined in {@link Roo.form.VTypes} (defaults to null)",
- "memberOf" : "Roo.form.TextField"
+ "memberOf" : "Roo.util.Observable",
+ "isOptional" : false,
+ "optvals" : []
},
{
- "name" : "width",
- "type" : "Number",
- "desc" : "width (optional) size of component",
- "memberOf" : "Roo.BoxComponent"
+ "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",
+ "isOptional" : false,
+ "optvals" : []
}
],
"events" : [
- {
- "name" : "autosize",
- "type" : "function",
- "desc" : "Fires when the autosize function is triggered. The field may or may not have actually changed size\naccording to the default logic, but this event provides a hook for the developer to apply additional\nlogic at runtime to resize the field if needed.",
- "sig" : "function (_self, width)\n{\n\n}",
- "memberOf" : "Roo.form.TextField",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.form.Field",
- "desc" : "This text field",
- "isOptional" : false
- },
- {
- "name" : "width",
- "type" : "Number",
- "desc" : "The new field width",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
{
"name" : "beforedestroy",
"type" : "function",
],
"returns" : []
},
- {
- "name" : "blur",
- "type" : "function",
- "desc" : "Fires when this field loses input focus.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.form.Field",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.form.Field",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "change",
- "type" : "function",
- "desc" : "Fires just before the field blurs if the field value has changed.",
- "sig" : "function (_self, newValue, oldValue)\n{\n\n}",
- "memberOf" : "Roo.form.Field",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.form.Field",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "newValue",
- "type" : "Mixed",
- "desc" : "The new value",
- "isOptional" : false
- },
- {
- "name" : "oldValue",
- "type" : "Mixed",
- "desc" : "The original value",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
{
"name" : "destroy",
"type" : "function",
],
"returns" : []
},
- {
- "name" : "editorinit",
- "type" : "function",
- "desc" : "Fired when the editor is initialized - you can add extra handlers here..",
- "sig" : "function (_self, the)\n{\n\n}",
- "memberOf" : "",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "FCKeditor",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "the",
- "type" : "Object",
- "desc" : "FCK object.",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
{
"name" : "enable",
"type" : "function",
],
"returns" : []
},
- {
- "name" : "focus",
- "type" : "function",
- "desc" : "Fires when this field receives input focus.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.form.Field",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.form.Field",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
{
"name" : "hide",
"type" : "function",
],
"returns" : []
},
- {
- "name" : "invalid",
- "type" : "function",
- "desc" : "Fires after the field has been marked as invalid.",
- "sig" : "function (_self, msg)\n{\n\n}",
- "memberOf" : "Roo.form.Field",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.form.Field",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "msg",
- "type" : "String",
- "desc" : "The validation message",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "keyup",
- "type" : "function",
- "desc" : "Fires after the key up",
- "sig" : "function (_self, e)\n{\n\n}",
- "memberOf" : "Roo.form.Field",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.form.Field",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "e",
- "type" : "Roo.EventObject",
- "desc" : "The event Object",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "move",
- "type" : "function",
- "desc" : "Fires after the component is moved.",
- "sig" : "function (_self, x, y)\n{\n\n}",
- "memberOf" : "Roo.BoxComponent",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.Component",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "x",
- "type" : "Number",
- "desc" : "The new x position",
- "isOptional" : false
- },
- {
- "name" : "y",
- "type" : "Number",
- "desc" : "The new y position",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
{
"name" : "render",
"type" : "function",
],
"returns" : []
},
- {
- "name" : "resize",
- "type" : "function",
- "desc" : "Fires after the component is resized.",
- "sig" : "function (_self, adjWidth, adjHeight, rawWidth, rawHeight)\n{\n\n}",
- "memberOf" : "Roo.BoxComponent",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.Component",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "adjWidth",
- "type" : "Number",
- "desc" : "The box-adjusted width that was set",
- "isOptional" : false
- },
- {
- "name" : "adjHeight",
- "type" : "Number",
- "desc" : "The box-adjusted height that was set",
- "isOptional" : false
- },
- {
- "name" : "rawWidth",
- "type" : "Number",
- "desc" : "The width that was originally specified",
- "isOptional" : false
- },
- {
- "name" : "rawHeight",
- "type" : "Number",
- "desc" : "The height that was originally specified",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
{
"name" : "show",
"type" : "function",
}
],
"returns" : []
- },
- {
- "name" : "specialkey",
- "type" : "function",
- "desc" : "Fires when any key related to navigation (arrows, tab, enter, esc, etc.) is pressed. You can check\n{@link Roo.EventObject#getKey} to determine which key was pressed.",
- "sig" : "function (_self, e)\n{\n\n}",
- "memberOf" : "Roo.form.Field",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.form.Field",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "e",
- "type" : "Roo.EventObject",
- "desc" : "The event object",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "valid",
- "type" : "function",
- "desc" : "Fires after the field has been validated with no errors.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.form.Field",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.form.Field",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
}
],
"methods" : [
"returns" : []
},
{
- "name" : "applyTo",
+ "name" : "addxtype",
"type" : "function",
- "desc" : "Apply the behaviors of this component to an existing element. <b>This is used instead of render().</b>",
- "sig" : "(el)",
+ "desc" : "Adds a object form elements (using the xtype property as the factory method.)\nValid xtypes are: TextField, TextArea .... Button, Layout, FieldSet, Column",
+ "sig" : "(config)",
"static" : false,
- "memberOf" : "Roo.form.Field",
+ "memberOf" : "Roo.form.Layout",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "el",
- "type" : "String/HTMLElement/Element",
- "desc" : "The id of the node, a DOM node or an existing Element",
+ "name" : "config",
+ "type" : "Object",
+ "desc" : "",
"isOptional" : false
}
],
- "returns" : [
- {
- "name" : "",
- "type" : "Roo.form.Field",
- "desc" : "this"
- }
- ]
- },
- {
- "name" : "autoSize",
- "type" : "function",
- "desc" : "Automatically grows the field to accomodate the height of the text up to the maximum field height allowed.\nThis only takes effect if grow = true, and fires the autosize event if the height changes.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.form.TextArea",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
"returns" : []
},
{
"returns" : []
},
{
- "name" : "clearInvalid",
- "type" : "function",
- "desc" : "Clear any invalid styles/messages for this field",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.form.Field",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
- {
- "name" : "destroy",
- "type" : "function",
- "desc" : "Destroys this component by purging any event listeners, removing the component's element from the DOM,\nremoving the component from its {@link Roo.Container} (if applicable) and unregistering it from {@link Roo.ComponentMgr}.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.Component",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
- {
- "name" : "disable",
- "type" : "function",
- "desc" : "Disable this component.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.Component",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : [
- {
- "name" : "",
- "type" : "Roo.Component",
- "desc" : "this"
- }
- ]
- },
- {
- "name" : "enable",
- "type" : "function",
- "desc" : "Enable this component.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.Component",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : [
- {
- "name" : "",
- "type" : "Roo.Component",
- "desc" : "this"
- }
- ]
- },
- {
- "name" : "fireEvent",
- "type" : "function",
- "desc" : "Fires the specified event with the passed parameters (minus the event name).",
- "sig" : "(eventName, args)",
- "static" : false,
- "memberOf" : "Roo.util.Observable",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "eventName",
- "type" : "String",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "args",
- "type" : "Object...",
- "desc" : "Variable number of parameters are passed to handlers",
- "isOptional" : false
- }
- ],
- "returns" : [
- {
- "name" : "",
- "type" : "Boolean",
- "desc" : "returns false if any of the handlers return false otherwise it returns true"
- }
- ]
- },
- {
- "name" : "focus",
- "type" : "function",
- "desc" : "Try to focus this component.",
- "sig" : "(selectText)",
- "static" : false,
- "memberOf" : "Roo.Component",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "selectText",
- "type" : "Boolean",
- "desc" : "True to also select the text in this component (if applicable)",
- "isOptional" : false
- }
- ],
- "returns" : [
- {
- "name" : "",
- "type" : "Roo.Component",
- "desc" : "this"
- }
- ]
- },
- {
- "name" : "getBox",
- "type" : "function",
- "desc" : "Gets the current box measurements of the component's underlying element.",
- "sig" : "(local)",
- "static" : false,
- "memberOf" : "Roo.BoxComponent",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "local",
- "type" : "Boolean",
- "desc" : "(optional) If true the element's left and top are returned instead of page XY (defaults to false)",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "getEl",
- "type" : "function",
- "desc" : "Returns the underlying {@link Roo.Element}.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.Component",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : [
- {
- "name" : "",
- "type" : "Roo.Element",
- "desc" : "The element"
- }
- ]
- },
- {
- "name" : "getId",
- "type" : "function",
- "desc" : "Returns the id of this component.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.Component",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : [
- {
- "name" : "",
- "type" : "String",
- "desc" : ""
- }
- ]
- },
- {
- "name" : "getName",
- "type" : "function",
- "desc" : "Returns the name attribute of the field if available",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.form.Field",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : [
- {
- "name" : "",
- "type" : "String",
- "desc" : "name The field name"
- }
- ]
- },
- {
- "name" : "getPosition",
- "type" : "function",
- "desc" : "Gets the current XY position of the component's underlying element.",
- "sig" : "(local)",
- "static" : false,
- "memberOf" : "Roo.BoxComponent",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "local",
- "type" : "Boolean",
- "desc" : "(optional) If true the element's left and top are returned instead of page XY (defaults to false)",
- "isOptional" : false
- }
- ],
- "returns" : [
- {
- "name" : "",
- "type" : "Array",
- "desc" : "The XY position of the element (e.g., [100, 200])"
- }
- ]
- },
- {
- "name" : "getRawValue",
+ "name" : "destroy",
"type" : "function",
- "desc" : "Returns the raw data value which may or may not be a valid, defined value. To return a normalized value see {@link #getValue}.",
+ "desc" : "Destroys this component by purging any event listeners, removing the component's element from the DOM,\nremoving the component from its {@link Roo.Container} (if applicable) and unregistering it from {@link Roo.ComponentMgr}.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"exceptions" : "",
"requires" : "",
"params" : [],
- "returns" : [
- {
- "name" : "",
- "type" : "Mixed",
- "desc" : "value The field value"
- }
- ]
+ "returns" : []
},
{
- "name" : "getSize",
+ "name" : "disable",
"type" : "function",
- "desc" : "Gets the current size of the component's underlying element.",
+ "desc" : "Disable this component.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.BoxComponent",
+ "memberOf" : "Roo.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"returns" : [
{
"name" : "",
- "type" : "Object",
- "desc" : "An object containing the element's size {width: (element width), height: (element height)}"
+ "type" : "Roo.Component",
+ "desc" : "this"
}
]
},
{
- "name" : "getValue",
+ "name" : "enable",
"type" : "function",
- "desc" : "Returns the normalized data value (undefined or emptyText will be returned as ''). To return the raw value see {@link #getRawValue}.",
+ "desc" : "Enable this component.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"returns" : [
{
"name" : "",
- "type" : "Mixed",
- "desc" : "value The field value"
+ "type" : "Roo.Component",
+ "desc" : "this"
}
]
},
{
- "name" : "hasChanged",
+ "name" : "fireEvent",
"type" : "function",
- "desc" : "checks the current value against the 'loaded' value.\nNote - will return false if 'resetHasChanged' has not been called first.",
- "sig" : "()\n{\n\n}",
+ "desc" : "Fires the specified event with the passed parameters (minus the event name).",
+ "sig" : "(eventName, args)",
"static" : false,
- "memberOf" : "Roo.form.Field",
+ "memberOf" : "Roo.util.Observable",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
- "returns" : []
+ "params" : [
+ {
+ "name" : "eventName",
+ "type" : "String",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "args",
+ "type" : "Object...",
+ "desc" : "Variable number of parameters are passed to handlers",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Boolean",
+ "desc" : "returns false if any of the handlers return false otherwise it returns true"
+ }
+ ]
},
{
- "name" : "hasListener",
+ "name" : "focus",
"type" : "function",
- "desc" : "Checks to see if this object has any listeners for a specified event",
- "sig" : "(eventName)",
+ "desc" : "Try to focus this component.",
+ "sig" : "(selectText)",
"static" : false,
- "memberOf" : "Roo.util.Observable",
+ "memberOf" : "Roo.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "eventName",
- "type" : "String",
- "desc" : "The name of the event to check for",
+ "name" : "selectText",
+ "type" : "Boolean",
+ "desc" : "True to also select the text in this component (if applicable)",
"isOptional" : false
}
],
"returns" : [
{
"name" : "",
- "type" : "Boolean",
- "desc" : "True if the event is being listened for, else false"
+ "type" : "Roo.Component",
+ "desc" : "this"
}
]
},
{
- "name" : "hide",
+ "name" : "getEl",
"type" : "function",
- "desc" : "Hide this component.",
+ "desc" : "Returns the underlying {@link Roo.Element}.",
"sig" : "()\n{\n\n}",
"static" : false,
"memberOf" : "Roo.Component",
"returns" : [
{
"name" : "",
- "type" : "Roo.Component",
- "desc" : "this"
+ "type" : "Roo.Element",
+ "desc" : "The element"
}
]
},
{
- "name" : "isDirty",
+ "name" : "getId",
"type" : "function",
- "desc" : "Returns true if this field has been changed since it was originally loaded and is not disabled.\nDEPRICATED - it never worked well - use hasChanged/resetHasChanged.",
+ "desc" : "Returns the id of this component.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.form.Field",
+ "memberOf" : "Roo.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"exceptions" : "",
"requires" : "",
"params" : [],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "String",
+ "desc" : ""
+ }
+ ]
},
{
- "name" : "isValid",
+ "name" : "hasListener",
"type" : "function",
- "desc" : "Returns whether or not the field value is currently valid",
- "sig" : "(preventMark)",
+ "desc" : "Checks to see if this object has any listeners for a specified event",
+ "sig" : "(eventName)",
"static" : false,
- "memberOf" : "Roo.form.Field",
+ "memberOf" : "Roo.util.Observable",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "preventMark",
- "type" : "Boolean",
- "desc" : "True to disable marking the field invalid",
+ "name" : "eventName",
+ "type" : "String",
+ "desc" : "The name of the event to check for",
"isOptional" : false
}
],
{
"name" : "",
"type" : "Boolean",
- "desc" : "True if the value is valid, else false"
+ "desc" : "True if the event is being listened for, else false"
}
]
},
{
- "name" : "isVisible",
+ "name" : "hide",
"type" : "function",
- "desc" : "Returns true if this component is visible.",
+ "desc" : "Hide this component.",
"sig" : "()\n{\n\n}",
"static" : false,
"memberOf" : "Roo.Component",
"exceptions" : "",
"requires" : "",
"params" : [],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.Component",
+ "desc" : "this"
+ }
+ ]
},
{
- "name" : "markInvalid",
+ "name" : "isVisible",
"type" : "function",
- "desc" : "Mark this field as invalid",
- "sig" : "(msg)",
+ "desc" : "Returns true if this component is visible.",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.form.Field",
+ "memberOf" : "Roo.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "msg",
- "type" : "String",
- "desc" : "The validation message",
- "isOptional" : false
- }
- ],
+ "params" : [],
"returns" : []
},
{
],
"returns" : []
},
- {
- "name" : "onPosition",
- "type" : "function",
- "desc" : "Called after the component is moved, this method is empty by default but can be implemented by any\nsubclass that needs to perform custom logic after a move occurs.",
- "sig" : "(x, y)",
- "static" : false,
- "memberOf" : "Roo.BoxComponent",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "x",
- "type" : "Number",
- "desc" : "The new x position",
- "isOptional" : false
- },
- {
- "name" : "y",
- "type" : "Number",
- "desc" : "The new y position",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "onResize",
- "type" : "function",
- "desc" : "Called after the component is resized, this method is empty by default but can be implemented by any\nsubclass that needs to perform custom logic after a resize occurs.",
- "sig" : "(adjWidth, adjHeight, rawWidth, rawHeight)",
- "static" : false,
- "memberOf" : "Roo.BoxComponent",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "adjWidth",
- "type" : "Number",
- "desc" : "The box-adjusted width that was set",
- "isOptional" : false
- },
- {
- "name" : "adjHeight",
- "type" : "Number",
- "desc" : "The box-adjusted height that was set",
- "isOptional" : false
- },
- {
- "name" : "rawWidth",
- "type" : "Number",
- "desc" : "The width that was originally specified",
- "isOptional" : false
- },
- {
- "name" : "rawHeight",
- "type" : "Number",
- "desc" : "The height that was originally specified",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
{
"name" : "purgeListeners",
"type" : "function",
],
"returns" : []
},
- {
- "name" : "reset",
- "type" : "function",
- "desc" : "Resets the current field value to the originally-loaded value and clears any validation messages.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.form.TextField",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
- {
- "name" : "resetHasChanged",
- "type" : "function",
- "desc" : "stores the current value in loadedValue",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.form.Field",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
- {
- "name" : "selectText",
- "type" : "function",
- "desc" : "Selects text in this field",
- "sig" : "(start, end)",
- "static" : false,
- "memberOf" : "Roo.form.TextField",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "start",
- "type" : "Number",
- "desc" : "(optional) The index where the selection should start (defaults to 0)",
- "isOptional" : false
- },
- {
- "name" : "end",
- "type" : "Number",
- "desc" : "(optional) The index where the selection should end (defaults to the text length)",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
{
"name" : "setDisabled",
"type" : "function",
],
"returns" : []
},
- {
- "name" : "setPagePosition",
- "type" : "function",
- "desc" : "Sets the page XY position of the component. To set the left and top instead, use {@link #setPosition}.\nThis method fires the move event.",
- "sig" : "(x, y)",
- "static" : false,
- "memberOf" : "Roo.BoxComponent",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "x",
- "type" : "Number",
- "desc" : "The new x position",
- "isOptional" : false
- },
- {
- "name" : "y",
- "type" : "Number",
- "desc" : "The new y position",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "setPosition",
- "type" : "function",
- "desc" : "Sets the left and top of the component. To set the page XY position instead, use {@link #setPagePosition}.\nThis method fires the move event.",
- "sig" : "(left, top)",
- "static" : false,
- "memberOf" : "Roo.BoxComponent",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "left",
- "type" : "Number",
- "desc" : "The new left",
- "isOptional" : false
- },
- {
- "name" : "top",
- "type" : "Number",
- "desc" : "The new top",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "setRawValue",
- "type" : "function",
- "desc" : "Sets the underlying DOM field's value directly, bypassing validation. To set the value with validation see {@link #setValue}.",
- "sig" : "(value)",
- "static" : false,
- "memberOf" : "Roo.form.Field",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "value",
- "type" : "Mixed",
- "desc" : "The value to set",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "setSize",
- "type" : "function",
- "desc" : "Sets the width and height of the component. This method fires the resize event. This method can accept\neither width and height as separate numeric arguments, or you can pass a size object like {width:10, height:20}.",
- "sig" : "(width, height)",
- "static" : false,
- "memberOf" : "Roo.BoxComponent",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "width",
- "type" : "Number/Object",
- "desc" : "The new width to set, or a size object in the format {width, height}",
- "isOptional" : false
- },
- {
- "name" : "height",
- "type" : "Number",
- "desc" : "The new height to set (not required if a size object is passed as the first arg)",
- "isOptional" : false
- }
- ],
- "returns" : [
- {
- "name" : "",
- "type" : "Roo.BoxComponent",
- "desc" : "this"
- }
- ]
- },
- {
- "name" : "setValue",
- "type" : "function",
- "desc" : "Sets a data value into the field and validates it. To set the value directly without validation see {@link #setRawValue}.",
- "sig" : "(value)",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "value",
- "type" : "Mixed",
- "desc" : "The value to set",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
{
"name" : "setVisible",
"type" : "function",
}
]
},
- {
- "name" : "syncSize",
- "type" : "function",
- "desc" : "Force the component's size to recalculate based on the underlying element's current height and width.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.BoxComponent",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
{
"name" : "un",
"type" : "function",
}
],
"returns" : []
- },
- {
- "name" : "updateBox",
- "type" : "function",
- "desc" : "Sets the current box measurements of the component's underlying element.",
- "sig" : "(box)",
- "static" : false,
- "memberOf" : "Roo.BoxComponent",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "box",
- "type" : "Object",
- "desc" : "An object in the format {x, y, width, height}",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "validate",
- "type" : "function",
- "desc" : "Validates the field value",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.form.Field",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : [
- {
- "name" : "",
- "type" : "Boolean",
- "desc" : "True if the value is valid, else false"
- }
- ]
- },
- {
- "name" : "validateValue",
- "type" : "function",
- "desc" : "Validates a value according to the field's validation rules and marks the field as invalid\nif the validation fails",
- "sig" : "(value)",
- "static" : false,
- "memberOf" : "Roo.form.TextField",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "value",
- "type" : "Mixed",
- "desc" : "The value to validate",
- "isOptional" : false
- }
- ],
- "returns" : [
- {
- "name" : "",
- "type" : "Boolean",
- "desc" : "True if the value is valid, else false"
- }
- ]
}
],
"isAbstract" : false,
"isBuilderTop" : false,
- "childClasses" : { },
- "tree_children" : [],
+ "implementations" : [],
+ "tree_children" : [
+ "Roo.form.Column",
+ "Roo.form.Row",
+ "Roo.form.Field",
+ "Roo.form.Checkbox",
+ "Roo.form.ComboBox",
+ "Roo.form.ComboBoxArray",
+ "Roo.form.ComboCheck",
+ "Roo.form.ComboNested",
+ "Roo.form.DateField",
+ "Roo.form.DayPicker",
+ "Roo.form.DisplayField",
+ "Roo.form.FCKeditor",
+ "Roo.form.GridField",
+ "Roo.form.Hidden",
+ "Roo.form.HtmlEditor",
+ "Roo.form.MonthField",
+ "Roo.form.NumberField",
+ "Roo.form.Radio",
+ "Roo.form.Select",
+ "Roo.form.Signature",
+ "Roo.form.TextArea",
+ "Roo.form.TextField",
+ "Roo.form.TriggerField",
+ "Roo.Button",
+ "Roo.SplitButton",
+ "Roo.Toolbar.Button",
+ "Roo.Toolbar.SplitButton",
+ "Roo.form.TextItem"
+ ],
"tree_parent" : []
},
- "Roo.form.Field" : {
+ "Roo.form.Form" : {
"props" : [
{
- "name" : "actionMode",
+ "name" : "(left|center|right)",
"type" : "String",
- "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el' for forms you probably want to set this to fieldEl",
- "memberOf" : "Roo.Component"
+ "desc" : "buttonAlign Valid values are \"left,\" \"center\" and \"right\" (defaults to \"center\")",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
- "name" : "allowDomMove",
- "type" : "Boolean",
- "desc" : "Whether the component can move the Dom node when rendering (defaults to true).",
- "memberOf" : "Roo.Component"
+ "name" : "baseParams",
+ "type" : "Object",
+ "desc" : "Parameters to pass with all requests. e.g. baseParams: {id: '123', foo: 'bar'}.",
+ "memberOf" : "Roo.form.BasicForm",
+ "isOptional" : false,
+ "optvals" : []
},
{
- "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" : "buttons[]",
+ "type" : "Roo.Button",
+ "desc" : "buttons at bottom of form",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
- "name" : "cls",
- "type" : "String",
- "desc" : "A CSS class to apply to the field's underlying element.",
- "memberOf" : ""
+ "name" : "errorMask",
+ "type" : "Boolean",
+ "desc" : "e) default fal",
+ "memberOf" : "Roo.form.BasicForm",
+ "isOptional" : false,
+ "optvals" : [
+ "true",
+ "false"
+ ]
},
{
- "name" : "disableClass",
- "type" : "String",
- "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").",
- "memberOf" : "Roo.Component"
+ "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",
+ "isOptional" : false,
+ "optvals" : []
},
{
- "name" : "disabled",
+ "name" : "fileUpload",
"type" : "Boolean",
- "desc" : "True to disable the field (defaults to false).",
- "memberOf" : ""
+ "desc" : "Set to true if this form is a file upload.",
+ "memberOf" : "Roo.form.BasicForm",
+ "isOptional" : false,
+ "optvals" : []
},
{
- "name" : "fieldClass",
- "type" : "String",
- "desc" : "The default CSS class for the field (defaults to \"x-form-field\")",
- "memberOf" : ""
+ "name" : "formData",
+ "type" : "boolean|FormData",
+ "desc" : "- true to use new 'FormData' post, or set to a new FormData({dom form}) Object, if\nsending a formdata with extra parameters - eg uploaded elements.",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
- "name" : "fieldLabel",
+ "name" : "itemCls",
"type" : "String",
- "desc" : "Label to use when rendering a form.",
- "memberOf" : ""
+ "desc" : "A css class to apply to the x-form-item of fields. This property cascades to child containers.",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
- "name" : "focusClass",
+ "name" : "labelAlign",
"type" : "String",
- "desc" : "The CSS class to use when the field receives focus (defaults to \"x-form-focus\")",
- "memberOf" : ""
+ "desc" : "t) Valid values are \"left,\" \"top\" and \"right\" (defaults to \"left\").\nThis property cascades to child containers if not se",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : [
+ "left",
+ "top",
+ "right"
+ ]
},
{
- "name" : "height",
+ "name" : "labelWidth",
"type" : "Number",
- "desc" : "height (optional) size of component",
- "memberOf" : "Roo.BoxComponent"
- },
- {
- "name" : "hideMode",
- "type" : "String",
- "desc" : "y)\nHow this component 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" : "inputType",
- "type" : "String",
- "desc" : "The type attribute for input fields -- e.g. radio, text, password (defaults to \"text\").",
- "memberOf" : ""
- },
- {
- "name" : "invalidClass",
- "type" : "String",
- "desc" : "The CSS class to use when marking a field invalid (defaults to \"x-form-invalid\")",
- "memberOf" : ""
- },
- {
- "name" : "invalidText",
- "type" : "String",
- "desc" : "The error text to use when marking a field invalid and no message is provided (defaults to \"The value in this field is invalid\")",
- "memberOf" : ""
+ "desc" : "The width of labels. This property cascades to child containers.",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"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"
+ "memberOf" : "Roo.util.Observable",
+ "isOptional" : false,
+ "optvals" : []
},
{
- "name" : "msgFx",
- "type" : "String",
- "desc" : "<b>Experimental</b> The effect used when displaying a validation message under the field (defaults to 'normal').",
- "memberOf" : ""
+ "name" : "maskOffset",
+ "type" : "Number",
+ "desc" : "Default 100",
+ "memberOf" : "Roo.form.BasicForm",
+ "isOptional" : false,
+ "optvals" : []
},
{
- "name" : "msgTarget",
+ "name" : "method",
"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" : "The request method to use (GET or POST) for form actions if one isn't supplied in the action options.",
+ "memberOf" : "Roo.form.BasicForm",
+ "isOptional" : false,
+ "optvals" : []
},
{
- "name" : "name",
- "type" : "String",
- "desc" : "The field's HTML name attribute.",
- "memberOf" : ""
+ "name" : "minButtonWidth",
+ "type" : "Number",
+ "desc" : "Minimum width of all buttons in pixels (defaults to 75)",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
- "name" : "qtip",
- "type" : "String",
- "desc" : "Mouse over tip",
- "memberOf" : ""
+ "name" : "monitorPoll",
+ "type" : "Number",
+ "desc" : "The milliseconds to poll valid state, ignored if monitorValid is not true (defaults to 200)",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
- "name" : "readOnly",
+ "name" : "monitorValid",
"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" : ""
+ "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" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
- "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" : "progressUrl",
+ "type" : "String",
+ "desc" : "- Url to return progress data",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
- "name" : "validateOnBlur",
- "type" : "Boolean",
- "desc" : "Whether the field should validate when it loses focus (defaults to true).",
- "memberOf" : ""
+ "name" : "reader",
+ "type" : "DataReader",
+ "desc" : "An Roo.data.DataReader (e.g. {@link Roo.data.XmlReader}) to be used to read data when executing \"load\" actions.\nThis is optional as there is built-in support for processing JSON.",
+ "memberOf" : "Roo.form.BasicForm",
+ "isOptional" : false,
+ "optvals" : []
},
{
- "name" : "validationDelay",
+ "name" : "timeout",
"type" : "Number",
- "desc" : "The length of time in milliseconds after user input begins until validation is initiated (defaults to 250)",
- "memberOf" : ""
- },
- {
- "name" : "validationEvent",
- "type" : "String/Boolean",
- "desc" : "The event that should initiate field validation. Set to false to disable\n automatic validation (defaults to \"keyup\").",
- "memberOf" : ""
+ "desc" : "Timeout for form actions in seconds (default is 30 seconds).",
+ "memberOf" : "Roo.form.BasicForm",
+ "isOptional" : false,
+ "optvals" : []
},
{
- "name" : "value",
- "type" : "Mixed",
- "desc" : "A value to initialize this field with.",
- "memberOf" : ""
+ "name" : "trackResetOnLoad",
+ "type" : "Boolean",
+ "desc" : "If set to true, form.reset() resets to the last loaded\nor setValues() data instead of when the form was first created.",
+ "memberOf" : "Roo.form.BasicForm",
+ "isOptional" : false,
+ "optvals" : []
},
{
- "name" : "width",
- "type" : "Number",
- "desc" : "width (optional) size of component",
- "memberOf" : "Roo.BoxComponent"
+ "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",
+ "isOptional" : false,
+ "optvals" : []
}
],
"events" : [
{
- "name" : "beforedestroy",
- "type" : "function",
- "desc" : "Fires before the component is destroyed. Return false to stop the destroy.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.Component",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "beforehide",
- "type" : "function",
- "desc" : "Fires before the component is hidden. Return false to stop the hide.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.Component",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "beforerender",
- "type" : "function",
- "desc" : "Fires before the component is rendered. Return false to stop the render.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.Component",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "beforeshow",
- "type" : "function",
- "desc" : "Fires before the component is shown. Return false to stop the show.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.Component",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "blur",
- "type" : "function",
- "desc" : "Fires when this field loses input focus.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.form.Field",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "change",
- "type" : "function",
- "desc" : "Fires just before the field blurs if the field value has changed.",
- "sig" : "function (_self, newValue, oldValue)\n{\n\n}",
- "memberOf" : "",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.form.Field",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "newValue",
- "type" : "Mixed",
- "desc" : "The new value",
- "isOptional" : false
- },
- {
- "name" : "oldValue",
- "type" : "Mixed",
- "desc" : "The original value",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "destroy",
- "type" : "function",
- "desc" : "Fires after the component is destroyed.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.Component",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "disable",
- "type" : "function",
- "desc" : "Fires after the component is disabled.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.Component",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "enable",
- "type" : "function",
- "desc" : "Fires after the component is enabled.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.Component",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "focus",
- "type" : "function",
- "desc" : "Fires when this field receives input focus.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.form.Field",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "hide",
- "type" : "function",
- "desc" : "Fires after the component is hidden.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.Component",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "invalid",
- "type" : "function",
- "desc" : "Fires after the field has been marked as invalid.",
- "sig" : "function (_self, msg)\n{\n\n}",
- "memberOf" : "",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.form.Field",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "msg",
- "type" : "String",
- "desc" : "The validation message",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "keyup",
+ "name" : "actioncomplete",
"type" : "function",
- "desc" : "Fires after the key up",
- "sig" : "function (_self, e)\n{\n\n}",
- "memberOf" : "",
+ "desc" : "Fires when an action is completed.",
+ "sig" : "function (_self, action)\n{\n\n}",
+ "memberOf" : "Roo.form.BasicForm",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.form.Field",
+ "type" : "Form",
"desc" : "",
"isOptional" : false
},
{
- "name" : "e",
- "type" : "Roo.EventObject",
- "desc" : "The event Object",
+ "name" : "action",
+ "type" : "Action",
+ "desc" : "The action that completed",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "move",
+ "name" : "actionfailed",
"type" : "function",
- "desc" : "Fires after the component is moved.",
- "sig" : "function (_self, x, y)\n{\n\n}",
- "memberOf" : "Roo.BoxComponent",
+ "desc" : "Fires when an action fails.",
+ "sig" : "function (_self, action)\n{\n\n}",
+ "memberOf" : "Roo.form.BasicForm",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.Component",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "x",
- "type" : "Number",
- "desc" : "The new x position",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Form",
+ "desc" : "",
"isOptional" : false
},
{
- "name" : "y",
- "type" : "Number",
- "desc" : "The new y position",
+ "name" : "action",
+ "type" : "Action",
+ "desc" : "The action that failed",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "render",
+ "name" : "beforeaction",
"type" : "function",
- "desc" : "Fires after the component is rendered.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
+ "desc" : "Fires before any action is performed. Return false to cancel the action.",
+ "sig" : "function (_self, action)\n{\n\n}",
+ "memberOf" : "Roo.form.BasicForm",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.Component",
+ "type" : "Form",
"desc" : "",
"isOptional" : false
+ },
+ {
+ "name" : "action",
+ "type" : "Action",
+ "desc" : "The action to be performed",
+ "isOptional" : false
}
],
"returns" : []
},
{
- "name" : "resize",
+ "name" : "clientvalidation",
"type" : "function",
- "desc" : "Fires after the component is resized.",
- "sig" : "function (_self, adjWidth, adjHeight, rawWidth, rawHeight)\n{\n\n}",
- "memberOf" : "Roo.BoxComponent",
+ "desc" : "If the monitorValid config option is true, this event fires repetitively to notify of valid state",
+ "sig" : "function (_self, valid)\n{\n\n}",
+ "memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.Component",
+ "type" : "Form",
"desc" : "",
"isOptional" : false
},
{
- "name" : "adjWidth",
- "type" : "Number",
- "desc" : "The box-adjusted width that was set",
- "isOptional" : false
- },
- {
- "name" : "adjHeight",
- "type" : "Number",
- "desc" : "The box-adjusted height that was set",
- "isOptional" : false
- },
- {
- "name" : "rawWidth",
- "type" : "Number",
- "desc" : "The width that was originally specified",
- "isOptional" : false
- },
- {
- "name" : "rawHeight",
- "type" : "Number",
- "desc" : "The height that was originally specified",
+ "name" : "valid",
+ "type" : "Boolean",
+ "desc" : "true if the form has passed client-side validation",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "show",
+ "name" : "rendered",
"type" : "function",
- "desc" : "Fires after the component is shown.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
+ "desc" : "Fires when the form is rendered",
+ "sig" : "function (form)\n{\n\n}",
+ "memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
"params" : [
{
- "name" : "this",
- "type" : "Roo.Component",
+ "name" : "form",
+ "type" : "Roo.form.Form",
"desc" : "",
"isOptional" : false
}
],
"returns" : []
- },
+ }
+ ],
+ "methods" : [
{
- "name" : "specialkey",
+ "name" : "add",
"type" : "function",
- "desc" : "Fires when any key related to navigation (arrows, tab, enter, esc, etc.) is pressed. You can check\n{@link Roo.EventObject#getKey} to determine which key was pressed.",
- "sig" : "function (_self, e)\n{\n\n}",
+ "desc" : "Add Roo.form components to the current open container (e.g. column, fieldset, etc.). Fields added via this method\ncan also be passed with an additional property of fieldLabel, which if supplied, will provide the text to display\nas the label of the field.",
+ "sig" : "(field1, field2)",
+ "static" : false,
"memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
- "name" : "this",
- "type" : "Roo.form.Field",
+ "name" : "field1",
+ "type" : "Field",
"desc" : "",
"isOptional" : false
},
{
- "name" : "e",
- "type" : "Roo.EventObject",
- "desc" : "The event object",
+ "name" : "field2",
+ "type" : "Field",
+ "desc" : "(optional)",
"isOptional" : false
}
],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Form",
+ "desc" : "this"
+ }
+ ]
},
{
- "name" : "valid",
+ "name" : "addButton",
"type" : "function",
- "desc" : "Fires after the field has been validated with no errors.",
- "sig" : "function (_self)\n{\n\n}",
+ "desc" : "Adds a button to the footer of the form - this <b>must</b> be called before the form is rendered.",
+ "sig" : "(config, handler, scope)",
+ "static" : false,
"memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
- "name" : "this",
- "type" : "Roo.form.Field",
- "desc" : "",
+ "name" : "config",
+ "type" : "String/Object",
+ "desc" : "A string becomes the button text, an object can either be a Button config\nobject or a valid Roo.DomHelper element config",
+ "isOptional" : false
+ },
+ {
+ "name" : "handler",
+ "type" : "Function",
+ "desc" : "The function called when the button is clicked",
+ "isOptional" : false
+ },
+ {
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "(optional) The scope of the handler function",
"isOptional" : false
}
],
- "returns" : []
- }
- ],
- "methods" : [
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.Button",
+ "desc" : ""
+ }
+ ]
+ },
{
"name" : "addEvents",
"type" : "function",
],
"returns" : []
},
+ {
+ "name" : "addForm",
+ "type" : "function",
+ "desc" : "Add a secondary form to this one, \nUsed to provide tabbed forms. One form is primary, with hidden values \nwhich mirror the elements from the other forms.",
+ "sig" : "(form)",
+ "static" : false,
+ "memberOf" : "Roo.form.BasicForm",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "form",
+ "type" : "Roo.form.Form",
+ "desc" : "to add.",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
{
"name" : "addListener",
"type" : "function",
"returns" : []
},
{
- "name" : "applyTo",
+ "name" : "addxtype",
"type" : "function",
- "desc" : "Apply the behaviors of this component to an existing element. <b>This is used instead of render().</b>",
- "sig" : "(el)",
+ "desc" : "Adds a series of form elements (using the xtype property as the factory method.\nValid xtypes are: TextField, TextArea .... Button, Layout, FieldSet, Column, (and 'end' to close a block)",
+ "sig" : "(config)",
"static" : false,
"memberOf" : "",
"isStatic" : false,
"requires" : "",
"params" : [
{
- "name" : "el",
- "type" : "String/HTMLElement/Element",
- "desc" : "The id of the node, a DOM node or an existing Element",
+ "name" : "config",
+ "type" : "Object",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "applyIfToFields",
+ "type" : "function",
+ "desc" : "Calls {@link Ext#applyIf} for all field in this form with the passed object.",
+ "sig" : "(values)",
+ "static" : false,
+ "memberOf" : "Roo.form.BasicForm",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "values",
+ "type" : "Object",
+ "desc" : "",
"isOptional" : false
}
],
"returns" : [
{
"name" : "",
- "type" : "Roo.form.Field",
+ "type" : "BasicForm",
+ "desc" : "this"
+ }
+ ]
+ },
+ {
+ "name" : "applyToFields",
+ "type" : "function",
+ "desc" : "Calls {@link Ext#apply} for all fields in this form with the passed object.",
+ "sig" : "(values)",
+ "static" : false,
+ "memberOf" : "Roo.form.BasicForm",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "values",
+ "type" : "Object",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "BasicForm",
"desc" : "this"
}
]
{
"name" : "clearInvalid",
"type" : "function",
- "desc" : "Clear any invalid styles/messages for this field",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
- {
- "name" : "destroy",
- "type" : "function",
- "desc" : "Destroys this component by purging any event listeners, removing the component's element from the DOM,\nremoving the component from its {@link Roo.Container} (if applicable) and unregistering it from {@link Roo.ComponentMgr}.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.Component",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
- {
- "name" : "disable",
- "type" : "function",
- "desc" : "Disable this component.",
+ "desc" : "Clears all invalid messages in this form.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.Component",
+ "memberOf" : "Roo.form.BasicForm",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"returns" : [
{
"name" : "",
- "type" : "Roo.Component",
+ "type" : "BasicForm",
"desc" : "this"
}
]
},
{
- "name" : "enable",
+ "name" : "column",
"type" : "function",
- "desc" : "Enable this component.",
- "sig" : "()\n{\n\n}",
+ "desc" : "Opens a new {@link Roo.form.Column} container in the layout stack. If fields are passed after the config, the\nfields are added and the column is closed. If no fields are passed the column remains open\nuntil end() is called.",
+ "sig" : "(config, field1, field2, etc)",
"static" : false,
- "memberOf" : "Roo.Component",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
+ "params" : [
+ {
+ "name" : "config",
+ "type" : "Object",
+ "desc" : "The config to pass to the column",
+ "isOptional" : false
+ },
+ {
+ "name" : "field1",
+ "type" : "Field",
+ "desc" : "(optional)",
+ "isOptional" : false
+ },
+ {
+ "name" : "field2",
+ "type" : "Field",
+ "desc" : "(optional)",
+ "isOptional" : false
+ },
+ {
+ "name" : "etc",
+ "type" : "Field",
+ "desc" : "(optional)",
+ "isOptional" : false
+ }
+ ],
"returns" : [
{
"name" : "",
- "type" : "Roo.Component",
- "desc" : "this"
+ "type" : "",
+ "desc" : "Column The column container object"
}
]
},
{
- "name" : "fireEvent",
+ "name" : "container",
"type" : "function",
- "desc" : "Fires the specified event with the passed parameters (minus the event name).",
- "sig" : "(eventName, args)",
+ "desc" : "Opens a new {@link Roo.form.Layout} container in the layout stack. If fields are passed after the config, the\nfields are added and the container is closed. If no fields are passed the container remains open\nuntil end() is called.",
+ "sig" : "(config, field1, field2, etc)",
"static" : false,
- "memberOf" : "Roo.util.Observable",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "eventName",
- "type" : "String",
- "desc" : "",
+ "name" : "config",
+ "type" : "Object",
+ "desc" : "The config to pass to the Layout",
"isOptional" : false
},
{
- "name" : "args",
- "type" : "Object...",
- "desc" : "Variable number of parameters are passed to handlers",
+ "name" : "field1",
+ "type" : "Field",
+ "desc" : "(optional)",
+ "isOptional" : false
+ },
+ {
+ "name" : "field2",
+ "type" : "Field",
+ "desc" : "(optional)",
+ "isOptional" : false
+ },
+ {
+ "name" : "etc",
+ "type" : "Field",
+ "desc" : "(optional)",
"isOptional" : false
}
],
"returns" : [
{
"name" : "",
- "type" : "Boolean",
- "desc" : "returns false if any of the handlers return false otherwise it returns true"
+ "type" : "",
+ "desc" : "Layout The container object"
}
]
},
{
- "name" : "focus",
+ "name" : "doAction",
"type" : "function",
- "desc" : "Try to focus this component.",
- "sig" : "(selectText)",
+ "desc" : "Performs a predefined action (submit or load) or custom actions you define on this form.",
+ "sig" : "(actionName, options)",
"static" : false,
- "memberOf" : "Roo.Component",
+ "memberOf" : "Roo.form.BasicForm",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "selectText",
- "type" : "Boolean",
- "desc" : "True to also select the text in this component (if applicable)",
+ "name" : "actionName",
+ "type" : "String",
+ "desc" : "The name of the action type",
+ "isOptional" : false
+ },
+ {
+ "name" : "options",
+ "type" : "Object",
+ "desc" : "(optional) The options to pass to the action. All of the config options listed\nbelow are supported by both the submit and load actions unless otherwise noted (custom actions could also\naccept other config options):\n<pre>\nProperty Type Description\n---------------- --------------- ----------------------------------------------------------------------------------\nurl String The url for the action (defaults to the form's url)\nmethod String The form method to use (defaults to the form's method, or POST if not defined)\nparams String/Object The params to pass (defaults to the form's baseParams, or none if not defined)\nclientValidation Boolean Applies to submit only. Pass true to call form.isValid() prior to posting to\n validate the form on the client (defaults to false)\n</pre>",
"isOptional" : false
}
],
"returns" : [
{
"name" : "",
- "type" : "Roo.Component",
+ "type" : "BasicForm",
"desc" : "this"
}
]
},
{
- "name" : "getBox",
- "type" : "function",
- "desc" : "Gets the current box measurements of the component's underlying element.",
- "sig" : "(local)",
- "static" : false,
- "memberOf" : "Roo.BoxComponent",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "local",
- "type" : "Boolean",
- "desc" : "(optional) If true the element's left and top are returned instead of page XY (defaults to false)",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "getEl",
+ "name" : "end",
"type" : "function",
- "desc" : "Returns the underlying {@link Roo.Element}.",
+ "desc" : "Closes the current open container",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.Component",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"returns" : [
{
"name" : "",
- "type" : "Roo.Element",
- "desc" : "The element"
+ "type" : "Form",
+ "desc" : "this"
}
]
},
{
- "name" : "getId",
+ "name" : "fieldset",
"type" : "function",
- "desc" : "Returns the id of this component.",
- "sig" : "()\n{\n\n}",
+ "desc" : "Opens a new {@link Roo.form.FieldSet} container in the layout stack. If fields are passed after the config, the\nfields are added and the fieldset is closed. If no fields are passed the fieldset remains open\nuntil end() is called.",
+ "sig" : "(config, field1, field2, etc)",
"static" : false,
- "memberOf" : "Roo.Component",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
+ "params" : [
+ {
+ "name" : "config",
+ "type" : "Object",
+ "desc" : "The config to pass to the fieldset",
+ "isOptional" : false
+ },
+ {
+ "name" : "field1",
+ "type" : "Field",
+ "desc" : "(optional)",
+ "isOptional" : false
+ },
+ {
+ "name" : "field2",
+ "type" : "Field",
+ "desc" : "(optional)",
+ "isOptional" : false
+ },
+ {
+ "name" : "etc",
+ "type" : "Field",
+ "desc" : "(optional)",
+ "isOptional" : false
+ }
+ ],
"returns" : [
{
"name" : "",
- "type" : "String",
- "desc" : ""
+ "type" : "",
+ "desc" : "FieldSet The fieldset container object"
}
]
},
{
- "name" : "getName",
+ "name" : "findField",
"type" : "function",
- "desc" : "Returns the name attribute of the field if available",
- "sig" : "()\n{\n\n}",
+ "desc" : "Find a Roo.form.Field in this form by id, dataIndex, name or hiddenName",
+ "sig" : "(id)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.form.BasicForm",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
+ "params" : [
+ {
+ "name" : "id",
+ "type" : "String",
+ "desc" : "The value to search for",
+ "isOptional" : false
+ }
+ ],
"returns" : [
{
"name" : "",
- "type" : "String",
- "desc" : "name The field name"
+ "type" : "",
+ "desc" : "Field"
}
]
},
{
- "name" : "getPosition",
+ "name" : "findbyId",
"type" : "function",
- "desc" : "Gets the current XY position of the component's underlying element.",
- "sig" : "(local)",
+ "desc" : "Find any element that has been added to a form, using it's ID or name\nThis can include framesets, columns etc. along with regular fields..",
+ "sig" : "(id)",
"static" : false,
- "memberOf" : "Roo.BoxComponent",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "local",
- "type" : "Boolean",
- "desc" : "(optional) If true the element's left and top are returned instead of page XY (defaults to false)",
+ "name" : "id",
+ "type" : "String",
+ "desc" : "- id or name to find.",
"isOptional" : false
}
],
"returns" : [
{
"name" : "",
- "type" : "Array",
- "desc" : "The XY position of the element (e.g., [100, 200])"
+ "type" : "Element",
+ "desc" : "e - or false if nothing found."
}
]
},
{
- "name" : "getRawValue",
+ "name" : "fireEvent",
"type" : "function",
- "desc" : "Returns the raw data value which may or may not be a valid, defined value. To return a normalized value see {@link #getValue}.",
- "sig" : "()\n{\n\n}",
+ "desc" : "Fires the specified event with the passed parameters (minus the event name).",
+ "sig" : "(eventName, args)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.util.Observable",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
+ "params" : [
+ {
+ "name" : "eventName",
+ "type" : "String",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "args",
+ "type" : "Object...",
+ "desc" : "Variable number of parameters are passed to handlers",
+ "isOptional" : false
+ }
+ ],
"returns" : [
{
"name" : "",
- "type" : "Mixed",
- "desc" : "value The field value"
+ "type" : "Boolean",
+ "desc" : "returns false if any of the handlers return false otherwise it returns true"
}
]
},
{
- "name" : "getSize",
+ "name" : "getFieldValues",
"type" : "function",
- "desc" : "Gets the current size of the component's underlying element.",
- "sig" : "()\n{\n\n}",
+ "desc" : "Returns the fields in this form as an object with key/value pairs. \nThis differs from getValues as it calls getValue on each child item, rather than using dom data.\nNormally this will not return readOnly data",
+ "sig" : "(with_readonly)",
"static" : false,
- "memberOf" : "Roo.BoxComponent",
+ "memberOf" : "Roo.form.BasicForm",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
+ "params" : [
+ {
+ "name" : "with_readonly",
+ "type" : "Boolean",
+ "desc" : "return readonly field data.",
+ "isOptional" : false
+ }
+ ],
"returns" : [
{
"name" : "",
"type" : "Object",
- "desc" : "An object containing the element's size {width: (element width), height: (element height)}"
+ "desc" : ""
}
]
},
{
- "name" : "getValue",
+ "name" : "getValues",
"type" : "function",
- "desc" : "Returns the normalized data value (undefined or emptyText will be returned as ''). To return the raw value see {@link #getRawValue}.",
- "sig" : "()\n{\n\n}",
+ "desc" : "Returns the fields in this form as an object with key/value pairs. If multiple fields exist with the same name\nthey are returned as an array.",
+ "sig" : "(asString)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.form.BasicForm",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
+ "params" : [
+ {
+ "name" : "asString",
+ "type" : "Boolean",
+ "desc" : "(def)",
+ "isOptional" : false
+ }
+ ],
"returns" : [
{
"name" : "",
- "type" : "Mixed",
- "desc" : "value The field value"
+ "type" : "Object",
+ "desc" : ""
}
]
},
{
"name" : "hasChanged",
"type" : "function",
- "desc" : "checks the current value against the 'loaded' value.\nNote - will return false if 'resetHasChanged' has not been called first.",
+ "desc" : "Returns true if any fields in this form have changed since their original load. (New version)",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.form.BasicForm",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"exceptions" : "",
"requires" : "",
"params" : [],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "",
+ "desc" : "Boolean"
+ }
+ ]
},
{
"name" : "hasListener",
]
},
{
- "name" : "hide",
+ "name" : "invalidFields",
"type" : "function",
- "desc" : "Hide this component.",
+ "desc" : "Returns array of invalid form fields.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.Component",
+ "memberOf" : "Roo.form.BasicForm",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"returns" : [
{
"name" : "",
- "type" : "Roo.Component",
- "desc" : "this"
+ "type" : "",
+ "desc" : "Array"
}
]
},
{
"name" : "isDirty",
"type" : "function",
- "desc" : "Returns true if this field has been changed since it was originally loaded and is not disabled.\nDEPRICATED - it never worked well - use hasChanged/resetHasChanged.",
+ "desc" : "DEPRICATED Returns true if any fields in this form have changed since their original load.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.form.BasicForm",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"exceptions" : "",
"requires" : "",
"params" : [],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "",
+ "desc" : "Boolean"
+ }
+ ]
},
{
"name" : "isValid",
"type" : "function",
- "desc" : "Returns whether or not the field value is currently valid",
- "sig" : "(preventMark)",
+ "desc" : "Returns true if client-side validation on the form is successful.",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.form.BasicForm",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "",
+ "desc" : "Boolean"
+ }
+ ]
+ },
+ {
+ "name" : "load",
+ "type" : "function",
+ "desc" : "Shortcut to do a load action.",
+ "sig" : "(options)",
+ "static" : false,
+ "memberOf" : "Roo.form.BasicForm",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "preventMark",
- "type" : "Boolean",
- "desc" : "True to disable marking the field invalid",
+ "name" : "options",
+ "type" : "Object",
+ "desc" : "The options to pass to the action (see {@link #doAction} for details)",
"isOptional" : false
}
],
"returns" : [
{
"name" : "",
- "type" : "Boolean",
- "desc" : "True if the value is valid, else false"
+ "type" : "BasicForm",
+ "desc" : "this"
}
]
},
{
- "name" : "isVisible",
+ "name" : "loadRecord",
"type" : "function",
- "desc" : "Returns true if this component is visible.",
- "sig" : "()\n{\n\n}",
+ "desc" : "Loads an Roo.data.Record into this form.",
+ "sig" : "(record)",
"static" : false,
- "memberOf" : "Roo.Component",
+ "memberOf" : "Roo.form.BasicForm",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
- "returns" : []
+ "params" : [
+ {
+ "name" : "record",
+ "type" : "Record",
+ "desc" : "The record to load",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "BasicForm",
+ "desc" : "this"
+ }
+ ]
},
{
"name" : "markInvalid",
"type" : "function",
- "desc" : "Mark this field as invalid",
- "sig" : "(msg)",
+ "desc" : "Mark fields in this form invalid in bulk.",
+ "sig" : "(errors)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.form.BasicForm",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "msg",
- "type" : "String",
- "desc" : "The validation message",
+ "name" : "errors",
+ "type" : "Array/Object",
+ "desc" : "Either an array in the form [{id:'fieldId', msg:'The message'},...] or an object hash of {id: msg, id2: msg2}",
"isOptional" : false
}
],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "BasicForm",
+ "desc" : "this"
+ }
+ ]
},
{
"name" : "on",
"returns" : []
},
{
- "name" : "onPosition",
+ "name" : "purgeListeners",
"type" : "function",
- "desc" : "Called after the component is moved, this method is empty by default but can be implemented by any\nsubclass that needs to perform custom logic after a move occurs.",
- "sig" : "(x, y)",
+ "desc" : "Removes all listeners for this object",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.BoxComponent",
+ "memberOf" : "Roo.util.Observable",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "x",
- "type" : "Number",
- "desc" : "The new x position",
- "isOptional" : false
- },
- {
- "name" : "y",
- "type" : "Number",
- "desc" : "The new y position",
- "isOptional" : false
- }
- ],
+ "params" : [],
"returns" : []
},
{
- "name" : "onResize",
+ "name" : "releaseCapture",
"type" : "function",
- "desc" : "Called after the component is resized, this method is empty by default but can be implemented by any\nsubclass that needs to perform custom logic after a resize occurs.",
- "sig" : "(adjWidth, adjHeight, rawWidth, rawHeight)",
- "static" : false,
- "memberOf" : "Roo.BoxComponent",
- "isStatic" : false,
+ "desc" : "Removes <b>all</b> added captures from the Observable.",
+ "sig" : "(o)",
+ "static" : true,
+ "memberOf" : "Roo.util.Observable",
+ "isStatic" : true,
"isConstructor" : false,
"isPrivate" : false,
"example" : "",
"requires" : "",
"params" : [
{
- "name" : "adjWidth",
- "type" : "Number",
- "desc" : "The box-adjusted width that was set",
- "isOptional" : false
- },
- {
- "name" : "adjHeight",
- "type" : "Number",
- "desc" : "The box-adjusted height that was set",
- "isOptional" : false
- },
- {
- "name" : "rawWidth",
- "type" : "Number",
- "desc" : "The width that was originally specified",
- "isOptional" : false
- },
- {
- "name" : "rawHeight",
- "type" : "Number",
- "desc" : "The height that was originally specified",
+ "name" : "o",
+ "type" : "Observable",
+ "desc" : "The Observable to release",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "purgeListeners",
+ "name" : "remove",
"type" : "function",
- "desc" : "Removes all listeners for this object",
- "sig" : "()\n{\n\n}",
+ "desc" : "Removes a field from the items collection (does NOT remove its markup).",
+ "sig" : "(field)",
"static" : false,
- "memberOf" : "Roo.util.Observable",
+ "memberOf" : "Roo.form.BasicForm",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
- "returns" : []
- },
- {
- "name" : "releaseCapture",
- "type" : "function",
- "desc" : "Removes <b>all</b> added captures from the Observable.",
- "sig" : "(o)",
- "static" : true,
- "memberOf" : "Roo.util.Observable",
- "isStatic" : true,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
"params" : [
{
- "name" : "o",
- "type" : "Observable",
- "desc" : "The Observable to release",
+ "name" : "field",
+ "type" : "Field",
+ "desc" : "",
"isOptional" : false
}
],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "BasicForm",
+ "desc" : "this"
+ }
+ ]
},
{
"name" : "removeListener",
{
"name" : "render",
"type" : "function",
- "desc" : "If this is a lazy rendering component, render it to its container element.",
+ "desc" : "Render this form into the passed container. This should only be called once!",
"sig" : "(container)",
"static" : false,
- "memberOf" : "Roo.Component",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
{
"name" : "container",
"type" : "String/HTMLElement/Element",
- "desc" : "(optional) The element this component should be rendered into. If it is being applied to existing markup, this should be left off.",
+ "desc" : "The element this component should be rendered into",
"isOptional" : false
}
],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Form",
+ "desc" : "this"
+ }
+ ]
},
{
"name" : "reset",
"type" : "function",
- "desc" : "Resets the current field value to the originally loaded value and clears any validation messages",
+ "desc" : "Resets this form.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.form.BasicForm",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"exceptions" : "",
"requires" : "",
"params" : [],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "BasicForm",
+ "desc" : "this"
+ }
+ ]
},
{
"name" : "resetHasChanged",
"type" : "function",
- "desc" : "stores the current value in loadedValue",
+ "desc" : "Resets all hasChanged to 'false' -\nThe old 'isDirty' used 'original value..' however this breaks reset() and a few other things.\nSo hasChanged storage is only to be used for this purpose",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.form.BasicForm",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"exceptions" : "",
"requires" : "",
"params" : [],
- "returns" : []
- },
- {
- "name" : "setDisabled",
- "type" : "function",
- "desc" : "Convenience function for setting disabled/enabled by boolean.",
- "sig" : "(disabled)",
- "static" : false,
- "memberOf" : "Roo.Component",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
+ "returns" : [
{
- "name" : "disabled",
- "type" : "Boolean",
- "desc" : "",
- "isOptional" : false
+ "name" : "",
+ "type" : "",
+ "desc" : "Boolean"
}
- ],
- "returns" : []
+ ]
},
{
- "name" : "setPagePosition",
+ "name" : "setValues",
"type" : "function",
- "desc" : "Sets the page XY position of the component. To set the left and top instead, use {@link #setPosition}.\nThis method fires the move event.",
- "sig" : "(x, y)",
+ "desc" : "Set values for fields in this form in bulk.",
+ "sig" : "(values)",
"static" : false,
- "memberOf" : "Roo.BoxComponent",
+ "memberOf" : "Roo.form.BasicForm",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "x",
- "type" : "Number",
- "desc" : "The new x position",
- "isOptional" : false
- },
- {
- "name" : "y",
- "type" : "Number",
- "desc" : "The new y position",
+ "name" : "values",
+ "type" : "Array/Object",
+ "desc" : "Either an array in the form [{id:'fieldId', value:'foo'},...] or an object hash of {id: value, id2: value2}",
"isOptional" : false
}
],
- "returns" : []
- },
- {
- "name" : "setPosition",
- "type" : "function",
- "desc" : "Sets the left and top of the component. To set the page XY position instead, use {@link #setPagePosition}.\nThis method fires the move event.",
- "sig" : "(left, top)",
- "static" : false,
- "memberOf" : "Roo.BoxComponent",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "left",
- "type" : "Number",
- "desc" : "The new left",
- "isOptional" : false
- },
+ "returns" : [
{
- "name" : "top",
- "type" : "Number",
- "desc" : "The new top",
- "isOptional" : false
+ "name" : "",
+ "type" : "BasicForm",
+ "desc" : "this"
}
- ],
- "returns" : []
+ ]
},
{
- "name" : "setRawValue",
+ "name" : "start",
"type" : "function",
- "desc" : "Sets the underlying DOM field's value directly, bypassing validation. To set the value with validation see {@link #setValue}.",
- "sig" : "(value)",
+ "desc" : "Opens the passed container in the layout stack. The container can be any {@link Roo.form.Layout} or subclass.",
+ "sig" : "(container)",
"static" : false,
"memberOf" : "",
"isStatic" : false,
"requires" : "",
"params" : [
{
- "name" : "value",
- "type" : "Mixed",
- "desc" : "The value to set",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "setSize",
- "type" : "function",
- "desc" : "Sets the width and height of the component. This method fires the resize event. This method can accept\neither width and height as separate numeric arguments, or you can pass a size object like {width:10, height:20}.",
- "sig" : "(width, height)",
- "static" : false,
- "memberOf" : "Roo.BoxComponent",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "width",
- "type" : "Number/Object",
- "desc" : "The new width to set, or a size object in the format {width, height}",
- "isOptional" : false
- },
- {
- "name" : "height",
- "type" : "Number",
- "desc" : "The new height to set (not required if a size object is passed as the first arg)",
+ "name" : "container",
+ "type" : "Object",
+ "desc" : "A Roo.form.Layout or subclass of Layout",
"isOptional" : false
}
],
"returns" : [
{
"name" : "",
- "type" : "Roo.BoxComponent",
+ "type" : "Form",
"desc" : "this"
}
]
},
{
- "name" : "setValue",
+ "name" : "startMonitoring",
"type" : "function",
- "desc" : "Sets a data value into the field and validates it. To set the value directly without validation see {@link #setRawValue}.",
- "sig" : "(value)",
+ "desc" : "Starts monitoring of the valid state of this form. Usually this is done by passing the config\noption \"monitorValid\"",
+ "sig" : "()\n{\n\n}",
"static" : false,
"memberOf" : "",
"isStatic" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "value",
- "type" : "Mixed",
- "desc" : "The value to set",
- "isOptional" : false
- }
- ],
+ "params" : [],
"returns" : []
},
{
- "name" : "setVisible",
- "type" : "function",
- "desc" : "Convenience function to hide or show this component by boolean.",
- "sig" : "(visible)",
- "static" : false,
- "memberOf" : "Roo.Component",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "visible",
- "type" : "Boolean",
- "desc" : "True to show, false to hide",
- "isOptional" : false
- }
- ],
- "returns" : [
- {
- "name" : "",
- "type" : "Roo.Component",
- "desc" : "this"
- }
- ]
- },
- {
- "name" : "show",
+ "name" : "stopMonitoring",
"type" : "function",
- "desc" : "Show this component.",
+ "desc" : "Stops monitoring of the valid state of this form",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.Component",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"exceptions" : "",
"requires" : "",
"params" : [],
- "returns" : [
- {
- "name" : "",
- "type" : "Roo.Component",
- "desc" : "this"
- }
- ]
+ "returns" : []
},
{
- "name" : "syncSize",
+ "name" : "submit",
"type" : "function",
- "desc" : "Force the component's size to recalculate based on the underlying element's current height and width.",
- "sig" : "()\n{\n\n}",
+ "desc" : "Shortcut to do a submit action.",
+ "sig" : "(options)",
"static" : false,
- "memberOf" : "Roo.BoxComponent",
+ "memberOf" : "Roo.form.BasicForm",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
- "returns" : []
+ "params" : [
+ {
+ "name" : "options",
+ "type" : "Object",
+ "desc" : "The options to pass to the action (see {@link #doAction} for details)",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "BasicForm",
+ "desc" : "this"
+ }
+ ]
},
{
"name" : "un",
"returns" : []
},
{
- "name" : "updateBox",
+ "name" : "updateRecord",
"type" : "function",
- "desc" : "Sets the current box measurements of the component's underlying element.",
- "sig" : "(box)",
+ "desc" : "Persists the values in this form into the passed Roo.data.Record object in a beginEdit/endEdit block.",
+ "sig" : "(record)",
"static" : false,
- "memberOf" : "Roo.BoxComponent",
+ "memberOf" : "Roo.form.BasicForm",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "box",
- "type" : "Object",
- "desc" : "An object in the format {x, y, width, height}",
+ "name" : "record",
+ "type" : "Record",
+ "desc" : "The record to edit",
"isOptional" : false
}
],
- "returns" : []
- },
- {
- "name" : "validate",
- "type" : "function",
- "desc" : "Validates the field value",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
"returns" : [
{
"name" : "",
- "type" : "Boolean",
- "desc" : "True if the value is valid, else false"
+ "type" : "BasicForm",
+ "desc" : "this"
}
]
}
],
"isAbstract" : false,
"isBuilderTop" : false,
- "childClasses" : {
- "Roo.form.Field" : [
- "Roo.form.Checkbox",
- "Roo.form.DayPicker",
- "Roo.form.DisplayField",
- "Roo.form.GridField",
- "Roo.form.HtmlEditor",
- "Roo.form.Signature",
- "Roo.form.TextField"
- ],
- "Roo.form.TextArea" : [
- "Roo.form.FCKeditor"
- ],
- "Roo.form.Checkbox" : [
- "Roo.form.Radio"
- ],
- "Roo.form.TextField" : [
- "Roo.form.ComboBoxArray",
- "Roo.form.Hidden",
- "Roo.form.NumberField",
- "Roo.form.TextArea",
- "Roo.form.TriggerField"
- ],
- "Roo.form.TriggerField" : [
- "Roo.form.ComboBox",
- "Roo.form.DateField",
- "Roo.form.MonthField",
- "Roo.form.Select"
- ],
- "Roo.form.ComboBox" : [
- "Roo.form.ComboCheck",
- "Roo.form.ComboNested"
- ]
- },
- "tree_children" : [],
+ "implementations" : [],
+ "tree_children" : [
+ "Roo.form.Column",
+ "Roo.form.FieldSet",
+ "Roo.form.Row",
+ "Roo.form.Field",
+ "Roo.form.Checkbox",
+ "Roo.form.ComboBox",
+ "Roo.form.ComboBoxArray",
+ "Roo.form.ComboCheck",
+ "Roo.form.ComboNested",
+ "Roo.form.DateField",
+ "Roo.form.DayPicker",
+ "Roo.form.DisplayField",
+ "Roo.form.FCKeditor",
+ "Roo.form.GridField",
+ "Roo.form.Hidden",
+ "Roo.form.HtmlEditor",
+ "Roo.form.MonthField",
+ "Roo.form.NumberField",
+ "Roo.form.Radio",
+ "Roo.form.Select",
+ "Roo.form.Signature",
+ "Roo.form.TextArea",
+ "Roo.form.TextField",
+ "Roo.form.TriggerField",
+ "Roo.Button",
+ "Roo.SplitButton",
+ "Roo.Toolbar.Button",
+ "Roo.Toolbar.SplitButton",
+ "Roo.form.TextItem"
+ ],
"tree_parent" : []
},
- "Roo.form.FieldSet" : {
+ "Roo.form.GridField" : {
"props" : [
{
"name" : "actionMode",
"type" : "String",
"desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el' for forms you probably want to set this to fieldEl",
- "memberOf" : "Roo.Component"
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "addTitle",
+ "type" : "String",
+ "desc" : "Text to include for adding a title.",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "allowDomMove",
"type" : "Boolean",
"desc" : "Whether the component can move the Dom node when rendering (defaults to true).",
- "memberOf" : "Roo.Component"
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "autoCreate",
"type" : "String/Object",
- "desc" : "A DomHelper element spec used to autocreate the fieldset (defaults to {tag: 'fieldset', cn: {tag:'legend'}})",
- "memberOf" : ""
+ "desc" : "A DomHelper element spec, or true for a default element spec (defaults to\n{tag: \"input\", type: \"checkbox\", autocomplete: \"off\"})",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
- "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" : "cls",
+ "type" : "String",
+ "desc" : "A CSS class to apply to the field's underlying element.",
+ "memberOf" : "Roo.form.Field",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "disableClass",
"type" : "String",
"desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").",
- "memberOf" : "Roo.Component"
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
- "name" : "hideLabels",
+ "name" : "disabled",
"type" : "Boolean",
- "desc" : "True to suppress the display of field labels in this layout (defaults to false)",
- "memberOf" : "Roo.form.Layout"
+ "desc" : "True to disable the field (defaults to false).",
+ "memberOf" : "Roo.form.Field",
+ "isOptional" : false,
+ "optvals" : []
},
{
- "name" : "hideMode",
+ "name" : "fieldClass",
"type" : "String",
- "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".",
- "memberOf" : "Roo.Component"
+ "desc" : "The default CSS class for the field (defaults to \"x-form-field\")",
+ "memberOf" : "Roo.form.Field",
+ "isOptional" : false,
+ "optvals" : []
},
{
- "name" : "labelAlign",
+ "name" : "fieldLabel",
"type" : "String",
- "desc" : "Valid values are \"left,\" \"top\" and \"right\" (defaults to \"left\")",
- "memberOf" : "Roo.form.Layout"
+ "desc" : "Label to use when rendering a form.",
+ "memberOf" : "Roo.form.Field",
+ "isOptional" : false,
+ "optvals" : []
},
{
- "name" : "labelSeparator",
+ "name" : "focusClass",
"type" : "String",
- "desc" : "The separator to use after field labels (defaults to ':')",
- "memberOf" : "Roo.form.Layout"
+ "desc" : "The CSS class to use when the field receives focus (defaults to \"x-form-focus\")",
+ "memberOf" : "Roo.form.Field",
+ "isOptional" : false,
+ "optvals" : []
},
{
- "name" : "labelWidth",
+ "name" : "height",
"type" : "Number",
- "desc" : "Fixed width in pixels of all field labels (defaults to undefined)",
- "memberOf" : "Roo.form.Layout"
+ "desc" : "- used to restrict height of grid..",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
- "name" : "legend",
+ "name" : "hideMode",
"type" : "String",
- "desc" : "The text to display as the legend for the FieldSet (defaults to '')",
- "memberOf" : ""
+ "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display",
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : [
+ "display",
+ "visibility"
+ ]
+ },
+ {
+ "name" : "inputType",
+ "type" : "String",
+ "desc" : "The type attribute for input fields -- e.g. radio, text, password (defaults to \"text\").",
+ "memberOf" : "Roo.form.Field",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "invalidClass",
+ "type" : "String",
+ "desc" : "The CSS class to use when marking a field invalid (defaults to \"x-form-invalid\")",
+ "memberOf" : "Roo.form.Field",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "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",
+ "isOptional" : false,
+ "optvals" : []
},
{
"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"
+ "memberOf" : "Roo.util.Observable",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "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",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "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",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "name",
+ "type" : "String",
+ "desc" : "The field's HTML name attribute.",
+ "memberOf" : "Roo.form.Field",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "qtip",
+ "type" : "String",
+ "desc" : "Mouse over tip",
+ "memberOf" : "Roo.form.Field",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "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",
+ "isOptional" : false,
+ "optvals" : []
},
{
"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"
+ "type" : "String",
+ "desc" : "css styles to add to component\neg. text-align:right;",
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "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",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "validateOnBlur",
+ "type" : "Boolean",
+ "desc" : "Whether the field should validate when it loses focus (defaults to true).",
+ "memberOf" : "Roo.form.Field",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "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",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "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",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "value",
+ "type" : "Mixed",
+ "desc" : "A value to initialize this field with.",
+ "memberOf" : "Roo.form.Field",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "width",
+ "type" : "Number",
+ "desc" : "- used to restrict width of grid..",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "xgrid",
+ "type" : "Object",
+ "desc" : "(xtype'd description of grid) { xtype : 'Grid', dataSource: .... }\n\n}",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
}
],
"events" : [
],
"returns" : []
},
+ {
+ "name" : "blur",
+ "type" : "function",
+ "desc" : "Fires when this field loses input focus.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.form.Field",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.form.Field",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "change",
+ "type" : "function",
+ "desc" : "Fires just before the field blurs if the field value has changed.",
+ "sig" : "function (_self, newValue, oldValue)\n{\n\n}",
+ "memberOf" : "Roo.form.Field",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.form.Field",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "newValue",
+ "type" : "Mixed",
+ "desc" : "The new value",
+ "isOptional" : false
+ },
+ {
+ "name" : "oldValue",
+ "type" : "Mixed",
+ "desc" : "The original value",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
{
"name" : "destroy",
"type" : "function",
],
"returns" : []
},
+ {
+ "name" : "focus",
+ "type" : "function",
+ "desc" : "Fires when this field receives input focus.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.form.Field",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.form.Field",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
{
"name" : "hide",
"type" : "function",
],
"returns" : []
},
+ {
+ "name" : "invalid",
+ "type" : "function",
+ "desc" : "Fires after the field has been marked as invalid.",
+ "sig" : "function (_self, msg)\n{\n\n}",
+ "memberOf" : "Roo.form.Field",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.form.Field",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "msg",
+ "type" : "String",
+ "desc" : "The validation message",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "keyup",
+ "type" : "function",
+ "desc" : "Fires after the key up",
+ "sig" : "function (_self, e)\n{\n\n}",
+ "memberOf" : "Roo.form.Field",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.form.Field",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "e",
+ "type" : "Roo.EventObject",
+ "desc" : "The event Object",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "move",
+ "type" : "function",
+ "desc" : "Fires after the component is moved.",
+ "sig" : "function (_self, x, y)\n{\n\n}",
+ "memberOf" : "Roo.BoxComponent",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.Component",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "x",
+ "type" : "Number",
+ "desc" : "The new x position",
+ "isOptional" : false
+ },
+ {
+ "name" : "y",
+ "type" : "Number",
+ "desc" : "The new y position",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
{
"name" : "render",
"type" : "function",
],
"returns" : []
},
+ {
+ "name" : "resize",
+ "type" : "function",
+ "desc" : "Fires after the component is resized.",
+ "sig" : "function (_self, adjWidth, adjHeight, rawWidth, rawHeight)\n{\n\n}",
+ "memberOf" : "Roo.BoxComponent",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.Component",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "adjWidth",
+ "type" : "Number",
+ "desc" : "The box-adjusted width that was set",
+ "isOptional" : false
+ },
+ {
+ "name" : "adjHeight",
+ "type" : "Number",
+ "desc" : "The box-adjusted height that was set",
+ "isOptional" : false
+ },
+ {
+ "name" : "rawWidth",
+ "type" : "Number",
+ "desc" : "The width that was originally specified",
+ "isOptional" : false
+ },
+ {
+ "name" : "rawHeight",
+ "type" : "Number",
+ "desc" : "The height that was originally specified",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
{
"name" : "show",
"type" : "function",
}
],
"returns" : []
+ },
+ {
+ "name" : "specialkey",
+ "type" : "function",
+ "desc" : "Fires when any key related to navigation (arrows, tab, enter, esc, etc.) is pressed. You can check\n{@link Roo.EventObject#getKey} to determine which key was pressed.",
+ "sig" : "function (_self, e)\n{\n\n}",
+ "memberOf" : "Roo.form.Field",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.form.Field",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "e",
+ "type" : "Roo.EventObject",
+ "desc" : "The event object",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "valid",
+ "type" : "function",
+ "desc" : "Fires after the field has been validated with no errors.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.form.Field",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.form.Field",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
}
],
"methods" : [
"returns" : []
},
{
- "name" : "addxtype",
+ "name" : "applyTo",
"type" : "function",
- "desc" : "Adds a object form elements (using the xtype property as the factory method.)\nValid xtypes are: TextField, TextArea .... Button, Layout, FieldSet, Column",
- "sig" : "(config)",
+ "desc" : "Apply the behaviors of this component to an existing element. <b>This is used instead of render().</b>",
+ "sig" : "(el)",
"static" : false,
- "memberOf" : "Roo.form.Layout",
+ "memberOf" : "Roo.form.Field",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "config",
- "type" : "Object",
- "desc" : "",
+ "name" : "el",
+ "type" : "String/HTMLElement/Element",
+ "desc" : "The id of the node, a DOM node or an existing Element",
"isOptional" : false
}
],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.form.Field",
+ "desc" : "this"
+ }
+ ]
},
{
"name" : "capture",
],
"returns" : []
},
+ {
+ "name" : "clearInvalid",
+ "type" : "function",
+ "desc" : "Clear any invalid styles/messages for this field",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.form.Field",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
{
"name" : "destroy",
"type" : "function",
}
]
},
+ {
+ "name" : "getBox",
+ "type" : "function",
+ "desc" : "Gets the current box measurements of the component's underlying element.",
+ "sig" : "(local)",
+ "static" : false,
+ "memberOf" : "Roo.BoxComponent",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "local",
+ "type" : "Boolean",
+ "desc" : "(optional) If true the element's left and top are returned instead of page XY (defaults to false)",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
{
"name" : "getEl",
"type" : "function",
}
]
},
+ {
+ "name" : "getName",
+ "type" : "function",
+ "desc" : "Returns the name attribute of the field if available",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.form.Field",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "String",
+ "desc" : "name The field name"
+ }
+ ]
+ },
+ {
+ "name" : "getPosition",
+ "type" : "function",
+ "desc" : "Gets the current XY position of the component's underlying element.",
+ "sig" : "(local)",
+ "static" : false,
+ "memberOf" : "Roo.BoxComponent",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "local",
+ "type" : "Boolean",
+ "desc" : "(optional) If true the element's left and top are returned instead of page XY (defaults to false)",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Array",
+ "desc" : "The XY position of the element (e.g., [100, 200])"
+ }
+ ]
+ },
+ {
+ "name" : "getRawValue",
+ "type" : "function",
+ "desc" : "Returns the raw data value which may or may not be a valid, defined value. To return a normalized value see {@link #getValue}.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.form.Field",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Mixed",
+ "desc" : "value The field value"
+ }
+ ]
+ },
+ {
+ "name" : "getSize",
+ "type" : "function",
+ "desc" : "Gets the current size of the component's underlying element.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.BoxComponent",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Object",
+ "desc" : "An object containing the element's size {width: (element width), height: (element height)}"
+ }
+ ]
+ },
+ {
+ "name" : "getValue",
+ "type" : "function",
+ "desc" : "Returns the normalized data value (undefined or emptyText will be returned as ''). To return the raw value see {@link #getRawValue}.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.form.Field",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Mixed",
+ "desc" : "value The field value"
+ }
+ ]
+ },
+ {
+ "name" : "hasChanged",
+ "type" : "function",
+ "desc" : "checks the current value against the 'loaded' value.\nNote - will return false if 'resetHasChanged' has not been called first.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.form.Field",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
{
"name" : "hasListener",
"type" : "function",
}
]
},
+ {
+ "name" : "isDirty",
+ "type" : "function",
+ "desc" : "Returns true if this field has been changed since it was originally loaded and is not disabled.\nDEPRICATED - it never worked well - use hasChanged/resetHasChanged.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.form.Field",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
+ {
+ "name" : "isValid",
+ "type" : "function",
+ "desc" : "Returns whether or not the field value is currently valid",
+ "sig" : "(preventMark)",
+ "static" : false,
+ "memberOf" : "Roo.form.Field",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "preventMark",
+ "type" : "Boolean",
+ "desc" : "True to disable marking the field invalid",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Boolean",
+ "desc" : "True if the value is valid, else false"
+ }
+ ]
+ },
{
"name" : "isVisible",
"type" : "function",
"params" : [],
"returns" : []
},
+ {
+ "name" : "markInvalid",
+ "type" : "function",
+ "desc" : "Mark this field as invalid",
+ "sig" : "(msg)",
+ "static" : false,
+ "memberOf" : "Roo.form.Field",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "msg",
+ "type" : "String",
+ "desc" : "The validation message",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
{
"name" : "on",
"type" : "function",
],
"returns" : []
},
+ {
+ "name" : "onPosition",
+ "type" : "function",
+ "desc" : "Called after the component is moved, this method is empty by default but can be implemented by any\nsubclass that needs to perform custom logic after a move occurs.",
+ "sig" : "(x, y)",
+ "static" : false,
+ "memberOf" : "Roo.BoxComponent",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "x",
+ "type" : "Number",
+ "desc" : "The new x position",
+ "isOptional" : false
+ },
+ {
+ "name" : "y",
+ "type" : "Number",
+ "desc" : "The new y position",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "onResize",
+ "type" : "function",
+ "desc" : "Called after the component is resized, this method is empty by default but can be implemented by any\nsubclass that needs to perform custom logic after a resize occurs.",
+ "sig" : "(adjWidth, adjHeight, rawWidth, rawHeight)",
+ "static" : false,
+ "memberOf" : "Roo.BoxComponent",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "adjWidth",
+ "type" : "Number",
+ "desc" : "The box-adjusted width that was set",
+ "isOptional" : false
+ },
+ {
+ "name" : "adjHeight",
+ "type" : "Number",
+ "desc" : "The box-adjusted height that was set",
+ "isOptional" : false
+ },
+ {
+ "name" : "rawWidth",
+ "type" : "Number",
+ "desc" : "The width that was originally specified",
+ "isOptional" : false
+ },
+ {
+ "name" : "rawHeight",
+ "type" : "Number",
+ "desc" : "The height that was originally specified",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
{
"name" : "purgeListeners",
"type" : "function",
"requires" : "",
"params" : [
{
- "name" : "o",
- "type" : "Observable",
- "desc" : "The Observable to release",
+ "name" : "o",
+ "type" : "Observable",
+ "desc" : "The Observable to release",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "removeListener",
+ "type" : "function",
+ "desc" : "Removes a listener",
+ "sig" : "(eventName, handler, scope)",
+ "static" : false,
+ "memberOf" : "Roo.util.Observable",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "eventName",
+ "type" : "String",
+ "desc" : "The type of event to listen for",
+ "isOptional" : false
+ },
+ {
+ "name" : "handler",
+ "type" : "Function",
+ "desc" : "The handler to remove",
+ "isOptional" : false
+ },
+ {
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "(optional) The scope (this object) for the handler",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "render",
+ "type" : "function",
+ "desc" : "If this is a lazy rendering component, render it to its container element.",
+ "sig" : "(container)",
+ "static" : false,
+ "memberOf" : "Roo.Component",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "container",
+ "type" : "String/HTMLElement/Element",
+ "desc" : "(optional) The element this component should be rendered into. If it is being applied to existing markup, this should be left off.",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "reset",
+ "type" : "function",
+ "desc" : "Resets the current field value to the originally loaded value and clears any validation messages",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.form.Field",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
+ {
+ "name" : "resetHasChanged",
+ "type" : "function",
+ "desc" : "stores the current value in loadedValue",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.form.Field",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
+ {
+ "name" : "setDisabled",
+ "type" : "function",
+ "desc" : "Convenience function for setting disabled/enabled by boolean.",
+ "sig" : "(disabled)",
+ "static" : false,
+ "memberOf" : "Roo.Component",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "disabled",
+ "type" : "Boolean",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "setPagePosition",
+ "type" : "function",
+ "desc" : "Sets the page XY position of the component. To set the left and top instead, use {@link #setPosition}.\nThis method fires the move event.",
+ "sig" : "(x, y)",
+ "static" : false,
+ "memberOf" : "Roo.BoxComponent",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "x",
+ "type" : "Number",
+ "desc" : "The new x position",
+ "isOptional" : false
+ },
+ {
+ "name" : "y",
+ "type" : "Number",
+ "desc" : "The new y position",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "setPosition",
+ "type" : "function",
+ "desc" : "Sets the left and top of the component. To set the page XY position instead, use {@link #setPagePosition}.\nThis method fires the move event.",
+ "sig" : "(left, top)",
+ "static" : false,
+ "memberOf" : "Roo.BoxComponent",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "left",
+ "type" : "Number",
+ "desc" : "The new left",
+ "isOptional" : false
+ },
+ {
+ "name" : "top",
+ "type" : "Number",
+ "desc" : "The new top",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "removeListener",
+ "name" : "setRawValue",
"type" : "function",
- "desc" : "Removes a listener",
- "sig" : "(eventName, handler, scope)",
+ "desc" : "Sets the underlying DOM field's value directly, bypassing validation. To set the value with validation see {@link #setValue}.",
+ "sig" : "(value)",
"static" : false,
- "memberOf" : "Roo.util.Observable",
+ "memberOf" : "Roo.form.Field",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "eventName",
- "type" : "String",
- "desc" : "The type of event to listen for",
- "isOptional" : false
- },
- {
- "name" : "handler",
- "type" : "Function",
- "desc" : "The handler to remove",
- "isOptional" : false
- },
- {
- "name" : "scope",
- "type" : "Object",
- "desc" : "(optional) The scope (this object) for the handler",
+ "name" : "value",
+ "type" : "Mixed",
+ "desc" : "The value to set",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "render",
+ "name" : "setSize",
"type" : "function",
- "desc" : "If this is a lazy rendering component, render it to its container element.",
- "sig" : "(container)",
+ "desc" : "Sets the width and height of the component. This method fires the resize event. This method can accept\neither width and height as separate numeric arguments, or you can pass a size object like {width:10, height:20}.",
+ "sig" : "(width, height)",
"static" : false,
- "memberOf" : "Roo.Component",
+ "memberOf" : "Roo.BoxComponent",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "container",
- "type" : "String/HTMLElement/Element",
- "desc" : "(optional) The element this component should be rendered into. If it is being applied to existing markup, this should be left off.",
+ "name" : "width",
+ "type" : "Number/Object",
+ "desc" : "The new width to set, or a size object in the format {width, height}",
+ "isOptional" : false
+ },
+ {
+ "name" : "height",
+ "type" : "Number",
+ "desc" : "The new height to set (not required if a size object is passed as the first arg)",
"isOptional" : false
}
],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.BoxComponent",
+ "desc" : "this"
+ }
+ ]
},
{
- "name" : "setDisabled",
+ "name" : "setValue",
"type" : "function",
- "desc" : "Convenience function for setting disabled/enabled by boolean.",
- "sig" : "(disabled)",
+ "desc" : "Sets the value of the item.",
+ "sig" : "(either)",
"static" : false,
- "memberOf" : "Roo.Component",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "disabled",
- "type" : "Boolean",
- "desc" : "",
+ "name" : "either",
+ "type" : "String",
+ "desc" : "an object or a string..",
"isOptional" : false
}
],
}
]
},
+ {
+ "name" : "syncSize",
+ "type" : "function",
+ "desc" : "Force the component's size to recalculate based on the underlying element's current height and width.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.BoxComponent",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
{
"name" : "un",
"type" : "function",
}
],
"returns" : []
+ },
+ {
+ "name" : "updateBox",
+ "type" : "function",
+ "desc" : "Sets the current box measurements of the component's underlying element.",
+ "sig" : "(box)",
+ "static" : false,
+ "memberOf" : "Roo.BoxComponent",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "box",
+ "type" : "Object",
+ "desc" : "An object in the format {x, y, width, height}",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "validate",
+ "type" : "function",
+ "desc" : "Validates the field value",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.form.Field",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Boolean",
+ "desc" : "True if the value is valid, else false"
+ }
+ ]
}
],
"isAbstract" : false,
"isBuilderTop" : false,
- "childClasses" : { },
- "tree_children" : [
- "Roo.form.Column",
- "Roo.form.Row",
- "Roo.form.Field",
- "Roo.form.Checkbox",
- "Roo.form.ComboBox",
- "Roo.form.ComboBoxArray",
- "Roo.form.ComboCheck",
- "Roo.form.ComboNested",
- "Roo.form.DateField",
- "Roo.form.DayPicker",
- "Roo.form.DisplayField",
- "Roo.form.FCKeditor",
- "Roo.form.GridField",
- "Roo.form.Hidden",
- "Roo.form.HtmlEditor",
- "Roo.form.MonthField",
- "Roo.form.NumberField",
- "Roo.form.Radio",
- "Roo.form.Select",
- "Roo.form.Signature",
- "Roo.form.TextArea",
- "Roo.form.TextField",
- "Roo.form.TriggerField",
- "Roo.Button",
- "Roo.SplitButton",
- "Roo.Toolbar.Button",
- "Roo.Toolbar.SplitButton",
- "Roo.form.TextItem"
- ],
+ "implementations" : [],
+ "tree_children" : [],
"tree_parent" : []
},
- "Roo.form.Form" : {
+ "Roo.form.Hidden" : {
"props" : [
{
- "name" : "baseParams",
- "type" : "Object",
- "desc" : "Parameters to pass with all requests. e.g. baseParams: {id: '123', foo: 'bar'}.",
- "memberOf" : "Roo.form.BasicForm"
+ "name" : "actionMode",
+ "type" : "String",
+ "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el' for forms you probably want to set this to fieldEl",
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
- "name" : "buttonAlign",
- "type" : "String",
- "desc" : "Valid values are \"left,\" \"center\" and \"right\" (defaults to \"center\")",
- "memberOf" : ""
+ "name" : "allowBlank",
+ "type" : "Boolean",
+ "desc" : "False to validate that the value length > 0 (defaults to true)",
+ "memberOf" : "Roo.form.TextField",
+ "isOptional" : false,
+ "optvals" : []
},
{
- "name" : "buttons[]",
- "type" : "Roo.Button",
- "desc" : "buttons at bottom of form",
- "memberOf" : ""
+ "name" : "allowDomMove",
+ "type" : "Boolean",
+ "desc" : "Whether the component can move the Dom node when rendering (defaults to true).",
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
- "name" : "errorMask",
+ "name" : "allowLeadingSpace",
"type" : "Boolean",
- "desc" : "e) default false",
- "memberOf" : "Roo.form.BasicForm"
+ "desc" : "True to prevent the stripping of leading white space",
+ "memberOf" : "Roo.form.TextField",
+ "isOptional" : false,
+ "optvals" : []
},
{
- "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" : "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",
+ "isOptional" : false,
+ "optvals" : []
},
{
- "name" : "fileUpload",
+ "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",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "cls",
+ "type" : "String",
+ "desc" : "A CSS class to apply to the field's underlying element.",
+ "memberOf" : "Roo.form.Field",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "disableClass",
+ "type" : "String",
+ "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").",
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "disableKeyFilter",
"type" : "Boolean",
- "desc" : "Set to true if this form is a file upload.",
- "memberOf" : "Roo.form.BasicForm"
+ "desc" : "True to disable input keystroke filtering (defaults to false)",
+ "memberOf" : "Roo.form.TextField",
+ "isOptional" : false,
+ "optvals" : []
},
{
- "name" : "formData",
- "type" : "boolean|FormData",
- "desc" : "- true to use new 'FormData' post, or set to a new FormData({dom form}) Object, if\nsending a formdata with extra parameters - eg uploaded elements.",
- "memberOf" : ""
+ "name" : "disabled",
+ "type" : "Boolean",
+ "desc" : "True to disable the field (defaults to false).",
+ "memberOf" : "Roo.form.Field",
+ "isOptional" : false,
+ "optvals" : []
},
{
- "name" : "itemCls",
+ "name" : "emptyText",
"type" : "String",
- "desc" : "A css class to apply to the x-form-item of fields. This property cascades to child containers.",
- "memberOf" : ""
+ "desc" : "The default text to display in an empty field - placeholder... (defaults to null).",
+ "memberOf" : "Roo.form.TextField",
+ "isOptional" : false,
+ "optvals" : []
},
{
- "name" : "labelAlign",
+ "name" : "fieldClass",
"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 default CSS class for the field (defaults to \"x-form-field\")",
+ "memberOf" : "Roo.form.Field",
+ "isOptional" : false,
+ "optvals" : []
},
{
- "name" : "labelWidth",
+ "name" : "fieldLabel",
+ "type" : "String",
+ "desc" : "Label to use when rendering a form.",
+ "memberOf" : "Roo.form.Field",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "focusClass",
+ "type" : "String",
+ "desc" : "The CSS class to use when the field receives focus (defaults to \"x-form-focus\")",
+ "memberOf" : "Roo.form.Field",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "grow",
+ "type" : "Boolean",
+ "desc" : "True if this field should automatically grow and shrink to its content",
+ "memberOf" : "Roo.form.TextField",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "growMax",
"type" : "Number",
- "desc" : "The width of labels. This property cascades to child containers.",
- "memberOf" : ""
+ "desc" : "The maximum width to allow when grow = true (defaults to 800)",
+ "memberOf" : "Roo.form.TextField",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "growMin",
+ "type" : "Number",
+ "desc" : "The minimum width to allow when grow = true (defaults to 30)",
+ "memberOf" : "Roo.form.TextField",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "height",
+ "type" : "Number",
+ "desc" : "height (optional) size of component",
+ "memberOf" : "Roo.BoxComponent",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "hideMode",
+ "type" : "String",
+ "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display",
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : [
+ "display",
+ "visibility"
+ ]
+ },
+ {
+ "name" : "inputType",
+ "type" : "String",
+ "desc" : "The type attribute for input fields -- e.g. radio, text, password (defaults to \"text\").",
+ "memberOf" : "Roo.form.Field",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "invalidClass",
+ "type" : "String",
+ "desc" : "The CSS class to use when marking a field invalid (defaults to \"x-form-invalid\")",
+ "memberOf" : "Roo.form.Field",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "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",
+ "isOptional" : false,
+ "optvals" : []
},
{
"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"
+ "memberOf" : "Roo.util.Observable",
+ "isOptional" : false,
+ "optvals" : []
},
{
- "name" : "maskOffset",
+ "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",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "maxLength",
"type" : "Number",
- "desc" : "Default 100",
- "memberOf" : "Roo.form.BasicForm"
+ "desc" : "Maximum input field length allowed (defaults to Number.MAX_VALUE)",
+ "memberOf" : "Roo.form.TextField",
+ "isOptional" : false,
+ "optvals" : []
},
{
- "name" : "method",
+ "name" : "maxLengthText",
"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"
+ "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",
+ "isOptional" : false,
+ "optvals" : []
},
{
- "name" : "minButtonWidth",
+ "name" : "minLength",
"type" : "Number",
- "desc" : "Minimum width of all buttons in pixels (defaults to 75)",
- "memberOf" : ""
+ "desc" : "Minimum input field length required (defaults to 0)",
+ "memberOf" : "Roo.form.TextField",
+ "isOptional" : false,
+ "optvals" : []
},
{
- "name" : "monitorPoll",
- "type" : "Number",
- "desc" : "The milliseconds to poll valid state, ignored if monitorValid is not true (defaults to 200)",
- "memberOf" : ""
+ "name" : "minLengthText",
+ "type" : "String",
+ "desc" : "Error text to display if the minimum length validation fails (defaults to \"The minimum length for this field is {minLength}\")",
+ "memberOf" : "Roo.form.TextField",
+ "isOptional" : false,
+ "optvals" : []
},
{
- "name" : "monitorValid",
+ "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",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "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",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "name",
+ "type" : "String",
+ "desc" : "The field's HTML name attribute.",
+ "memberOf" : "Roo.form.Field",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "qtip",
+ "type" : "String",
+ "desc" : "Mouse over tip",
+ "memberOf" : "Roo.form.Field",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "readOnly",
"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 mark the field as readOnly in HTML (defaults to false) -- Note: this only sets the element's readOnly DOM attribute.",
+ "memberOf" : "Roo.form.Field",
+ "isOptional" : false,
+ "optvals" : []
},
{
- "name" : "progressUrl",
+ "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",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "regexText",
"type" : "String",
- "desc" : "- Url to return progress data",
- "memberOf" : ""
+ "desc" : "The error text to display if {@link #regex} is used and the test fails during validation (defaults to \"\")",
+ "memberOf" : "Roo.form.TextField",
+ "isOptional" : false,
+ "optvals" : []
},
{
- "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" : "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",
+ "isOptional" : false,
+ "optvals" : []
},
{
- "name" : "timeout",
+ "name" : "style",
+ "type" : "String",
+ "desc" : "css styles to add to component\neg. text-align:right;",
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "tabIndex",
"type" : "Number",
- "desc" : "Timeout for form actions in seconds (default is 30 seconds).",
- "memberOf" : "Roo.form.BasicForm"
+ "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",
+ "isOptional" : false,
+ "optvals" : []
},
{
- "name" : "trackResetOnLoad",
+ "name" : "validateOnBlur",
"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"
+ "desc" : "Whether the field should validate when it loses focus (defaults to true).",
+ "memberOf" : "Roo.form.Field",
+ "isOptional" : false,
+ "optvals" : []
},
{
- "name" : "url",
+ "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",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "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",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "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",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "value",
+ "type" : "Mixed",
+ "desc" : "A value to initialize this field with.",
+ "memberOf" : "Roo.form.Field",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "vtype",
"type" : "String",
- "desc" : "The URL to use for form actions if one isn't supplied in the action options.",
- "memberOf" : "Roo.form.BasicForm"
+ "desc" : "A validation type name as defined in {@link Roo.form.VTypes} (defaults to null)",
+ "memberOf" : "Roo.form.TextField",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "width",
+ "type" : "Number",
+ "desc" : "width (optional) size of component",
+ "memberOf" : "Roo.BoxComponent",
+ "isOptional" : false,
+ "optvals" : []
}
],
"events" : [
{
- "name" : "actioncomplete",
+ "name" : "autosize",
"type" : "function",
- "desc" : "Fires when an action is completed.",
- "sig" : "function (_self, action)\n{\n\n}",
- "memberOf" : "Roo.form.BasicForm",
+ "desc" : "Fires when the autosize function is triggered. The field may or may not have actually changed size\naccording to the default logic, but this event provides a hook for the developer to apply additional\nlogic at runtime to resize the field if needed.",
+ "sig" : "function (_self, width)\n{\n\n}",
+ "memberOf" : "Roo.form.TextField",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Form",
- "desc" : "",
+ "type" : "Roo.form.Field",
+ "desc" : "This text field",
"isOptional" : false
},
{
- "name" : "action",
- "type" : "Action",
- "desc" : "The action that completed",
+ "name" : "width",
+ "type" : "Number",
+ "desc" : "The new field width",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "actionfailed",
+ "name" : "beforedestroy",
"type" : "function",
- "desc" : "Fires when an action fails.",
- "sig" : "function (_self, action)\n{\n\n}",
- "memberOf" : "Roo.form.BasicForm",
+ "desc" : "Fires before the component is destroyed. Return false to stop the destroy.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Form",
+ "type" : "Roo.Component",
"desc" : "",
"isOptional" : false
- },
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "beforehide",
+ "type" : "function",
+ "desc" : "Fires before the component is hidden. Return false to stop the hide.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
{
- "name" : "action",
- "type" : "Action",
- "desc" : "The action that failed",
+ "name" : "this",
+ "type" : "Roo.Component",
+ "desc" : "",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "beforeaction",
+ "name" : "beforerender",
"type" : "function",
- "desc" : "Fires before any action is performed. Return false to cancel the action.",
- "sig" : "function (_self, action)\n{\n\n}",
- "memberOf" : "Roo.form.BasicForm",
+ "desc" : "Fires before the component is rendered. Return false to stop the render.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Form",
+ "type" : "Roo.Component",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "beforeshow",
+ "type" : "function",
+ "desc" : "Fires before the component is shown. Return false to stop the show.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.Component",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "blur",
+ "type" : "function",
+ "desc" : "Fires when this field loses input focus.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.form.Field",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.form.Field",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "change",
+ "type" : "function",
+ "desc" : "Fires just before the field blurs if the field value has changed.",
+ "sig" : "function (_self, newValue, oldValue)\n{\n\n}",
+ "memberOf" : "Roo.form.Field",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.form.Field",
"desc" : "",
"isOptional" : false
},
{
- "name" : "action",
- "type" : "Action",
- "desc" : "The action to be performed",
+ "name" : "newValue",
+ "type" : "Mixed",
+ "desc" : "The new value",
+ "isOptional" : false
+ },
+ {
+ "name" : "oldValue",
+ "type" : "Mixed",
+ "desc" : "The original value",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "clientvalidation",
+ "name" : "destroy",
"type" : "function",
- "desc" : "If the monitorValid config option is true, this event fires repetitively to notify of valid state",
- "sig" : "function (_self, valid)\n{\n\n}",
- "memberOf" : "",
+ "desc" : "Fires after the component is destroyed.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Form",
+ "type" : "Roo.Component",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "disable",
+ "type" : "function",
+ "desc" : "Fires after the component is disabled.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.Component",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "enable",
+ "type" : "function",
+ "desc" : "Fires after the component is enabled.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.Component",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "focus",
+ "type" : "function",
+ "desc" : "Fires when this field receives input focus.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.form.Field",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.form.Field",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "hide",
+ "type" : "function",
+ "desc" : "Fires after the component is hidden.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.Component",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "invalid",
+ "type" : "function",
+ "desc" : "Fires after the field has been marked as invalid.",
+ "sig" : "function (_self, msg)\n{\n\n}",
+ "memberOf" : "Roo.form.Field",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.form.Field",
"desc" : "",
"isOptional" : false
},
{
- "name" : "valid",
- "type" : "Boolean",
- "desc" : "true if the form has passed client-side validation",
+ "name" : "msg",
+ "type" : "String",
+ "desc" : "The validation message",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "rendered",
+ "name" : "keyup",
"type" : "function",
- "desc" : "Fires when the form is rendered",
- "sig" : "function (form)\n{\n\n}",
- "memberOf" : "",
+ "desc" : "Fires after the key up",
+ "sig" : "function (_self, e)\n{\n\n}",
+ "memberOf" : "Roo.form.Field",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
"params" : [
{
- "name" : "form",
- "type" : "Roo.form.Form",
+ "name" : "this",
+ "type" : "Roo.form.Field",
"desc" : "",
"isOptional" : false
+ },
+ {
+ "name" : "e",
+ "type" : "Roo.EventObject",
+ "desc" : "The event Object",
+ "isOptional" : false
}
],
"returns" : []
- }
- ],
- "methods" : [
+ },
{
- "name" : "add",
+ "name" : "move",
"type" : "function",
- "desc" : "Add Roo.form components to the current open container (e.g. column, fieldset, etc.). Fields added via this method\ncan also be passed with an additional property of fieldLabel, which if supplied, will provide the text to display\nas the label of the field.",
- "sig" : "(field1, field2)",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
+ "desc" : "Fires after the component is moved.",
+ "sig" : "function (_self, x, y)\n{\n\n}",
+ "memberOf" : "Roo.BoxComponent",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
"params" : [
{
- "name" : "field1",
- "type" : "Field",
+ "name" : "this",
+ "type" : "Roo.Component",
"desc" : "",
"isOptional" : false
},
{
- "name" : "field2",
- "type" : "Field",
- "desc" : "(optional)",
+ "name" : "x",
+ "type" : "Number",
+ "desc" : "The new x position",
+ "isOptional" : false
+ },
+ {
+ "name" : "y",
+ "type" : "Number",
+ "desc" : "The new y position",
"isOptional" : false
}
],
- "returns" : [
+ "returns" : []
+ },
+ {
+ "name" : "render",
+ "type" : "function",
+ "desc" : "Fires after the component is rendered.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
{
- "name" : "",
- "type" : "Form",
- "desc" : "this"
+ "name" : "this",
+ "type" : "Roo.Component",
+ "desc" : "",
+ "isOptional" : false
}
- ]
+ ],
+ "returns" : []
},
{
- "name" : "addButton",
+ "name" : "resize",
"type" : "function",
- "desc" : "Adds a button to the footer of the form - this <b>must</b> be called before the form is rendered.",
- "sig" : "(config, handler, scope)",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
+ "desc" : "Fires after the component is resized.",
+ "sig" : "function (_self, adjWidth, adjHeight, rawWidth, rawHeight)\n{\n\n}",
+ "memberOf" : "Roo.BoxComponent",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
"params" : [
{
- "name" : "config",
- "type" : "String/Object",
- "desc" : "A string becomes the button text, an object can either be a Button config\nobject or a valid Roo.DomHelper element config",
+ "name" : "this",
+ "type" : "Roo.Component",
+ "desc" : "",
"isOptional" : false
},
{
- "name" : "handler",
- "type" : "Function",
- "desc" : "The function called when the button is clicked",
+ "name" : "adjWidth",
+ "type" : "Number",
+ "desc" : "The box-adjusted width that was set",
"isOptional" : false
},
{
- "name" : "scope",
- "type" : "Object",
- "desc" : "(optional) The scope of the handler function",
+ "name" : "adjHeight",
+ "type" : "Number",
+ "desc" : "The box-adjusted height that was set",
+ "isOptional" : false
+ },
+ {
+ "name" : "rawWidth",
+ "type" : "Number",
+ "desc" : "The width that was originally specified",
+ "isOptional" : false
+ },
+ {
+ "name" : "rawHeight",
+ "type" : "Number",
+ "desc" : "The height that was originally specified",
"isOptional" : false
}
],
- "returns" : [
+ "returns" : []
+ },
+ {
+ "name" : "show",
+ "type" : "function",
+ "desc" : "Fires after the component is shown.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
{
- "name" : "",
- "type" : "Roo.Button",
- "desc" : ""
+ "name" : "this",
+ "type" : "Roo.Component",
+ "desc" : "",
+ "isOptional" : false
}
- ]
+ ],
+ "returns" : []
},
{
- "name" : "addEvents",
+ "name" : "specialkey",
"type" : "function",
- "desc" : "Used to define events on this Observable",
- "sig" : "(object)",
- "static" : false,
- "memberOf" : "Roo.util.Observable",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
+ "desc" : "Fires when any key related to navigation (arrows, tab, enter, esc, etc.) is pressed. You can check\n{@link Roo.EventObject#getKey} to determine which key was pressed.",
+ "sig" : "function (_self, e)\n{\n\n}",
+ "memberOf" : "Roo.form.Field",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
"params" : [
{
- "name" : "object",
- "type" : "Object",
- "desc" : "The object with the events defined",
+ "name" : "this",
+ "type" : "Roo.form.Field",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "e",
+ "type" : "Roo.EventObject",
+ "desc" : "The event object",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "addForm",
+ "name" : "valid",
"type" : "function",
- "desc" : "Add a secondary form to this one, \nUsed to provide tabbed forms. One form is primary, with hidden values \nwhich mirror the elements from the other forms.",
- "sig" : "(form)",
+ "desc" : "Fires after the field has been validated with no errors.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.form.Field",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.form.Field",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ }
+ ],
+ "methods" : [
+ {
+ "name" : "addEvents",
+ "type" : "function",
+ "desc" : "Used to define events on this Observable",
+ "sig" : "(object)",
"static" : false,
- "memberOf" : "Roo.form.BasicForm",
+ "memberOf" : "Roo.util.Observable",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "form",
- "type" : "Roo.form.Form",
- "desc" : "to add.",
+ "name" : "object",
+ "type" : "Object",
+ "desc" : "The object with the events defined",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "addxtype",
- "type" : "function",
- "desc" : "Adds a series of form elements (using the xtype property as the factory method.\nValid xtypes are: TextField, TextArea .... Button, Layout, FieldSet, Column, (and 'end' to close a block)",
- "sig" : "(config)",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "config",
- "type" : "Object",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "applyIfToFields",
+ "name" : "applyTo",
"type" : "function",
- "desc" : "Calls {@link Ext#applyIf} for all field in this form with the passed object.",
- "sig" : "(values)",
+ "desc" : "Apply the behaviors of this component to an existing element. <b>This is used instead of render().</b>",
+ "sig" : "(el)",
"static" : false,
- "memberOf" : "Roo.form.BasicForm",
+ "memberOf" : "Roo.form.Field",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "values",
- "type" : "Object",
- "desc" : "",
+ "name" : "el",
+ "type" : "String/HTMLElement/Element",
+ "desc" : "The id of the node, a DOM node or an existing Element",
"isOptional" : false
}
],
"returns" : [
{
"name" : "",
- "type" : "BasicForm",
+ "type" : "Roo.form.Field",
"desc" : "this"
}
]
},
{
- "name" : "applyToFields",
+ "name" : "autoSize",
"type" : "function",
- "desc" : "Calls {@link Ext#apply} for all fields in this form with the passed object.",
- "sig" : "(values)",
+ "desc" : "Automatically grows the field to accomodate the width of the text up to the maximum field width allowed.\nThis only takes effect if grow = true, and fires the autosize event.",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.form.BasicForm",
+ "memberOf" : "Roo.form.TextField",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "values",
- "type" : "Object",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : [
- {
- "name" : "",
- "type" : "BasicForm",
- "desc" : "this"
- }
- ]
+ "params" : [],
+ "returns" : []
},
{
"name" : "capture",
{
"name" : "clearInvalid",
"type" : "function",
- "desc" : "Clears all invalid messages in this form.",
+ "desc" : "Clear any invalid styles/messages for this field",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.form.Field",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
+ {
+ "name" : "destroy",
+ "type" : "function",
+ "desc" : "Destroys this component by purging any event listeners, removing the component's element from the DOM,\nremoving the component from its {@link Roo.Container} (if applicable) and unregistering it from {@link Roo.ComponentMgr}.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.Component",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
+ {
+ "name" : "disable",
+ "type" : "function",
+ "desc" : "Disable this component.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.Component",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.Component",
+ "desc" : "this"
+ }
+ ]
+ },
+ {
+ "name" : "enable",
+ "type" : "function",
+ "desc" : "Enable this component.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.form.BasicForm",
+ "memberOf" : "Roo.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"returns" : [
{
"name" : "",
- "type" : "BasicForm",
+ "type" : "Roo.Component",
"desc" : "this"
}
]
},
{
- "name" : "column",
+ "name" : "fireEvent",
"type" : "function",
- "desc" : "Opens a new {@link Roo.form.Column} container in the layout stack. If fields are passed after the config, the\nfields are added and the column is closed. If no fields are passed the column remains open\nuntil end() is called.",
- "sig" : "(config, field1, field2, etc)",
+ "desc" : "Fires the specified event with the passed parameters (minus the event name).",
+ "sig" : "(eventName, args)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.util.Observable",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "config",
- "type" : "Object",
- "desc" : "The config to pass to the column",
- "isOptional" : false
- },
- {
- "name" : "field1",
- "type" : "Field",
- "desc" : "(optional)",
- "isOptional" : false
- },
- {
- "name" : "field2",
- "type" : "Field",
- "desc" : "(optional)",
+ "name" : "eventName",
+ "type" : "String",
+ "desc" : "",
"isOptional" : false
},
{
- "name" : "etc",
- "type" : "Field",
- "desc" : "(optional)",
+ "name" : "args",
+ "type" : "Object...",
+ "desc" : "Variable number of parameters are passed to handlers",
"isOptional" : false
}
],
"returns" : [
{
"name" : "",
- "type" : "",
- "desc" : "Column The column container object"
+ "type" : "Boolean",
+ "desc" : "returns false if any of the handlers return false otherwise it returns true"
}
]
},
{
- "name" : "container",
+ "name" : "focus",
"type" : "function",
- "desc" : "Opens a new {@link Roo.form.Layout} container in the layout stack. If fields are passed after the config, the\nfields are added and the container is closed. If no fields are passed the container remains open\nuntil end() is called.",
- "sig" : "(config, field1, field2, etc)",
+ "desc" : "Try to focus this component.",
+ "sig" : "(selectText)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "config",
- "type" : "Object",
- "desc" : "The config to pass to the Layout",
- "isOptional" : false
- },
- {
- "name" : "field1",
- "type" : "Field",
- "desc" : "(optional)",
- "isOptional" : false
- },
- {
- "name" : "field2",
- "type" : "Field",
- "desc" : "(optional)",
- "isOptional" : false
- },
- {
- "name" : "etc",
- "type" : "Field",
- "desc" : "(optional)",
+ "name" : "selectText",
+ "type" : "Boolean",
+ "desc" : "True to also select the text in this component (if applicable)",
"isOptional" : false
}
],
"returns" : [
{
"name" : "",
- "type" : "",
- "desc" : "Layout The container object"
+ "type" : "Roo.Component",
+ "desc" : "this"
}
]
},
{
- "name" : "doAction",
+ "name" : "getBox",
"type" : "function",
- "desc" : "Performs a predefined action (submit or load) or custom actions you define on this form.",
- "sig" : "(actionName, options)",
+ "desc" : "Gets the current box measurements of the component's underlying element.",
+ "sig" : "(local)",
"static" : false,
- "memberOf" : "Roo.form.BasicForm",
+ "memberOf" : "Roo.BoxComponent",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "actionName",
- "type" : "String",
- "desc" : "The name of the action type",
- "isOptional" : false
- },
- {
- "name" : "options",
- "type" : "Object",
- "desc" : "(optional) The options to pass to the action. All of the config options listed\nbelow are supported by both the submit and load actions unless otherwise noted (custom actions could also\naccept other config options):\n<pre>\nProperty Type Description\n---------------- --------------- ----------------------------------------------------------------------------------\nurl String The url for the action (defaults to the form's url)\nmethod String The form method to use (defaults to the form's method, or POST if not defined)\nparams String/Object The params to pass (defaults to the form's baseParams, or none if not defined)\nclientValidation Boolean Applies to submit only. Pass true to call form.isValid() prior to posting to\n validate the form on the client (defaults to false)\n</pre>",
+ "name" : "local",
+ "type" : "Boolean",
+ "desc" : "(optional) If true the element's left and top are returned instead of page XY (defaults to false)",
"isOptional" : false
}
],
- "returns" : [
- {
- "name" : "",
- "type" : "BasicForm",
- "desc" : "this"
- }
- ]
+ "returns" : []
},
{
- "name" : "end",
+ "name" : "getEl",
"type" : "function",
- "desc" : "Closes the current open container",
+ "desc" : "Returns the underlying {@link Roo.Element}.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"returns" : [
{
"name" : "",
- "type" : "Form",
- "desc" : "this"
+ "type" : "Roo.Element",
+ "desc" : "The element"
}
]
},
{
- "name" : "fieldset",
+ "name" : "getId",
"type" : "function",
- "desc" : "Opens a new {@link Roo.form.FieldSet} container in the layout stack. If fields are passed after the config, the\nfields are added and the fieldset is closed. If no fields are passed the fieldset remains open\nuntil end() is called.",
- "sig" : "(config, field1, field2, etc)",
+ "desc" : "Returns the id of this component.",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "config",
- "type" : "Object",
- "desc" : "The config to pass to the fieldset",
- "isOptional" : false
- },
- {
- "name" : "field1",
- "type" : "Field",
- "desc" : "(optional)",
- "isOptional" : false
- },
- {
- "name" : "field2",
- "type" : "Field",
- "desc" : "(optional)",
- "isOptional" : false
- },
- {
- "name" : "etc",
- "type" : "Field",
- "desc" : "(optional)",
- "isOptional" : false
- }
- ],
+ "params" : [],
"returns" : [
{
"name" : "",
- "type" : "",
- "desc" : "FieldSet The fieldset container object"
+ "type" : "String",
+ "desc" : ""
}
]
},
{
- "name" : "findField",
+ "name" : "getName",
"type" : "function",
- "desc" : "Find a Roo.form.Field in this form by id, dataIndex, name or hiddenName",
- "sig" : "(id)",
+ "desc" : "Returns the name attribute of the field if available",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.form.BasicForm",
+ "memberOf" : "Roo.form.Field",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "id",
- "type" : "String",
- "desc" : "The value to search for",
- "isOptional" : false
- }
- ],
+ "params" : [],
"returns" : [
{
"name" : "",
- "type" : "",
- "desc" : "Field"
+ "type" : "String",
+ "desc" : "name The field name"
}
]
},
{
- "name" : "findbyId",
+ "name" : "getPosition",
"type" : "function",
- "desc" : "Find any element that has been added to a form, using it's ID or name\nThis can include framesets, columns etc. along with regular fields..",
- "sig" : "(id)",
+ "desc" : "Gets the current XY position of the component's underlying element.",
+ "sig" : "(local)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.BoxComponent",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "id",
- "type" : "String",
- "desc" : "- id or name to find.",
+ "name" : "local",
+ "type" : "Boolean",
+ "desc" : "(optional) If true the element's left and top are returned instead of page XY (defaults to false)",
"isOptional" : false
}
],
"returns" : [
{
"name" : "",
- "type" : "Element",
- "desc" : "e - or false if nothing found."
+ "type" : "Array",
+ "desc" : "The XY position of the element (e.g., [100, 200])"
}
]
},
{
- "name" : "fireEvent",
+ "name" : "getRawValue",
"type" : "function",
- "desc" : "Fires the specified event with the passed parameters (minus the event name).",
- "sig" : "(eventName, args)",
+ "desc" : "Returns the raw data value which may or may not be a valid, defined value. To return a normalized value see {@link #getValue}.",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.util.Observable",
+ "memberOf" : "Roo.form.Field",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "eventName",
- "type" : "String",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "args",
- "type" : "Object...",
- "desc" : "Variable number of parameters are passed to handlers",
- "isOptional" : false
- }
- ],
+ "params" : [],
"returns" : [
{
"name" : "",
- "type" : "Boolean",
- "desc" : "returns false if any of the handlers return false otherwise it returns true"
+ "type" : "Mixed",
+ "desc" : "value The field value"
}
]
},
{
- "name" : "getFieldValues",
+ "name" : "getSize",
"type" : "function",
- "desc" : "Returns the fields in this form as an object with key/value pairs. \nThis differs from getValues as it calls getValue on each child item, rather than using dom data.",
+ "desc" : "Gets the current size of the component's underlying element.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.form.BasicForm",
+ "memberOf" : "Roo.BoxComponent",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
{
"name" : "",
"type" : "Object",
- "desc" : ""
+ "desc" : "An object containing the element's size {width: (element width), height: (element height)}"
}
]
},
{
- "name" : "getValues",
+ "name" : "getValue",
"type" : "function",
- "desc" : "Returns the fields in this form as an object with key/value pairs. If multiple fields exist with the same name\nthey are returned as an array.",
- "sig" : "(asString)",
+ "desc" : "Returns the normalized data value (undefined or emptyText will be returned as ''). To return the raw value see {@link #getRawValue}.",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.form.BasicForm",
+ "memberOf" : "Roo.form.Field",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "asString",
- "type" : "Boolean",
- "desc" : "",
- "isOptional" : false
- }
- ],
+ "params" : [],
"returns" : [
{
"name" : "",
- "type" : "Object",
- "desc" : ""
+ "type" : "Mixed",
+ "desc" : "value The field value"
}
]
},
{
"name" : "hasChanged",
"type" : "function",
- "desc" : "Returns true if any fields in this form have changed since their original load. (New version)",
+ "desc" : "checks the current value against the 'loaded' value.\nNote - will return false if 'resetHasChanged' has not been called first.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.form.BasicForm",
+ "memberOf" : "Roo.form.Field",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"exceptions" : "",
"requires" : "",
"params" : [],
- "returns" : [
- {
- "name" : "",
- "type" : "",
- "desc" : "Boolean"
- }
- ]
+ "returns" : []
},
{
"name" : "hasListener",
]
},
{
- "name" : "invalidFields",
+ "name" : "hide",
"type" : "function",
- "desc" : "Returns array of invalid form fields.",
+ "desc" : "Hide this component.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.form.BasicForm",
+ "memberOf" : "Roo.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"returns" : [
{
"name" : "",
- "type" : "",
- "desc" : "Array"
+ "type" : "Roo.Component",
+ "desc" : "this"
}
]
},
{
"name" : "isDirty",
"type" : "function",
- "desc" : "DEPRICATED Returns true if any fields in this form have changed since their original load.",
+ "desc" : "Returns true if this field has been changed since it was originally loaded and is not disabled.\nDEPRICATED - it never worked well - use hasChanged/resetHasChanged.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.form.BasicForm",
+ "memberOf" : "Roo.form.Field",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"exceptions" : "",
"requires" : "",
"params" : [],
- "returns" : [
- {
- "name" : "",
- "type" : "",
- "desc" : "Boolean"
- }
- ]
+ "returns" : []
},
{
"name" : "isValid",
"type" : "function",
- "desc" : "Returns true if client-side validation on the form is successful.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.form.BasicForm",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : [
- {
- "name" : "",
- "type" : "",
- "desc" : "Boolean"
- }
- ]
- },
- {
- "name" : "load",
- "type" : "function",
- "desc" : "Shortcut to do a load action.",
- "sig" : "(options)",
+ "desc" : "Returns whether or not the field value is currently valid",
+ "sig" : "(preventMark)",
"static" : false,
- "memberOf" : "Roo.form.BasicForm",
+ "memberOf" : "Roo.form.Field",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "options",
- "type" : "Object",
- "desc" : "The options to pass to the action (see {@link #doAction} for details)",
+ "name" : "preventMark",
+ "type" : "Boolean",
+ "desc" : "True to disable marking the field invalid",
"isOptional" : false
}
],
"returns" : [
{
"name" : "",
- "type" : "BasicForm",
- "desc" : "this"
+ "type" : "Boolean",
+ "desc" : "True if the value is valid, else false"
}
]
},
{
- "name" : "loadRecord",
+ "name" : "isVisible",
"type" : "function",
- "desc" : "Loads an Roo.data.Record into this form.",
- "sig" : "(record)",
+ "desc" : "Returns true if this component is visible.",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.form.BasicForm",
+ "memberOf" : "Roo.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "record",
- "type" : "Record",
- "desc" : "The record to load",
- "isOptional" : false
- }
- ],
- "returns" : [
- {
- "name" : "",
- "type" : "BasicForm",
- "desc" : "this"
- }
- ]
+ "params" : [],
+ "returns" : []
},
{
"name" : "markInvalid",
"type" : "function",
- "desc" : "Mark fields in this form invalid in bulk.",
- "sig" : "(errors)",
+ "desc" : "Mark this field as invalid",
+ "sig" : "(msg)",
"static" : false,
- "memberOf" : "Roo.form.BasicForm",
+ "memberOf" : "Roo.form.Field",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "errors",
- "type" : "Array/Object",
- "desc" : "Either an array in the form [{id:'fieldId', msg:'The message'},...] or an object hash of {id: msg, id2: msg2}",
+ "name" : "msg",
+ "type" : "String",
+ "desc" : "The validation message",
"isOptional" : false
}
],
- "returns" : [
- {
- "name" : "",
- "type" : "BasicForm",
- "desc" : "this"
- }
- ]
+ "returns" : []
},
{
"name" : "on",
"returns" : []
},
{
- "name" : "purgeListeners",
+ "name" : "onPosition",
"type" : "function",
- "desc" : "Removes all listeners for this object",
- "sig" : "()\n{\n\n}",
+ "desc" : "Called after the component is moved, this method is empty by default but can be implemented by any\nsubclass that needs to perform custom logic after a move occurs.",
+ "sig" : "(x, y)",
"static" : false,
- "memberOf" : "Roo.util.Observable",
+ "memberOf" : "Roo.BoxComponent",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
+ "params" : [
+ {
+ "name" : "x",
+ "type" : "Number",
+ "desc" : "The new x position",
+ "isOptional" : false
+ },
+ {
+ "name" : "y",
+ "type" : "Number",
+ "desc" : "The new y position",
+ "isOptional" : false
+ }
+ ],
"returns" : []
},
{
- "name" : "releaseCapture",
+ "name" : "onResize",
"type" : "function",
- "desc" : "Removes <b>all</b> added captures from the Observable.",
- "sig" : "(o)",
- "static" : true,
- "memberOf" : "Roo.util.Observable",
- "isStatic" : true,
+ "desc" : "Called after the component is resized, this method is empty by default but can be implemented by any\nsubclass that needs to perform custom logic after a resize occurs.",
+ "sig" : "(adjWidth, adjHeight, rawWidth, rawHeight)",
+ "static" : false,
+ "memberOf" : "Roo.BoxComponent",
+ "isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"example" : "",
"requires" : "",
"params" : [
{
- "name" : "o",
- "type" : "Observable",
- "desc" : "The Observable to release",
+ "name" : "adjWidth",
+ "type" : "Number",
+ "desc" : "The box-adjusted width that was set",
+ "isOptional" : false
+ },
+ {
+ "name" : "adjHeight",
+ "type" : "Number",
+ "desc" : "The box-adjusted height that was set",
+ "isOptional" : false
+ },
+ {
+ "name" : "rawWidth",
+ "type" : "Number",
+ "desc" : "The width that was originally specified",
+ "isOptional" : false
+ },
+ {
+ "name" : "rawHeight",
+ "type" : "Number",
+ "desc" : "The height that was originally specified",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "remove",
+ "name" : "purgeListeners",
"type" : "function",
- "desc" : "Removes a field from the items collection (does NOT remove its markup).",
- "sig" : "(field)",
+ "desc" : "Removes all listeners for this object",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.form.BasicForm",
+ "memberOf" : "Roo.util.Observable",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
+ "params" : [],
+ "returns" : []
+ },
+ {
+ "name" : "releaseCapture",
+ "type" : "function",
+ "desc" : "Removes <b>all</b> added captures from the Observable.",
+ "sig" : "(o)",
+ "static" : true,
+ "memberOf" : "Roo.util.Observable",
+ "isStatic" : true,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
- "name" : "field",
- "type" : "Field",
- "desc" : "",
+ "name" : "o",
+ "type" : "Observable",
+ "desc" : "The Observable to release",
"isOptional" : false
}
],
- "returns" : [
- {
- "name" : "",
- "type" : "BasicForm",
- "desc" : "this"
- }
- ]
+ "returns" : []
},
{
"name" : "removeListener",
{
"name" : "render",
"type" : "function",
- "desc" : "Render this form into the passed container. This should only be called once!",
+ "desc" : "If this is a lazy rendering component, render it to its container element.",
"sig" : "(container)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
{
"name" : "container",
"type" : "String/HTMLElement/Element",
- "desc" : "The element this component should be rendered into",
+ "desc" : "(optional) The element this component should be rendered into. If it is being applied to existing markup, this should be left off.",
"isOptional" : false
}
],
- "returns" : [
- {
- "name" : "",
- "type" : "Form",
- "desc" : "this"
- }
- ]
+ "returns" : []
},
{
"name" : "reset",
"type" : "function",
- "desc" : "Resets this form.",
+ "desc" : "Resets the current field value to the originally-loaded value and clears any validation messages.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.form.BasicForm",
+ "memberOf" : "Roo.form.TextField",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"exceptions" : "",
"requires" : "",
"params" : [],
- "returns" : [
- {
- "name" : "",
- "type" : "BasicForm",
- "desc" : "this"
- }
- ]
+ "returns" : []
},
{
"name" : "resetHasChanged",
"type" : "function",
- "desc" : "Resets all hasChanged to 'false' -\nThe old 'isDirty' used 'original value..' however this breaks reset() and a few other things.\nSo hasChanged storage is only to be used for this purpose",
+ "desc" : "stores the current value in loadedValue",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.form.BasicForm",
+ "memberOf" : "Roo.form.Field",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"exceptions" : "",
"requires" : "",
"params" : [],
- "returns" : [
+ "returns" : []
+ },
+ {
+ "name" : "selectText",
+ "type" : "function",
+ "desc" : "Selects text in this field",
+ "sig" : "(start, end)",
+ "static" : false,
+ "memberOf" : "Roo.form.TextField",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
{
- "name" : "",
- "type" : "",
- "desc" : "Boolean"
+ "name" : "start",
+ "type" : "Number",
+ "desc" : "(optional) The index where the selection should start (defaults to 0)",
+ "isOptional" : false
+ },
+ {
+ "name" : "end",
+ "type" : "Number",
+ "desc" : "(optional) The index where the selection should end (defaults to the text length)",
+ "isOptional" : false
}
- ]
+ ],
+ "returns" : []
},
{
- "name" : "setValues",
+ "name" : "setDisabled",
"type" : "function",
- "desc" : "Set values for fields in this form in bulk.",
- "sig" : "(values)",
+ "desc" : "Convenience function for setting disabled/enabled by boolean.",
+ "sig" : "(disabled)",
"static" : false,
- "memberOf" : "Roo.form.BasicForm",
+ "memberOf" : "Roo.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "values",
- "type" : "Array/Object",
- "desc" : "Either an array in the form [{id:'fieldId', value:'foo'},...] or an object hash of {id: value, id2: value2}",
+ "name" : "disabled",
+ "type" : "Boolean",
+ "desc" : "",
"isOptional" : false
}
],
- "returns" : [
+ "returns" : []
+ },
+ {
+ "name" : "setPagePosition",
+ "type" : "function",
+ "desc" : "Sets the page XY position of the component. To set the left and top instead, use {@link #setPosition}.\nThis method fires the move event.",
+ "sig" : "(x, y)",
+ "static" : false,
+ "memberOf" : "Roo.BoxComponent",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
{
- "name" : "",
- "type" : "BasicForm",
- "desc" : "this"
+ "name" : "x",
+ "type" : "Number",
+ "desc" : "The new x position",
+ "isOptional" : false
+ },
+ {
+ "name" : "y",
+ "type" : "Number",
+ "desc" : "The new y position",
+ "isOptional" : false
}
- ]
+ ],
+ "returns" : []
},
{
- "name" : "start",
+ "name" : "setPosition",
"type" : "function",
- "desc" : "Opens the passed container in the layout stack. The container can be any {@link Roo.form.Layout} or subclass.",
- "sig" : "(container)",
+ "desc" : "Sets the left and top of the component. To set the page XY position instead, use {@link #setPagePosition}.\nThis method fires the move event.",
+ "sig" : "(left, top)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.BoxComponent",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "container",
- "type" : "Object",
- "desc" : "A Roo.form.Layout or subclass of Layout",
+ "name" : "left",
+ "type" : "Number",
+ "desc" : "The new left",
+ "isOptional" : false
+ },
+ {
+ "name" : "top",
+ "type" : "Number",
+ "desc" : "The new top",
"isOptional" : false
}
],
- "returns" : [
+ "returns" : []
+ },
+ {
+ "name" : "setRawValue",
+ "type" : "function",
+ "desc" : "Sets the underlying DOM field's value directly, bypassing validation. To set the value with validation see {@link #setValue}.",
+ "sig" : "(value)",
+ "static" : false,
+ "memberOf" : "Roo.form.Field",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
{
- "name" : "",
- "type" : "Form",
- "desc" : "this"
+ "name" : "value",
+ "type" : "Mixed",
+ "desc" : "The value to set",
+ "isOptional" : false
}
- ]
+ ],
+ "returns" : []
},
{
- "name" : "startMonitoring",
+ "name" : "setSize",
"type" : "function",
- "desc" : "Starts monitoring of the valid state of this form. Usually this is done by passing the config\noption \"monitorValid\"",
- "sig" : "()\n{\n\n}",
+ "desc" : "Sets the width and height of the component. This method fires the resize event. This method can accept\neither width and height as separate numeric arguments, or you can pass a size object like {width:10, height:20}.",
+ "sig" : "(width, height)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.BoxComponent",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
- "returns" : []
+ "params" : [
+ {
+ "name" : "width",
+ "type" : "Number/Object",
+ "desc" : "The new width to set, or a size object in the format {width, height}",
+ "isOptional" : false
+ },
+ {
+ "name" : "height",
+ "type" : "Number",
+ "desc" : "The new height to set (not required if a size object is passed as the first arg)",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.BoxComponent",
+ "desc" : "this"
+ }
+ ]
},
{
- "name" : "stopMonitoring",
+ "name" : "setValue",
"type" : "function",
- "desc" : "Stops monitoring of the valid state of this form",
- "sig" : "()\n{\n\n}",
+ "desc" : "Sets a data value into the field and validates it. To set the value directly without validation see {@link #setRawValue}.",
+ "sig" : "(value)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.form.Field",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
+ "params" : [
+ {
+ "name" : "value",
+ "type" : "Mixed",
+ "desc" : "The value to set",
+ "isOptional" : false
+ }
+ ],
"returns" : []
},
{
- "name" : "submit",
+ "name" : "setVisible",
"type" : "function",
- "desc" : "Shortcut to do a submit action.",
- "sig" : "(options)",
+ "desc" : "Convenience function to hide or show this component by boolean.",
+ "sig" : "(visible)",
"static" : false,
- "memberOf" : "Roo.form.BasicForm",
+ "memberOf" : "Roo.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "options",
- "type" : "Object",
- "desc" : "The options to pass to the action (see {@link #doAction} for details)",
+ "name" : "visible",
+ "type" : "Boolean",
+ "desc" : "True to show, false to hide",
"isOptional" : false
}
],
"returns" : [
{
"name" : "",
- "type" : "BasicForm",
+ "type" : "Roo.Component",
+ "desc" : "this"
+ }
+ ]
+ },
+ {
+ "name" : "show",
+ "type" : "function",
+ "desc" : "Show this component.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.Component",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.Component",
"desc" : "this"
}
]
},
+ {
+ "name" : "syncSize",
+ "type" : "function",
+ "desc" : "Force the component's size to recalculate based on the underlying element's current height and width.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.BoxComponent",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
{
"name" : "un",
"type" : "function",
"returns" : []
},
{
- "name" : "updateRecord",
+ "name" : "updateBox",
"type" : "function",
- "desc" : "Persists the values in this form into the passed Roo.data.Record object in a beginEdit/endEdit block.",
- "sig" : "(record)",
+ "desc" : "Sets the current box measurements of the component's underlying element.",
+ "sig" : "(box)",
"static" : false,
- "memberOf" : "Roo.form.BasicForm",
+ "memberOf" : "Roo.BoxComponent",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "record",
- "type" : "Record",
- "desc" : "The record to edit",
+ "name" : "box",
+ "type" : "Object",
+ "desc" : "An object in the format {x, y, width, height}",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "validate",
+ "type" : "function",
+ "desc" : "Validates the field value",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.form.Field",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Boolean",
+ "desc" : "True if the value is valid, else false"
+ }
+ ]
+ },
+ {
+ "name" : "validateValue",
+ "type" : "function",
+ "desc" : "Validates a value according to the field's validation rules and marks the field as invalid\nif the validation fails",
+ "sig" : "(value)",
+ "static" : false,
+ "memberOf" : "Roo.form.TextField",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "value",
+ "type" : "Mixed",
+ "desc" : "The value to validate",
"isOptional" : false
}
],
"returns" : [
{
"name" : "",
- "type" : "BasicForm",
- "desc" : "this"
+ "type" : "Boolean",
+ "desc" : "True if the value is valid, else false"
}
]
}
],
"isAbstract" : false,
"isBuilderTop" : false,
- "childClasses" : { },
- "tree_children" : [
- "Roo.form.Column",
- "Roo.form.FieldSet",
- "Roo.form.Row",
- "Roo.form.Field",
- "Roo.form.Checkbox",
- "Roo.form.ComboBox",
- "Roo.form.ComboBoxArray",
- "Roo.form.ComboCheck",
- "Roo.form.ComboNested",
- "Roo.form.DateField",
- "Roo.form.DayPicker",
- "Roo.form.DisplayField",
- "Roo.form.FCKeditor",
- "Roo.form.GridField",
- "Roo.form.Hidden",
- "Roo.form.HtmlEditor",
- "Roo.form.MonthField",
- "Roo.form.NumberField",
- "Roo.form.Radio",
- "Roo.form.Select",
- "Roo.form.Signature",
- "Roo.form.TextArea",
- "Roo.form.TextField",
- "Roo.form.TriggerField",
- "Roo.Button",
- "Roo.SplitButton",
- "Roo.Toolbar.Button",
- "Roo.Toolbar.SplitButton",
- "Roo.form.TextItem"
- ],
+ "implementations" : [],
+ "tree_children" : [],
"tree_parent" : []
},
- "Roo.form.GridField" : {
+ "Roo.form.HtmlEditor" : {
"props" : [
{
"name" : "actionMode",
"type" : "String",
"desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el' for forms you probably want to set this to fieldEl",
- "memberOf" : "Roo.Component"
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
- "name" : "addTitle",
- "type" : "String",
- "desc" : "Text to include for adding a title.",
- "memberOf" : ""
+ "name" : "allowComments",
+ "type" : "boolean",
+ "desc" : "- default false - allow comments in HTML source - by default they are stripped - if you are editing email you may need this.",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "allowDomMove",
"type" : "Boolean",
"desc" : "Whether the component can move the Dom node when rendering (defaults to true).",
- "memberOf" : "Roo.Component"
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
- "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" : "autoClean",
+ "type" : "boolean",
+ "desc" : "- default true - loading and saving will remove quite a bit of formating,\n if you are doing an email editor, this probably needs disabling, it's designed",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "blacklist",
+ "type" : "Array",
+ "desc" : "of html tags - in addition to standard blacklist.",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "bodyCls",
+ "type" : "string",
+ "desc" : "default '' default classes to add to body of editable area - usually undoreset is a good start..",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "clearUp",
+ "type" : "Boolean",
+ "desc" : "",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "cls",
"type" : "String",
"desc" : "A CSS class to apply to the field's underlying element.",
- "memberOf" : "Roo.form.Field"
+ "memberOf" : "Roo.form.Field",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "disableClass",
"type" : "String",
"desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").",
- "memberOf" : "Roo.Component"
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "disabled",
"type" : "Boolean",
"desc" : "True to disable the field (defaults to false).",
- "memberOf" : "Roo.form.Field"
+ "memberOf" : "Roo.form.Field",
+ "isOptional" : false,
+ "optvals" : []
},
{
- "name" : "fieldClass",
- "type" : "String",
- "desc" : "The default CSS class for the field (defaults to \"x-form-field\")",
- "memberOf" : "Roo.form.Field"
+ "name" : "enableBlocks",
+ "type" : "boolean",
+ "desc" : "- default true - if the block editor (table and figure should be enabled)",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "fieldLabel",
"type" : "String",
"desc" : "Label to use when rendering a form.",
- "memberOf" : "Roo.form.Field"
- },
- {
- "name" : "focusClass",
- "type" : "String",
- "desc" : "The CSS class to use when the field receives focus (defaults to \"x-form-focus\")",
- "memberOf" : "Roo.form.Field"
+ "memberOf" : "Roo.form.Field",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "height",
"type" : "Number",
- "desc" : "- used to restrict height of grid..",
- "memberOf" : ""
+ "desc" : "(in pixels)",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "hideMode",
"type" : "String",
- "desc" : "y)\nHow this component 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" : "inputType",
- "type" : "String",
- "desc" : "The type attribute for input fields -- e.g. radio, text, password (defaults to \"text\").",
- "memberOf" : "Roo.form.Field"
- },
- {
- "name" : "invalidClass",
- "type" : "String",
- "desc" : "The CSS class to use when marking a field invalid (defaults to \"x-form-invalid\")",
- "memberOf" : "Roo.form.Field"
+ "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display",
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : [
+ "display",
+ "visibility"
+ ]
},
{
- "name" : "invalidText",
+ "name" : "language",
"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"
+ "desc" : "default en - language of text (usefull for rtl languages)",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"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"
- },
- {
- "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"
+ "memberOf" : "Roo.util.Observable",
+ "isOptional" : false,
+ "optvals" : []
},
{
"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"
+ "memberOf" : "Roo.form.Field",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "name",
"type" : "String",
"desc" : "The field's HTML name attribute.",
- "memberOf" : "Roo.form.Field"
+ "memberOf" : "Roo.form.Field",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "qtip",
"type" : "String",
"desc" : "Mouse over tip",
- "memberOf" : "Roo.form.Field"
+ "memberOf" : "Roo.form.Field",
+ "isOptional" : false,
+ "optvals" : []
},
{
"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"
+ "memberOf" : "Roo.form.Field",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "resizable",
+ "type" : "String",
+ "desc" : "'s' or 'se' or 'e' - wrapps the element in a\n Roo.resizable.",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "style",
+ "type" : "String",
+ "desc" : "css styles to add to component\neg. text-align:right;",
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "stylesheets",
+ "type" : "Array",
+ "desc" : "url of stylesheets. set to [] to disable stylesheets - this is usally a good idea rootURL + '/roojs1/css/undoreset.css', .",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"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"
+ "memberOf" : "Roo.form.Field",
+ "isOptional" : false,
+ "optvals" : []
},
{
- "name" : "validateOnBlur",
- "type" : "Boolean",
- "desc" : "Whether the field should validate when it loses focus (defaults to true).",
- "memberOf" : "Roo.form.Field"
+ "name" : "toolbars",
+ "type" : "Array",
+ "desc" : "Array of toolbars. - defaults to just the Standard one",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"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"
+ "memberOf" : "Roo.form.Field",
+ "isOptional" : false,
+ "optvals" : []
},
{
"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"
+ "memberOf" : "Roo.form.Field",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "value",
"type" : "Mixed",
"desc" : "A value to initialize this field with.",
- "memberOf" : "Roo.form.Field"
+ "memberOf" : "Roo.form.Field",
+ "isOptional" : false,
+ "optvals" : []
},
{
- "name" : "width",
- "type" : "Number",
- "desc" : "- used to restrict width of grid..",
- "memberOf" : ""
+ "name" : "whitelist",
+ "type" : "Array",
+ "desc" : "of html tags - in addition to statndard whitelist",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
- "name" : "xgrid",
- "type" : "Object",
- "desc" : "(xtype'd description of grid) { xtype : 'Grid', dataSource: .... }\n\n}",
- "memberOf" : ""
+ "name" : "width",
+ "type" : "Number",
+ "desc" : "(in pixels)",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
}
],
"events" : [
+ {
+ "name" : "activate",
+ "type" : "function",
+ "desc" : "Fires when the editor is first receives the focus. Any insertion must wait\nuntil after this event.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "HtmlEditor",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "autosave",
+ "type" : "function",
+ "desc" : "Auto save the htmlEditor value as a file into Events",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "HtmlEditor",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
{
"name" : "beforedestroy",
"type" : "function",
],
"returns" : []
},
+ {
+ "name" : "beforepush",
+ "type" : "function",
+ "desc" : "Fires before the iframe editor is updated with content from the textarea. Return false\nto cancel the push.",
+ "sig" : "function (_self, html)\n{\n\n}",
+ "memberOf" : "",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "HtmlEditor",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "html",
+ "type" : "String",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
{
"name" : "beforerender",
"type" : "function",
"returns" : []
},
{
- "name" : "blur",
+ "name" : "beforesync",
"type" : "function",
- "desc" : "Fires when this field loses input focus.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.form.Field",
+ "desc" : "Fires before the textarea is updated with content from the editor iframe. Return false\nto cancel the sync.",
+ "sig" : "function (_self, html)\n{\n\n}",
+ "memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.form.Field",
+ "type" : "HtmlEditor",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "html",
+ "type" : "String",
"desc" : "",
"isOptional" : false
}
],
"returns" : []
},
+ {
+ "name" : "blur",
+ "type" : "function",
+ "desc" : "",
+ "sig" : "function ()\n{\n\n}",
+ "memberOf" : "",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [],
+ "returns" : []
+ },
{
"name" : "change",
"type" : "function",
- "desc" : "Fires just before the field blurs if the field value has changed.",
- "sig" : "function (_self, newValue, oldValue)\n{\n\n}",
- "memberOf" : "Roo.form.Field",
+ "desc" : "",
+ "sig" : "function ()\n{\n\n}",
+ "memberOf" : "",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [],
+ "returns" : []
+ },
+ {
+ "name" : "destroy",
+ "type" : "function",
+ "desc" : "Fires after the component is destroyed.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.form.Field",
+ "type" : "Roo.Component",
"desc" : "",
"isOptional" : false
- },
- {
- "name" : "newValue",
- "type" : "Mixed",
- "desc" : "The new value",
- "isOptional" : false
- },
- {
- "name" : "oldValue",
- "type" : "Mixed",
- "desc" : "The original value",
- "isOptional" : false
}
],
"returns" : []
},
{
- "name" : "destroy",
+ "name" : "disable",
"type" : "function",
- "desc" : "Fires after the component is destroyed.",
+ "desc" : "Fires after the component is disabled.",
"sig" : "function (_self)\n{\n\n}",
"memberOf" : "Roo.Component",
"example" : "",
"returns" : []
},
{
- "name" : "disable",
+ "name" : "editmodechange",
"type" : "function",
- "desc" : "Fires after the component is disabled.",
+ "desc" : "Fires when the editor switches edit modes",
+ "sig" : "function (_self, sourceEdit)\n{\n\n}",
+ "memberOf" : "",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "HtmlEditor",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "sourceEdit",
+ "type" : "Boolean",
+ "desc" : "True if source edit, false if standard editing.",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "editorevent",
+ "type" : "function",
+ "desc" : "Fires when on any editor (mouse up/down cursor movement etc.) - used for toolbar hooks.",
"sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
+ "memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.Component",
+ "type" : "HtmlEditor",
"desc" : "",
"isOptional" : false
}
"returns" : []
},
{
- "name" : "focus",
+ "name" : "firstfocus",
"type" : "function",
- "desc" : "Fires when this field receives input focus.",
+ "desc" : "Fires when on first focus - needed by toolbars..",
"sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.form.Field",
+ "memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.form.Field",
+ "type" : "HtmlEditor",
"desc" : "",
"isOptional" : false
}
],
"returns" : []
},
+ {
+ "name" : "focus",
+ "type" : "function",
+ "desc" : "",
+ "sig" : "function ()\n{\n\n}",
+ "memberOf" : "",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [],
+ "returns" : []
+ },
{
"name" : "hide",
"type" : "function",
],
"returns" : []
},
+ {
+ "name" : "initialize",
+ "type" : "function",
+ "desc" : "Fires when the editor is fully initialized (including the iframe)",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "HtmlEditor",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
{
"name" : "invalid",
"type" : "function",
],
"returns" : []
},
+ {
+ "name" : "paste",
+ "type" : "function",
+ "desc" : "Fires when press user pastes into the editor",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.HtmlEditorCore",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "push",
+ "type" : "function",
+ "desc" : "Fires when the iframe editor is updated with content from the textarea.",
+ "sig" : "function (_self, html)\n{\n\n}",
+ "memberOf" : "",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "HtmlEditor",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "html",
+ "type" : "String",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
{
"name" : "render",
"type" : "function",
],
"returns" : []
},
+ {
+ "name" : "savedpreview",
+ "type" : "function",
+ "desc" : "preview the saved version of htmlEditor",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "HtmlEditor",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
{
"name" : "show",
"type" : "function",
{
"name" : "specialkey",
"type" : "function",
- "desc" : "Fires when any key related to navigation (arrows, tab, enter, esc, etc.) is pressed. You can check\n{@link Roo.EventObject#getKey} to determine which key was pressed.",
- "sig" : "function (_self, e)\n{\n\n}",
- "memberOf" : "Roo.form.Field",
+ "desc" : "",
+ "sig" : "function ()\n{\n\n}",
+ "memberOf" : "",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [],
+ "returns" : []
+ },
+ {
+ "name" : "stylesheetsclick",
+ "type" : "function",
+ "desc" : "Fires when press the Sytlesheets button",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.form.Field",
+ "type" : "Roo.HtmlEditorCore",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "sync",
+ "type" : "function",
+ "desc" : "Fires when the textarea is updated with content from the editor iframe.",
+ "sig" : "function (_self, html)\n{\n\n}",
+ "memberOf" : "",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "HtmlEditor",
"desc" : "",
"isOptional" : false
},
{
- "name" : "e",
- "type" : "Roo.EventObject",
- "desc" : "The event object",
+ "name" : "html",
+ "type" : "String",
+ "desc" : "",
"isOptional" : false
}
],
{
"name" : "clearInvalid",
"type" : "function",
- "desc" : "Clear any invalid styles/messages for this field",
+ "desc" : "Overridden and disabled. The editor element does not support standard valid/invalid marking. @hide",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.form.Field",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"params" : [],
"returns" : []
},
+ {
+ "name" : "createToolbar",
+ "type" : "function",
+ "desc" : "Protected method that will not generally be called directly. It\nis called when the editor creates its toolbar. Override this method if you need to\nadd custom toolbar buttons.",
+ "sig" : "(editor)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "editor",
+ "type" : "HtmlEditor",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
{
"name" : "destroy",
"type" : "function",
}
]
},
+ {
+ "name" : "getSelectedNode",
+ "type" : "function",
+ "desc" : "get the Context selected node",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
{
"name" : "getSize",
"type" : "function",
{
"name" : "markInvalid",
"type" : "function",
- "desc" : "Mark this field as invalid",
- "sig" : "(msg)",
+ "desc" : "Overridden and disabled. The editor element does not support standard valid/invalid marking. @hide",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.form.Field",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "msg",
- "type" : "String",
- "desc" : "The validation message",
- "isOptional" : false
- }
- ],
+ "params" : [],
"returns" : []
},
{
{
"name" : "setValue",
"type" : "function",
- "desc" : "Sets the value of the item.",
- "sig" : "(either)",
+ "desc" : "Sets a data value into the field and validates it. To set the value directly without validation see {@link #setRawValue}.",
+ "sig" : "(value)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.form.Field",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "either",
- "type" : "String",
- "desc" : "an object or a string..",
+ "name" : "value",
+ "type" : "Mixed",
+ "desc" : "The value to set",
"isOptional" : false
}
],
"params" : [],
"returns" : []
},
+ {
+ "name" : "toggleSourceEdit",
+ "type" : "function",
+ "desc" : "Toggles the editor between standard and source edit mode.",
+ "sig" : "(sourceEdit)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "sourceEdit",
+ "type" : "Boolean",
+ "desc" : "(optional) True for source edit, false for standard",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
{
"name" : "un",
"type" : "function",
],
"returns" : []
},
+ {
+ "name" : "updateLanguage",
+ "type" : "function",
+ "desc" : "update the language in the body - really done by core",
+ "sig" : "(language)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "language",
+ "type" : "String",
+ "desc" : "- eg. en / ar / zh-CN etc..",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
{
"name" : "validate",
"type" : "function",
],
"isAbstract" : false,
"isBuilderTop" : false,
- "childClasses" : { },
+ "implementations" : [],
"tree_children" : [],
"tree_parent" : []
},
- "Roo.form.Hidden" : {
+ "Roo.form.HtmlEditor.ToolbarContext" : {
"props" : [
{
- "name" : "actionMode",
- "type" : "String",
- "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el' for forms you probably want to set this to fieldEl",
- "memberOf" : "Roo.Component"
- },
- {
- "name" : "allowBlank",
- "type" : "Boolean",
- "desc" : "False to validate that the value length > 0 (defaults to true)",
- "memberOf" : "Roo.form.TextField"
+ "name" : "disable",
+ "type" : "Object",
+ "desc" : "List of toolbar elements to disable",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
- "name" : "allowDomMove",
- "type" : "Boolean",
- "desc" : "Whether the component can move the Dom node when rendering (defaults to true).",
- "memberOf" : "Roo.Component"
- },
+ "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" : "",
+ "isOptional" : false,
+ "optvals" : []
+ }
+ ],
+ "events" : [],
+ "methods" : [
{
- "name" : "allowLeadingSpace",
- "type" : "Boolean",
- "desc" : "True to prevent the stripping of leading white space",
- "memberOf" : "Roo.form.TextField"
- },
+ "name" : "updateToolbar",
+ "type" : "function",
+ "desc" : "Protected method that will not generally be called directly. It triggers\na toolbar update by reading the markup state of the current selection in the editor.\n\nNote you can force an update by calling on('editorevent', scope, false)",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ }
+ ],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "implementations" : [],
+ "tree_children" : [],
+ "tree_parent" : []
+ },
+ "Roo.form.HtmlEditor.ToolbarStandard" : {
+ "props" : [
{
- "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" : "btns[]",
+ "type" : "Roo.Toolbar.Item|Roo.Toolbar.Button|Roo.Toolbar.SplitButton|Roo.form.Field",
+ "desc" : "List of additional buttons.\n\n\nNEEDS Extra CSS? \n.x-html-editor-tb .x-edit-none .x-btn-text { background: none; }",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
- "name" : "blankText",
+ "name" : "createLinkText",
"type" : "String",
- "desc" : "Error text to display if the allow blank validation fails (defaults to \"This field is required\")",
- "memberOf" : "Roo.form.TextField"
+ "desc" : "The default text for the create link prompt",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
- "name" : "cls",
+ "name" : "defaultFont",
"type" : "String",
- "desc" : "A CSS class to apply to the field's underlying element.",
- "memberOf" : "Roo.form.Field"
+ "desc" : "default font to use.",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
- "name" : "disableClass",
+ "name" : "defaultLinkValue",
"type" : "String",
- "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").",
- "memberOf" : "Roo.Component"
+ "desc" : "The default value for the create link prompt (defaults to http:/ /)",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
- "name" : "disableKeyFilter",
- "type" : "Boolean",
- "desc" : "True to disable input keystroke filtering (defaults to false)",
- "memberOf" : "Roo.form.TextField"
+ "name" : "disable",
+ "type" : "Object",
+ "desc" : "List of elements to disable..",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
- "name" : "disabled",
- "type" : "Boolean",
- "desc" : "True to disable the field (defaults to false).",
- "memberOf" : "Roo.form.Field"
- },
+ "name" : "fontFamilies",
+ "type" : "Array",
+ "desc" : "An array of available font families",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ }
+ ],
+ "events" : [],
+ "methods" : [
{
- "name" : "emptyText",
- "type" : "String",
- "desc" : "The default text to display in an empty field - placeholder... (defaults to null).",
- "memberOf" : "Roo.form.TextField"
- },
+ "name" : "updateToolbar",
+ "type" : "function",
+ "desc" : "Protected method that will not generally be called directly. It triggers\na toolbar update by reading the markup state of the current selection in the editor.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ }
+ ],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "implementations" : [],
+ "tree_children" : [],
+ "tree_parent" : []
+ },
+ "Roo.form.Layout" : {
+ "props" : [
{
- "name" : "fieldClass",
+ "name" : "actionMode",
"type" : "String",
- "desc" : "The default CSS class for the field (defaults to \"x-form-field\")",
- "memberOf" : "Roo.form.Field"
+ "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el' for forms you probably want to set this to fieldEl",
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
- "name" : "fieldLabel",
- "type" : "String",
- "desc" : "Label to use when rendering a form.",
- "memberOf" : "Roo.form.Field"
+ "name" : "allowDomMove",
+ "type" : "Boolean",
+ "desc" : "Whether the component can move the Dom node when rendering (defaults to true).",
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
- "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" : "autoCreate",
+ "type" : "String/Object",
+ "desc" : "A DomHelper element spec used to autocreate the layout (defaults to {tag: 'div', cls: 'x-form-ct'})",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
- "name" : "grow",
+ "name" : "clear",
"type" : "Boolean",
- "desc" : "True if this field should automatically grow and shrink to its content",
- "memberOf" : "Roo.form.TextField"
- },
- {
- "name" : "growMax",
- "type" : "Number",
- "desc" : "The maximum width to allow when grow = true (defaults to 800)",
- "memberOf" : "Roo.form.TextField"
+ "desc" : "True to add a clearing element at the end of this layout, equivalent to CSS clear: both (defaults to true)",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
- "name" : "growMin",
- "type" : "Number",
- "desc" : "The minimum width to allow when grow = true (defaults to 30)",
- "memberOf" : "Roo.form.TextField"
+ "name" : "disableClass",
+ "type" : "String",
+ "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").",
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
- "name" : "height",
- "type" : "Number",
- "desc" : "height (optional) size of component",
- "memberOf" : "Roo.BoxComponent"
+ "name" : "hideLabels",
+ "type" : "Boolean",
+ "desc" : "True to suppress the display of field labels in this layout (defaults to false)",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "hideMode",
"type" : "String",
- "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".",
- "memberOf" : "Roo.Component"
+ "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display",
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : [
+ "display",
+ "visibility"
+ ]
},
{
- "name" : "inputType",
+ "name" : "labelAlign",
"type" : "String",
- "desc" : "The type attribute for input fields -- e.g. radio, text, password (defaults to \"text\").",
- "memberOf" : "Roo.form.Field"
+ "desc" : "t)\nValid values are \"left,\" \"top\" and \"right\" (defaults to \"left",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : [
+ "left",
+ "top",
+ "right"
+ ]
},
{
- "name" : "invalidClass",
+ "name" : "labelSeparator",
"type" : "String",
- "desc" : "The CSS class to use when marking a field invalid (defaults to \"x-form-invalid\")",
- "memberOf" : "Roo.form.Field"
+ "desc" : "The separator to use after field labels (defaults to ':')",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
- "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" : "labelWidth",
+ "type" : "Number",
+ "desc" : "Fixed width in pixels of all field labels (defaults to undefined)",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"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"
- },
- {
- "name" : "maskRe",
- "type" : "String",
- "desc" : "An input mask regular expression that will be used to filter keystrokes that don't match (defaults to null)",
- "memberOf" : "Roo.form.TextField"
- },
- {
- "name" : "maxLength",
- "type" : "Number",
- "desc" : "Maximum input field length allowed (defaults to Number.MAX_VALUE)",
- "memberOf" : "Roo.form.TextField"
- },
- {
- "name" : "maxLengthText",
- "type" : "String",
- "desc" : "Error text to display if the maximum length validation fails (defaults to \"The maximum length for this field is {maxLength}\")",
- "memberOf" : "Roo.form.TextField"
- },
- {
- "name" : "minLength",
- "type" : "Number",
- "desc" : "Minimum input field length required (defaults to 0)",
- "memberOf" : "Roo.form.TextField"
- },
- {
- "name" : "minLengthText",
- "type" : "String",
- "desc" : "Error text to display if the minimum length validation fails (defaults to \"The minimum length for this field is {minLength}\")",
- "memberOf" : "Roo.form.TextField"
- },
- {
- "name" : "msgFx",
- "type" : "String",
- "desc" : "<b>Experimental</b> The effect used when displaying a validation message under the field (defaults to 'normal').",
- "memberOf" : "Roo.form.Field"
- },
- {
- "name" : "msgTarget",
- "type" : "String",
- "desc" : "The location where error text should display. Should be one of the following values (defaults to 'qtip'):\n<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" : "name",
- "type" : "String",
- "desc" : "The field's HTML name attribute.",
- "memberOf" : "Roo.form.Field"
- },
- {
- "name" : "qtip",
- "type" : "String",
- "desc" : "Mouse over tip",
- "memberOf" : "Roo.form.Field"
- },
- {
- "name" : "readOnly",
- "type" : "Boolean",
- "desc" : "True to mark the field as readOnly in HTML (defaults to false) -- Note: this only sets the element's readOnly DOM attribute.",
- "memberOf" : "Roo.form.Field"
- },
- {
- "name" : "regex",
- "type" : "RegExp",
- "desc" : "A JavaScript RegExp object to be tested against the field value during validation (defaults to null).\nIf available, this regex will be evaluated only after the basic validators all return true, and will be passed the\ncurrent field value. If the test fails, the field will be marked invalid using {@link #regexText}.",
- "memberOf" : "Roo.form.TextField"
- },
- {
- "name" : "regexText",
- "type" : "String",
- "desc" : "The error text to display if {@link #regex} is used and the test fails during validation (defaults to \"\")",
- "memberOf" : "Roo.form.TextField"
- },
- {
- "name" : "selectOnFocus",
- "type" : "Boolean",
- "desc" : "True to automatically select any existing field text when the field receives input focus (defaults to false)",
- "memberOf" : "Roo.form.TextField"
- },
- {
- "name" : "tabIndex",
- "type" : "Number",
- "desc" : "The tabIndex for this field. Note this only applies to fields that are rendered, not those which are built via applyTo (defaults to undefined).",
- "memberOf" : "Roo.form.Field"
- },
- {
- "name" : "validateOnBlur",
- "type" : "Boolean",
- "desc" : "Whether the field should validate when it loses focus (defaults to true).",
- "memberOf" : "Roo.form.Field"
- },
- {
- "name" : "validationDelay",
- "type" : "Number",
- "desc" : "The length of time in milliseconds after user input begins until validation is initiated (defaults to 250)",
- "memberOf" : "Roo.form.Field"
- },
- {
- "name" : "validationEvent",
- "type" : "String/Boolean",
- "desc" : "The event that should initiate field validation. Set to false to disable\n automatic validation (defaults to \"keyup\").",
- "memberOf" : "Roo.form.Field"
- },
- {
- "name" : "validator",
- "type" : "Function",
- "desc" : "A custom validation function to be called during field validation (defaults to null).\nIf available, this function will be called only after the basic validators all return true, and will be passed the\ncurrent field value and expected to return boolean true if the value is valid or a string error message if invalid.",
- "memberOf" : "Roo.form.TextField"
- },
- {
- "name" : "value",
- "type" : "Mixed",
- "desc" : "A value to initialize this field with.",
- "memberOf" : "Roo.form.Field"
- },
- {
- "name" : "vtype",
- "type" : "String",
- "desc" : "A validation type name as defined in {@link Roo.form.VTypes} (defaults to null)",
- "memberOf" : "Roo.form.TextField"
+ "memberOf" : "Roo.util.Observable",
+ "isOptional" : false,
+ "optvals" : []
},
{
- "name" : "width",
- "type" : "Number",
- "desc" : "width (optional) size of component",
- "memberOf" : "Roo.BoxComponent"
+ "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" : "",
+ "isOptional" : false,
+ "optvals" : []
}
],
"events" : [
- {
- "name" : "autosize",
- "type" : "function",
- "desc" : "Fires when the autosize function is triggered. The field may or may not have actually changed size\naccording to the default logic, but this event provides a hook for the developer to apply additional\nlogic at runtime to resize the field if needed.",
- "sig" : "function (_self, width)\n{\n\n}",
- "memberOf" : "Roo.form.TextField",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.form.Field",
- "desc" : "This text field",
- "isOptional" : false
- },
- {
- "name" : "width",
- "type" : "Number",
- "desc" : "The new field width",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
{
"name" : "beforedestroy",
"type" : "function",
],
"returns" : []
},
- {
- "name" : "blur",
- "type" : "function",
- "desc" : "Fires when this field loses input focus.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.form.Field",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.form.Field",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "change",
- "type" : "function",
- "desc" : "Fires just before the field blurs if the field value has changed.",
- "sig" : "function (_self, newValue, oldValue)\n{\n\n}",
- "memberOf" : "Roo.form.Field",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.form.Field",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "newValue",
- "type" : "Mixed",
- "desc" : "The new value",
- "isOptional" : false
- },
- {
- "name" : "oldValue",
- "type" : "Mixed",
- "desc" : "The original value",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
{
"name" : "destroy",
"type" : "function",
],
"returns" : []
},
- {
- "name" : "focus",
- "type" : "function",
- "desc" : "Fires when this field receives input focus.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.form.Field",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.form.Field",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
{
"name" : "hide",
"type" : "function",
],
"returns" : []
},
- {
- "name" : "invalid",
- "type" : "function",
- "desc" : "Fires after the field has been marked as invalid.",
- "sig" : "function (_self, msg)\n{\n\n}",
- "memberOf" : "Roo.form.Field",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.form.Field",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "msg",
- "type" : "String",
- "desc" : "The validation message",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "keyup",
- "type" : "function",
- "desc" : "Fires after the key up",
- "sig" : "function (_self, e)\n{\n\n}",
- "memberOf" : "Roo.form.Field",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.form.Field",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "e",
- "type" : "Roo.EventObject",
- "desc" : "The event Object",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "move",
- "type" : "function",
- "desc" : "Fires after the component is moved.",
- "sig" : "function (_self, x, y)\n{\n\n}",
- "memberOf" : "Roo.BoxComponent",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.Component",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "x",
- "type" : "Number",
- "desc" : "The new x position",
- "isOptional" : false
- },
- {
- "name" : "y",
- "type" : "Number",
- "desc" : "The new y position",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
{
"name" : "render",
"type" : "function",
],
"returns" : []
},
- {
- "name" : "resize",
- "type" : "function",
- "desc" : "Fires after the component is resized.",
- "sig" : "function (_self, adjWidth, adjHeight, rawWidth, rawHeight)\n{\n\n}",
- "memberOf" : "Roo.BoxComponent",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.Component",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "adjWidth",
- "type" : "Number",
- "desc" : "The box-adjusted width that was set",
- "isOptional" : false
- },
- {
- "name" : "adjHeight",
- "type" : "Number",
- "desc" : "The box-adjusted height that was set",
- "isOptional" : false
- },
- {
- "name" : "rawWidth",
- "type" : "Number",
- "desc" : "The width that was originally specified",
- "isOptional" : false
- },
- {
- "name" : "rawHeight",
- "type" : "Number",
- "desc" : "The height that was originally specified",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
{
"name" : "show",
"type" : "function",
}
],
"returns" : []
- },
- {
- "name" : "specialkey",
- "type" : "function",
- "desc" : "Fires when any key related to navigation (arrows, tab, enter, esc, etc.) is pressed. You can check\n{@link Roo.EventObject#getKey} to determine which key was pressed.",
- "sig" : "function (_self, e)\n{\n\n}",
- "memberOf" : "Roo.form.Field",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.form.Field",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "e",
- "type" : "Roo.EventObject",
- "desc" : "The event object",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "valid",
- "type" : "function",
- "desc" : "Fires after the field has been validated with no errors.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.form.Field",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.form.Field",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
}
],
"methods" : [
"returns" : []
},
{
- "name" : "applyTo",
+ "name" : "addxtype",
"type" : "function",
- "desc" : "Apply the behaviors of this component to an existing element. <b>This is used instead of render().</b>",
- "sig" : "(el)",
+ "desc" : "Adds a object form elements (using the xtype property as the factory method.)\nValid xtypes are: TextField, TextArea .... Button, Layout, FieldSet, Column",
+ "sig" : "(config)",
"static" : false,
- "memberOf" : "Roo.form.Field",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "el",
- "type" : "String/HTMLElement/Element",
- "desc" : "The id of the node, a DOM node or an existing Element",
- "isOptional" : false
- }
- ],
- "returns" : [
- {
- "name" : "",
- "type" : "Roo.form.Field",
- "desc" : "this"
- }
- ]
- },
- {
- "name" : "autoSize",
- "type" : "function",
- "desc" : "Automatically grows the field to accomodate the width of the text up to the maximum field width allowed.\nThis only takes effect if grow = true, and fires the autosize event.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.form.TextField",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
+ "name" : "config",
+ "type" : "Object",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
"returns" : []
},
{
],
"returns" : []
},
- {
- "name" : "clearInvalid",
- "type" : "function",
- "desc" : "Clear any invalid styles/messages for this field",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.form.Field",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
{
"name" : "destroy",
"type" : "function",
}
]
},
- {
- "name" : "getBox",
- "type" : "function",
- "desc" : "Gets the current box measurements of the component's underlying element.",
- "sig" : "(local)",
- "static" : false,
- "memberOf" : "Roo.BoxComponent",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "local",
- "type" : "Boolean",
- "desc" : "(optional) If true the element's left and top are returned instead of page XY (defaults to false)",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
{
"name" : "getEl",
"type" : "function",
}
]
},
- {
- "name" : "getName",
- "type" : "function",
- "desc" : "Returns the name attribute of the field if available",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.form.Field",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : [
- {
- "name" : "",
- "type" : "String",
- "desc" : "name The field name"
- }
- ]
- },
- {
- "name" : "getPosition",
- "type" : "function",
- "desc" : "Gets the current XY position of the component's underlying element.",
- "sig" : "(local)",
- "static" : false,
- "memberOf" : "Roo.BoxComponent",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "local",
- "type" : "Boolean",
- "desc" : "(optional) If true the element's left and top are returned instead of page XY (defaults to false)",
- "isOptional" : false
- }
- ],
- "returns" : [
- {
- "name" : "",
- "type" : "Array",
- "desc" : "The XY position of the element (e.g., [100, 200])"
- }
- ]
- },
- {
- "name" : "getRawValue",
- "type" : "function",
- "desc" : "Returns the raw data value which may or may not be a valid, defined value. To return a normalized value see {@link #getValue}.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.form.Field",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : [
- {
- "name" : "",
- "type" : "Mixed",
- "desc" : "value The field value"
- }
- ]
- },
- {
- "name" : "getSize",
- "type" : "function",
- "desc" : "Gets the current size of the component's underlying element.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.BoxComponent",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : [
- {
- "name" : "",
- "type" : "Object",
- "desc" : "An object containing the element's size {width: (element width), height: (element height)}"
- }
- ]
- },
- {
- "name" : "getValue",
- "type" : "function",
- "desc" : "Returns the normalized data value (undefined or emptyText will be returned as ''). To return the raw value see {@link #getRawValue}.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.form.Field",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : [
- {
- "name" : "",
- "type" : "Mixed",
- "desc" : "value The field value"
- }
- ]
- },
- {
- "name" : "hasChanged",
- "type" : "function",
- "desc" : "checks the current value against the 'loaded' value.\nNote - will return false if 'resetHasChanged' has not been called first.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.form.Field",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
{
"name" : "hasListener",
"type" : "function",
}
]
},
- {
- "name" : "isDirty",
- "type" : "function",
- "desc" : "Returns true if this field has been changed since it was originally loaded and is not disabled.\nDEPRICATED - it never worked well - use hasChanged/resetHasChanged.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.form.Field",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
- {
- "name" : "isValid",
- "type" : "function",
- "desc" : "Returns whether or not the field value is currently valid",
- "sig" : "(preventMark)",
- "static" : false,
- "memberOf" : "Roo.form.Field",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "preventMark",
- "type" : "Boolean",
- "desc" : "True to disable marking the field invalid",
- "isOptional" : false
- }
- ],
- "returns" : [
- {
- "name" : "",
- "type" : "Boolean",
- "desc" : "True if the value is valid, else false"
- }
- ]
- },
{
"name" : "isVisible",
"type" : "function",
"params" : [],
"returns" : []
},
- {
- "name" : "markInvalid",
- "type" : "function",
- "desc" : "Mark this field as invalid",
- "sig" : "(msg)",
- "static" : false,
- "memberOf" : "Roo.form.Field",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "msg",
- "type" : "String",
- "desc" : "The validation message",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
{
"name" : "on",
"type" : "function",
],
"returns" : []
},
- {
- "name" : "onPosition",
- "type" : "function",
- "desc" : "Called after the component is moved, this method is empty by default but can be implemented by any\nsubclass that needs to perform custom logic after a move occurs.",
- "sig" : "(x, y)",
- "static" : false,
- "memberOf" : "Roo.BoxComponent",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "x",
- "type" : "Number",
- "desc" : "The new x position",
- "isOptional" : false
- },
- {
- "name" : "y",
- "type" : "Number",
- "desc" : "The new y position",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "onResize",
- "type" : "function",
- "desc" : "Called after the component is resized, this method is empty by default but can be implemented by any\nsubclass that needs to perform custom logic after a resize occurs.",
- "sig" : "(adjWidth, adjHeight, rawWidth, rawHeight)",
- "static" : false,
- "memberOf" : "Roo.BoxComponent",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "adjWidth",
- "type" : "Number",
- "desc" : "The box-adjusted width that was set",
- "isOptional" : false
- },
- {
- "name" : "adjHeight",
- "type" : "Number",
- "desc" : "The box-adjusted height that was set",
- "isOptional" : false
- },
- {
- "name" : "rawWidth",
- "type" : "Number",
- "desc" : "The width that was originally specified",
- "isOptional" : false
- },
- {
- "name" : "rawHeight",
- "type" : "Number",
- "desc" : "The height that was originally specified",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
{
"name" : "purgeListeners",
"type" : "function",
],
"returns" : []
},
- {
- "name" : "reset",
- "type" : "function",
- "desc" : "Resets the current field value to the originally-loaded value and clears any validation messages.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.form.TextField",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
- {
- "name" : "resetHasChanged",
- "type" : "function",
- "desc" : "stores the current value in loadedValue",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.form.Field",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
- {
- "name" : "selectText",
- "type" : "function",
- "desc" : "Selects text in this field",
- "sig" : "(start, end)",
- "static" : false,
- "memberOf" : "Roo.form.TextField",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "start",
- "type" : "Number",
- "desc" : "(optional) The index where the selection should start (defaults to 0)",
- "isOptional" : false
- },
- {
- "name" : "end",
- "type" : "Number",
- "desc" : "(optional) The index where the selection should end (defaults to the text length)",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
{
"name" : "setDisabled",
"type" : "function",
],
"returns" : []
},
- {
- "name" : "setPagePosition",
- "type" : "function",
- "desc" : "Sets the page XY position of the component. To set the left and top instead, use {@link #setPosition}.\nThis method fires the move event.",
- "sig" : "(x, y)",
- "static" : false,
- "memberOf" : "Roo.BoxComponent",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "x",
- "type" : "Number",
- "desc" : "The new x position",
- "isOptional" : false
- },
- {
- "name" : "y",
- "type" : "Number",
- "desc" : "The new y position",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "setPosition",
- "type" : "function",
- "desc" : "Sets the left and top of the component. To set the page XY position instead, use {@link #setPagePosition}.\nThis method fires the move event.",
- "sig" : "(left, top)",
- "static" : false,
- "memberOf" : "Roo.BoxComponent",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "left",
- "type" : "Number",
- "desc" : "The new left",
- "isOptional" : false
- },
- {
- "name" : "top",
- "type" : "Number",
- "desc" : "The new top",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "setRawValue",
- "type" : "function",
- "desc" : "Sets the underlying DOM field's value directly, bypassing validation. To set the value with validation see {@link #setValue}.",
- "sig" : "(value)",
- "static" : false,
- "memberOf" : "Roo.form.Field",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "value",
- "type" : "Mixed",
- "desc" : "The value to set",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "setSize",
- "type" : "function",
- "desc" : "Sets the width and height of the component. This method fires the resize event. This method can accept\neither width and height as separate numeric arguments, or you can pass a size object like {width:10, height:20}.",
- "sig" : "(width, height)",
- "static" : false,
- "memberOf" : "Roo.BoxComponent",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "width",
- "type" : "Number/Object",
- "desc" : "The new width to set, or a size object in the format {width, height}",
- "isOptional" : false
- },
- {
- "name" : "height",
- "type" : "Number",
- "desc" : "The new height to set (not required if a size object is passed as the first arg)",
- "isOptional" : false
- }
- ],
- "returns" : [
- {
- "name" : "",
- "type" : "Roo.BoxComponent",
- "desc" : "this"
- }
- ]
- },
- {
- "name" : "setValue",
- "type" : "function",
- "desc" : "Sets a data value into the field and validates it. To set the value directly without validation see {@link #setRawValue}.",
- "sig" : "(value)",
- "static" : false,
- "memberOf" : "Roo.form.Field",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "value",
- "type" : "Mixed",
- "desc" : "The value to set",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
{
"name" : "setVisible",
"type" : "function",
}
]
},
- {
- "name" : "syncSize",
- "type" : "function",
- "desc" : "Force the component's size to recalculate based on the underlying element's current height and width.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.BoxComponent",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
{
"name" : "un",
"type" : "function",
}
],
"returns" : []
- },
- {
- "name" : "updateBox",
- "type" : "function",
- "desc" : "Sets the current box measurements of the component's underlying element.",
- "sig" : "(box)",
- "static" : false,
- "memberOf" : "Roo.BoxComponent",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "box",
- "type" : "Object",
- "desc" : "An object in the format {x, y, width, height}",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "validate",
- "type" : "function",
- "desc" : "Validates the field value",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.form.Field",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : [
- {
- "name" : "",
- "type" : "Boolean",
- "desc" : "True if the value is valid, else false"
- }
- ]
- },
- {
- "name" : "validateValue",
- "type" : "function",
- "desc" : "Validates a value according to the field's validation rules and marks the field as invalid\nif the validation fails",
- "sig" : "(value)",
- "static" : false,
- "memberOf" : "Roo.form.TextField",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "value",
- "type" : "Mixed",
- "desc" : "The value to validate",
- "isOptional" : false
- }
- ],
- "returns" : [
- {
- "name" : "",
- "type" : "Boolean",
- "desc" : "True if the value is valid, else false"
- }
- ]
}
],
"isAbstract" : false,
"isBuilderTop" : false,
- "childClasses" : { },
- "tree_children" : [],
+ "implementations" : [
+ "Roo.form.Column",
+ "Roo.form.FieldSet",
+ "Roo.form.Row"
+ ],
+ "tree_children" : [
+ "Roo.form.Column",
+ "Roo.form.Row",
+ "Roo.form.Field",
+ "Roo.form.Checkbox",
+ "Roo.form.ComboBox",
+ "Roo.form.ComboBoxArray",
+ "Roo.form.ComboCheck",
+ "Roo.form.ComboNested",
+ "Roo.form.DateField",
+ "Roo.form.DayPicker",
+ "Roo.form.DisplayField",
+ "Roo.form.FCKeditor",
+ "Roo.form.GridField",
+ "Roo.form.Hidden",
+ "Roo.form.HtmlEditor",
+ "Roo.form.MonthField",
+ "Roo.form.NumberField",
+ "Roo.form.Radio",
+ "Roo.form.Select",
+ "Roo.form.Signature",
+ "Roo.form.TextArea",
+ "Roo.form.TextField",
+ "Roo.form.TriggerField",
+ "Roo.Button",
+ "Roo.SplitButton",
+ "Roo.Toolbar.Button",
+ "Roo.Toolbar.SplitButton",
+ "Roo.form.TextItem",
+ "Roo.form.FieldSet"
+ ],
"tree_parent" : []
},
- "Roo.form.HtmlEditor" : {
+ "Roo.form.MonthField" : {
"props" : [
{
"name" : "actionMode",
"type" : "String",
"desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el' for forms you probably want to set this to fieldEl",
- "memberOf" : "Roo.Component"
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
- "name" : "allowComments",
- "type" : "boolean",
- "desc" : "- default false - allow comments in HTML source - by default they are stripped - if you are editing email you may need this.",
- "memberOf" : ""
+ "name" : "allowBlank",
+ "type" : "Boolean",
+ "desc" : "False to validate that the value length > 0 (defaults to true)",
+ "memberOf" : "Roo.form.TextField",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "allowDomMove",
"type" : "Boolean",
"desc" : "Whether the component can move the Dom node when rendering (defaults to true).",
- "memberOf" : "Roo.Component"
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
- "name" : "blacklist",
- "type" : "Array",
- "desc" : "of html tags - in addition to standard blacklist.",
- "memberOf" : ""
+ "name" : "allowLeadingSpace",
+ "type" : "Boolean",
+ "desc" : "True to prevent the stripping of leading white space",
+ "memberOf" : "Roo.form.TextField",
+ "isOptional" : false,
+ "optvals" : []
},
{
- "name" : "clearUp",
- "type" : "Boolean",
- "desc" : "",
- "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" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "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" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "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",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "cls",
"type" : "String",
"desc" : "A CSS class to apply to the field's underlying element.",
- "memberOf" : "Roo.form.Field"
+ "memberOf" : "Roo.form.Field",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "disableClass",
"type" : "String",
"desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").",
- "memberOf" : "Roo.Component"
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "disableKeyFilter",
+ "type" : "Boolean",
+ "desc" : "True to disable input keystroke filtering (defaults to false)",
+ "memberOf" : "Roo.form.TextField",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "disabled",
"type" : "Boolean",
"desc" : "True to disable the field (defaults to false).",
- "memberOf" : "Roo.form.Field"
+ "memberOf" : "Roo.form.Field",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "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" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "disabledDatesText",
+ "type" : "String",
+ "desc" : "The tooltip text to display when the date falls on a disabled date (defaults to 'Disabled')",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "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" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "disabledDaysText",
+ "type" : "String",
+ "desc" : "The tooltip to display when the date falls on a disabled day (defaults to 'Disabled')",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "emptyText",
+ "type" : "String",
+ "desc" : "The default text to display in an empty field - placeholder... (defaults to null).",
+ "memberOf" : "Roo.form.TextField",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "fieldClass",
+ "type" : "String",
+ "desc" : "The default CSS class for the field (defaults to \"x-form-field\")",
+ "memberOf" : "Roo.form.Field",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "fieldLabel",
"type" : "String",
"desc" : "Label to use when rendering a form.",
- "memberOf" : "Roo.form.Field"
+ "memberOf" : "Roo.form.Field",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "focusClass",
+ "type" : "String",
+ "desc" : "The CSS class to use when the field receives focus (defaults to \"x-form-focus\")",
+ "memberOf" : "Roo.form.Field",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "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" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "height",
"type" : "Number",
- "desc" : "(in pixels)",
- "memberOf" : ""
+ "desc" : "height (optional) size of component",
+ "memberOf" : "Roo.BoxComponent",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "hideMode",
"type" : "String",
- "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".",
- "memberOf" : "Roo.Component"
+ "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display",
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : [
+ "display",
+ "visibility"
+ ]
+ },
+ {
+ "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",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "inputType",
+ "type" : "String",
+ "desc" : "The type attribute for input fields -- e.g. radio, text, password (defaults to \"text\").",
+ "memberOf" : "Roo.form.Field",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "invalidClass",
+ "type" : "String",
+ "desc" : "The CSS class to use when marking a field invalid (defaults to \"x-form-invalid\")",
+ "memberOf" : "Roo.form.Field",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "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" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"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"
+ "memberOf" : "Roo.util.Observable",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "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",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "maxLength",
+ "type" : "Number",
+ "desc" : "Maximum input field length allowed (defaults to Number.MAX_VALUE)",
+ "memberOf" : "Roo.form.TextField",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "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",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "maxTextf",
+ "type" : "String",
+ "desc" : "The error text to display when the date in the cell is after maxValue (defaults to\n'The date in this field must be before {maxValue}').",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "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" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "minLength",
+ "type" : "Number",
+ "desc" : "Minimum input field length required (defaults to 0)",
+ "memberOf" : "Roo.form.TextField",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "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",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "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" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "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" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "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",
+ "isOptional" : false,
+ "optvals" : []
},
{
"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"
+ "memberOf" : "Roo.form.Field",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "name",
"type" : "String",
"desc" : "The field's HTML name attribute.",
- "memberOf" : "Roo.form.Field"
+ "memberOf" : "Roo.form.Field",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "qtip",
"type" : "String",
"desc" : "Mouse over tip",
- "memberOf" : "Roo.form.Field"
+ "memberOf" : "Roo.form.Field",
+ "isOptional" : false,
+ "optvals" : []
},
{
"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"
+ "memberOf" : "Roo.form.Field",
+ "isOptional" : false,
+ "optvals" : []
},
{
- "name" : "resizable",
+ "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",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "regexText",
"type" : "String",
- "desc" : "'s' or 'se' or 'e' - wrapps the element in a\n Roo.resizable.",
- "memberOf" : ""
+ "desc" : "The error text to display if {@link #regex} is used and the test fails during validation (defaults to \"\")",
+ "memberOf" : "Roo.form.TextField",
+ "isOptional" : false,
+ "optvals" : []
},
{
- "name" : "stylesheets",
- "type" : "Array",
- "desc" : "url of stylesheets. set to [] to disable stylesheets.",
- "memberOf" : ""
+ "name" : "selectOnFocus",
+ "type" : "Boolean",
+ "desc" : "True to automatically select any existing field text when the field receives input focus (defaults to false)",
+ "memberOf" : "Roo.form.TextField",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "style",
+ "type" : "String",
+ "desc" : "css styles to add to component\neg. text-align:right;",
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"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"
+ "memberOf" : "Roo.form.Field",
+ "isOptional" : false,
+ "optvals" : []
},
{
- "name" : "toolbars",
- "type" : "Array",
- "desc" : "Array of toolbars. - defaults to just the Standard one",
- "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" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "useIso",
+ "type" : "Boolean",
+ "desc" : "if enabled, then the date field will use a hidden field to store the \nreal value as iso formated date. default (true)",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "validateOnBlur",
+ "type" : "Boolean",
+ "desc" : "Whether the field should validate when it loses focus (defaults to true).",
+ "memberOf" : "Roo.form.Field",
+ "isOptional" : false,
+ "optvals" : []
},
{
"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"
+ "memberOf" : "Roo.form.Field",
+ "isOptional" : false,
+ "optvals" : []
},
{
"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"
+ "memberOf" : "Roo.form.Field",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "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",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "value",
"type" : "Mixed",
"desc" : "A value to initialize this field with.",
- "memberOf" : "Roo.form.Field"
+ "memberOf" : "Roo.form.Field",
+ "isOptional" : false,
+ "optvals" : []
},
{
- "name" : "whitelist",
- "type" : "Array",
- "desc" : "of html tags - in addition to statndard whitelist",
- "memberOf" : ""
+ "name" : "vtype",
+ "type" : "String",
+ "desc" : "A validation type name as defined in {@link Roo.form.VTypes} (defaults to null)",
+ "memberOf" : "Roo.form.TextField",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "width",
"type" : "Number",
- "desc" : "(in pixels)",
- "memberOf" : ""
+ "desc" : "width (optional) size of component",
+ "memberOf" : "Roo.BoxComponent",
+ "isOptional" : false,
+ "optvals" : []
}
],
"events" : [
{
- "name" : "activate",
+ "name" : "autosize",
"type" : "function",
- "desc" : "Fires when the editor is first receives the focus. Any insertion must wait\nuntil after this event.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "",
+ "desc" : "Fires when the autosize function is triggered. The field may or may not have actually changed size\naccording to the default logic, but this event provides a hook for the developer to apply additional\nlogic at runtime to resize the field if needed.",
+ "sig" : "function (_self, width)\n{\n\n}",
+ "memberOf" : "Roo.form.TextField",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "HtmlEditor",
- "desc" : "",
+ "type" : "Roo.form.Field",
+ "desc" : "This text field",
"isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "autosave",
- "type" : "function",
- "desc" : "Auto save the htmlEditor value as a file into Events",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
+ },
{
- "name" : "this",
- "type" : "HtmlEditor",
- "desc" : "",
+ "name" : "width",
+ "type" : "Number",
+ "desc" : "The new field width",
"isOptional" : false
}
],
],
"returns" : []
},
- {
- "name" : "beforepush",
- "type" : "function",
- "desc" : "Fires before the iframe editor is updated with content from the textarea. Return false\nto cancel the push.",
- "sig" : "function (_self, html)\n{\n\n}",
- "memberOf" : "",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "HtmlEditor",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "html",
- "type" : "String",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
{
"name" : "beforerender",
"type" : "function",
"returns" : []
},
{
- "name" : "beforesync",
+ "name" : "blur",
"type" : "function",
- "desc" : "Fires before the textarea is updated with content from the editor iframe. Return false\nto cancel the sync.",
- "sig" : "function (_self, html)\n{\n\n}",
- "memberOf" : "",
+ "desc" : "Fires when this field loses input focus.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.form.Field",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "HtmlEditor",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "html",
- "type" : "String",
+ "type" : "Roo.form.Field",
"desc" : "",
"isOptional" : false
}
],
"returns" : []
},
- {
- "name" : "blur",
- "type" : "function",
- "desc" : "",
- "sig" : "function ()\n{\n\n}",
- "memberOf" : "",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [],
- "returns" : []
- },
{
"name" : "change",
"type" : "function",
- "desc" : "",
- "sig" : "function ()\n{\n\n}",
- "memberOf" : "",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [],
- "returns" : []
- },
- {
- "name" : "destroy",
- "type" : "function",
- "desc" : "Fires after the component is destroyed.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
+ "desc" : "Fires just before the field blurs if the field value has changed.",
+ "sig" : "function (_self, newValue, oldValue)\n{\n\n}",
+ "memberOf" : "Roo.form.Field",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.Component",
+ "type" : "Roo.form.Field",
"desc" : "",
"isOptional" : false
+ },
+ {
+ "name" : "newValue",
+ "type" : "Mixed",
+ "desc" : "The new value",
+ "isOptional" : false
+ },
+ {
+ "name" : "oldValue",
+ "type" : "Mixed",
+ "desc" : "The original value",
+ "isOptional" : false
}
],
"returns" : []
},
{
- "name" : "disable",
+ "name" : "destroy",
"type" : "function",
- "desc" : "Fires after the component is disabled.",
+ "desc" : "Fires after the component is destroyed.",
"sig" : "function (_self)\n{\n\n}",
"memberOf" : "Roo.Component",
"example" : "",
"returns" : []
},
{
- "name" : "editmodechange",
- "type" : "function",
- "desc" : "Fires when the editor switches edit modes",
- "sig" : "function (_self, sourceEdit)\n{\n\n}",
- "memberOf" : "",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "HtmlEditor",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "sourceEdit",
- "type" : "Boolean",
- "desc" : "True if source edit, false if standard editing.",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "editorevent",
+ "name" : "disable",
"type" : "function",
- "desc" : "Fires when on any editor (mouse up/down cursor movement etc.) - used for toolbar hooks.",
+ "desc" : "Fires after the component is disabled.",
"sig" : "function (_self)\n{\n\n}",
- "memberOf" : "",
+ "memberOf" : "Roo.Component",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "HtmlEditor",
+ "type" : "Roo.Component",
"desc" : "",
"isOptional" : false
}
"returns" : []
},
{
- "name" : "firstfocus",
+ "name" : "focus",
"type" : "function",
- "desc" : "Fires when on first focus - needed by toolbars..",
+ "desc" : "Fires when this field receives input focus.",
"sig" : "function (_self)\n{\n\n}",
- "memberOf" : "",
+ "memberOf" : "Roo.form.Field",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "HtmlEditor",
+ "type" : "Roo.form.Field",
"desc" : "",
"isOptional" : false
}
],
"returns" : []
},
- {
- "name" : "focus",
- "type" : "function",
- "desc" : "",
- "sig" : "function ()\n{\n\n}",
- "memberOf" : "",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [],
- "returns" : []
- },
{
"name" : "hide",
"type" : "function",
],
"returns" : []
},
- {
- "name" : "initialize",
- "type" : "function",
- "desc" : "Fires when the editor is fully initialized (including the iframe)",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "HtmlEditor",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
{
"name" : "invalid",
"type" : "function",
],
"returns" : []
},
- {
- "name" : "push",
- "type" : "function",
- "desc" : "Fires when the iframe editor is updated with content from the textarea.",
- "sig" : "function (_self, html)\n{\n\n}",
- "memberOf" : "",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "HtmlEditor",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "html",
- "type" : "String",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
{
"name" : "render",
"type" : "function",
"returns" : []
},
{
- "name" : "savedpreview",
+ "name" : "select",
"type" : "function",
- "desc" : "preview the saved version of htmlEditor",
- "sig" : "function (_self)\n{\n\n}",
+ "desc" : "Fires when a date is selected",
+ "sig" : "function (combo, date)\n{\n\n}",
"memberOf" : "",
"example" : "",
"deprecated" : "",
"see" : "",
"params" : [
{
- "name" : "this",
- "type" : "HtmlEditor",
- "desc" : "",
+ "name" : "combo",
+ "type" : "Roo.form.MonthFieeld",
+ "desc" : "This combo box",
+ "isOptional" : false
+ },
+ {
+ "name" : "date",
+ "type" : "Date",
+ "desc" : "The date selected",
"isOptional" : false
}
],
{
"name" : "specialkey",
"type" : "function",
- "desc" : "",
- "sig" : "function ()\n{\n\n}",
- "memberOf" : "",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [],
- "returns" : []
- },
- {
- "name" : "stylesheetsclick",
- "type" : "function",
- "desc" : "Fires when press the Sytlesheets button",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.HtmlEditorCore",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "sync",
- "type" : "function",
- "desc" : "Fires when the textarea is updated with content from the editor iframe.",
- "sig" : "function (_self, html)\n{\n\n}",
- "memberOf" : "",
+ "desc" : "Fires when any key related to navigation (arrows, tab, enter, esc, etc.) is pressed. You can check\n{@link Roo.EventObject#getKey} to determine which key was pressed.",
+ "sig" : "function (_self, e)\n{\n\n}",
+ "memberOf" : "Roo.form.Field",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "HtmlEditor",
+ "type" : "Roo.form.Field",
"desc" : "",
"isOptional" : false
},
{
- "name" : "html",
- "type" : "String",
- "desc" : "",
+ "name" : "e",
+ "type" : "Roo.EventObject",
+ "desc" : "The event object",
"isOptional" : false
}
],
}
]
},
+ {
+ "name" : "autoSize",
+ "type" : "function",
+ "desc" : "",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.form.TriggerField",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
{
"name" : "capture",
"type" : "function",
{
"name" : "clearInvalid",
"type" : "function",
- "desc" : "Overridden and disabled. The editor element does not support standard valid/invalid marking. @hide",
+ "desc" : "Clear any invalid styles/messages for this field",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.form.Field",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"params" : [],
"returns" : []
},
- {
- "name" : "createToolbar",
- "type" : "function",
- "desc" : "Protected method that will not generally be called directly. It\nis called when the editor creates its toolbar. Override this method if you need to\nadd custom toolbar buttons.",
- "sig" : "(editor)",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "editor",
- "type" : "HtmlEditor",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
{
"name" : "destroy",
"type" : "function",
{
"name" : "getValue",
"type" : "function",
- "desc" : "Returns the normalized data value (undefined or emptyText will be returned as ''). To return the raw value see {@link #getRawValue}.",
+ "desc" : "Returns the current date value of the date field.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.form.Field",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"returns" : [
{
"name" : "",
- "type" : "Mixed",
- "desc" : "value The field value"
+ "type" : "Date",
+ "desc" : "The date value"
}
]
},
{
"name" : "markInvalid",
"type" : "function",
- "desc" : "Overridden and disabled. The editor element does not support standard valid/invalid marking. @hide",
- "sig" : "()\n{\n\n}",
+ "desc" : "Mark this field as invalid",
+ "sig" : "(msg)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.form.Field",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
+ "params" : [
+ {
+ "name" : "msg",
+ "type" : "String",
+ "desc" : "The validation message",
+ "isOptional" : false
+ }
+ ],
"returns" : []
},
{
],
"returns" : []
},
+ {
+ "name" : "onTriggerClick",
+ "type" : "function",
+ "desc" : "The function that should handle the trigger's click event. This method does nothing by default until overridden\nby an implementing function.",
+ "sig" : "(e)",
+ "static" : false,
+ "memberOf" : "Roo.form.TriggerField",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "e",
+ "type" : "EventObject",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
{
"name" : "purgeListeners",
"type" : "function",
{
"name" : "reset",
"type" : "function",
- "desc" : "Resets the current field value to the originally loaded value and clears any validation messages",
+ "desc" : "Resets the current field value to the originally-loaded value and clears any validation messages.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.form.Field",
+ "memberOf" : "Roo.form.TextField",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"params" : [],
"returns" : []
},
+ {
+ "name" : "selectText",
+ "type" : "function",
+ "desc" : "Selects text in this field",
+ "sig" : "(start, end)",
+ "static" : false,
+ "memberOf" : "Roo.form.TextField",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "start",
+ "type" : "Number",
+ "desc" : "(optional) The index where the selection should start (defaults to 0)",
+ "isOptional" : false
+ },
+ {
+ "name" : "end",
+ "type" : "Number",
+ "desc" : "(optional) The index where the selection should end (defaults to the text length)",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
{
"name" : "setDisabled",
"type" : "function",
{
"name" : "setValue",
"type" : "function",
- "desc" : "Sets a data value into the field and validates it. To set the value directly without validation see {@link #setRawValue}.",
- "sig" : "(value)",
+ "desc" : "Sets the value of the date field. You can pass a date object or any string that can be parsed into a valid\ndate, using MonthField.format as the date format, according to the same rules as {@link Date#parseDate}\n(the default format used is \"m/d/y\").\n<br />Usage:\n<pre><code>\n//All of these calls set the same date value (May 4, 2006)\n\n//Pass a date object:\nvar dt = new Date('5/4/06');\nmonthField.setValue(dt);\n\n//Pass a date string (default format):\nmonthField.setValue('5/4/06');\n\n//Pass a date string (custom format):\nmonthField.format = 'Y-m-d';\nmonthField.setValue('2006-5-4');\n</code></pre>",
+ "sig" : "(date)",
"static" : false,
- "memberOf" : "Roo.form.Field",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "value",
- "type" : "Mixed",
- "desc" : "The value to set",
+ "name" : "date",
+ "type" : "String/Date",
+ "desc" : "The date or valid date string",
"isOptional" : false
}
],
"params" : [],
"returns" : []
},
- {
- "name" : "toggleSourceEdit",
- "type" : "function",
- "desc" : "Toggles the editor between standard and source edit mode.",
- "sig" : "(sourceEdit)",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "sourceEdit",
- "type" : "Boolean",
- "desc" : "(optional) True for source edit, false for standard",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
{
"name" : "un",
"type" : "function",
"desc" : "True if the value is valid, else false"
}
]
- }
- ],
- "isAbstract" : false,
- "isBuilderTop" : false,
- "childClasses" : { },
- "tree_children" : [],
- "tree_parent" : []
- },
- "Roo.form.HtmlEditor.ToolbarContext" : {
- "props" : [
- {
- "name" : "disable",
- "type" : "Object",
- "desc" : "List of toolbar elements to disable",
- "memberOf" : ""
},
{
- "name" : "styles",
- "type" : "Object",
- "desc" : "List of styles \n eg. { '*' : [ 'headline' ] , 'TD' : [ 'underline', 'double-underline' ] } \n\nThese must be defined in the page, so they get rendered correctly..\n.headline { }\nTD.underline { }",
- "memberOf" : ""
- }
- ],
- "events" : [],
- "methods" : [
- {
- "name" : "updateToolbar",
+ "name" : "validateValue",
"type" : "function",
- "desc" : "Protected method that will not generally be called directly. It triggers\na toolbar update by reading the markup state of the current selection in the editor.\n\nNote you can force an update by calling on('editorevent', scope, false)",
- "sig" : "()\n{\n\n}",
+ "desc" : "Validates a value according to the field's validation rules and marks the field as invalid\nif the validation fails",
+ "sig" : "(value)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.form.TextField",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
- "returns" : []
+ "params" : [
+ {
+ "name" : "value",
+ "type" : "Mixed",
+ "desc" : "The value to validate",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Boolean",
+ "desc" : "True if the value is valid, else false"
+ }
+ ]
}
],
"isAbstract" : false,
"isBuilderTop" : false,
- "childClasses" : { },
+ "implementations" : [],
"tree_children" : [],
"tree_parent" : []
},
- "Roo.form.HtmlEditor.ToolbarStandard" : {
+ "Roo.form.NumberField" : {
"props" : [
{
- "name" : "btns",
- "type" : "Array",
- "desc" : "List of additional buttons.\n\n\nNEEDS Extra CSS? \n.x-html-editor-tb .x-edit-none .x-btn-text { background: none; }",
- "memberOf" : ""
+ "name" : "actionMode",
+ "type" : "String",
+ "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el' for forms you probably want to set this to fieldEl",
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
- "name" : "createLinkText",
+ "name" : "allowBlank",
+ "type" : "Boolean",
+ "desc" : "False to validate that the value length > 0 (defaults to true)",
+ "memberOf" : "Roo.form.TextField",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "allowDecimals",
+ "type" : "Boolean",
+ "desc" : "False to disallow decimal values (defaults to true)",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "allowDomMove",
+ "type" : "Boolean",
+ "desc" : "Whether the component can move the Dom node when rendering (defaults to true).",
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "allowLeadingSpace",
+ "type" : "Boolean",
+ "desc" : "True to prevent the stripping of leading white space",
+ "memberOf" : "Roo.form.TextField",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "allowNegative",
+ "type" : "Boolean",
+ "desc" : "False to prevent entering a negative sign (defaults to true)",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "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",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "blankText",
"type" : "String",
- "desc" : "The default text for the create link prompt",
- "memberOf" : ""
+ "desc" : "Error text to display if the allow blank validation fails (defaults to \"This field is required\")",
+ "memberOf" : "Roo.form.TextField",
+ "isOptional" : false,
+ "optvals" : []
},
{
- "name" : "defaultFont",
+ "name" : "cls",
"type" : "String",
- "desc" : "default font to use.",
- "memberOf" : ""
+ "desc" : "A CSS class to apply to the field's underlying element.",
+ "memberOf" : "Roo.form.Field",
+ "isOptional" : false,
+ "optvals" : []
},
{
- "name" : "defaultLinkValue",
+ "name" : "decimalPrecision",
+ "type" : "Number",
+ "desc" : "The maximum precision to display after the decimal separator (defaults to 2)",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "decimalSeparator",
"type" : "String",
- "desc" : "The default value for the create link prompt (defaults to http:/ /)",
- "memberOf" : ""
+ "desc" : "Character(s) to allow as the decimal separator (defaults to '.')",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
- "name" : "disable",
+ "name" : "disableClass",
+ "type" : "String",
+ "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").",
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "disableKeyFilter",
+ "type" : "Boolean",
+ "desc" : "True to disable input keystroke filtering (defaults to false)",
+ "memberOf" : "Roo.form.TextField",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "disabled",
+ "type" : "Boolean",
+ "desc" : "True to disable the field (defaults to false).",
+ "memberOf" : "Roo.form.Field",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "emptyText",
+ "type" : "String",
+ "desc" : "The default text to display in an empty field - placeholder... (defaults to null).",
+ "memberOf" : "Roo.form.TextField",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "fieldClass",
+ "type" : "String",
+ "desc" : "The default CSS class for the field (defaults to \"x-form-field x-form-num-field\")",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "fieldLabel",
+ "type" : "String",
+ "desc" : "Label to use when rendering a form.",
+ "memberOf" : "Roo.form.Field",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "focusClass",
+ "type" : "String",
+ "desc" : "The CSS class to use when the field receives focus (defaults to \"x-form-focus\")",
+ "memberOf" : "Roo.form.Field",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "grow",
+ "type" : "Boolean",
+ "desc" : "True if this field should automatically grow and shrink to its content",
+ "memberOf" : "Roo.form.TextField",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "growMax",
+ "type" : "Number",
+ "desc" : "The maximum width to allow when grow = true (defaults to 800)",
+ "memberOf" : "Roo.form.TextField",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "growMin",
+ "type" : "Number",
+ "desc" : "The minimum width to allow when grow = true (defaults to 30)",
+ "memberOf" : "Roo.form.TextField",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "height",
+ "type" : "Number",
+ "desc" : "height (optional) size of component",
+ "memberOf" : "Roo.BoxComponent",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "hideMode",
+ "type" : "String",
+ "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display",
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : [
+ "display",
+ "visibility"
+ ]
+ },
+ {
+ "name" : "inputType",
+ "type" : "String",
+ "desc" : "The type attribute for input fields -- e.g. radio, text, password (defaults to \"text\").",
+ "memberOf" : "Roo.form.Field",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "invalidClass",
+ "type" : "String",
+ "desc" : "The CSS class to use when marking a field invalid (defaults to \"x-form-invalid\")",
+ "memberOf" : "Roo.form.Field",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "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",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "listeners",
"type" : "Object",
- "desc" : "List of 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",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "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",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "maxLength",
+ "type" : "Number",
+ "desc" : "Maximum input field length allowed (defaults to Number.MAX_VALUE)",
+ "memberOf" : "Roo.form.TextField",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "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",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "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" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "maxValue",
+ "type" : "Number",
+ "desc" : "The maximum allowed value (defaults to Number.MAX_VALUE)",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "minLength",
+ "type" : "Number",
+ "desc" : "Minimum input field length required (defaults to 0)",
+ "memberOf" : "Roo.form.TextField",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "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",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "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" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "minValue",
+ "type" : "Number",
+ "desc" : "The minimum allowed value (defaults to Number.NEGATIVE_INFINITY)",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "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",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "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",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "name",
+ "type" : "String",
+ "desc" : "The field's HTML name attribute.",
+ "memberOf" : "Roo.form.Field",
+ "isOptional" : false,
+ "optvals" : []
},
{
- "name" : "fontFamilies",
- "type" : "Array",
- "desc" : "An array of available font families",
- "memberOf" : ""
- }
- ],
- "events" : [],
- "methods" : [
- {
- "name" : "updateToolbar",
- "type" : "function",
- "desc" : "Protected method that will not generally be called directly. It triggers\na toolbar update by reading the markup state of the current selection in the editor.",
- "sig" : "()\n{\n\n}",
- "static" : false,
+ "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" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- }
- ],
- "isAbstract" : false,
- "isBuilderTop" : false,
- "childClasses" : { },
- "tree_children" : [],
- "tree_parent" : []
- },
- "Roo.form.Layout" : {
- "props" : [
+ "isOptional" : false,
+ "optvals" : []
+ },
{
- "name" : "actionMode",
+ "name" : "qtip",
"type" : "String",
- "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el' for forms you probably want to set this to fieldEl",
- "memberOf" : "Roo.Component"
+ "desc" : "Mouse over tip",
+ "memberOf" : "Roo.form.Field",
+ "isOptional" : false,
+ "optvals" : []
},
{
- "name" : "allowDomMove",
+ "name" : "readOnly",
"type" : "Boolean",
- "desc" : "Whether the component can move the Dom node when rendering (defaults to true).",
- "memberOf" : "Roo.Component"
+ "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",
+ "isOptional" : false,
+ "optvals" : []
},
{
- "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" : "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",
+ "isOptional" : false,
+ "optvals" : []
},
{
- "name" : "clear",
+ "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",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "selectOnFocus",
"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 automatically select any existing field text when the field receives input focus (defaults to false)",
+ "memberOf" : "Roo.form.TextField",
+ "isOptional" : false,
+ "optvals" : []
},
{
- "name" : "disableClass",
+ "name" : "style",
"type" : "String",
- "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").",
- "memberOf" : "Roo.Component"
+ "desc" : "css styles to add to component\neg. text-align:right;",
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
- "name" : "hideLabels",
+ "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",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "validateOnBlur",
"type" : "Boolean",
- "desc" : "True to suppress the display of field labels in this layout (defaults to false)",
- "memberOf" : ""
+ "desc" : "Whether the field should validate when it loses focus (defaults to true).",
+ "memberOf" : "Roo.form.Field",
+ "isOptional" : false,
+ "optvals" : []
},
{
- "name" : "hideMode",
- "type" : "String",
- "desc" : "y)\nHow this component 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" : "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",
+ "isOptional" : false,
+ "optvals" : []
},
{
- "name" : "labelAlign",
- "type" : "String",
- "desc" : "Valid values are \"left,\" \"top\" and \"right\" (defaults to \"left\")",
- "memberOf" : ""
+ "name" : "validationEvent",
+ "type" : "String/Boolean",
+ "desc" : "The event that should initiate field validation. Set to false to disable\n automatic validation (defaults to \"keyup\").",
+ "memberOf" : "Roo.form.Field",
+ "isOptional" : false,
+ "optvals" : []
},
{
- "name" : "labelSeparator",
- "type" : "String",
- "desc" : "The separator to use after field labels (defaults to ':')",
- "memberOf" : ""
+ "name" : "validator",
+ "type" : "Function",
+ "desc" : "A custom validation function to be called during field validation (defaults to null).\nIf available, this function will be called only after the basic validators all return true, and will be passed the\ncurrent field value and expected to return boolean true if the value is valid or a string error message if invalid.",
+ "memberOf" : "Roo.form.TextField",
+ "isOptional" : false,
+ "optvals" : []
},
{
- "name" : "labelWidth",
- "type" : "Number",
- "desc" : "Fixed width in pixels of all field labels (defaults to undefined)",
- "memberOf" : ""
+ "name" : "value",
+ "type" : "Mixed",
+ "desc" : "A value to initialize this field with.",
+ "memberOf" : "Roo.form.Field",
+ "isOptional" : false,
+ "optvals" : []
},
{
- "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"
+ "name" : "vtype",
+ "type" : "String",
+ "desc" : "A validation type name as defined in {@link Roo.form.VTypes} (defaults to null)",
+ "memberOf" : "Roo.form.TextField",
+ "isOptional" : false,
+ "optvals" : []
},
{
- "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" : "width",
+ "type" : "Number",
+ "desc" : "width (optional) size of component",
+ "memberOf" : "Roo.BoxComponent",
+ "isOptional" : false,
+ "optvals" : []
}
],
"events" : [
+ {
+ "name" : "autosize",
+ "type" : "function",
+ "desc" : "Fires when the autosize function is triggered. The field may or may not have actually changed size\naccording to the default logic, but this event provides a hook for the developer to apply additional\nlogic at runtime to resize the field if needed.",
+ "sig" : "function (_self, width)\n{\n\n}",
+ "memberOf" : "Roo.form.TextField",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.form.Field",
+ "desc" : "This text field",
+ "isOptional" : false
+ },
+ {
+ "name" : "width",
+ "type" : "Number",
+ "desc" : "The new field width",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
{
"name" : "beforedestroy",
"type" : "function",
],
"returns" : []
},
+ {
+ "name" : "blur",
+ "type" : "function",
+ "desc" : "Fires when this field loses input focus.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.form.Field",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.form.Field",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "change",
+ "type" : "function",
+ "desc" : "Fires just before the field blurs if the field value has changed.",
+ "sig" : "function (_self, newValue, oldValue)\n{\n\n}",
+ "memberOf" : "Roo.form.Field",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.form.Field",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "newValue",
+ "type" : "Mixed",
+ "desc" : "The new value",
+ "isOptional" : false
+ },
+ {
+ "name" : "oldValue",
+ "type" : "Mixed",
+ "desc" : "The original value",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
{
"name" : "destroy",
"type" : "function",
],
"returns" : []
},
+ {
+ "name" : "focus",
+ "type" : "function",
+ "desc" : "Fires when this field receives input focus.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.form.Field",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.form.Field",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
{
"name" : "hide",
"type" : "function",
],
"returns" : []
},
+ {
+ "name" : "invalid",
+ "type" : "function",
+ "desc" : "Fires after the field has been marked as invalid.",
+ "sig" : "function (_self, msg)\n{\n\n}",
+ "memberOf" : "Roo.form.Field",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.form.Field",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "msg",
+ "type" : "String",
+ "desc" : "The validation message",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "keyup",
+ "type" : "function",
+ "desc" : "Fires after the key up",
+ "sig" : "function (_self, e)\n{\n\n}",
+ "memberOf" : "Roo.form.Field",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.form.Field",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "e",
+ "type" : "Roo.EventObject",
+ "desc" : "The event Object",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "move",
+ "type" : "function",
+ "desc" : "Fires after the component is moved.",
+ "sig" : "function (_self, x, y)\n{\n\n}",
+ "memberOf" : "Roo.BoxComponent",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.Component",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "x",
+ "type" : "Number",
+ "desc" : "The new x position",
+ "isOptional" : false
+ },
+ {
+ "name" : "y",
+ "type" : "Number",
+ "desc" : "The new y position",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
{
"name" : "render",
"type" : "function",
],
"returns" : []
},
+ {
+ "name" : "resize",
+ "type" : "function",
+ "desc" : "Fires after the component is resized.",
+ "sig" : "function (_self, adjWidth, adjHeight, rawWidth, rawHeight)\n{\n\n}",
+ "memberOf" : "Roo.BoxComponent",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.Component",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "adjWidth",
+ "type" : "Number",
+ "desc" : "The box-adjusted width that was set",
+ "isOptional" : false
+ },
+ {
+ "name" : "adjHeight",
+ "type" : "Number",
+ "desc" : "The box-adjusted height that was set",
+ "isOptional" : false
+ },
+ {
+ "name" : "rawWidth",
+ "type" : "Number",
+ "desc" : "The width that was originally specified",
+ "isOptional" : false
+ },
+ {
+ "name" : "rawHeight",
+ "type" : "Number",
+ "desc" : "The height that was originally specified",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
{
"name" : "show",
"type" : "function",
}
],
"returns" : []
+ },
+ {
+ "name" : "specialkey",
+ "type" : "function",
+ "desc" : "Fires when any key related to navigation (arrows, tab, enter, esc, etc.) is pressed. You can check\n{@link Roo.EventObject#getKey} to determine which key was pressed.",
+ "sig" : "function (_self, e)\n{\n\n}",
+ "memberOf" : "Roo.form.Field",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.form.Field",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "e",
+ "type" : "Roo.EventObject",
+ "desc" : "The event object",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "valid",
+ "type" : "function",
+ "desc" : "Fires after the field has been validated with no errors.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.form.Field",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.form.Field",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
}
],
"methods" : [
"returns" : []
},
{
- "name" : "addxtype",
+ "name" : "applyTo",
"type" : "function",
- "desc" : "Adds a object form elements (using the xtype property as the factory method.)\nValid xtypes are: TextField, TextArea .... Button, Layout, FieldSet, Column",
- "sig" : "(config)",
+ "desc" : "Apply the behaviors of this component to an existing element. <b>This is used instead of render().</b>",
+ "sig" : "(el)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.form.Field",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "config",
- "type" : "Object",
- "desc" : "",
+ "name" : "el",
+ "type" : "String/HTMLElement/Element",
+ "desc" : "The id of the node, a DOM node or an existing Element",
"isOptional" : false
}
],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.form.Field",
+ "desc" : "this"
+ }
+ ]
+ },
+ {
+ "name" : "autoSize",
+ "type" : "function",
+ "desc" : "Automatically grows the field to accomodate the width of the text up to the maximum field width allowed.\nThis only takes effect if grow = true, and fires the autosize event.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.form.TextField",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
"returns" : []
},
{
],
"returns" : []
},
+ {
+ "name" : "clearInvalid",
+ "type" : "function",
+ "desc" : "Clear any invalid styles/messages for this field",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.form.Field",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
{
"name" : "destroy",
"type" : "function",
}
]
},
+ {
+ "name" : "getBox",
+ "type" : "function",
+ "desc" : "Gets the current box measurements of the component's underlying element.",
+ "sig" : "(local)",
+ "static" : false,
+ "memberOf" : "Roo.BoxComponent",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "local",
+ "type" : "Boolean",
+ "desc" : "(optional) If true the element's left and top are returned instead of page XY (defaults to false)",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
{
"name" : "getEl",
"type" : "function",
}
]
},
+ {
+ "name" : "getName",
+ "type" : "function",
+ "desc" : "Returns the name attribute of the field if available",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.form.Field",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "String",
+ "desc" : "name The field name"
+ }
+ ]
+ },
+ {
+ "name" : "getPosition",
+ "type" : "function",
+ "desc" : "Gets the current XY position of the component's underlying element.",
+ "sig" : "(local)",
+ "static" : false,
+ "memberOf" : "Roo.BoxComponent",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "local",
+ "type" : "Boolean",
+ "desc" : "(optional) If true the element's left and top are returned instead of page XY (defaults to false)",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Array",
+ "desc" : "The XY position of the element (e.g., [100, 200])"
+ }
+ ]
+ },
+ {
+ "name" : "getRawValue",
+ "type" : "function",
+ "desc" : "Returns the raw data value which may or may not be a valid, defined value. To return a normalized value see {@link #getValue}.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.form.Field",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Mixed",
+ "desc" : "value The field value"
+ }
+ ]
+ },
+ {
+ "name" : "getSize",
+ "type" : "function",
+ "desc" : "Gets the current size of the component's underlying element.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.BoxComponent",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Object",
+ "desc" : "An object containing the element's size {width: (element width), height: (element height)}"
+ }
+ ]
+ },
+ {
+ "name" : "getValue",
+ "type" : "function",
+ "desc" : "Returns the normalized data value (undefined or emptyText will be returned as ''). To return the raw value see {@link #getRawValue}.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.form.Field",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Mixed",
+ "desc" : "value The field value"
+ }
+ ]
+ },
+ {
+ "name" : "hasChanged",
+ "type" : "function",
+ "desc" : "checks the current value against the 'loaded' value.\nNote - will return false if 'resetHasChanged' has not been called first.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.form.Field",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
{
"name" : "hasListener",
"type" : "function",
}
]
},
+ {
+ "name" : "isDirty",
+ "type" : "function",
+ "desc" : "Returns true if this field has been changed since it was originally loaded and is not disabled.\nDEPRICATED - it never worked well - use hasChanged/resetHasChanged.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.form.Field",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
+ {
+ "name" : "isValid",
+ "type" : "function",
+ "desc" : "Returns whether or not the field value is currently valid",
+ "sig" : "(preventMark)",
+ "static" : false,
+ "memberOf" : "Roo.form.Field",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "preventMark",
+ "type" : "Boolean",
+ "desc" : "True to disable marking the field invalid",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Boolean",
+ "desc" : "True if the value is valid, else false"
+ }
+ ]
+ },
{
"name" : "isVisible",
"type" : "function",
"params" : [],
"returns" : []
},
+ {
+ "name" : "markInvalid",
+ "type" : "function",
+ "desc" : "Mark this field as invalid",
+ "sig" : "(msg)",
+ "static" : false,
+ "memberOf" : "Roo.form.Field",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "msg",
+ "type" : "String",
+ "desc" : "The validation message",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
{
"name" : "on",
"type" : "function",
],
"returns" : []
},
+ {
+ "name" : "onPosition",
+ "type" : "function",
+ "desc" : "Called after the component is moved, this method is empty by default but can be implemented by any\nsubclass that needs to perform custom logic after a move occurs.",
+ "sig" : "(x, y)",
+ "static" : false,
+ "memberOf" : "Roo.BoxComponent",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "x",
+ "type" : "Number",
+ "desc" : "The new x position",
+ "isOptional" : false
+ },
+ {
+ "name" : "y",
+ "type" : "Number",
+ "desc" : "The new y position",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "onResize",
+ "type" : "function",
+ "desc" : "Called after the component is resized, this method is empty by default but can be implemented by any\nsubclass that needs to perform custom logic after a resize occurs.",
+ "sig" : "(adjWidth, adjHeight, rawWidth, rawHeight)",
+ "static" : false,
+ "memberOf" : "Roo.BoxComponent",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "adjWidth",
+ "type" : "Number",
+ "desc" : "The box-adjusted width that was set",
+ "isOptional" : false
+ },
+ {
+ "name" : "adjHeight",
+ "type" : "Number",
+ "desc" : "The box-adjusted height that was set",
+ "isOptional" : false
+ },
+ {
+ "name" : "rawWidth",
+ "type" : "Number",
+ "desc" : "The width that was originally specified",
+ "isOptional" : false
+ },
+ {
+ "name" : "rawHeight",
+ "type" : "Number",
+ "desc" : "The height that was originally specified",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
{
"name" : "purgeListeners",
"type" : "function",
],
"returns" : []
},
+ {
+ "name" : "reset",
+ "type" : "function",
+ "desc" : "Resets the current field value to the originally-loaded value and clears any validation messages.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.form.TextField",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
+ {
+ "name" : "resetHasChanged",
+ "type" : "function",
+ "desc" : "stores the current value in loadedValue",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.form.Field",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
+ {
+ "name" : "selectText",
+ "type" : "function",
+ "desc" : "Selects text in this field",
+ "sig" : "(start, end)",
+ "static" : false,
+ "memberOf" : "Roo.form.TextField",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "start",
+ "type" : "Number",
+ "desc" : "(optional) The index where the selection should start (defaults to 0)",
+ "isOptional" : false
+ },
+ {
+ "name" : "end",
+ "type" : "Number",
+ "desc" : "(optional) The index where the selection should end (defaults to the text length)",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
{
"name" : "setDisabled",
"type" : "function",
],
"returns" : []
},
+ {
+ "name" : "setPagePosition",
+ "type" : "function",
+ "desc" : "Sets the page XY position of the component. To set the left and top instead, use {@link #setPosition}.\nThis method fires the move event.",
+ "sig" : "(x, y)",
+ "static" : false,
+ "memberOf" : "Roo.BoxComponent",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "x",
+ "type" : "Number",
+ "desc" : "The new x position",
+ "isOptional" : false
+ },
+ {
+ "name" : "y",
+ "type" : "Number",
+ "desc" : "The new y position",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "setPosition",
+ "type" : "function",
+ "desc" : "Sets the left and top of the component. To set the page XY position instead, use {@link #setPagePosition}.\nThis method fires the move event.",
+ "sig" : "(left, top)",
+ "static" : false,
+ "memberOf" : "Roo.BoxComponent",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "left",
+ "type" : "Number",
+ "desc" : "The new left",
+ "isOptional" : false
+ },
+ {
+ "name" : "top",
+ "type" : "Number",
+ "desc" : "The new top",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "setRawValue",
+ "type" : "function",
+ "desc" : "Sets the underlying DOM field's value directly, bypassing validation. To set the value with validation see {@link #setValue}.",
+ "sig" : "(value)",
+ "static" : false,
+ "memberOf" : "Roo.form.Field",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "value",
+ "type" : "Mixed",
+ "desc" : "The value to set",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "setSize",
+ "type" : "function",
+ "desc" : "Sets the width and height of the component. This method fires the resize event. This method can accept\neither width and height as separate numeric arguments, or you can pass a size object like {width:10, height:20}.",
+ "sig" : "(width, height)",
+ "static" : false,
+ "memberOf" : "Roo.BoxComponent",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "width",
+ "type" : "Number/Object",
+ "desc" : "The new width to set, or a size object in the format {width, height}",
+ "isOptional" : false
+ },
+ {
+ "name" : "height",
+ "type" : "Number",
+ "desc" : "The new height to set (not required if a size object is passed as the first arg)",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.BoxComponent",
+ "desc" : "this"
+ }
+ ]
+ },
+ {
+ "name" : "setValue",
+ "type" : "function",
+ "desc" : "Sets a data value into the field and validates it. To set the value directly without validation see {@link #setRawValue}.",
+ "sig" : "(value)",
+ "static" : false,
+ "memberOf" : "Roo.form.Field",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "value",
+ "type" : "Mixed",
+ "desc" : "The value to set",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
{
"name" : "setVisible",
"type" : "function",
}
]
},
+ {
+ "name" : "syncSize",
+ "type" : "function",
+ "desc" : "Force the component's size to recalculate based on the underlying element's current height and width.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.BoxComponent",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
{
"name" : "un",
"type" : "function",
}
],
"returns" : []
+ },
+ {
+ "name" : "updateBox",
+ "type" : "function",
+ "desc" : "Sets the current box measurements of the component's underlying element.",
+ "sig" : "(box)",
+ "static" : false,
+ "memberOf" : "Roo.BoxComponent",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "box",
+ "type" : "Object",
+ "desc" : "An object in the format {x, y, width, height}",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "validate",
+ "type" : "function",
+ "desc" : "Validates the field value",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.form.Field",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Boolean",
+ "desc" : "True if the value is valid, else false"
+ }
+ ]
+ },
+ {
+ "name" : "validateValue",
+ "type" : "function",
+ "desc" : "Validates a value according to the field's validation rules and marks the field as invalid\nif the validation fails",
+ "sig" : "(value)",
+ "static" : false,
+ "memberOf" : "Roo.form.TextField",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "value",
+ "type" : "Mixed",
+ "desc" : "The value to validate",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Boolean",
+ "desc" : "True if the value is valid, else false"
+ }
+ ]
}
],
"isAbstract" : false,
"isBuilderTop" : false,
- "childClasses" : {
- "Roo.form.Layout" : [
- "Roo.form.Column",
- "Roo.form.FieldSet",
- "Roo.form.Row"
- ]
- },
- "tree_children" : [
- "Roo.form.Column",
- "Roo.form.Row",
- "Roo.form.Field",
- "Roo.form.Checkbox",
- "Roo.form.ComboBox",
- "Roo.form.ComboBoxArray",
- "Roo.form.ComboCheck",
- "Roo.form.ComboNested",
- "Roo.form.DateField",
- "Roo.form.DayPicker",
- "Roo.form.DisplayField",
- "Roo.form.FCKeditor",
- "Roo.form.GridField",
- "Roo.form.Hidden",
- "Roo.form.HtmlEditor",
- "Roo.form.MonthField",
- "Roo.form.NumberField",
- "Roo.form.Radio",
- "Roo.form.Select",
- "Roo.form.Signature",
- "Roo.form.TextArea",
- "Roo.form.TextField",
- "Roo.form.TriggerField",
- "Roo.Button",
- "Roo.SplitButton",
- "Roo.Toolbar.Button",
- "Roo.Toolbar.SplitButton",
- "Roo.form.TextItem"
- ],
+ "implementations" : [],
+ "tree_children" : [],
"tree_parent" : []
},
- "Roo.form.MonthField" : {
+ "Roo.form.Radio" : {
"props" : [
{
"name" : "actionMode",
"type" : "String",
"desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el' for forms you probably want to set this to fieldEl",
- "memberOf" : "Roo.Component"
- },
- {
- "name" : "allowBlank",
- "type" : "Boolean",
- "desc" : "False to validate that the value length > 0 (defaults to true)",
- "memberOf" : "Roo.form.TextField"
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "allowDomMove",
"type" : "Boolean",
"desc" : "Whether the component can move the Dom node when rendering (defaults to true).",
- "memberOf" : "Roo.Component"
- },
- {
- "name" : "allowLeadingSpace",
- "type" : "Boolean",
- "desc" : "True to prevent the stripping of leading white space",
- "memberOf" : "Roo.form.TextField"
- },
- {
- "name" : "altFormats",
- "type" : "String",
- "desc" : "Multiple date formats separated by \"|\" to try when parsing a user input value and it doesn't match the defined\nformat (defaults to 'm/d/Y|m-d-y|m-d-Y|m/d|m-d|d').",
- "memberOf" : ""
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"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" : ""
+ "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",
+ "isOptional" : false,
+ "optvals" : []
},
{
- "name" : "blankText",
+ "name" : "boxLabel",
"type" : "String",
- "desc" : "Error text to display if the allow blank validation fails (defaults to \"This field is required\")",
- "memberOf" : "Roo.form.TextField"
+ "desc" : "The text that appears beside the checkbox",
+ "memberOf" : "Roo.form.Checkbox",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "checked",
+ "type" : "Boolean",
+ "desc" : "True if the the checkbox should render already checked (defaults to false)",
+ "memberOf" : "Roo.form.Checkbox",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "cls",
"type" : "String",
"desc" : "A CSS class to apply to the field's underlying element.",
- "memberOf" : "Roo.form.Field"
+ "memberOf" : "Roo.form.Field",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "disableClass",
"type" : "String",
"desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").",
- "memberOf" : "Roo.Component"
- },
- {
- "name" : "disableKeyFilter",
- "type" : "Boolean",
- "desc" : "True to disable input keystroke filtering (defaults to false)",
- "memberOf" : "Roo.form.TextField"
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "disabled",
"type" : "Boolean",
"desc" : "True to disable the field (defaults to false).",
- "memberOf" : "Roo.form.Field"
- },
- {
- "name" : "disabledDates",
- "type" : "Array",
- "desc" : "An array of \"dates\" to disable, as strings. These strings will be used to build a dynamic regular\nexpression so they are very powerful. Some examples:\n<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" : "disabledDays",
- "type" : "Array",
- "desc" : "An array of days to disable, 0 based. For example, [0, 6] disables Sunday and Saturday (defaults to null).",
- "memberOf" : ""
- },
- {
- "name" : "disabledDaysText",
- "type" : "String",
- "desc" : "The tooltip to display when the date falls on a disabled day (defaults to 'Disabled')",
- "memberOf" : ""
- },
- {
- "name" : "emptyText",
- "type" : "String",
- "desc" : "The default text to display in an empty field - placeholder... (defaults to null).",
- "memberOf" : "Roo.form.TextField"
+ "memberOf" : "Roo.form.Field",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "fieldClass",
"type" : "String",
- "desc" : "The default CSS class for the field (defaults to \"x-form-field\")",
- "memberOf" : "Roo.form.Field"
+ "desc" : "The default CSS class for the checkbox (defaults to \"x-form-field\")",
+ "memberOf" : "Roo.form.Checkbox",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "fieldLabel",
"type" : "String",
"desc" : "Label to use when rendering a form.",
- "memberOf" : "Roo.form.Field"
+ "memberOf" : "Roo.form.Field",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "focusClass",
"type" : "String",
- "desc" : "The CSS class to use when the field receives focus (defaults to \"x-form-focus\")",
- "memberOf" : "Roo.form.Field"
- },
- {
- "name" : "format",
- "type" : "String",
- "desc" : "The default date format string which can be overriden for localization support. The format must be\nvalid according to {@link Date#parseDate} (defaults to 'm/d/y').",
- "memberOf" : ""
+ "desc" : "The CSS class to use when the checkbox receives focus (defaults to undefined)",
+ "memberOf" : "Roo.form.Checkbox",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "height",
"type" : "Number",
"desc" : "height (optional) size of component",
- "memberOf" : "Roo.BoxComponent"
+ "memberOf" : "Roo.BoxComponent",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "hideMode",
"type" : "String",
- "desc" : "y)\nHow this component 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" : "hideTrigger",
- "type" : "Boolean",
- "desc" : "True to hide the trigger element and display only the base text field (defaults to false)",
- "memberOf" : "Roo.form.TriggerField"
+ "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display",
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : [
+ "display",
+ "visibility"
+ ]
},
{
"name" : "inputType",
"type" : "String",
"desc" : "The type attribute for input fields -- e.g. radio, text, password (defaults to \"text\").",
- "memberOf" : "Roo.form.Field"
+ "memberOf" : "Roo.form.Field",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "inputValue",
+ "type" : "String",
+ "desc" : "The value that should go into the generated input element's value attribute",
+ "memberOf" : "Roo.form.Checkbox",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "invalidClass",
"type" : "String",
"desc" : "The CSS class to use when marking a field invalid (defaults to \"x-form-invalid\")",
- "memberOf" : "Roo.form.Field"
+ "memberOf" : "Roo.form.Field",
+ "isOptional" : false,
+ "optvals" : []
},
{
"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" : ""
+ "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",
+ "isOptional" : false,
+ "optvals" : []
},
{
"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"
- },
- {
- "name" : "maskRe",
- "type" : "String",
- "desc" : "An input mask regular expression that will be used to filter keystrokes that don't match (defaults to null)",
- "memberOf" : "Roo.form.TextField"
- },
- {
- "name" : "maxLength",
- "type" : "Number",
- "desc" : "Maximum input field length allowed (defaults to Number.MAX_VALUE)",
- "memberOf" : "Roo.form.TextField"
- },
- {
- "name" : "maxLengthText",
- "type" : "String",
- "desc" : "Error text to display if the maximum length validation fails (defaults to \"The maximum length for this field is {maxLength}\")",
- "memberOf" : "Roo.form.TextField"
- },
- {
- "name" : "maxTextf",
- "type" : "String",
- "desc" : "The error text to display when the date in the cell is after maxValue (defaults to\n'The date in this field must be before {maxValue}').",
- "memberOf" : ""
- },
- {
- "name" : "maxValue",
- "type" : "Date/String",
- "desc" : "The maximum allowed date. Can be either a Javascript date object or a string date in a\nvalid format (defaults to null).",
- "memberOf" : ""
- },
- {
- "name" : "minLength",
- "type" : "Number",
- "desc" : "Minimum input field length required (defaults to 0)",
- "memberOf" : "Roo.form.TextField"
- },
- {
- "name" : "minLengthText",
- "type" : "String",
- "desc" : "Error text to display if the minimum length validation fails (defaults to \"The minimum length for this field is {minLength}\")",
- "memberOf" : "Roo.form.TextField"
- },
- {
- "name" : "minText",
- "type" : "String",
- "desc" : "The error text to display when the date in the cell is before minValue (defaults to\n'The date in this field must be after {minValue}').",
- "memberOf" : ""
- },
- {
- "name" : "minValue",
- "type" : "Date/String",
- "desc" : "The minimum allowed date. Can be either a Javascript date object or a string date in a\nvalid format (defaults to null).",
- "memberOf" : ""
+ "memberOf" : "Roo.util.Observable",
+ "isOptional" : false,
+ "optvals" : []
},
{
"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"
+ "memberOf" : "Roo.form.Field",
+ "isOptional" : false,
+ "optvals" : []
},
{
"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"
+ "memberOf" : "Roo.form.Field",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "name",
"type" : "String",
"desc" : "The field's HTML name attribute.",
- "memberOf" : "Roo.form.Field"
+ "memberOf" : "Roo.form.Field",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "qtip",
"type" : "String",
"desc" : "Mouse over tip",
- "memberOf" : "Roo.form.Field"
+ "memberOf" : "Roo.form.Field",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "readOnly",
"type" : "Boolean",
"desc" : "True to mark the field as readOnly in HTML (defaults to false) -- Note: this only sets the element's readOnly DOM attribute.",
- "memberOf" : "Roo.form.Field"
- },
- {
- "name" : "regex",
- "type" : "RegExp",
- "desc" : "A JavaScript RegExp object to be tested against the field value during validation (defaults to null).\nIf available, this regex will be evaluated only after the basic validators all return true, and will be passed the\ncurrent field value. If the test fails, the field will be marked invalid using {@link #regexText}.",
- "memberOf" : "Roo.form.TextField"
+ "memberOf" : "Roo.form.Field",
+ "isOptional" : false,
+ "optvals" : []
},
{
- "name" : "regexText",
+ "name" : "style",
"type" : "String",
- "desc" : "The error text to display if {@link #regex} is used and the test fails during validation (defaults to \"\")",
- "memberOf" : "Roo.form.TextField"
- },
- {
- "name" : "selectOnFocus",
- "type" : "Boolean",
- "desc" : "True to automatically select any existing field text when the field receives input focus (defaults to false)",
- "memberOf" : "Roo.form.TextField"
+ "desc" : "css styles to add to component\neg. text-align:right;",
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "tabIndex",
"type" : "Number",
"desc" : "The tabIndex for this field. Note this only applies to fields that are rendered, not those which are built via applyTo (defaults to undefined).",
- "memberOf" : "Roo.form.Field"
- },
- {
- "name" : "triggerClass",
- "type" : "String",
- "desc" : "An additional CSS class used to style the trigger button. The trigger will always get the\nclass 'x-form-trigger' and triggerClass will be <b>appended</b> if specified (defaults to 'x-form-date-trigger'\nwhich displays a calendar icon).",
- "memberOf" : ""
- },
- {
- "name" : "useIso",
- "type" : "Boolean",
- "desc" : "if enabled, then the date field will use a hidden field to store the \nreal value as iso formated date. default (true)",
- "memberOf" : ""
+ "memberOf" : "Roo.form.Field",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "validateOnBlur",
"type" : "Boolean",
"desc" : "Whether the field should validate when it loses focus (defaults to true).",
- "memberOf" : "Roo.form.Field"
+ "memberOf" : "Roo.form.Field",
+ "isOptional" : false,
+ "optvals" : []
},
{
"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"
+ "memberOf" : "Roo.form.Field",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "validationEvent",
"type" : "String/Boolean",
"desc" : "The event that should initiate field validation. Set to false to disable\n automatic validation (defaults to \"keyup\").",
- "memberOf" : "Roo.form.Field"
- },
- {
- "name" : "validator",
- "type" : "Function",
- "desc" : "A custom validation function to be called during field validation (defaults to null).\nIf available, this function will be called only after the basic validators all return true, and will be passed the\ncurrent field value and expected to return boolean true if the value is valid or a string error message if invalid.",
- "memberOf" : "Roo.form.TextField"
+ "memberOf" : "Roo.form.Field",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "value",
"type" : "Mixed",
"desc" : "A value to initialize this field with.",
- "memberOf" : "Roo.form.Field"
+ "memberOf" : "Roo.form.Field",
+ "isOptional" : false,
+ "optvals" : []
},
{
- "name" : "vtype",
+ "name" : "valueOff",
"type" : "String",
- "desc" : "A validation type name as defined in {@link Roo.form.VTypes} (defaults to null)",
- "memberOf" : "Roo.form.TextField"
+ "desc" : "The value that should go into the generated input element's value when unchecked.",
+ "memberOf" : "Roo.form.Checkbox",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "width",
"type" : "Number",
"desc" : "width (optional) size of component",
- "memberOf" : "Roo.BoxComponent"
+ "memberOf" : "Roo.BoxComponent",
+ "isOptional" : false,
+ "optvals" : []
}
],
"events" : [
- {
- "name" : "autosize",
- "type" : "function",
- "desc" : "Fires when the autosize function is triggered. The field may or may not have actually changed size\naccording to the default logic, but this event provides a hook for the developer to apply additional\nlogic at runtime to resize the field if needed.",
- "sig" : "function (_self, width)\n{\n\n}",
- "memberOf" : "Roo.form.TextField",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.form.Field",
- "desc" : "This text field",
- "isOptional" : false
- },
- {
- "name" : "width",
- "type" : "Number",
- "desc" : "The new field width",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
{
"name" : "beforedestroy",
"type" : "function",
],
"returns" : []
},
+ {
+ "name" : "check",
+ "type" : "function",
+ "desc" : "Fires when the checkbox is checked or unchecked.",
+ "sig" : "function (_self, checked)\n{\n\n}",
+ "memberOf" : "Roo.form.Checkbox",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.form.Checkbox",
+ "desc" : "This checkbox",
+ "isOptional" : false
+ },
+ {
+ "name" : "checked",
+ "type" : "Boolean",
+ "desc" : "The new checked value",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
{
"name" : "destroy",
"type" : "function",
],
"returns" : []
},
- {
- "name" : "select",
- "type" : "function",
- "desc" : "Fires when a date is selected",
- "sig" : "function (combo, date)\n{\n\n}",
- "memberOf" : "",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "combo",
- "type" : "Roo.form.MonthFieeld",
- "desc" : "This combo box",
- "isOptional" : false
- },
- {
- "name" : "date",
- "type" : "Date",
- "desc" : "The date selected",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
{
"name" : "show",
"type" : "function",
}
]
},
- {
- "name" : "autoSize",
- "type" : "function",
- "desc" : "",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.form.TriggerField",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
{
"name" : "capture",
"type" : "function",
}
]
},
+ {
+ "name" : "getGroupValue",
+ "type" : "function",
+ "desc" : "If this radio is part of a group, it will return the selected value",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "String",
+ "desc" : ""
+ }
+ ]
+ },
{
"name" : "getId",
"type" : "function",
{
"name" : "getValue",
"type" : "function",
- "desc" : "Returns the current date value of the date field.",
+ "desc" : "Returns the checked state of the checkbox.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.form.Checkbox",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"returns" : [
{
"name" : "",
- "type" : "Date",
- "desc" : "The date value"
+ "type" : "Boolean",
+ "desc" : "True if checked, else false"
}
]
},
],
"returns" : []
},
- {
- "name" : "onTriggerClick",
- "type" : "function",
- "desc" : "The function that should handle the trigger's click event. This method does nothing by default until overridden\nby an implementing function.",
- "sig" : "(e)",
- "static" : false,
- "memberOf" : "Roo.form.TriggerField",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "e",
- "type" : "EventObject",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
{
"name" : "purgeListeners",
"type" : "function",
{
"name" : "reset",
"type" : "function",
- "desc" : "Resets the current field value to the originally-loaded value and clears any validation messages.",
+ "desc" : "Resets the current field value to the originally loaded value and clears any validation messages",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.form.TextField",
+ "memberOf" : "Roo.form.Field",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"params" : [],
"returns" : []
},
- {
- "name" : "selectText",
- "type" : "function",
- "desc" : "Selects text in this field",
- "sig" : "(start, end)",
- "static" : false,
- "memberOf" : "Roo.form.TextField",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "start",
- "type" : "Number",
- "desc" : "(optional) The index where the selection should start (defaults to 0)",
- "isOptional" : false
- },
- {
- "name" : "end",
- "type" : "Number",
- "desc" : "(optional) The index where the selection should end (defaults to the text length)",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
{
"name" : "setDisabled",
"type" : "function",
{
"name" : "setValue",
"type" : "function",
- "desc" : "Sets the value of the date field. You can pass a date object or any string that can be parsed into a valid\ndate, using MonthField.format as the date format, according to the same rules as {@link Date#parseDate}\n(the default format used is \"m/d/y\").\n<br />Usage:\n<pre><code>\n//All of these calls set the same date value (May 4, 2006)\n\n//Pass a date object:\nvar dt = new Date('5/4/06');\nmonthField.setValue(dt);\n\n//Pass a date string (default format):\nmonthField.setValue('5/4/06');\n\n//Pass a date string (custom format):\nmonthField.format = 'Y-m-d';\nmonthField.setValue('2006-5-4');\n</code></pre>",
- "sig" : "(date)",
+ "desc" : "Sets the checked state of the checkbox.\nOn is always based on a string comparison between inputValue and the param.",
+ "sig" : "(value, suppressEvent)",
"static" : false,
"memberOf" : "",
"isStatic" : false,
"requires" : "",
"params" : [
{
- "name" : "date",
- "type" : "String/Date",
- "desc" : "The date or valid date string",
+ "name" : "value",
+ "type" : "Boolean/String",
+ "desc" : "- the value to set",
+ "isOptional" : false
+ },
+ {
+ "name" : "suppressEvent",
+ "type" : "Boolean/String",
+ "desc" : "- whether to suppress the checkchange event.",
"isOptional" : false
}
],
"desc" : "True if the value is valid, else false"
}
]
- },
- {
- "name" : "validateValue",
- "type" : "function",
- "desc" : "Validates a value according to the field's validation rules and marks the field as invalid\nif the validation fails",
- "sig" : "(value)",
- "static" : false,
- "memberOf" : "Roo.form.TextField",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "value",
- "type" : "Mixed",
- "desc" : "The value to validate",
- "isOptional" : false
- }
- ],
- "returns" : [
- {
- "name" : "",
- "type" : "Boolean",
- "desc" : "True if the value is valid, else false"
- }
- ]
}
],
"isAbstract" : false,
"isBuilderTop" : false,
- "childClasses" : { },
+ "implementations" : [],
"tree_children" : [],
"tree_parent" : []
},
- "Roo.form.NumberField" : {
+ "Roo.form.Row" : {
"props" : [
{
"name" : "actionMode",
"type" : "String",
"desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el' for forms you probably want to set this to fieldEl",
- "memberOf" : "Roo.Component"
- },
- {
- "name" : "allowBlank",
- "type" : "Boolean",
- "desc" : "False to validate that the value length > 0 (defaults to true)",
- "memberOf" : "Roo.form.TextField"
- },
- {
- "name" : "allowDecimals",
- "type" : "Boolean",
- "desc" : "False to disallow decimal values (defaults to true)",
- "memberOf" : ""
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "allowDomMove",
"type" : "Boolean",
"desc" : "Whether the component can move the Dom node when rendering (defaults to true).",
- "memberOf" : "Roo.Component"
- },
- {
- "name" : "allowLeadingSpace",
- "type" : "Boolean",
- "desc" : "True to prevent the stripping of leading white space",
- "memberOf" : "Roo.form.TextField"
- },
- {
- "name" : "allowNegative",
- "type" : "Boolean",
- "desc" : "False to prevent entering a negative sign (defaults to true)",
- "memberOf" : ""
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "autoCreate",
"type" : "String/Object",
- "desc" : "A DomHelper element spec, or true for a default element spec (defaults to\n{tag: \"input\", type: \"text\", size: \"20\", autocomplete: \"off\"})",
- "memberOf" : "Roo.form.Field"
- },
- {
- "name" : "blankText",
- "type" : "String",
- "desc" : "Error text to display if the allow blank validation fails (defaults to \"This field is required\")",
- "memberOf" : "Roo.form.TextField"
- },
- {
- "name" : "cls",
- "type" : "String",
- "desc" : "A CSS class to apply to the field's underlying element.",
- "memberOf" : "Roo.form.Field"
- },
- {
- "name" : "decimalPrecision",
- "type" : "Number",
- "desc" : "The maximum precision to display after the decimal separator (defaults to 2)",
- "memberOf" : ""
+ "desc" : "A DomHelper element spec used to autocreate the layout (defaults to {tag: 'div', cls: 'x-form-ct'})",
+ "memberOf" : "Roo.form.Layout",
+ "isOptional" : false,
+ "optvals" : []
},
{
- "name" : "decimalSeparator",
- "type" : "String",
- "desc" : "Character(s) to allow as the decimal separator (defaults to '.')",
- "memberOf" : ""
+ "name" : "clear",
+ "type" : "Boolean",
+ "desc" : "True to add a clearing element at the end of this layout, equivalent to CSS clear: both (defaults to true)",
+ "memberOf" : "Roo.form.Layout",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "disableClass",
"type" : "String",
"desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").",
- "memberOf" : "Roo.Component"
- },
- {
- "name" : "disableKeyFilter",
- "type" : "Boolean",
- "desc" : "True to disable input keystroke filtering (defaults to false)",
- "memberOf" : "Roo.form.TextField"
- },
- {
- "name" : "disabled",
- "type" : "Boolean",
- "desc" : "True to disable the field (defaults to false).",
- "memberOf" : "Roo.form.Field"
- },
- {
- "name" : "emptyText",
- "type" : "String",
- "desc" : "The default text to display in an empty field - placeholder... (defaults to null).",
- "memberOf" : "Roo.form.TextField"
- },
- {
- "name" : "fieldClass",
- "type" : "String",
- "desc" : "The default CSS class for the field (defaults to \"x-form-field x-form-num-field\")",
- "memberOf" : ""
- },
- {
- "name" : "fieldLabel",
- "type" : "String",
- "desc" : "Label to use when rendering a form.",
- "memberOf" : "Roo.form.Field"
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
- "name" : "focusClass",
- "type" : "String",
- "desc" : "The CSS class to use when the field receives focus (defaults to \"x-form-focus\")",
- "memberOf" : "Roo.form.Field"
+ "name" : "height",
+ "type" : "Number/String",
+ "desc" : "The fixed height of the column in pixels or CSS value (defaults to \"auto\")",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
- "name" : "grow",
+ "name" : "hideLabels",
"type" : "Boolean",
- "desc" : "True if this field should automatically grow and shrink to its content",
- "memberOf" : "Roo.form.TextField"
- },
- {
- "name" : "growMax",
- "type" : "Number",
- "desc" : "The maximum width to allow when grow = true (defaults to 800)",
- "memberOf" : "Roo.form.TextField"
- },
- {
- "name" : "growMin",
- "type" : "Number",
- "desc" : "The minimum width to allow when grow = true (defaults to 30)",
- "memberOf" : "Roo.form.TextField"
- },
- {
- "name" : "height",
- "type" : "Number",
- "desc" : "height (optional) size of component",
- "memberOf" : "Roo.BoxComponent"
+ "desc" : "True to suppress the display of field labels in this layout (defaults to false)",
+ "memberOf" : "Roo.form.Layout",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "hideMode",
"type" : "String",
- "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".",
- "memberOf" : "Roo.Component"
+ "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display",
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : [
+ "display",
+ "visibility"
+ ]
},
{
- "name" : "inputType",
+ "name" : "labelAlign",
"type" : "String",
- "desc" : "The type attribute for input fields -- e.g. radio, text, password (defaults to \"text\").",
- "memberOf" : "Roo.form.Field"
+ "desc" : "t)\nValid values are \"left,\" \"top\" and \"right\" (defaults to \"left",
+ "memberOf" : "Roo.form.Layout",
+ "isOptional" : false,
+ "optvals" : [
+ "left",
+ "top",
+ "right"
+ ]
},
{
- "name" : "invalidClass",
+ "name" : "labelSeparator",
"type" : "String",
- "desc" : "The CSS class to use when marking a field invalid (defaults to \"x-form-invalid\")",
- "memberOf" : "Roo.form.Field"
+ "desc" : "The separator to use after field labels (defaults to ':')",
+ "memberOf" : "Roo.form.Layout",
+ "isOptional" : false,
+ "optvals" : []
},
{
- "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" : "labelWidth",
+ "type" : "Number",
+ "desc" : "Fixed width in pixels of all field labels (defaults to undefined)",
+ "memberOf" : "Roo.form.Layout",
+ "isOptional" : false,
+ "optvals" : []
},
{
"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"
- },
- {
- "name" : "maskRe",
- "type" : "String",
- "desc" : "An input mask regular expression that will be used to filter keystrokes that don't match (defaults to null)",
- "memberOf" : "Roo.form.TextField"
- },
- {
- "name" : "maxLength",
- "type" : "Number",
- "desc" : "Maximum input field length allowed (defaults to Number.MAX_VALUE)",
- "memberOf" : "Roo.form.TextField"
- },
- {
- "name" : "maxLengthText",
- "type" : "String",
- "desc" : "Error text to display if the maximum length validation fails (defaults to \"The maximum length for this field is {maxLength}\")",
- "memberOf" : "Roo.form.TextField"
- },
- {
- "name" : "maxText",
- "type" : "String",
- "desc" : "Error text to display if the maximum value validation fails (defaults to \"The maximum value for this field is {maxValue}\")",
- "memberOf" : ""
- },
- {
- "name" : "maxValue",
- "type" : "Number",
- "desc" : "The maximum allowed value (defaults to Number.MAX_VALUE)",
- "memberOf" : ""
- },
- {
- "name" : "minLength",
- "type" : "Number",
- "desc" : "Minimum input field length required (defaults to 0)",
- "memberOf" : "Roo.form.TextField"
- },
- {
- "name" : "minLengthText",
- "type" : "String",
- "desc" : "Error text to display if the minimum length validation fails (defaults to \"The minimum length for this field is {minLength}\")",
- "memberOf" : "Roo.form.TextField"
- },
- {
- "name" : "minText",
- "type" : "String",
- "desc" : "Error text to display if the minimum value validation fails (defaults to \"The minimum value for this field is {minValue}\")",
- "memberOf" : ""
- },
- {
- "name" : "minValue",
- "type" : "Number",
- "desc" : "The minimum allowed value (defaults to Number.NEGATIVE_INFINITY)",
- "memberOf" : ""
- },
- {
- "name" : "msgFx",
- "type" : "String",
- "desc" : "<b>Experimental</b> The effect used when displaying a validation message under the field (defaults to 'normal').",
- "memberOf" : "Roo.form.Field"
- },
- {
- "name" : "msgTarget",
- "type" : "String",
- "desc" : "The location where error text should display. Should be one of the following values (defaults to 'qtip'):\n<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" : "name",
- "type" : "String",
- "desc" : "The field's HTML name attribute.",
- "memberOf" : "Roo.form.Field"
- },
- {
- "name" : "nanText",
- "type" : "String",
- "desc" : "Error text to display if the value is not a valid number. For example, this can happen\nif a valid character like '.' or '-' is left in the field with no number (defaults to \"{value} is not a valid number\")",
- "memberOf" : ""
- },
- {
- "name" : "qtip",
- "type" : "String",
- "desc" : "Mouse over tip",
- "memberOf" : "Roo.form.Field"
- },
- {
- "name" : "readOnly",
- "type" : "Boolean",
- "desc" : "True to mark the field as readOnly in HTML (defaults to false) -- Note: this only sets the element's readOnly DOM attribute.",
- "memberOf" : "Roo.form.Field"
- },
- {
- "name" : "regex",
- "type" : "RegExp",
- "desc" : "A JavaScript RegExp object to be tested against the field value during validation (defaults to null).\nIf available, this regex will be evaluated only after the basic validators all return true, and will be passed the\ncurrent field value. If the test fails, the field will be marked invalid using {@link #regexText}.",
- "memberOf" : "Roo.form.TextField"
- },
- {
- "name" : "regexText",
- "type" : "String",
- "desc" : "The error text to display if {@link #regex} is used and the test fails during validation (defaults to \"\")",
- "memberOf" : "Roo.form.TextField"
- },
- {
- "name" : "selectOnFocus",
- "type" : "Boolean",
- "desc" : "True to automatically select any existing field text when the field receives input focus (defaults to false)",
- "memberOf" : "Roo.form.TextField"
- },
- {
- "name" : "tabIndex",
- "type" : "Number",
- "desc" : "The tabIndex for this field. Note this only applies to fields that are rendered, not those which are built via applyTo (defaults to undefined).",
- "memberOf" : "Roo.form.Field"
- },
- {
- "name" : "validateOnBlur",
- "type" : "Boolean",
- "desc" : "Whether the field should validate when it loses focus (defaults to true).",
- "memberOf" : "Roo.form.Field"
- },
- {
- "name" : "validationDelay",
- "type" : "Number",
- "desc" : "The length of time in milliseconds after user input begins until validation is initiated (defaults to 250)",
- "memberOf" : "Roo.form.Field"
- },
- {
- "name" : "validationEvent",
- "type" : "String/Boolean",
- "desc" : "The event that should initiate field validation. Set to false to disable\n automatic validation (defaults to \"keyup\").",
- "memberOf" : "Roo.form.Field"
- },
- {
- "name" : "validator",
- "type" : "Function",
- "desc" : "A custom validation function to be called during field validation (defaults to null).\nIf available, this function will be called only after the basic validators all return true, and will be passed the\ncurrent field value and expected to return boolean true if the value is valid or a string error message if invalid.",
- "memberOf" : "Roo.form.TextField"
- },
- {
- "name" : "value",
- "type" : "Mixed",
- "desc" : "A value to initialize this field with.",
- "memberOf" : "Roo.form.Field"
+ "memberOf" : "Roo.util.Observable",
+ "isOptional" : false,
+ "optvals" : []
},
{
- "name" : "vtype",
- "type" : "String",
- "desc" : "A validation type name as defined in {@link Roo.form.VTypes} (defaults to null)",
- "memberOf" : "Roo.form.TextField"
+ "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",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "width",
- "type" : "Number",
- "desc" : "width (optional) size of component",
- "memberOf" : "Roo.BoxComponent"
+ "type" : "Number/String",
+ "desc" : "The fixed width of the column in pixels or CSS value (defaults to \"auto\")",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
}
],
"events" : [
- {
- "name" : "autosize",
- "type" : "function",
- "desc" : "Fires when the autosize function is triggered. The field may or may not have actually changed size\naccording to the default logic, but this event provides a hook for the developer to apply additional\nlogic at runtime to resize the field if needed.",
- "sig" : "function (_self, width)\n{\n\n}",
- "memberOf" : "Roo.form.TextField",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.form.Field",
- "desc" : "This text field",
- "isOptional" : false
- },
- {
- "name" : "width",
- "type" : "Number",
- "desc" : "The new field width",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
{
"name" : "beforedestroy",
"type" : "function",
],
"returns" : []
},
- {
- "name" : "blur",
- "type" : "function",
- "desc" : "Fires when this field loses input focus.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.form.Field",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.form.Field",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "change",
- "type" : "function",
- "desc" : "Fires just before the field blurs if the field value has changed.",
- "sig" : "function (_self, newValue, oldValue)\n{\n\n}",
- "memberOf" : "Roo.form.Field",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.form.Field",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "newValue",
- "type" : "Mixed",
- "desc" : "The new value",
- "isOptional" : false
- },
- {
- "name" : "oldValue",
- "type" : "Mixed",
- "desc" : "The original value",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
{
"name" : "destroy",
"type" : "function",
],
"returns" : []
},
- {
- "name" : "focus",
- "type" : "function",
- "desc" : "Fires when this field receives input focus.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.form.Field",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.form.Field",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
{
"name" : "hide",
"type" : "function",
],
"returns" : []
},
- {
- "name" : "invalid",
- "type" : "function",
- "desc" : "Fires after the field has been marked as invalid.",
- "sig" : "function (_self, msg)\n{\n\n}",
- "memberOf" : "Roo.form.Field",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.form.Field",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "msg",
- "type" : "String",
- "desc" : "The validation message",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "keyup",
- "type" : "function",
- "desc" : "Fires after the key up",
- "sig" : "function (_self, e)\n{\n\n}",
- "memberOf" : "Roo.form.Field",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.form.Field",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "e",
- "type" : "Roo.EventObject",
- "desc" : "The event Object",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "move",
- "type" : "function",
- "desc" : "Fires after the component is moved.",
- "sig" : "function (_self, x, y)\n{\n\n}",
- "memberOf" : "Roo.BoxComponent",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.Component",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "x",
- "type" : "Number",
- "desc" : "The new x position",
- "isOptional" : false
- },
- {
- "name" : "y",
- "type" : "Number",
- "desc" : "The new y position",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
{
"name" : "render",
"type" : "function",
],
"returns" : []
},
- {
- "name" : "resize",
- "type" : "function",
- "desc" : "Fires after the component is resized.",
- "sig" : "function (_self, adjWidth, adjHeight, rawWidth, rawHeight)\n{\n\n}",
- "memberOf" : "Roo.BoxComponent",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.Component",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "adjWidth",
- "type" : "Number",
- "desc" : "The box-adjusted width that was set",
- "isOptional" : false
- },
- {
- "name" : "adjHeight",
- "type" : "Number",
- "desc" : "The box-adjusted height that was set",
- "isOptional" : false
- },
- {
- "name" : "rawWidth",
- "type" : "Number",
- "desc" : "The width that was originally specified",
- "isOptional" : false
- },
- {
- "name" : "rawHeight",
- "type" : "Number",
- "desc" : "The height that was originally specified",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
{
"name" : "show",
"type" : "function",
}
],
"returns" : []
- },
- {
- "name" : "specialkey",
- "type" : "function",
- "desc" : "Fires when any key related to navigation (arrows, tab, enter, esc, etc.) is pressed. You can check\n{@link Roo.EventObject#getKey} to determine which key was pressed.",
- "sig" : "function (_self, e)\n{\n\n}",
- "memberOf" : "Roo.form.Field",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.form.Field",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "e",
- "type" : "Roo.EventObject",
- "desc" : "The event object",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "valid",
- "type" : "function",
- "desc" : "Fires after the field has been validated with no errors.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.form.Field",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.form.Field",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
}
],
"methods" : [
"returns" : []
},
{
- "name" : "applyTo",
+ "name" : "addxtype",
"type" : "function",
- "desc" : "Apply the behaviors of this component to an existing element. <b>This is used instead of render().</b>",
- "sig" : "(el)",
+ "desc" : "Adds a object form elements (using the xtype property as the factory method.)\nValid xtypes are: TextField, TextArea .... Button, Layout, FieldSet, Column",
+ "sig" : "(config)",
"static" : false,
- "memberOf" : "Roo.form.Field",
+ "memberOf" : "Roo.form.Layout",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "el",
- "type" : "String/HTMLElement/Element",
- "desc" : "The id of the node, a DOM node or an existing Element",
+ "name" : "config",
+ "type" : "Object",
+ "desc" : "",
"isOptional" : false
}
],
- "returns" : [
- {
- "name" : "",
- "type" : "Roo.form.Field",
- "desc" : "this"
- }
- ]
- },
- {
- "name" : "autoSize",
- "type" : "function",
- "desc" : "Automatically grows the field to accomodate the width of the text up to the maximum field width allowed.\nThis only takes effect if grow = true, and fires the autosize event.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.form.TextField",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
"returns" : []
},
{
"isOptional" : false
},
{
- "name" : "fn",
- "type" : "Function",
- "desc" : "The function to call",
- "isOptional" : false
- },
- {
- "name" : "scope",
- "type" : "Object",
- "desc" : "(optional) The scope (this object) for the fn",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "clearInvalid",
- "type" : "function",
- "desc" : "Clear any invalid styles/messages for this field",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.form.Field",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
+ "name" : "fn",
+ "type" : "Function",
+ "desc" : "The function to call",
+ "isOptional" : false
+ },
+ {
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "(optional) The scope (this object) for the fn",
+ "isOptional" : false
+ }
+ ],
"returns" : []
},
{
}
]
},
- {
- "name" : "getBox",
- "type" : "function",
- "desc" : "Gets the current box measurements of the component's underlying element.",
- "sig" : "(local)",
- "static" : false,
- "memberOf" : "Roo.BoxComponent",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "local",
- "type" : "Boolean",
- "desc" : "(optional) If true the element's left and top are returned instead of page XY (defaults to false)",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
{
"name" : "getEl",
"type" : "function",
}
]
},
- {
- "name" : "getName",
- "type" : "function",
- "desc" : "Returns the name attribute of the field if available",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.form.Field",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : [
- {
- "name" : "",
- "type" : "String",
- "desc" : "name The field name"
- }
- ]
- },
- {
- "name" : "getPosition",
- "type" : "function",
- "desc" : "Gets the current XY position of the component's underlying element.",
- "sig" : "(local)",
- "static" : false,
- "memberOf" : "Roo.BoxComponent",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "local",
- "type" : "Boolean",
- "desc" : "(optional) If true the element's left and top are returned instead of page XY (defaults to false)",
- "isOptional" : false
- }
- ],
- "returns" : [
- {
- "name" : "",
- "type" : "Array",
- "desc" : "The XY position of the element (e.g., [100, 200])"
- }
- ]
- },
- {
- "name" : "getRawValue",
- "type" : "function",
- "desc" : "Returns the raw data value which may or may not be a valid, defined value. To return a normalized value see {@link #getValue}.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.form.Field",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : [
- {
- "name" : "",
- "type" : "Mixed",
- "desc" : "value The field value"
- }
- ]
- },
- {
- "name" : "getSize",
- "type" : "function",
- "desc" : "Gets the current size of the component's underlying element.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.BoxComponent",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : [
- {
- "name" : "",
- "type" : "Object",
- "desc" : "An object containing the element's size {width: (element width), height: (element height)}"
- }
- ]
- },
- {
- "name" : "getValue",
- "type" : "function",
- "desc" : "Returns the normalized data value (undefined or emptyText will be returned as ''). To return the raw value see {@link #getRawValue}.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.form.Field",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : [
- {
- "name" : "",
- "type" : "Mixed",
- "desc" : "value The field value"
- }
- ]
- },
- {
- "name" : "hasChanged",
- "type" : "function",
- "desc" : "checks the current value against the 'loaded' value.\nNote - will return false if 'resetHasChanged' has not been called first.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.form.Field",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
{
"name" : "hasListener",
"type" : "function",
}
]
},
- {
- "name" : "isDirty",
- "type" : "function",
- "desc" : "Returns true if this field has been changed since it was originally loaded and is not disabled.\nDEPRICATED - it never worked well - use hasChanged/resetHasChanged.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.form.Field",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
- {
- "name" : "isValid",
- "type" : "function",
- "desc" : "Returns whether or not the field value is currently valid",
- "sig" : "(preventMark)",
- "static" : false,
- "memberOf" : "Roo.form.Field",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "preventMark",
- "type" : "Boolean",
- "desc" : "True to disable marking the field invalid",
- "isOptional" : false
- }
- ],
- "returns" : [
- {
- "name" : "",
- "type" : "Boolean",
- "desc" : "True if the value is valid, else false"
- }
- ]
- },
{
"name" : "isVisible",
"type" : "function",
"params" : [],
"returns" : []
},
- {
- "name" : "markInvalid",
- "type" : "function",
- "desc" : "Mark this field as invalid",
- "sig" : "(msg)",
- "static" : false,
- "memberOf" : "Roo.form.Field",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "msg",
- "type" : "String",
- "desc" : "The validation message",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
{
"name" : "on",
"type" : "function",
],
"returns" : []
},
- {
- "name" : "onPosition",
- "type" : "function",
- "desc" : "Called after the component is moved, this method is empty by default but can be implemented by any\nsubclass that needs to perform custom logic after a move occurs.",
- "sig" : "(x, y)",
- "static" : false,
- "memberOf" : "Roo.BoxComponent",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "x",
- "type" : "Number",
- "desc" : "The new x position",
- "isOptional" : false
- },
- {
- "name" : "y",
- "type" : "Number",
- "desc" : "The new y position",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "onResize",
- "type" : "function",
- "desc" : "Called after the component is resized, this method is empty by default but can be implemented by any\nsubclass that needs to perform custom logic after a resize occurs.",
- "sig" : "(adjWidth, adjHeight, rawWidth, rawHeight)",
- "static" : false,
- "memberOf" : "Roo.BoxComponent",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "adjWidth",
- "type" : "Number",
- "desc" : "The box-adjusted width that was set",
- "isOptional" : false
- },
- {
- "name" : "adjHeight",
- "type" : "Number",
- "desc" : "The box-adjusted height that was set",
- "isOptional" : false
- },
- {
- "name" : "rawWidth",
- "type" : "Number",
- "desc" : "The width that was originally specified",
- "isOptional" : false
- },
- {
- "name" : "rawHeight",
- "type" : "Number",
- "desc" : "The height that was originally specified",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
{
"name" : "purgeListeners",
"type" : "function",
],
"returns" : []
},
- {
- "name" : "reset",
- "type" : "function",
- "desc" : "Resets the current field value to the originally-loaded value and clears any validation messages.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.form.TextField",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
- {
- "name" : "resetHasChanged",
- "type" : "function",
- "desc" : "stores the current value in loadedValue",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.form.Field",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
- {
- "name" : "selectText",
- "type" : "function",
- "desc" : "Selects text in this field",
- "sig" : "(start, end)",
- "static" : false,
- "memberOf" : "Roo.form.TextField",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "start",
- "type" : "Number",
- "desc" : "(optional) The index where the selection should start (defaults to 0)",
- "isOptional" : false
- },
- {
- "name" : "end",
- "type" : "Number",
- "desc" : "(optional) The index where the selection should end (defaults to the text length)",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
{
"name" : "setDisabled",
"type" : "function",
],
"returns" : []
},
- {
- "name" : "setPagePosition",
- "type" : "function",
- "desc" : "Sets the page XY position of the component. To set the left and top instead, use {@link #setPosition}.\nThis method fires the move event.",
- "sig" : "(x, y)",
- "static" : false,
- "memberOf" : "Roo.BoxComponent",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "x",
- "type" : "Number",
- "desc" : "The new x position",
- "isOptional" : false
- },
- {
- "name" : "y",
- "type" : "Number",
- "desc" : "The new y position",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "setPosition",
- "type" : "function",
- "desc" : "Sets the left and top of the component. To set the page XY position instead, use {@link #setPagePosition}.\nThis method fires the move event.",
- "sig" : "(left, top)",
- "static" : false,
- "memberOf" : "Roo.BoxComponent",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "left",
- "type" : "Number",
- "desc" : "The new left",
- "isOptional" : false
- },
- {
- "name" : "top",
- "type" : "Number",
- "desc" : "The new top",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "setRawValue",
- "type" : "function",
- "desc" : "Sets the underlying DOM field's value directly, bypassing validation. To set the value with validation see {@link #setValue}.",
- "sig" : "(value)",
- "static" : false,
- "memberOf" : "Roo.form.Field",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "value",
- "type" : "Mixed",
- "desc" : "The value to set",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "setSize",
- "type" : "function",
- "desc" : "Sets the width and height of the component. This method fires the resize event. This method can accept\neither width and height as separate numeric arguments, or you can pass a size object like {width:10, height:20}.",
- "sig" : "(width, height)",
- "static" : false,
- "memberOf" : "Roo.BoxComponent",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "width",
- "type" : "Number/Object",
- "desc" : "The new width to set, or a size object in the format {width, height}",
- "isOptional" : false
- },
- {
- "name" : "height",
- "type" : "Number",
- "desc" : "The new height to set (not required if a size object is passed as the first arg)",
- "isOptional" : false
- }
- ],
- "returns" : [
- {
- "name" : "",
- "type" : "Roo.BoxComponent",
- "desc" : "this"
- }
- ]
- },
- {
- "name" : "setValue",
- "type" : "function",
- "desc" : "Sets a data value into the field and validates it. To set the value directly without validation see {@link #setRawValue}.",
- "sig" : "(value)",
- "static" : false,
- "memberOf" : "Roo.form.Field",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "value",
- "type" : "Mixed",
- "desc" : "The value to set",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
{
"name" : "setVisible",
"type" : "function",
}
]
},
- {
- "name" : "syncSize",
- "type" : "function",
- "desc" : "Force the component's size to recalculate based on the underlying element's current height and width.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.BoxComponent",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
{
"name" : "un",
"type" : "function",
}
],
"returns" : []
- },
- {
- "name" : "updateBox",
- "type" : "function",
- "desc" : "Sets the current box measurements of the component's underlying element.",
- "sig" : "(box)",
- "static" : false,
- "memberOf" : "Roo.BoxComponent",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "box",
- "type" : "Object",
- "desc" : "An object in the format {x, y, width, height}",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "validate",
- "type" : "function",
- "desc" : "Validates the field value",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.form.Field",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : [
- {
- "name" : "",
- "type" : "Boolean",
- "desc" : "True if the value is valid, else false"
- }
- ]
- },
- {
- "name" : "validateValue",
- "type" : "function",
- "desc" : "Validates a value according to the field's validation rules and marks the field as invalid\nif the validation fails",
- "sig" : "(value)",
- "static" : false,
- "memberOf" : "Roo.form.TextField",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "value",
- "type" : "Mixed",
- "desc" : "The value to validate",
- "isOptional" : false
- }
- ],
- "returns" : [
- {
- "name" : "",
- "type" : "Boolean",
- "desc" : "True if the value is valid, else false"
- }
- ]
}
],
"isAbstract" : false,
"isBuilderTop" : false,
- "childClasses" : { },
- "tree_children" : [],
+ "implementations" : [],
+ "tree_children" : [
+ "Roo.form.Column",
+ "Roo.form.Row",
+ "Roo.form.Field",
+ "Roo.form.Checkbox",
+ "Roo.form.ComboBox",
+ "Roo.form.ComboBoxArray",
+ "Roo.form.ComboCheck",
+ "Roo.form.ComboNested",
+ "Roo.form.DateField",
+ "Roo.form.DayPicker",
+ "Roo.form.DisplayField",
+ "Roo.form.FCKeditor",
+ "Roo.form.GridField",
+ "Roo.form.Hidden",
+ "Roo.form.HtmlEditor",
+ "Roo.form.MonthField",
+ "Roo.form.NumberField",
+ "Roo.form.Radio",
+ "Roo.form.Select",
+ "Roo.form.Signature",
+ "Roo.form.TextArea",
+ "Roo.form.TextField",
+ "Roo.form.TriggerField",
+ "Roo.Button",
+ "Roo.SplitButton",
+ "Roo.Toolbar.Button",
+ "Roo.Toolbar.SplitButton",
+ "Roo.form.TextItem",
+ "Roo.form.FieldSet"
+ ],
"tree_parent" : []
},
- "Roo.form.Radio" : {
+ "Roo.form.Select" : {
"props" : [
{
"name" : "actionMode",
"type" : "String",
"desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el' for forms you probably want to set this to fieldEl",
- "memberOf" : "Roo.Component"
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "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" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "allowBlank",
+ "type" : "Boolean",
+ "desc" : "False to validate that the value length > 0 (defaults to true)",
+ "memberOf" : "Roo.form.TextField",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "allowDomMove",
"type" : "Boolean",
"desc" : "Whether the component can move the Dom node when rendering (defaults to true).",
- "memberOf" : "Roo.Component"
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "allowLeadingSpace",
+ "type" : "Boolean",
+ "desc" : "True to prevent the stripping of leading white space",
+ "memberOf" : "Roo.form.TextField",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "alwaysQuery",
+ "type" : "Boolean",
+ "desc" : "Disable caching of results, and always send query",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"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"
+ "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" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
- "name" : "boxLabel",
+ "name" : "blankText",
"type" : "String",
- "desc" : "The text that appears beside the checkbox",
- "memberOf" : "Roo.form.Checkbox"
+ "desc" : "Error text to display if the allow blank validation fails (defaults to \"This field is required\")",
+ "memberOf" : "Roo.form.TextField",
+ "isOptional" : false,
+ "optvals" : []
},
{
- "name" : "checked",
+ "name" : "blockFocus",
"type" : "Boolean",
- "desc" : "True if the the checkbox should render already checked (defaults to false)",
- "memberOf" : "Roo.form.Checkbox"
+ "desc" : "Prevents all focus calls, so it can work with things like HTML edtor bar",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "cls",
"type" : "String",
"desc" : "A CSS class to apply to the field's underlying element.",
- "memberOf" : "Roo.form.Field"
+ "memberOf" : "Roo.form.Field",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "defaultValue",
+ "type" : "String",
+ "desc" : "The value displayed after loading the store.",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "disableClass",
"type" : "String",
"desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").",
- "memberOf" : "Roo.Component"
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "disableClear",
+ "type" : "Boolean",
+ "desc" : "Disable showing of clear button.",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "disableKeyFilter",
+ "type" : "Boolean",
+ "desc" : "True to disable input keystroke filtering (defaults to false)",
+ "memberOf" : "Roo.form.TextField",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "disabled",
"type" : "Boolean",
"desc" : "True to disable the field (defaults to false).",
- "memberOf" : "Roo.form.Field"
+ "memberOf" : "Roo.form.Field",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "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" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "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" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "emptyText",
+ "type" : "String",
+ "desc" : "The default text to display in an empty field - placeholder... (defaults to null).",
+ "memberOf" : "Roo.form.TextField",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "fieldClass",
"type" : "String",
- "desc" : "The default CSS class for the checkbox (defaults to \"x-form-field\")",
- "memberOf" : "Roo.form.Checkbox"
+ "desc" : "The default CSS class for the field (defaults to \"x-form-field\")",
+ "memberOf" : "Roo.form.Field",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "fieldLabel",
"type" : "String",
"desc" : "Label to use when rendering a form.",
- "memberOf" : "Roo.form.Field"
+ "memberOf" : "Roo.form.Field",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "focusClass",
"type" : "String",
- "desc" : "The CSS class to use when the checkbox receives focus (defaults to undefined)",
- "memberOf" : "Roo.form.Checkbox"
+ "desc" : "The CSS class to use when the field receives focus (defaults to \"x-form-focus\")",
+ "memberOf" : "Roo.form.Field",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "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" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "grow",
+ "type" : "Boolean",
+ "desc" : "",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "growMax",
+ "type" : "Number",
+ "desc" : "",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "growMin",
+ "type" : "Number",
+ "desc" : "",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "handleHeight",
+ "type" : "Number",
+ "desc" : "The height in pixels of the dropdown list resize handle if resizable = true (defaults to 8)",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "height",
"type" : "Number",
"desc" : "height (optional) size of component",
- "memberOf" : "Roo.BoxComponent"
+ "memberOf" : "Roo.BoxComponent",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "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" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "hideMode",
"type" : "String",
- "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".",
- "memberOf" : "Roo.Component"
+ "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display",
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : [
+ "display",
+ "visibility"
+ ]
+ },
+ {
+ "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",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "inputType",
+ "type" : "String",
+ "desc" : "The type attribute for input fields -- e.g. radio, text, password (defaults to \"text\").",
+ "memberOf" : "Roo.form.Field",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "invalidClass",
+ "type" : "String",
+ "desc" : "The CSS class to use when marking a field invalid (defaults to \"x-form-invalid\")",
+ "memberOf" : "Roo.form.Field",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "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",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "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" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "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" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "listClass",
+ "type" : "String",
+ "desc" : "CSS class to apply to the dropdown list element (defaults to '')",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "listWidth",
+ "type" : "Number",
+ "desc" : "The width in pixels of the dropdown list (defaults to the width of the ComboBox field)",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "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",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "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" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "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",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "maxHeight",
+ "type" : "Number",
+ "desc" : "The maximum height in pixels of the dropdown list before scrollbars are shown (defaults to 300)",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "maxLength",
+ "type" : "Number",
+ "desc" : "Maximum input field length allowed (defaults to Number.MAX_VALUE)",
+ "memberOf" : "Roo.form.TextField",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "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",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "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" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "minLength",
+ "type" : "Number",
+ "desc" : "Minimum input field length required (defaults to 0)",
+ "memberOf" : "Roo.form.TextField",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "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",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "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" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "mode",
+ "type" : "String",
+ "desc" : "Set to 'local' if the ComboBox loads local data (defaults to 'remote' which loads from the server)",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "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",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "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",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "name",
+ "type" : "String",
+ "desc" : "The field's HTML name attribute.",
+ "memberOf" : "Roo.form.Field",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "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" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "qtip",
+ "type" : "String",
+ "desc" : "Mouse over tip",
+ "memberOf" : "Roo.form.Field",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "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" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "queryParam",
+ "type" : "String",
+ "desc" : "Name of the query as it will be passed on the querystring (defaults to 'query')",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "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",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "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",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "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",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "resizable",
+ "type" : "Boolean",
+ "desc" : "True to add a resize handle to the bottom of the dropdown list (defaults to false)",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "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" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "selectedClass",
+ "type" : "String",
+ "desc" : "CSS class to apply to the selected item in the dropdown list (defaults to 'x-combo-selected')",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "shadow",
+ "type" : "Boolean/String",
+ "desc" : "True or \"sides\" for the default effect, \"frame\" for 4-way shadow, and \"drop\" for bottom-right",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
- "name" : "inputType",
- "type" : "String",
- "desc" : "The type attribute for input fields -- e.g. radio, text, password (defaults to \"text\").",
- "memberOf" : "Roo.form.Field"
+ "name" : "store",
+ "type" : "Roo.data.Store",
+ "desc" : "The data store to which this combo is bound (defaults to undefined)",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
- "name" : "inputValue",
+ "name" : "style",
"type" : "String",
- "desc" : "The value that should go into the generated input element's value attribute",
- "memberOf" : "Roo.form.Checkbox"
+ "desc" : "css styles to add to component\neg. text-align:right;",
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
- "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" : "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",
+ "isOptional" : false,
+ "optvals" : []
},
{
- "name" : "invalidText",
+ "name" : "title",
"type" : "String",
- "desc" : "The error text to use when marking a field invalid and no message is provided (defaults to \"The value in this field is invalid\")",
- "memberOf" : "Roo.form.Field"
- },
- {
- "name" : "listeners",
- "type" : "Object",
- "desc" : "list of events and functions to call for this object, \nFor example :\n<pre><code>\n listeners : { \n 'click' : function(e) {\n ..... \n } ,\n .... \n } \n </code></pre>",
- "memberOf" : "Roo.util.Observable"
+ "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" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
- "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" : "tpl",
+ "type" : "String/Roo.Template",
+ "desc" : "The template to use to render the output",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
- "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" : "transform",
+ "type" : "String/HTMLElement/Element",
+ "desc" : "The id, DOM node or element of an existing select to convert to a ComboBox",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
- "name" : "name",
+ "name" : "triggerAction",
"type" : "String",
- "desc" : "The field's HTML name attribute.",
- "memberOf" : "Roo.form.Field"
+ "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" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
- "name" : "qtip",
+ "name" : "triggerClass",
"type" : "String",
- "desc" : "Mouse over tip",
- "memberOf" : "Roo.form.Field"
+ "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" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
- "name" : "readOnly",
+ "name" : "typeAhead",
"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"
+ "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" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
- "name" : "tabIndex",
+ "name" : "typeAheadDelay",
"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"
+ "desc" : "The length of time in milliseconds to wait until the typeahead text is displayed\nif typeAhead = true (defaults to 250)",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "validateOnBlur",
"type" : "Boolean",
"desc" : "Whether the field should validate when it loses focus (defaults to true).",
- "memberOf" : "Roo.form.Field"
+ "memberOf" : "Roo.form.Field",
+ "isOptional" : false,
+ "optvals" : []
},
{
"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"
+ "memberOf" : "Roo.form.Field",
+ "isOptional" : false,
+ "optvals" : []
},
{
"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"
+ "memberOf" : "Roo.form.Field",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "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",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "value",
"type" : "Mixed",
"desc" : "A value to initialize this field with.",
- "memberOf" : "Roo.form.Field"
+ "memberOf" : "Roo.form.Field",
+ "isOptional" : false,
+ "optvals" : []
},
{
- "name" : "valueOff",
+ "name" : "valueField",
"type" : "String",
- "desc" : "The value that should go into the generated input element's value when unchecked.",
- "memberOf" : "Roo.form.Checkbox"
+ "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" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "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" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "vtype",
+ "type" : "String",
+ "desc" : "A validation type name as defined in {@link Roo.form.VTypes} (defaults to null)",
+ "memberOf" : "Roo.form.TextField",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "width",
"type" : "Number",
"desc" : "width (optional) size of component",
- "memberOf" : "Roo.BoxComponent"
+ "memberOf" : "Roo.BoxComponent",
+ "isOptional" : false,
+ "optvals" : []
}
],
"events" : [
+ {
+ "name" : "autosize",
+ "type" : "function",
+ "desc" : "Fires when the autosize function is triggered. The field may or may not have actually changed size\naccording to the default logic, but this event provides a hook for the developer to apply additional\nlogic at runtime to resize the field if needed.",
+ "sig" : "function (_self, width)\n{\n\n}",
+ "memberOf" : "Roo.form.TextField",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.form.Field",
+ "desc" : "This text field",
+ "isOptional" : false
+ },
+ {
+ "name" : "width",
+ "type" : "Number",
+ "desc" : "The new field width",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
{
"name" : "beforedestroy",
"type" : "function",
],
"returns" : []
},
- {
- "name" : "check",
- "type" : "function",
- "desc" : "Fires when the checkbox is checked or unchecked.",
- "sig" : "function (_self, checked)\n{\n\n}",
- "memberOf" : "Roo.form.Checkbox",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.form.Checkbox",
- "desc" : "This checkbox",
- "isOptional" : false
- },
- {
- "name" : "checked",
- "type" : "Boolean",
- "desc" : "The new checked value",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
{
"name" : "destroy",
"type" : "function",
}
]
},
+ {
+ "name" : "autoSize",
+ "type" : "function",
+ "desc" : "",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.form.TriggerField",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
{
"name" : "capture",
"type" : "function",
"params" : [],
"returns" : []
},
+ {
+ "name" : "clearValue",
+ "type" : "function",
+ "desc" : "Clears any text/value currently set in the field",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
+ {
+ "name" : "collapse",
+ "type" : "function",
+ "desc" : "Hides the dropdown list if it is currently expanded. Fires the 'collapse' event on completion.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
{
"name" : "destroy",
"type" : "function",
}
]
},
+ {
+ "name" : "doQuery",
+ "type" : "function",
+ "desc" : "Execute a query to filter the dropdown list. Fires the beforequery event prior to performing the\nquery allowing the query action to be canceled if needed.",
+ "sig" : "(query, forceAll)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "query",
+ "type" : "String",
+ "desc" : "The SQL query to execute",
+ "isOptional" : false
+ },
+ {
+ "name" : "forceAll",
+ "type" : "Boolean",
+ "desc" : "True to force the query to execute even if there are currently fewer characters\nin the field than the minimum specified by the minChars config option. It also clears any filter previously\nsaved in the current store (defaults to false)",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
{
"name" : "enable",
"type" : "function",
}
]
},
+ {
+ "name" : "expand",
+ "type" : "function",
+ "desc" : "Expands the dropdown list if it is currently hidden. Fires the 'expand' event on completion.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
{
"name" : "fireEvent",
"type" : "function",
}
]
},
- {
- "name" : "getGroupValue",
- "type" : "function",
- "desc" : "If this radio is part of a group, it will return the selected value",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : [
- {
- "name" : "",
- "type" : "String",
- "desc" : ""
- }
- ]
- },
{
"name" : "getId",
"type" : "function",
{
"name" : "getValue",
"type" : "function",
- "desc" : "Returns the checked state of the checkbox.",
+ "desc" : "Returns the currently selected field value or empty string if no value is set.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.form.Checkbox",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"returns" : [
{
"name" : "",
- "type" : "Boolean",
- "desc" : "True if checked, else false"
+ "type" : "String",
+ "desc" : "value The selected value"
}
]
},
"params" : [],
"returns" : []
},
+ {
+ "name" : "isExpanded",
+ "type" : "function",
+ "desc" : "Returns true if the dropdown list is expanded, else false.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
{
"name" : "isValid",
"type" : "function",
],
"returns" : []
},
+ {
+ "name" : "onTriggerClick",
+ "type" : "function",
+ "desc" : "The function that should handle the trigger's click event. This method does nothing by default until overridden\nby an implementing function.",
+ "sig" : "(e)",
+ "static" : false,
+ "memberOf" : "Roo.form.TriggerField",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "e",
+ "type" : "EventObject",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
{
"name" : "purgeListeners",
"type" : "function",
{
"name" : "reset",
"type" : "function",
- "desc" : "Resets the current field value to the originally loaded value and clears any validation messages",
+ "desc" : "Resets the current field value to the originally-loaded value and clears any validation messages.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.form.Field",
+ "memberOf" : "Roo.form.TextField",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"returns" : []
},
{
- "name" : "setDisabled",
- "type" : "function",
- "desc" : "Convenience function for setting disabled/enabled by boolean.",
- "sig" : "(disabled)",
- "static" : false,
- "memberOf" : "Roo.Component",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "disabled",
- "type" : "Boolean",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "setPagePosition",
- "type" : "function",
- "desc" : "Sets the page XY position of the component. To set the left and top instead, use {@link #setPosition}.\nThis method fires the move event.",
- "sig" : "(x, y)",
- "static" : false,
- "memberOf" : "Roo.BoxComponent",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "x",
- "type" : "Number",
- "desc" : "The new x position",
- "isOptional" : false
- },
- {
- "name" : "y",
- "type" : "Number",
- "desc" : "The new y position",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "setPosition",
- "type" : "function",
- "desc" : "Sets the left and top of the component. To set the page XY position instead, use {@link #setPagePosition}.\nThis method fires the move event.",
- "sig" : "(left, top)",
- "static" : false,
- "memberOf" : "Roo.BoxComponent",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "left",
- "type" : "Number",
- "desc" : "The new left",
- "isOptional" : false
- },
- {
- "name" : "top",
- "type" : "Number",
- "desc" : "The new top",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "setRawValue",
- "type" : "function",
- "desc" : "Sets the underlying DOM field's value directly, bypassing validation. To set the value with validation see {@link #setValue}.",
- "sig" : "(value)",
- "static" : false,
- "memberOf" : "Roo.form.Field",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "value",
- "type" : "Mixed",
- "desc" : "The value to set",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "setSize",
+ "name" : "select",
"type" : "function",
- "desc" : "Sets the width and height of the component. This method fires the resize event. This method can accept\neither width and height as separate numeric arguments, or you can pass a size object like {width:10, height:20}.",
- "sig" : "(width, height)",
+ "desc" : "Select an item in the dropdown list by its numeric index in the list. This function does NOT cause the select event to fire.\nThe store must be loaded and the list expanded for this function to work, otherwise use setValue.",
+ "sig" : "(index, scrollIntoView)",
"static" : false,
- "memberOf" : "Roo.BoxComponent",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "width",
- "type" : "Number/Object",
- "desc" : "The new width to set, or a size object in the format {width, height}",
- "isOptional" : false
- },
- {
- "name" : "height",
+ "name" : "index",
"type" : "Number",
- "desc" : "The new height to set (not required if a size object is passed as the first arg)",
- "isOptional" : false
- }
- ],
- "returns" : [
- {
- "name" : "",
- "type" : "Roo.BoxComponent",
- "desc" : "this"
- }
- ]
- },
- {
- "name" : "setValue",
- "type" : "function",
- "desc" : "Sets the checked state of the checkbox.\nOn is always based on a string comparison between inputValue and the param.",
- "sig" : "(value, suppressEvent)",
- "static" : false,
- "memberOf" : "Roo.form.Checkbox",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "value",
- "type" : "Boolean/String",
- "desc" : "- the value to set",
- "isOptional" : false
- },
- {
- "name" : "suppressEvent",
- "type" : "Boolean/String",
- "desc" : "- whether to suppress the checkchange event.",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "setVisible",
- "type" : "function",
- "desc" : "Convenience function to hide or show this component by boolean.",
- "sig" : "(visible)",
- "static" : false,
- "memberOf" : "Roo.Component",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "visible",
- "type" : "Boolean",
- "desc" : "True to show, false to hide",
- "isOptional" : false
- }
- ],
- "returns" : [
- {
- "name" : "",
- "type" : "Roo.Component",
- "desc" : "this"
- }
- ]
- },
- {
- "name" : "show",
- "type" : "function",
- "desc" : "Show this component.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.Component",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : [
- {
- "name" : "",
- "type" : "Roo.Component",
- "desc" : "this"
- }
- ]
- },
- {
- "name" : "syncSize",
- "type" : "function",
- "desc" : "Force the component's size to recalculate based on the underlying element's current height and width.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.BoxComponent",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
- {
- "name" : "un",
- "type" : "function",
- "desc" : "Removes a listener (shorthand for removeListener)",
- "sig" : "(eventName, handler, scope)",
- "static" : false,
- "memberOf" : "Roo.util.Observable",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "eventName",
- "type" : "String",
- "desc" : "The type of event to listen for",
- "isOptional" : false
- },
- {
- "name" : "handler",
- "type" : "Function",
- "desc" : "The handler to remove",
+ "desc" : "The zero-based index of the list item to select",
"isOptional" : false
},
{
- "name" : "scope",
- "type" : "Object",
- "desc" : "(optional) The scope (this object) for the handler",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "updateBox",
- "type" : "function",
- "desc" : "Sets the current box measurements of the component's underlying element.",
- "sig" : "(box)",
- "static" : false,
- "memberOf" : "Roo.BoxComponent",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "box",
- "type" : "Object",
- "desc" : "An object in the format {x, y, width, height}",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "validate",
- "type" : "function",
- "desc" : "Validates the field value",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.form.Field",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : [
- {
- "name" : "",
+ "name" : "scrollIntoView",
"type" : "Boolean",
- "desc" : "True if the value is valid, else false"
- }
- ]
- }
- ],
- "isAbstract" : false,
- "isBuilderTop" : false,
- "childClasses" : { },
- "tree_children" : [],
- "tree_parent" : []
- },
- "Roo.form.Row" : {
- "props" : [
- {
- "name" : "actionMode",
- "type" : "String",
- "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el' for forms you probably want to set this to fieldEl",
- "memberOf" : "Roo.Component"
- },
- {
- "name" : "allowDomMove",
- "type" : "Boolean",
- "desc" : "Whether the component can move the Dom node when rendering (defaults to true).",
- "memberOf" : "Roo.Component"
- },
- {
- "name" : "autoCreate",
- "type" : "String/Object",
- "desc" : "A DomHelper element spec used to autocreate the layout (defaults to {tag: 'div', cls: 'x-form-ct'})",
- "memberOf" : "Roo.form.Layout"
- },
- {
- "name" : "clear",
- "type" : "Boolean",
- "desc" : "True to add a clearing element at the end of this layout, equivalent to CSS clear: both (defaults to true)",
- "memberOf" : "Roo.form.Layout"
- },
- {
- "name" : "disableClass",
- "type" : "String",
- "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").",
- "memberOf" : "Roo.Component"
- },
- {
- "name" : "height",
- "type" : "Number/String",
- "desc" : "The fixed height of the column in pixels or CSS value (defaults to \"auto\")",
- "memberOf" : ""
- },
- {
- "name" : "hideLabels",
- "type" : "Boolean",
- "desc" : "True to suppress the display of field labels in this layout (defaults to false)",
- "memberOf" : "Roo.form.Layout"
- },
- {
- "name" : "hideMode",
- "type" : "String",
- "desc" : "y)\nHow this component 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" : "labelAlign",
- "type" : "String",
- "desc" : "Valid values are \"left,\" \"top\" and \"right\" (defaults to \"left\")",
- "memberOf" : "Roo.form.Layout"
- },
- {
- "name" : "labelSeparator",
- "type" : "String",
- "desc" : "The separator to use after field labels (defaults to ':')",
- "memberOf" : "Roo.form.Layout"
- },
- {
- "name" : "labelWidth",
- "type" : "Number",
- "desc" : "Fixed width in pixels of all field labels (defaults to undefined)",
- "memberOf" : "Roo.form.Layout"
- },
- {
- "name" : "listeners",
- "type" : "Object",
- "desc" : "list of events and functions to call for this object, \nFor example :\n<pre><code>\n listeners : { \n 'click' : function(e) {\n ..... \n } ,\n .... \n } \n </code></pre>",
- "memberOf" : "Roo.util.Observable"
- },
- {
- "name" : "style",
- "type" : "String/Object/Function",
- "desc" : "A style specification string, e.g. \"width:100px\", or object in the form {width:\"100px\"}, or\na function which returns such a specification.",
- "memberOf" : "Roo.form.Layout"
- },
- {
- "name" : "width",
- "type" : "Number/String",
- "desc" : "The fixed width of the column in pixels or CSS value (defaults to \"auto\")",
- "memberOf" : ""
- }
- ],
- "events" : [
- {
- "name" : "beforedestroy",
- "type" : "function",
- "desc" : "Fires before the component is destroyed. Return false to stop the destroy.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.Component",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "beforehide",
- "type" : "function",
- "desc" : "Fires before the component is hidden. Return false to stop the hide.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.Component",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "beforerender",
- "type" : "function",
- "desc" : "Fires before the component is rendered. Return false to stop the render.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.Component",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "beforeshow",
- "type" : "function",
- "desc" : "Fires before the component is shown. Return false to stop the show.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.Component",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "destroy",
- "type" : "function",
- "desc" : "Fires after the component is destroyed.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.Component",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "disable",
- "type" : "function",
- "desc" : "Fires after the component is disabled.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.Component",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "enable",
- "type" : "function",
- "desc" : "Fires after the component is enabled.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.Component",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "hide",
- "type" : "function",
- "desc" : "Fires after the component is hidden.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.Component",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "render",
- "type" : "function",
- "desc" : "Fires after the component is rendered.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.Component",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "show",
- "type" : "function",
- "desc" : "Fires after the component is shown.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.Component",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- }
- ],
- "methods" : [
- {
- "name" : "addEvents",
- "type" : "function",
- "desc" : "Used to define events on this Observable",
- "sig" : "(object)",
- "static" : false,
- "memberOf" : "Roo.util.Observable",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "object",
- "type" : "Object",
- "desc" : "The object with the events defined",
+ "desc" : "False to prevent the dropdown list from autoscrolling to display the\nselected item if it is not currently in view (defaults to true)",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "addListener",
+ "name" : "selectByValue",
"type" : "function",
- "desc" : "Appends an event handler to this component",
- "sig" : "(eventName, handler, scope, options)",
+ "desc" : "Select an item in the dropdown list by its data value. This function does NOT cause the select event to fire.\nThe store must be loaded and the list expanded for this function to work, otherwise use setValue.",
+ "sig" : "(value, scrollIntoView)",
"static" : false,
- "memberOf" : "Roo.util.Observable",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "eventName",
+ "name" : "value",
"type" : "String",
- "desc" : "The type of event to listen for",
- "isOptional" : false
- },
- {
- "name" : "handler",
- "type" : "Function",
- "desc" : "The method the event invokes",
- "isOptional" : false
- },
- {
- "name" : "scope",
- "type" : "Object",
- "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
- "isOptional" : false
- },
- {
- "name" : "options",
- "type" : "Object",
- "desc" : "(optional) An object containing handler configuration\nproperties. This may contain any of the following properties:<ul>\n<li>scope {Object} The scope in which to execute the handler function. The handler function's \"this\" context.</li>\n<li>delay {Number} The number of milliseconds to delay the invocation of the handler after te event fires.</li>\n<li>single {Boolean} True to add a handler to handle just the next firing of the event, and then remove itself.</li>\n<li>buffer {Number} Causes the handler to be scheduled to run in an {@link Roo.util.DelayedTask} delayed\nby the specified number of milliseconds. If the event fires again within that time, the original\nhandler is <em>not</em> invoked, but the new handler is scheduled in its place.</li>\n</ul><br>\n<p>\n<b>Combining Options</b><br>\nUsing the options argument, it is possible to combine different types of listeners:<br>\n<br>\nA normalized, delayed, one-time listener that auto stops the event and passes a custom argument (forumId)\n\t\t<pre><code>\n\t\tel.on('click', this.onClick, this, {\n \t\t\tsingle: true,\n \t\tdelay: 100,\n \t\tforumId: 4\n\t\t});\n\t\t</code></pre>\n<p>\n<b>Attaching multiple handlers in 1 call</b><br>\nThe method also allows for a single argument to be passed which is a config object containing properties\nwhich specify multiple handlers.\n<pre><code>\n\t\tel.on({\n\t\t\t'click': {\n \t\tfn: this.onClick,\n \t\tscope: this,\n \t\tdelay: 100\n \t\t}, \n \t\t'mouseover': {\n \t\tfn: this.onMouseOver,\n \t\tscope: this\n \t\t},\n \t\t'mouseout': {\n \t\tfn: this.onMouseOut,\n \t\tscope: this\n \t\t}\n\t\t});\n\t\t</code></pre>\n<p>\nOr a shorthand syntax which passes the same scope object to all handlers:\n \t<pre><code>\n\t\tel.on({\n\t\t\t'click': this.onClick,\n \t\t'mouseover': this.onMouseOver,\n \t\t'mouseout': this.onMouseOut,\n \t\tscope: this\n\t\t});\n\t\t</code></pre>",
+ "desc" : "The data value of the item to select",
"isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "addxtype",
- "type" : "function",
- "desc" : "Adds a object form elements (using the xtype property as the factory method.)\nValid xtypes are: TextField, TextArea .... Button, Layout, FieldSet, Column",
- "sig" : "(config)",
- "static" : false,
- "memberOf" : "Roo.form.Layout",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
+ },
{
- "name" : "config",
- "type" : "Object",
- "desc" : "",
+ "name" : "scrollIntoView",
+ "type" : "Boolean",
+ "desc" : "False to prevent the dropdown list from autoscrolling to display the\nselected item if it is not currently in view (defaults to true)",
"isOptional" : false
}
],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Boolean",
+ "desc" : "True if the value matched an item in the list, else false"
+ }
+ ]
},
{
- "name" : "capture",
+ "name" : "selectText",
"type" : "function",
- "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\n<b>before</b> the event is fired. If the supplied function returns false,\nthe event will not fire.",
- "sig" : "(o, fn, scope)",
- "static" : true,
- "memberOf" : "Roo.util.Observable",
- "isStatic" : true,
+ "desc" : "Selects text in this field",
+ "sig" : "(start, end)",
+ "static" : false,
+ "memberOf" : "Roo.form.TextField",
+ "isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"example" : "",
"requires" : "",
"params" : [
{
- "name" : "o",
- "type" : "Observable",
- "desc" : "The Observable to capture",
- "isOptional" : false
- },
- {
- "name" : "fn",
- "type" : "Function",
- "desc" : "The function to call",
+ "name" : "start",
+ "type" : "Number",
+ "desc" : "(optional) The index where the selection should start (defaults to 0)",
"isOptional" : false
},
{
- "name" : "scope",
- "type" : "Object",
- "desc" : "(optional) The scope (this object) for the fn",
+ "name" : "end",
+ "type" : "Number",
+ "desc" : "(optional) The index where the selection should end (defaults to the text length)",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "destroy",
+ "name" : "setDisabled",
"type" : "function",
- "desc" : "Destroys this component by purging any event listeners, removing the component's element from the DOM,\nremoving the component from its {@link Roo.Container} (if applicable) and unregistering it from {@link Roo.ComponentMgr}.",
- "sig" : "()\n{\n\n}",
+ "desc" : "Convenience function for setting disabled/enabled by boolean.",
+ "sig" : "(disabled)",
"static" : false,
"memberOf" : "Roo.Component",
"isStatic" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
+ "params" : [
+ {
+ "name" : "disabled",
+ "type" : "Boolean",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
"returns" : []
},
{
- "name" : "disable",
+ "name" : "setEditable",
"type" : "function",
- "desc" : "Disable this component.",
- "sig" : "()\n{\n\n}",
+ "desc" : "Allow or prevent the user from directly editing the field text. If false is passed,\nthe user will only be able to select from the items defined in the dropdown list. This method\nis the runtime equivalent of setting the 'editable' config option at config time.",
+ "sig" : "(value)",
"static" : false,
- "memberOf" : "Roo.Component",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
- "returns" : [
+ "params" : [
{
- "name" : "",
- "type" : "Roo.Component",
- "desc" : "this"
+ "name" : "value",
+ "type" : "Boolean",
+ "desc" : "True to allow the user to directly edit the field text",
+ "isOptional" : false
}
- ]
+ ],
+ "returns" : []
},
{
- "name" : "enable",
+ "name" : "setFromData",
"type" : "function",
- "desc" : "Enable this component.",
- "sig" : "()\n{\n\n}",
+ "desc" : "Sets the value of the field based on a object which is related to the record format for the store.",
+ "sig" : "(value)",
"static" : false,
- "memberOf" : "Roo.Component",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
- "returns" : [
+ "params" : [
{
- "name" : "",
- "type" : "Roo.Component",
- "desc" : "this"
+ "name" : "value",
+ "type" : "Object",
+ "desc" : "the value to set as. or false on reset?",
+ "isOptional" : false
}
- ]
+ ],
+ "returns" : []
},
{
- "name" : "fireEvent",
+ "name" : "setPagePosition",
"type" : "function",
- "desc" : "Fires the specified event with the passed parameters (minus the event name).",
- "sig" : "(eventName, args)",
+ "desc" : "Sets the page XY position of the component. To set the left and top instead, use {@link #setPosition}.\nThis method fires the move event.",
+ "sig" : "(x, y)",
"static" : false,
- "memberOf" : "Roo.util.Observable",
+ "memberOf" : "Roo.BoxComponent",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "eventName",
- "type" : "String",
- "desc" : "",
+ "name" : "x",
+ "type" : "Number",
+ "desc" : "The new x position",
"isOptional" : false
},
{
- "name" : "args",
- "type" : "Object...",
- "desc" : "Variable number of parameters are passed to handlers",
+ "name" : "y",
+ "type" : "Number",
+ "desc" : "The new y position",
"isOptional" : false
}
],
- "returns" : [
- {
- "name" : "",
- "type" : "Boolean",
- "desc" : "returns false if any of the handlers return false otherwise it returns true"
- }
- ]
+ "returns" : []
},
{
- "name" : "focus",
+ "name" : "setPosition",
"type" : "function",
- "desc" : "Try to focus this component.",
- "sig" : "(selectText)",
+ "desc" : "Sets the left and top of the component. To set the page XY position instead, use {@link #setPagePosition}.\nThis method fires the move event.",
+ "sig" : "(left, top)",
"static" : false,
- "memberOf" : "Roo.Component",
+ "memberOf" : "Roo.BoxComponent",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "selectText",
- "type" : "Boolean",
- "desc" : "True to also select the text in this component (if applicable)",
+ "name" : "left",
+ "type" : "Number",
+ "desc" : "The new left",
"isOptional" : false
- }
- ],
- "returns" : [
+ },
{
- "name" : "",
- "type" : "Roo.Component",
- "desc" : "this"
+ "name" : "top",
+ "type" : "Number",
+ "desc" : "The new top",
+ "isOptional" : false
}
- ]
+ ],
+ "returns" : []
},
{
- "name" : "getEl",
+ "name" : "setRawValue",
"type" : "function",
- "desc" : "Returns the underlying {@link Roo.Element}.",
- "sig" : "()\n{\n\n}",
+ "desc" : "Sets the underlying DOM field's value directly, bypassing validation. To set the value with validation see {@link #setValue}.",
+ "sig" : "(value)",
"static" : false,
- "memberOf" : "Roo.Component",
+ "memberOf" : "Roo.form.Field",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
- "returns" : [
+ "params" : [
{
- "name" : "",
- "type" : "Roo.Element",
- "desc" : "The element"
+ "name" : "value",
+ "type" : "Mixed",
+ "desc" : "The value to set",
+ "isOptional" : false
}
- ]
+ ],
+ "returns" : []
},
{
- "name" : "getId",
+ "name" : "setSize",
"type" : "function",
- "desc" : "Returns the id of this component.",
- "sig" : "()\n{\n\n}",
+ "desc" : "Sets the width and height of the component. This method fires the resize event. This method can accept\neither width and height as separate numeric arguments, or you can pass a size object like {width:10, height:20}.",
+ "sig" : "(width, height)",
"static" : false,
- "memberOf" : "Roo.Component",
+ "memberOf" : "Roo.BoxComponent",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
+ "params" : [
+ {
+ "name" : "width",
+ "type" : "Number/Object",
+ "desc" : "The new width to set, or a size object in the format {width, height}",
+ "isOptional" : false
+ },
+ {
+ "name" : "height",
+ "type" : "Number",
+ "desc" : "The new height to set (not required if a size object is passed as the first arg)",
+ "isOptional" : false
+ }
+ ],
"returns" : [
{
"name" : "",
- "type" : "String",
- "desc" : ""
+ "type" : "Roo.BoxComponent",
+ "desc" : "this"
}
]
},
{
- "name" : "hasListener",
+ "name" : "setValue",
"type" : "function",
- "desc" : "Checks to see if this object has any listeners for a specified event",
- "sig" : "(eventName)",
+ "desc" : "Sets the specified value into the field. If the value finds a match, the corresponding record text\nwill be displayed in the field. If the value does not match the data value of an existing item,\nand the valueNotFoundText config option is defined, it will be displayed as the default field text.\nOtherwise the field will be blank (although the value will still be set).",
+ "sig" : "(value)",
"static" : false,
- "memberOf" : "Roo.util.Observable",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "eventName",
+ "name" : "value",
"type" : "String",
- "desc" : "The name of the event to check for",
+ "desc" : "The value to match",
"isOptional" : false
}
],
- "returns" : [
- {
- "name" : "",
- "type" : "Boolean",
- "desc" : "True if the event is being listened for, else false"
- }
- ]
+ "returns" : []
},
{
- "name" : "hide",
+ "name" : "setVisible",
"type" : "function",
- "desc" : "Hide this component.",
- "sig" : "()\n{\n\n}",
+ "desc" : "Convenience function to hide or show this component by boolean.",
+ "sig" : "(visible)",
"static" : false,
"memberOf" : "Roo.Component",
"isStatic" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
+ "params" : [
+ {
+ "name" : "visible",
+ "type" : "Boolean",
+ "desc" : "True to show, false to hide",
+ "isOptional" : false
+ }
+ ],
"returns" : [
{
"name" : "",
]
},
{
- "name" : "isVisible",
+ "name" : "setWidth",
"type" : "function",
- "desc" : "Returns true if this component is visible.",
+ "desc" : "",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.Component",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"returns" : []
},
{
- "name" : "on",
+ "name" : "show",
"type" : "function",
- "desc" : "Appends an event handler to this element (shorthand for addListener)",
- "sig" : "(eventName, handler, scope, options)",
+ "desc" : "Show this component.",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.util.Observable",
+ "memberOf" : "Roo.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "eventName",
- "type" : "String",
- "desc" : "The type of event to listen for",
- "isOptional" : false
- },
- {
- "name" : "handler",
- "type" : "Function",
- "desc" : "The method the event invokes",
- "isOptional" : false
- },
- {
- "name" : "scope",
- "type" : "Object",
- "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
- "isOptional" : false
- },
+ "params" : [],
+ "returns" : [
{
- "name" : "options",
- "type" : "Object",
- "desc" : "(optional)",
- "isOptional" : false
+ "name" : "",
+ "type" : "Roo.Component",
+ "desc" : "this"
}
- ],
- "returns" : []
+ ]
},
{
- "name" : "purgeListeners",
+ "name" : "syncSize",
"type" : "function",
- "desc" : "Removes all listeners for this object",
+ "desc" : "Force the component's size to recalculate based on the underlying element's current height and width.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.util.Observable",
+ "memberOf" : "Roo.BoxComponent",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"returns" : []
},
{
- "name" : "releaseCapture",
- "type" : "function",
- "desc" : "Removes <b>all</b> added captures from the Observable.",
- "sig" : "(o)",
- "static" : true,
- "memberOf" : "Roo.util.Observable",
- "isStatic" : true,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "o",
- "type" : "Observable",
- "desc" : "The Observable to release",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "removeListener",
+ "name" : "un",
"type" : "function",
- "desc" : "Removes a listener",
+ "desc" : "Removes a listener (shorthand for removeListener)",
"sig" : "(eventName, handler, scope)",
"static" : false,
"memberOf" : "Roo.util.Observable",
"returns" : []
},
{
- "name" : "render",
+ "name" : "updateBox",
"type" : "function",
- "desc" : "If this is a lazy rendering component, render it to its container element.",
- "sig" : "(container)",
+ "desc" : "Sets the current box measurements of the component's underlying element.",
+ "sig" : "(box)",
"static" : false,
- "memberOf" : "Roo.Component",
+ "memberOf" : "Roo.BoxComponent",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "container",
- "type" : "String/HTMLElement/Element",
- "desc" : "(optional) The element this component should be rendered into. If it is being applied to existing markup, this should be left off.",
+ "name" : "box",
+ "type" : "Object",
+ "desc" : "An object in the format {x, y, width, height}",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "setDisabled",
+ "name" : "validate",
"type" : "function",
- "desc" : "Convenience function for setting disabled/enabled by boolean.",
- "sig" : "(disabled)",
+ "desc" : "Validates the field value",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.Component",
+ "memberOf" : "Roo.form.Field",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
+ "params" : [],
+ "returns" : [
{
- "name" : "disabled",
+ "name" : "",
"type" : "Boolean",
- "desc" : "",
- "isOptional" : false
+ "desc" : "True if the value is valid, else false"
}
- ],
- "returns" : []
+ ]
},
{
- "name" : "setVisible",
+ "name" : "validateValue",
"type" : "function",
- "desc" : "Convenience function to hide or show this component by boolean.",
- "sig" : "(visible)",
+ "desc" : "Validates a value according to the field's validation rules and marks the field as invalid\nif the validation fails",
+ "sig" : "(value)",
"static" : false,
- "memberOf" : "Roo.Component",
+ "memberOf" : "Roo.form.TextField",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "visible",
- "type" : "Boolean",
- "desc" : "True to show, false to hide",
+ "name" : "value",
+ "type" : "Mixed",
+ "desc" : "The value to validate",
"isOptional" : false
}
],
"returns" : [
{
"name" : "",
- "type" : "Roo.Component",
- "desc" : "this"
- }
- ]
- },
- {
- "name" : "show",
- "type" : "function",
- "desc" : "Show this component.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.Component",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : [
- {
- "name" : "",
- "type" : "Roo.Component",
- "desc" : "this"
+ "type" : "Boolean",
+ "desc" : "True if the value is valid, else false"
}
]
- },
- {
- "name" : "un",
- "type" : "function",
- "desc" : "Removes a listener (shorthand for removeListener)",
- "sig" : "(eventName, handler, scope)",
- "static" : false,
- "memberOf" : "Roo.util.Observable",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "eventName",
- "type" : "String",
- "desc" : "The type of event to listen for",
- "isOptional" : false
- },
- {
- "name" : "handler",
- "type" : "Function",
- "desc" : "The handler to remove",
- "isOptional" : false
- },
- {
- "name" : "scope",
- "type" : "Object",
- "desc" : "(optional) The scope (this object) for the handler",
- "isOptional" : false
- }
- ],
- "returns" : []
}
],
"isAbstract" : false,
"isBuilderTop" : false,
- "childClasses" : { },
- "tree_children" : [
- "Roo.form.Column",
- "Roo.form.Row",
- "Roo.form.Field",
- "Roo.form.Checkbox",
- "Roo.form.ComboBox",
- "Roo.form.ComboBoxArray",
- "Roo.form.ComboCheck",
- "Roo.form.ComboNested",
- "Roo.form.DateField",
- "Roo.form.DayPicker",
- "Roo.form.DisplayField",
- "Roo.form.FCKeditor",
- "Roo.form.GridField",
- "Roo.form.Hidden",
- "Roo.form.HtmlEditor",
- "Roo.form.MonthField",
- "Roo.form.NumberField",
- "Roo.form.Radio",
- "Roo.form.Select",
- "Roo.form.Signature",
- "Roo.form.TextArea",
- "Roo.form.TextField",
- "Roo.form.TriggerField",
- "Roo.Button",
- "Roo.SplitButton",
- "Roo.Toolbar.Button",
- "Roo.Toolbar.SplitButton",
- "Roo.form.TextItem"
- ],
+ "implementations" : [],
+ "tree_children" : [],
"tree_parent" : []
},
- "Roo.form.Select" : {
+ "Roo.form.Signature" : {
"props" : [
{
"name" : "actionMode",
"type" : "String",
"desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el' for forms you probably want to set this to fieldEl",
- "memberOf" : "Roo.Component"
- },
- {
- "name" : "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" : ""
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "allowBlank",
"type" : "Boolean",
- "desc" : "False to validate that the value length > 0 (defaults to true)",
- "memberOf" : "Roo.form.TextField"
+ "desc" : "False to validate that the value length > 0 (defaults to false)",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "allowDomMove",
"type" : "Boolean",
"desc" : "Whether the component can move the Dom node when rendering (defaults to true).",
- "memberOf" : "Roo.Component"
- },
- {
- "name" : "allowLeadingSpace",
- "type" : "Boolean",
- "desc" : "True to prevent the stripping of leading white space",
- "memberOf" : "Roo.form.TextField"
- },
- {
- "name" : "alwaysQuery",
- "type" : "Boolean",
- "desc" : "Disable caching of results, and always send query",
- "memberOf" : ""
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "autoCreate",
- "type" : "Boolean/Object",
- "desc" : "A DomHelper element spec, or true for a default element spec (defaults to:\n{tag: \"input\", type: \"text\", size: \"24\", autocomplete: \"off\"})",
- "memberOf" : ""
- },
- {
- "name" : "blankText",
- "type" : "String",
- "desc" : "Error text to display if the allow blank validation fails (defaults to \"This field is required\")",
- "memberOf" : "Roo.form.TextField"
- },
- {
- "name" : "blockFocus",
- "type" : "Boolean",
- "desc" : "Prevents all focus calls, so it can work with things like HTML edtor bar",
- "memberOf" : ""
+ "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",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "cls",
"type" : "String",
"desc" : "A CSS class to apply to the field's underlying element.",
- "memberOf" : "Roo.form.Field"
- },
- {
- "name" : "defaultValue",
- "type" : "String",
- "desc" : "The value displayed after loading the store.",
- "memberOf" : ""
+ "memberOf" : "Roo.form.Field",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "disableClass",
"type" : "String",
"desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").",
- "memberOf" : "Roo.Component"
- },
- {
- "name" : "disableClear",
- "type" : "Boolean",
- "desc" : "Disable showing of clear button.",
- "memberOf" : ""
- },
- {
- "name" : "disableKeyFilter",
- "type" : "Boolean",
- "desc" : "True to disable input keystroke filtering (defaults to false)",
- "memberOf" : "Roo.form.TextField"
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "disabled",
"type" : "Boolean",
"desc" : "True to disable the field (defaults to false).",
- "memberOf" : "Roo.form.Field"
- },
- {
- "name" : "displayField",
- "type" : "String",
- "desc" : "The underlying data field name to bind to this CombBox (defaults to undefined if\nmode = 'remote' or 'text' if mode = 'local')",
- "memberOf" : ""
- },
- {
- "name" : "editable",
- "type" : "Boolean",
- "desc" : "False to prevent the user from typing text directly into the field, just like a\ntraditional select (defaults to true)",
- "memberOf" : ""
- },
- {
- "name" : "emptyText",
- "type" : "String",
- "desc" : "The default text to display in an empty field - placeholder... (defaults to null).",
- "memberOf" : "Roo.form.TextField"
+ "memberOf" : "Roo.form.Field",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "fieldClass",
"type" : "String",
"desc" : "The default CSS class for the field (defaults to \"x-form-field\")",
- "memberOf" : "Roo.form.Field"
+ "memberOf" : "Roo.form.Field",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "fieldLabel",
"type" : "String",
"desc" : "Label to use when rendering a form.",
- "memberOf" : "Roo.form.Field"
+ "memberOf" : "Roo.form.Field",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "focusClass",
"type" : "String",
"desc" : "The CSS class to use when the field receives focus (defaults to \"x-form-focus\")",
- "memberOf" : "Roo.form.Field"
- },
- {
- "name" : "forceSelection",
- "type" : "Boolean",
- "desc" : "True to restrict the selected value to one of the values in the list, false to\nallow the user to set arbitrary text into the field (defaults to false)",
- "memberOf" : ""
- },
- {
- "name" : "grow",
- "type" : "Boolean",
- "desc" : "",
- "memberOf" : ""
- },
- {
- "name" : "growMax",
- "type" : "Number",
- "desc" : "",
- "memberOf" : ""
- },
- {
- "name" : "growMin",
- "type" : "Number",
- "desc" : "",
- "memberOf" : ""
- },
- {
- "name" : "handleHeight",
- "type" : "Number",
- "desc" : "The height in pixels of the dropdown list resize handle if resizable = true (defaults to 8)",
- "memberOf" : ""
+ "memberOf" : "Roo.form.Field",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "height",
"type" : "Number",
- "desc" : "height (optional) size of component",
- "memberOf" : "Roo.BoxComponent"
- },
- {
- "name" : "hiddenName",
- "type" : "String",
- "desc" : "If specified, a hidden form field with this name is dynamically generated to store the\nfield's data value (defaults to the underlying DOM element's name)",
- "memberOf" : ""
+ "desc" : "The signature panel height (defaults to 100)",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "hideMode",
"type" : "String",
- "desc" : "y)\nHow this component 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" : "hideTrigger",
- "type" : "Boolean",
- "desc" : "True to hide the trigger element and display only the base text field (defaults to false)",
- "memberOf" : "Roo.form.TriggerField"
+ "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display",
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : [
+ "display",
+ "visibility"
+ ]
},
{
"name" : "inputType",
"type" : "String",
"desc" : "The type attribute for input fields -- e.g. radio, text, password (defaults to \"text\").",
- "memberOf" : "Roo.form.Field"
+ "memberOf" : "Roo.form.Field",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "invalidClass",
"type" : "String",
"desc" : "The CSS class to use when marking a field invalid (defaults to \"x-form-invalid\")",
- "memberOf" : "Roo.form.Field"
+ "memberOf" : "Roo.form.Field",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "invalidText",
"type" : "String",
"desc" : "The error text to use when marking a field invalid and no message is provided (defaults to \"The value in this field is invalid\")",
- "memberOf" : "Roo.form.Field"
- },
- {
- "name" : "lazyRender",
- "type" : "Boolean",
- "desc" : "True to prevent the ComboBox from rendering until requested (should always be used when\nrendering into an Roo.Editor, defaults to false)",
- "memberOf" : ""
- },
- {
- "name" : "listAlign",
- "type" : "String",
- "desc" : "A valid anchor position value. See {@link Roo.Element#alignTo} for details on supported\nanchor positions (defaults to 'tl-bl')",
- "memberOf" : ""
- },
- {
- "name" : "listClass",
- "type" : "String",
- "desc" : "CSS class to apply to the dropdown list element (defaults to '')",
- "memberOf" : ""
+ "memberOf" : "Roo.form.Field",
+ "isOptional" : false,
+ "optvals" : []
},
{
- "name" : "listWidth",
- "type" : "Number",
- "desc" : "The width in pixels of the dropdown list (defaults to the width of the ComboBox field)",
- "memberOf" : ""
+ "name" : "labels",
+ "type" : "Object",
+ "desc" : "Label to use when rendering a form.\ndefaults to \nlabels : { \n clear : \"Clear\",\n confirm : \"Confirm\"\n }",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"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"
- },
- {
- "name" : "loadingText",
- "type" : "String",
- "desc" : "The text to display in the dropdown list while data is loading. Only applies\nwhen mode = 'remote' (defaults to 'Loading...')",
- "memberOf" : ""
- },
- {
- "name" : "maskRe",
- "type" : "String",
- "desc" : "An input mask regular expression that will be used to filter keystrokes that don't match (defaults to null)",
- "memberOf" : "Roo.form.TextField"
- },
- {
- "name" : "maxHeight",
- "type" : "Number",
- "desc" : "The maximum height in pixels of the dropdown list before scrollbars are shown (defaults to 300)",
- "memberOf" : ""
- },
- {
- "name" : "maxLength",
- "type" : "Number",
- "desc" : "Maximum input field length allowed (defaults to Number.MAX_VALUE)",
- "memberOf" : "Roo.form.TextField"
- },
- {
- "name" : "maxLengthText",
- "type" : "String",
- "desc" : "Error text to display if the maximum length validation fails (defaults to \"The maximum length for this field is {maxLength}\")",
- "memberOf" : "Roo.form.TextField"
- },
- {
- "name" : "minChars",
- "type" : "Number",
- "desc" : "The minimum number of characters the user must type before autocomplete and typeahead activate\n(defaults to 4, does not apply if editable = false)",
- "memberOf" : ""
- },
- {
- "name" : "minLength",
- "type" : "Number",
- "desc" : "Minimum input field length required (defaults to 0)",
- "memberOf" : "Roo.form.TextField"
- },
- {
- "name" : "minLengthText",
- "type" : "String",
- "desc" : "Error text to display if the minimum length validation fails (defaults to \"The minimum length for this field is {minLength}\")",
- "memberOf" : "Roo.form.TextField"
- },
- {
- "name" : "minListWidth",
- "type" : "Number",
- "desc" : "The minimum width of the dropdown list in pixels (defaults to 70, will be ignored if\nlistWidth has a higher value)",
- "memberOf" : ""
- },
- {
- "name" : "mode",
- "type" : "String",
- "desc" : "Set to 'local' if the ComboBox loads local data (defaults to 'remote' which loads from the server)",
- "memberOf" : ""
+ "memberOf" : "Roo.util.Observable",
+ "isOptional" : false,
+ "optvals" : []
},
{
"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"
+ "memberOf" : "Roo.form.Field",
+ "isOptional" : false,
+ "optvals" : []
},
{
"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"
+ "memberOf" : "Roo.form.Field",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "name",
"type" : "String",
"desc" : "The field's HTML name attribute.",
- "memberOf" : "Roo.form.Field"
- },
- {
- "name" : "pageSize",
- "type" : "Number",
- "desc" : "If greater than 0, a paging toolbar is displayed in the footer of the dropdown list and the\nfilter queries will execute with page start and limit parameters. Only applies when mode = 'remote' (defaults to 0)",
- "memberOf" : ""
+ "memberOf" : "Roo.form.Field",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "qtip",
"type" : "String",
"desc" : "Mouse over tip",
- "memberOf" : "Roo.form.Field"
- },
- {
- "name" : "queryDelay",
- "type" : "Number",
- "desc" : "The length of time in milliseconds to delay between the start of typing and sending the\nquery to filter the dropdown list (defaults to 500 if mode = 'remote' or 10 if mode = 'local')",
- "memberOf" : ""
- },
- {
- "name" : "queryParam",
- "type" : "String",
- "desc" : "Name of the query as it will be passed on the querystring (defaults to 'query')",
- "memberOf" : ""
+ "memberOf" : "Roo.form.Field",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "readOnly",
"type" : "Boolean",
"desc" : "True to mark the field as readOnly in HTML (defaults to false) -- Note: this only sets the element's readOnly DOM attribute.",
- "memberOf" : "Roo.form.Field"
- },
- {
- "name" : "regex",
- "type" : "RegExp",
- "desc" : "A JavaScript RegExp object to be tested against the field value during validation (defaults to null).\nIf available, this regex will be evaluated only after the basic validators all return true, and will be passed the\ncurrent field value. If the test fails, the field will be marked invalid using {@link #regexText}.",
- "memberOf" : "Roo.form.TextField"
- },
- {
- "name" : "regexText",
- "type" : "String",
- "desc" : "The error text to display if {@link #regex} is used and the test fails during validation (defaults to \"\")",
- "memberOf" : "Roo.form.TextField"
- },
- {
- "name" : "resizable",
- "type" : "Boolean",
- "desc" : "True to add a resize handle to the bottom of the dropdown list (defaults to false)",
- "memberOf" : ""
- },
- {
- "name" : "selectOnFocus",
- "type" : "Boolean",
- "desc" : "True to select any existing text in the field immediately on focus. Only applies\nwhen editable = true (defaults to false)",
- "memberOf" : ""
+ "memberOf" : "Roo.form.Field",
+ "isOptional" : false,
+ "optvals" : []
},
{
- "name" : "selectedClass",
+ "name" : "style",
"type" : "String",
- "desc" : "CSS class to apply to the selected item in the dropdown list (defaults to 'x-combo-selected')",
- "memberOf" : ""
- },
- {
- "name" : "shadow",
- "type" : "Boolean/String",
- "desc" : "True or \"sides\" for the default effect, \"frame\" for 4-way shadow, and \"drop\" for bottom-right",
- "memberOf" : ""
- },
- {
- "name" : "store",
- "type" : "Roo.data.Store",
- "desc" : "The data store to which this combo is bound (defaults to undefined)",
- "memberOf" : ""
+ "desc" : "css styles to add to component\neg. text-align:right;",
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "tabIndex",
"type" : "Number",
"desc" : "The tabIndex for this field. Note this only applies to fields that are rendered, not those which are built via applyTo (defaults to undefined).",
- "memberOf" : "Roo.form.Field"
- },
- {
- "name" : "title",
- "type" : "String",
- "desc" : "If supplied, a header element is created containing this text and added into the top of\nthe dropdown list (defaults to undefined, with no header element)",
- "memberOf" : ""
- },
- {
- "name" : "tpl",
- "type" : "String/Roo.Template",
- "desc" : "The template to use to render the output",
- "memberOf" : ""
- },
- {
- "name" : "transform",
- "type" : "String/HTMLElement/Element",
- "desc" : "The id, DOM node or element of an existing select to convert to a ComboBox",
- "memberOf" : ""
- },
- {
- "name" : "triggerAction",
- "type" : "String",
- "desc" : "The action to execute when the trigger field is activated. Use 'all' to run the\nquery specified by the allQuery config option (defaults to 'query')",
- "memberOf" : ""
- },
- {
- "name" : "triggerClass",
- "type" : "String",
- "desc" : "An additional CSS class used to style the trigger button. The trigger will always get the\nclass 'x-form-trigger' and triggerClass will be <b>appended</b> if specified (defaults to 'x-form-arrow-trigger'\nwhich displays a downward arrow icon).",
- "memberOf" : ""
- },
- {
- "name" : "typeAhead",
- "type" : "Boolean",
- "desc" : "True to populate and autoselect the remainder of the text being typed after a configurable\ndelay (typeAheadDelay) if it matches a known value (defaults to false)",
- "memberOf" : ""
- },
- {
- "name" : "typeAheadDelay",
- "type" : "Number",
- "desc" : "The length of time in milliseconds to wait until the typeahead text is displayed\nif typeAhead = true (defaults to 250)",
- "memberOf" : ""
+ "memberOf" : "Roo.form.Field",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "validateOnBlur",
"type" : "Boolean",
"desc" : "Whether the field should validate when it loses focus (defaults to true).",
- "memberOf" : "Roo.form.Field"
+ "memberOf" : "Roo.form.Field",
+ "isOptional" : false,
+ "optvals" : []
},
{
"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"
+ "memberOf" : "Roo.form.Field",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "validationEvent",
"type" : "String/Boolean",
"desc" : "The event that should initiate field validation. Set to false to disable\n automatic validation (defaults to \"keyup\").",
- "memberOf" : "Roo.form.Field"
- },
- {
- "name" : "validator",
- "type" : "Function",
- "desc" : "A custom validation function to be called during field validation (defaults to null).\nIf available, this function will be called only after the basic validators all return true, and will be passed the\ncurrent field value and expected to return boolean true if the value is valid or a string error message if invalid.",
- "memberOf" : "Roo.form.TextField"
+ "memberOf" : "Roo.form.Field",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "value",
"type" : "Mixed",
"desc" : "A value to initialize this field with.",
- "memberOf" : "Roo.form.Field"
- },
- {
- "name" : "valueField",
- "type" : "String",
- "desc" : "The underlying data value name to bind to this CombBox (defaults to undefined if\nmode = 'remote' or 'value' if mode = 'local'). \nNote: use of a valueField requires the user make a selection\nin order for a value to be mapped.",
- "memberOf" : ""
- },
- {
- "name" : "valueNotFoundText",
- "type" : "String",
- "desc" : "When using a name/value combo, if the value passed to setValue is not found in\nthe store, valueNotFoundText will be displayed as the field text if defined (defaults to undefined)",
- "memberOf" : ""
- },
- {
- "name" : "vtype",
- "type" : "String",
- "desc" : "A validation type name as defined in {@link Roo.form.VTypes} (defaults to null)",
- "memberOf" : "Roo.form.TextField"
+ "memberOf" : "Roo.form.Field",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "width",
"type" : "Number",
- "desc" : "width (optional) size of component",
- "memberOf" : "Roo.BoxComponent"
+ "desc" : "The signature panel width (defaults to 300)",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
}
],
"events" : [
- {
- "name" : "autosize",
- "type" : "function",
- "desc" : "Fires when the autosize function is triggered. The field may or may not have actually changed size\naccording to the default logic, but this event provides a hook for the developer to apply additional\nlogic at runtime to resize the field if needed.",
- "sig" : "function (_self, width)\n{\n\n}",
- "memberOf" : "Roo.form.TextField",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.form.Field",
- "desc" : "This text field",
- "isOptional" : false
- },
- {
- "name" : "width",
- "type" : "Number",
- "desc" : "The new field width",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
{
"name" : "beforedestroy",
"type" : "function",
],
"returns" : []
},
+ {
+ "name" : "confirm",
+ "type" : "function",
+ "desc" : "Fires when the 'confirm' icon is pressed (add a listener to enable add button)",
+ "sig" : "function (combo)\n{\n\n}",
+ "memberOf" : "",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "combo",
+ "type" : "Roo.form.Signature",
+ "desc" : "This combo box",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
{
"name" : "destroy",
"type" : "function",
],
"returns" : []
},
+ {
+ "name" : "reset",
+ "type" : "function",
+ "desc" : "Fires when the 'edit' icon is pressed (add a listener to enable add button)",
+ "sig" : "function (combo, record)\n{\n\n}",
+ "memberOf" : "",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "combo",
+ "type" : "Roo.form.ComboBox",
+ "desc" : "This combo box",
+ "isOptional" : false
+ },
+ {
+ "name" : "record",
+ "type" : "Roo.data.Record|false",
+ "desc" : "The data record returned from the underlying store (or false on nothing selected)",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
{
"name" : "resize",
"type" : "function",
}
]
},
- {
- "name" : "autoSize",
- "type" : "function",
- "desc" : "",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.form.TriggerField",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
{
"name" : "capture",
"type" : "function",
"returns" : []
},
{
- "name" : "clearValue",
- "type" : "function",
- "desc" : "Clears any text/value currently set in the field",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
- {
- "name" : "collapse",
+ "name" : "createToolbar",
"type" : "function",
- "desc" : "Hides the dropdown list if it is currently expanded. Fires the 'collapse' event on completion.",
- "sig" : "()\n{\n\n}",
+ "desc" : "Protected method that will not generally be called directly. It\nis called when the editor creates its toolbar. Override this method if you need to\nadd custom toolbar buttons.",
+ "sig" : "(editor)",
"static" : false,
"memberOf" : "",
"isStatic" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
+ "params" : [
+ {
+ "name" : "editor",
+ "type" : "HtmlEditor",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
"returns" : []
},
{
}
]
},
- {
- "name" : "doQuery",
- "type" : "function",
- "desc" : "Execute a query to filter the dropdown list. Fires the beforequery event prior to performing the\nquery allowing the query action to be canceled if needed.",
- "sig" : "(query, forceAll)",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "query",
- "type" : "String",
- "desc" : "The SQL query to execute",
- "isOptional" : false
- },
- {
- "name" : "forceAll",
- "type" : "Boolean",
- "desc" : "True to force the query to execute even if there are currently fewer characters\nin the field than the minimum specified by the minChars config option. It also clears any filter previously\nsaved in the current store (defaults to false)",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
{
"name" : "enable",
"type" : "function",
}
]
},
- {
- "name" : "expand",
- "type" : "function",
- "desc" : "Expands the dropdown list if it is currently hidden. Fires the 'expand' event on completion.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
{
"name" : "fireEvent",
"type" : "function",
],
"returns" : []
},
+ {
+ "name" : "getConfirmed",
+ "type" : "function",
+ "desc" : "",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Boolean",
+ "desc" : "this.isConfirmed"
+ }
+ ]
+ },
{
"name" : "getEl",
"type" : "function",
}
]
},
+ {
+ "name" : "getHeight",
+ "type" : "function",
+ "desc" : "",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Number",
+ "desc" : "this.height"
+ }
+ ]
+ },
{
"name" : "getId",
"type" : "function",
}
]
},
+ {
+ "name" : "getImageDataURI",
+ "type" : "function",
+ "desc" : "when user is clicked confirm then show this image.....",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "String",
+ "desc" : "Image Data URI"
+ }
+ ]
+ },
{
"name" : "getName",
"type" : "function",
{
"name" : "getValue",
"type" : "function",
- "desc" : "Returns the currently selected field value or empty string if no value is set.",
+ "desc" : "Returns the normalized data value (undefined or emptyText will be returned as ''). To return the raw value see {@link #getRawValue}.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.form.Field",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Mixed",
+ "desc" : "value The field value"
+ }
+ ]
+ },
+ {
+ "name" : "getWidth",
+ "type" : "function",
+ "desc" : "",
"sig" : "()\n{\n\n}",
"static" : false,
"memberOf" : "",
"returns" : [
{
"name" : "",
- "type" : "String",
- "desc" : "value The selected value"
+ "type" : "Number",
+ "desc" : "this.width"
}
]
},
"params" : [],
"returns" : []
},
- {
- "name" : "isExpanded",
- "type" : "function",
- "desc" : "Returns true if the dropdown list is expanded, else false.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
{
"name" : "isValid",
"type" : "function",
],
"returns" : []
},
- {
- "name" : "onTriggerClick",
- "type" : "function",
- "desc" : "The function that should handle the trigger's click event. This method does nothing by default until overridden\nby an implementing function.",
- "sig" : "(e)",
- "static" : false,
- "memberOf" : "Roo.form.TriggerField",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "e",
- "type" : "EventObject",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
{
"name" : "purgeListeners",
"type" : "function",
{
"name" : "reset",
"type" : "function",
- "desc" : "Resets the current field value to the originally-loaded value and clears any validation messages.",
+ "desc" : "Resets the current field value to the originally loaded value and clears any validation messages",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.form.TextField",
+ "memberOf" : "Roo.form.Field",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"params" : [],
"returns" : []
},
- {
- "name" : "select",
- "type" : "function",
- "desc" : "Select an item in the dropdown list by its numeric index in the list. This function does NOT cause the select event to fire.\nThe store must be loaded and the list expanded for this function to work, otherwise use setValue.",
- "sig" : "(index, scrollIntoView)",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "index",
- "type" : "Number",
- "desc" : "The zero-based index of the list item to select",
- "isOptional" : false
- },
- {
- "name" : "scrollIntoView",
- "type" : "Boolean",
- "desc" : "False to prevent the dropdown list from autoscrolling to display the\nselected item if it is not currently in view (defaults to true)",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "selectByValue",
- "type" : "function",
- "desc" : "Select an item in the dropdown list by its data value. This function does NOT cause the select event to fire.\nThe store must be loaded and the list expanded for this function to work, otherwise use setValue.",
- "sig" : "(value, scrollIntoView)",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "value",
- "type" : "String",
- "desc" : "The data value of the item to select",
- "isOptional" : false
- },
- {
- "name" : "scrollIntoView",
- "type" : "Boolean",
- "desc" : "False to prevent the dropdown list from autoscrolling to display the\nselected item if it is not currently in view (defaults to true)",
- "isOptional" : false
- }
- ],
- "returns" : [
- {
- "name" : "",
- "type" : "Boolean",
- "desc" : "True if the value matched an item in the list, else false"
- }
- ]
- },
- {
- "name" : "selectText",
- "type" : "function",
- "desc" : "Selects text in this field",
- "sig" : "(start, end)",
- "static" : false,
- "memberOf" : "Roo.form.TextField",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "start",
- "type" : "Number",
- "desc" : "(optional) The index where the selection should start (defaults to 0)",
- "isOptional" : false
- },
- {
- "name" : "end",
- "type" : "Number",
- "desc" : "(optional) The index where the selection should end (defaults to the text length)",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
{
"name" : "setDisabled",
"type" : "function",
],
"returns" : []
},
- {
- "name" : "setEditable",
- "type" : "function",
- "desc" : "Allow or prevent the user from directly editing the field text. If false is passed,\nthe user will only be able to select from the items defined in the dropdown list. This method\nis the runtime equivalent of setting the 'editable' config option at config time.",
- "sig" : "(value)",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "value",
- "type" : "Boolean",
- "desc" : "True to allow the user to directly edit the field text",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "setFromData",
- "type" : "function",
- "desc" : "Sets the value of the field based on a object which is related to the record format for the store.",
- "sig" : "(value)",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "value",
- "type" : "Object",
- "desc" : "the value to set as. or false on reset?",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
{
"name" : "setPagePosition",
"type" : "function",
{
"name" : "setValue",
"type" : "function",
- "desc" : "Sets the specified value into the field. If the value finds a match, the corresponding record text\nwill be displayed in the field. If the value does not match the data value of an existing item,\nand the valueNotFoundText config option is defined, it will be displayed as the default field text.\nOtherwise the field will be blank (although the value will still be set).",
+ "desc" : "Sets a data value into the field and validates it. To set the value directly without validation see {@link #setRawValue}.",
"sig" : "(value)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.form.Field",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"params" : [
{
"name" : "value",
- "type" : "String",
- "desc" : "The value to match",
+ "type" : "Mixed",
+ "desc" : "The value to set",
"isOptional" : false
}
],
}
]
},
- {
- "name" : "setWidth",
- "type" : "function",
- "desc" : "",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
{
"name" : "show",
"type" : "function",
"desc" : "True if the value is valid, else false"
}
]
- },
- {
- "name" : "validateValue",
- "type" : "function",
- "desc" : "Validates a value according to the field's validation rules and marks the field as invalid\nif the validation fails",
- "sig" : "(value)",
- "static" : false,
- "memberOf" : "Roo.form.TextField",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "value",
- "type" : "Mixed",
- "desc" : "The value to validate",
- "isOptional" : false
- }
- ],
- "returns" : [
- {
- "name" : "",
- "type" : "Boolean",
- "desc" : "True if the value is valid, else false"
- }
- ]
}
],
"isAbstract" : false,
"isBuilderTop" : false,
- "childClasses" : { },
+ "implementations" : [],
"tree_children" : [],
"tree_parent" : []
},
- "Roo.form.Signature" : {
+ "Roo.form.TextArea" : {
"props" : [
{
"name" : "actionMode",
"type" : "String",
"desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el' for forms you probably want to set this to fieldEl",
- "memberOf" : "Roo.Component"
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "allowBlank",
"type" : "Boolean",
- "desc" : "False to validate that the value length > 0 (defaults to false)",
- "memberOf" : ""
+ "desc" : "False to validate that the value length > 0 (defaults to true)",
+ "memberOf" : "Roo.form.TextField",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "allowDomMove",
"type" : "Boolean",
"desc" : "Whether the component can move the Dom node when rendering (defaults to true).",
- "memberOf" : "Roo.Component"
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "allowLeadingSpace",
+ "type" : "Boolean",
+ "desc" : "True to prevent the stripping of leading white space",
+ "memberOf" : "Roo.form.TextField",
+ "isOptional" : false,
+ "optvals" : []
},
{
"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"
+ "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" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "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",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "cls",
"type" : "String",
"desc" : "A CSS class to apply to the field's underlying element.",
- "memberOf" : "Roo.form.Field"
+ "memberOf" : "Roo.form.Field",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "disableClass",
"type" : "String",
"desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").",
- "memberOf" : "Roo.Component"
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "disableKeyFilter",
+ "type" : "Boolean",
+ "desc" : "True to disable input keystroke filtering (defaults to false)",
+ "memberOf" : "Roo.form.TextField",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "disabled",
"type" : "Boolean",
"desc" : "True to disable the field (defaults to false).",
- "memberOf" : "Roo.form.Field"
+ "memberOf" : "Roo.form.Field",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "emptyText",
+ "type" : "String",
+ "desc" : "The default text to display in an empty field - placeholder... (defaults to null).",
+ "memberOf" : "Roo.form.TextField",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "fieldClass",
"type" : "String",
"desc" : "The default CSS class for the field (defaults to \"x-form-field\")",
- "memberOf" : "Roo.form.Field"
+ "memberOf" : "Roo.form.Field",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "fieldLabel",
"type" : "String",
"desc" : "Label to use when rendering a form.",
- "memberOf" : "Roo.form.Field"
+ "memberOf" : "Roo.form.Field",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "focusClass",
"type" : "String",
"desc" : "The CSS class to use when the field receives focus (defaults to \"x-form-focus\")",
- "memberOf" : "Roo.form.Field"
+ "memberOf" : "Roo.form.Field",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "grow",
+ "type" : "Boolean",
+ "desc" : "True if this field should automatically grow and shrink to its content",
+ "memberOf" : "Roo.form.TextField",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "growMax",
+ "type" : "Number",
+ "desc" : "The maximum height to allow when grow = true (defaults to 1000)",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "growMin",
+ "type" : "Number",
+ "desc" : "The minimum height to allow when grow = true (defaults to 60)",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "height",
"type" : "Number",
- "desc" : "The signature panel height (defaults to 100)",
- "memberOf" : ""
+ "desc" : "height (optional) size of component",
+ "memberOf" : "Roo.BoxComponent",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "hideMode",
"type" : "String",
- "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".",
- "memberOf" : "Roo.Component"
+ "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display",
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : [
+ "display",
+ "visibility"
+ ]
},
{
"name" : "inputType",
"type" : "String",
"desc" : "The type attribute for input fields -- e.g. radio, text, password (defaults to \"text\").",
- "memberOf" : "Roo.form.Field"
+ "memberOf" : "Roo.form.Field",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "invalidClass",
"type" : "String",
"desc" : "The CSS class to use when marking a field invalid (defaults to \"x-form-invalid\")",
- "memberOf" : "Roo.form.Field"
+ "memberOf" : "Roo.form.Field",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "invalidText",
"type" : "String",
"desc" : "The error text to use when marking a field invalid and no message is provided (defaults to \"The value in this field is invalid\")",
- "memberOf" : "Roo.form.Field"
- },
- {
- "name" : "labels",
- "type" : "Object",
- "desc" : "Label to use when rendering a form.\ndefaults to \nlabels : { \n clear : \"Clear\",\n confirm : \"Confirm\"\n }",
- "memberOf" : ""
+ "memberOf" : "Roo.form.Field",
+ "isOptional" : false,
+ "optvals" : []
},
{
"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"
+ "memberOf" : "Roo.util.Observable",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "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",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "maxLength",
+ "type" : "Number",
+ "desc" : "Maximum input field length allowed (defaults to Number.MAX_VALUE)",
+ "memberOf" : "Roo.form.TextField",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "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",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "minLength",
+ "type" : "Number",
+ "desc" : "Minimum input field length required (defaults to 0)",
+ "memberOf" : "Roo.form.TextField",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "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",
+ "isOptional" : false,
+ "optvals" : []
},
{
"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"
+ "memberOf" : "Roo.form.Field",
+ "isOptional" : false,
+ "optvals" : []
},
{
"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"
+ "memberOf" : "Roo.form.Field",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "name",
"type" : "String",
"desc" : "The field's HTML name attribute.",
- "memberOf" : "Roo.form.Field"
+ "memberOf" : "Roo.form.Field",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "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" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "qtip",
"type" : "String",
"desc" : "Mouse over tip",
- "memberOf" : "Roo.form.Field"
+ "memberOf" : "Roo.form.Field",
+ "isOptional" : false,
+ "optvals" : []
},
{
"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"
+ "memberOf" : "Roo.form.Field",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "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",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "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",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "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",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "style",
+ "type" : "String",
+ "desc" : "css styles to add to component\neg. text-align:right;",
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"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"
+ "memberOf" : "Roo.form.Field",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "validateOnBlur",
"type" : "Boolean",
"desc" : "Whether the field should validate when it loses focus (defaults to true).",
- "memberOf" : "Roo.form.Field"
+ "memberOf" : "Roo.form.Field",
+ "isOptional" : false,
+ "optvals" : []
},
{
"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"
+ "memberOf" : "Roo.form.Field",
+ "isOptional" : false,
+ "optvals" : []
},
{
"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"
+ "memberOf" : "Roo.form.Field",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "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",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "value",
"type" : "Mixed",
"desc" : "A value to initialize this field with.",
- "memberOf" : "Roo.form.Field"
+ "memberOf" : "Roo.form.Field",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "vtype",
+ "type" : "String",
+ "desc" : "A validation type name as defined in {@link Roo.form.VTypes} (defaults to null)",
+ "memberOf" : "Roo.form.TextField",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "width",
"type" : "Number",
- "desc" : "The signature panel width (defaults to 300)",
- "memberOf" : ""
+ "desc" : "width (optional) size of component",
+ "memberOf" : "Roo.BoxComponent",
+ "isOptional" : false,
+ "optvals" : []
}
],
"events" : [
+ {
+ "name" : "autosize",
+ "type" : "function",
+ "desc" : "Fires when the autosize function is triggered. The field may or may not have actually changed size\naccording to the default logic, but this event provides a hook for the developer to apply additional\nlogic at runtime to resize the field if needed.",
+ "sig" : "function (_self, width)\n{\n\n}",
+ "memberOf" : "Roo.form.TextField",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.form.Field",
+ "desc" : "This text field",
+ "isOptional" : false
+ },
+ {
+ "name" : "width",
+ "type" : "Number",
+ "desc" : "The new field width",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
{
"name" : "beforedestroy",
"type" : "function",
],
"returns" : []
},
- {
- "name" : "confirm",
- "type" : "function",
- "desc" : "Fires when the 'confirm' icon is pressed (add a listener to enable add button)",
- "sig" : "function (combo)\n{\n\n}",
- "memberOf" : "",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "combo",
- "type" : "Roo.form.Signature",
- "desc" : "This combo box",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
{
"name" : "destroy",
"type" : "function",
],
"returns" : []
},
- {
- "name" : "reset",
- "type" : "function",
- "desc" : "Fires when the 'edit' icon is pressed (add a listener to enable add button)",
- "sig" : "function (combo, record)\n{\n\n}",
- "memberOf" : "",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "combo",
- "type" : "Roo.form.ComboBox",
- "desc" : "This combo box",
- "isOptional" : false
- },
- {
- "name" : "record",
- "type" : "Roo.data.Record|false",
- "desc" : "The data record returned from the underlying store (or false on nothing selected)",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
{
"name" : "resize",
"type" : "function",
}
]
},
+ {
+ "name" : "autoSize",
+ "type" : "function",
+ "desc" : "Automatically grows the field to accomodate the height of the text up to the maximum field height allowed.\nThis only takes effect if grow = true, and fires the autosize event if the height changes.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
{
"name" : "capture",
"type" : "function",
"params" : [],
"returns" : []
},
- {
- "name" : "createToolbar",
- "type" : "function",
- "desc" : "Protected method that will not generally be called directly. It\nis called when the editor creates its toolbar. Override this method if you need to\nadd custom toolbar buttons.",
- "sig" : "(editor)",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "editor",
- "type" : "HtmlEditor",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
{
"name" : "destroy",
"type" : "function",
],
"returns" : []
},
- {
- "name" : "getConfirmed",
- "type" : "function",
- "desc" : "",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : [
- {
- "name" : "",
- "type" : "Boolean",
- "desc" : "this.isConfirmed"
- }
- ]
- },
{
"name" : "getEl",
"type" : "function",
}
]
},
- {
- "name" : "getHeight",
- "type" : "function",
- "desc" : "",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : [
- {
- "name" : "",
- "type" : "Number",
- "desc" : "this.height"
- }
- ]
- },
{
"name" : "getId",
"type" : "function",
}
]
},
- {
- "name" : "getImageDataURI",
- "type" : "function",
- "desc" : "when user is clicked confirm then show this image.....",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : [
- {
- "name" : "",
- "type" : "String",
- "desc" : "Image Data URI"
- }
- ]
- },
{
"name" : "getName",
"type" : "function",
}
]
},
- {
- "name" : "getWidth",
- "type" : "function",
- "desc" : "",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : [
- {
- "name" : "",
- "type" : "Number",
- "desc" : "this.width"
- }
- ]
- },
{
"name" : "hasChanged",
"type" : "function",
{
"name" : "reset",
"type" : "function",
- "desc" : "Resets the current field value to the originally loaded value and clears any validation messages",
+ "desc" : "Resets the current field value to the originally-loaded value and clears any validation messages.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.form.Field",
+ "memberOf" : "Roo.form.TextField",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"params" : [],
"returns" : []
},
+ {
+ "name" : "selectText",
+ "type" : "function",
+ "desc" : "Selects text in this field",
+ "sig" : "(start, end)",
+ "static" : false,
+ "memberOf" : "Roo.form.TextField",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "start",
+ "type" : "Number",
+ "desc" : "(optional) The index where the selection should start (defaults to 0)",
+ "isOptional" : false
+ },
+ {
+ "name" : "end",
+ "type" : "Number",
+ "desc" : "(optional) The index where the selection should end (defaults to the text length)",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
{
"name" : "setDisabled",
"type" : "function",
"desc" : "True if the value is valid, else false"
}
]
+ },
+ {
+ "name" : "validateValue",
+ "type" : "function",
+ "desc" : "Validates a value according to the field's validation rules and marks the field as invalid\nif the validation fails",
+ "sig" : "(value)",
+ "static" : false,
+ "memberOf" : "Roo.form.TextField",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "value",
+ "type" : "Mixed",
+ "desc" : "The value to validate",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Boolean",
+ "desc" : "True if the value is valid, else false"
+ }
+ ]
}
],
"isAbstract" : false,
"isBuilderTop" : false,
- "childClasses" : { },
+ "implementations" : [
+ "Roo.form.FCKeditor"
+ ],
"tree_children" : [],
"tree_parent" : []
},
- "Roo.form.TextArea" : {
+ "Roo.form.TextField" : {
"props" : [
{
"name" : "actionMode",
"type" : "String",
"desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el' for forms you probably want to set this to fieldEl",
- "memberOf" : "Roo.Component"
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "allowBlank",
"type" : "Boolean",
"desc" : "False to validate that the value length > 0 (defaults to true)",
- "memberOf" : "Roo.form.TextField"
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "allowDomMove",
"type" : "Boolean",
"desc" : "Whether the component can move the Dom node when rendering (defaults to true).",
- "memberOf" : "Roo.Component"
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "allowLeadingSpace",
"type" : "Boolean",
"desc" : "True to prevent the stripping of leading white space",
- "memberOf" : "Roo.form.TextField"
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"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" : ""
+ "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",
+ "isOptional" : false,
+ "optvals" : []
},
{
"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"
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "cls",
"type" : "String",
"desc" : "A CSS class to apply to the field's underlying element.",
- "memberOf" : "Roo.form.Field"
+ "memberOf" : "Roo.form.Field",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "disableClass",
"type" : "String",
"desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").",
- "memberOf" : "Roo.Component"
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "disableKeyFilter",
"type" : "Boolean",
"desc" : "True to disable input keystroke filtering (defaults to false)",
- "memberOf" : "Roo.form.TextField"
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "disabled",
"type" : "Boolean",
"desc" : "True to disable the field (defaults to false).",
- "memberOf" : "Roo.form.Field"
+ "memberOf" : "Roo.form.Field",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "emptyText",
"type" : "String",
"desc" : "The default text to display in an empty field - placeholder... (defaults to null).",
- "memberOf" : "Roo.form.TextField"
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "fieldClass",
"type" : "String",
"desc" : "The default CSS class for the field (defaults to \"x-form-field\")",
- "memberOf" : "Roo.form.Field"
+ "memberOf" : "Roo.form.Field",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "fieldLabel",
"type" : "String",
"desc" : "Label to use when rendering a form.",
- "memberOf" : "Roo.form.Field"
+ "memberOf" : "Roo.form.Field",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "focusClass",
"type" : "String",
"desc" : "The CSS class to use when the field receives focus (defaults to \"x-form-focus\")",
- "memberOf" : "Roo.form.Field"
+ "memberOf" : "Roo.form.Field",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "grow",
"type" : "Boolean",
"desc" : "True if this field should automatically grow and shrink to its content",
- "memberOf" : "Roo.form.TextField"
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "growMax",
"type" : "Number",
- "desc" : "The maximum height to allow when grow = true (defaults to 1000)",
- "memberOf" : ""
+ "desc" : "The maximum width to allow when grow = true (defaults to 800)",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "growMin",
"type" : "Number",
- "desc" : "The minimum height to allow when grow = true (defaults to 60)",
- "memberOf" : ""
+ "desc" : "The minimum width to allow when grow = true (defaults to 30)",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "height",
"type" : "Number",
"desc" : "height (optional) size of component",
- "memberOf" : "Roo.BoxComponent"
+ "memberOf" : "Roo.BoxComponent",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "hideMode",
"type" : "String",
- "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".",
- "memberOf" : "Roo.Component"
+ "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display",
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : [
+ "display",
+ "visibility"
+ ]
},
{
"name" : "inputType",
"type" : "String",
"desc" : "The type attribute for input fields -- e.g. radio, text, password (defaults to \"text\").",
- "memberOf" : "Roo.form.Field"
+ "memberOf" : "Roo.form.Field",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "invalidClass",
"type" : "String",
"desc" : "The CSS class to use when marking a field invalid (defaults to \"x-form-invalid\")",
- "memberOf" : "Roo.form.Field"
+ "memberOf" : "Roo.form.Field",
+ "isOptional" : false,
+ "optvals" : []
},
{
"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"
+ "memberOf" : "Roo.form.Field",
+ "isOptional" : false,
+ "optvals" : []
},
{
"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"
+ "memberOf" : "Roo.util.Observable",
+ "isOptional" : false,
+ "optvals" : []
},
{
"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"
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "maxLength",
"type" : "Number",
"desc" : "Maximum input field length allowed (defaults to Number.MAX_VALUE)",
- "memberOf" : "Roo.form.TextField"
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"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"
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "minLength",
"type" : "Number",
"desc" : "Minimum input field length required (defaults to 0)",
- "memberOf" : "Roo.form.TextField"
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"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"
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"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"
+ "memberOf" : "Roo.form.Field",
+ "isOptional" : false,
+ "optvals" : []
},
{
"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"
+ "memberOf" : "Roo.form.Field",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "name",
"type" : "String",
"desc" : "The field's HTML name attribute.",
- "memberOf" : "Roo.form.Field"
- },
- {
- "name" : "preventScrollbars",
- "type" : "Boolean",
- "desc" : "True to prevent scrollbars from appearing regardless of how much text is\nin the field (equivalent to setting overflow: hidden, defaults to false)",
- "memberOf" : ""
+ "memberOf" : "Roo.form.Field",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "qtip",
"type" : "String",
"desc" : "Mouse over tip",
- "memberOf" : "Roo.form.Field"
+ "memberOf" : "Roo.form.Field",
+ "isOptional" : false,
+ "optvals" : []
},
{
"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"
+ "memberOf" : "Roo.form.Field",
+ "isOptional" : false,
+ "optvals" : []
},
{
"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"
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"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"
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"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"
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "style",
+ "type" : "String",
+ "desc" : "css styles to add to component\neg. text-align:right;",
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"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"
+ "memberOf" : "Roo.form.Field",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "validateOnBlur",
"type" : "Boolean",
"desc" : "Whether the field should validate when it loses focus (defaults to true).",
- "memberOf" : "Roo.form.Field"
+ "memberOf" : "Roo.form.Field",
+ "isOptional" : false,
+ "optvals" : []
},
{
"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"
+ "memberOf" : "Roo.form.Field",
+ "isOptional" : false,
+ "optvals" : []
},
{
"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"
+ "memberOf" : "Roo.form.Field",
+ "isOptional" : false,
+ "optvals" : []
},
{
"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"
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "value",
"type" : "Mixed",
"desc" : "A value to initialize this field with.",
- "memberOf" : "Roo.form.Field"
+ "memberOf" : "Roo.form.Field",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "vtype",
"type" : "String",
"desc" : "A validation type name as defined in {@link Roo.form.VTypes} (defaults to null)",
- "memberOf" : "Roo.form.TextField"
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "width",
"type" : "Number",
"desc" : "width (optional) size of component",
- "memberOf" : "Roo.BoxComponent"
+ "memberOf" : "Roo.BoxComponent",
+ "isOptional" : false,
+ "optvals" : []
}
],
"events" : [
"type" : "function",
"desc" : "Fires when the autosize function is triggered. The field may or may not have actually changed size\naccording to the default logic, but this event provides a hook for the developer to apply additional\nlogic at runtime to resize the field if needed.",
"sig" : "function (_self, width)\n{\n\n}",
- "memberOf" : "Roo.form.TextField",
+ "memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
{
"name" : "autoSize",
"type" : "function",
- "desc" : "Automatically grows the field to accomodate the height of the text up to the maximum field height allowed.\nThis only takes effect if grow = true, and fires the autosize event if the height changes.",
+ "desc" : "Automatically grows the field to accomodate the width of the text up to the maximum field width allowed.\nThis only takes effect if grow = true, and fires the autosize event.",
"sig" : "()\n{\n\n}",
"static" : false,
"memberOf" : "",
"desc" : "Resets the current field value to the originally-loaded value and clears any validation messages.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.form.TextField",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"desc" : "Selects text in this field",
"sig" : "(start, end)",
"static" : false,
- "memberOf" : "Roo.form.TextField",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"desc" : "Validates a value according to the field's validation rules and marks the field as invalid\nif the validation fails",
"sig" : "(value)",
"static" : false,
- "memberOf" : "Roo.form.TextField",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
]
}
],
- "isAbstract" : false,
- "isBuilderTop" : false,
- "childClasses" : {
- "Roo.form.TextArea" : [
- "Roo.form.FCKeditor"
- ]
- },
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "implementations" : [
+ "Roo.form.ComboBox",
+ "Roo.form.ComboBoxArray",
+ "Roo.form.ComboCheck",
+ "Roo.form.ComboNested",
+ "Roo.form.DateField",
+ "Roo.form.FCKeditor",
+ "Roo.form.Hidden",
+ "Roo.form.MonthField",
+ "Roo.form.NumberField",
+ "Roo.form.Select",
+ "Roo.form.TextArea",
+ "Roo.form.TriggerField"
+ ],
"tree_children" : [],
"tree_parent" : []
},
- "Roo.form.TextField" : {
+ "Roo.form.TextItem" : {
"props" : [
{
"name" : "actionMode",
"type" : "String",
"desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el' for forms you probably want to set this to fieldEl",
- "memberOf" : "Roo.Component"
- },
- {
- "name" : "allowBlank",
- "type" : "Boolean",
- "desc" : "False to validate that the value length > 0 (defaults to true)",
- "memberOf" : ""
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "allowDomMove",
"type" : "Boolean",
"desc" : "Whether the component can move the Dom node when rendering (defaults to true).",
- "memberOf" : "Roo.Component"
- },
- {
- "name" : "allowLeadingSpace",
- "type" : "Boolean",
- "desc" : "True to prevent the stripping of leading white space",
- "memberOf" : ""
- },
- {
- "name" : "autoCreate",
- "type" : "String/Object",
- "desc" : "A DomHelper element spec, or true for a default element spec (defaults to\n{tag: \"input\", type: \"text\", size: \"20\", autocomplete: \"off\"})",
- "memberOf" : "Roo.form.Field"
- },
- {
- "name" : "blankText",
- "type" : "String",
- "desc" : "Error text to display if the allow blank validation fails (defaults to \"This field is required\")",
- "memberOf" : ""
- },
- {
- "name" : "cls",
- "type" : "String",
- "desc" : "A CSS class to apply to the field's underlying element.",
- "memberOf" : "Roo.form.Field"
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "disableClass",
"type" : "String",
"desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").",
- "memberOf" : "Roo.Component"
- },
- {
- "name" : "disableKeyFilter",
- "type" : "Boolean",
- "desc" : "True to disable input keystroke filtering (defaults to false)",
- "memberOf" : ""
- },
- {
- "name" : "disabled",
- "type" : "Boolean",
- "desc" : "True to disable the field (defaults to false).",
- "memberOf" : "Roo.form.Field"
- },
- {
- "name" : "emptyText",
- "type" : "String",
- "desc" : "The default text to display in an empty field - placeholder... (defaults to null).",
- "memberOf" : ""
- },
- {
- "name" : "fieldClass",
- "type" : "String",
- "desc" : "The default CSS class for the field (defaults to \"x-form-field\")",
- "memberOf" : "Roo.form.Field"
- },
- {
- "name" : "fieldLabel",
- "type" : "String",
- "desc" : "Label to use when rendering a form.",
- "memberOf" : "Roo.form.Field"
- },
- {
- "name" : "focusClass",
- "type" : "String",
- "desc" : "The CSS class to use when the field receives focus (defaults to \"x-form-focus\")",
- "memberOf" : "Roo.form.Field"
- },
- {
- "name" : "grow",
- "type" : "Boolean",
- "desc" : "True if this field should automatically grow and shrink to its content",
- "memberOf" : ""
- },
- {
- "name" : "growMax",
- "type" : "Number",
- "desc" : "The maximum width to allow when grow = true (defaults to 800)",
- "memberOf" : ""
- },
- {
- "name" : "growMin",
- "type" : "Number",
- "desc" : "The minimum width to allow when grow = true (defaults to 30)",
- "memberOf" : ""
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "height",
"type" : "Number",
"desc" : "height (optional) size of component",
- "memberOf" : "Roo.BoxComponent"
+ "memberOf" : "Roo.BoxComponent",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "hideMode",
"type" : "String",
- "desc" : "y)\nHow this component 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" : "inputType",
- "type" : "String",
- "desc" : "The type attribute for input fields -- e.g. radio, text, password (defaults to \"text\").",
- "memberOf" : "Roo.form.Field"
- },
- {
- "name" : "invalidClass",
- "type" : "String",
- "desc" : "The CSS class to use when marking a field invalid (defaults to \"x-form-invalid\")",
- "memberOf" : "Roo.form.Field"
+ "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display",
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : [
+ "display",
+ "visibility"
+ ]
},
{
- "name" : "invalidText",
+ "name" : "html",
"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"
+ "desc" : "the content for this item",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"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"
- },
- {
- "name" : "maskRe",
- "type" : "String",
- "desc" : "An input mask regular expression that will be used to filter keystrokes that don't match (defaults to null)",
- "memberOf" : ""
- },
- {
- "name" : "maxLength",
- "type" : "Number",
- "desc" : "Maximum input field length allowed (defaults to Number.MAX_VALUE)",
- "memberOf" : ""
- },
- {
- "name" : "maxLengthText",
- "type" : "String",
- "desc" : "Error text to display if the maximum length validation fails (defaults to \"The maximum length for this field is {maxLength}\")",
- "memberOf" : ""
- },
- {
- "name" : "minLength",
- "type" : "Number",
- "desc" : "Minimum input field length required (defaults to 0)",
- "memberOf" : ""
- },
- {
- "name" : "minLengthText",
- "type" : "String",
- "desc" : "Error text to display if the minimum length validation fails (defaults to \"The minimum length for this field is {minLength}\")",
- "memberOf" : ""
- },
- {
- "name" : "msgFx",
- "type" : "String",
- "desc" : "<b>Experimental</b> The effect used when displaying a validation message under the field (defaults to 'normal').",
- "memberOf" : "Roo.form.Field"
- },
- {
- "name" : "msgTarget",
- "type" : "String",
- "desc" : "The location where error text should display. Should be one of the following values (defaults to 'qtip'):\n<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" : "name",
- "type" : "String",
- "desc" : "The field's HTML name attribute.",
- "memberOf" : "Roo.form.Field"
- },
- {
- "name" : "qtip",
- "type" : "String",
- "desc" : "Mouse over tip",
- "memberOf" : "Roo.form.Field"
- },
- {
- "name" : "readOnly",
- "type" : "Boolean",
- "desc" : "True to mark the field as readOnly in HTML (defaults to false) -- Note: this only sets the element's readOnly DOM attribute.",
- "memberOf" : "Roo.form.Field"
- },
- {
- "name" : "regex",
- "type" : "RegExp",
- "desc" : "A JavaScript RegExp object to be tested against the field value during validation (defaults to null).\nIf available, this regex will be evaluated only after the basic validators all return true, and will be passed the\ncurrent field value. If the test fails, the field will be marked invalid using {@link #regexText}.",
- "memberOf" : ""
+ "memberOf" : "Roo.util.Observable",
+ "isOptional" : false,
+ "optvals" : []
},
{
- "name" : "regexText",
+ "name" : "style",
"type" : "String",
- "desc" : "The error text to display if {@link #regex} is used and the test fails during validation (defaults to \"\")",
- "memberOf" : ""
- },
- {
- "name" : "selectOnFocus",
- "type" : "Boolean",
- "desc" : "True to automatically select any existing field text when the field receives input focus (defaults to false)",
- "memberOf" : ""
- },
- {
- "name" : "tabIndex",
- "type" : "Number",
- "desc" : "The tabIndex for this field. Note this only applies to fields that are rendered, not those which are built via applyTo (defaults to undefined).",
- "memberOf" : "Roo.form.Field"
- },
- {
- "name" : "validateOnBlur",
- "type" : "Boolean",
- "desc" : "Whether the field should validate when it loses focus (defaults to true).",
- "memberOf" : "Roo.form.Field"
- },
- {
- "name" : "validationDelay",
- "type" : "Number",
- "desc" : "The length of time in milliseconds after user input begins until validation is initiated (defaults to 250)",
- "memberOf" : "Roo.form.Field"
- },
- {
- "name" : "validationEvent",
- "type" : "String/Boolean",
- "desc" : "The event that should initiate field validation. Set to false to disable\n automatic validation (defaults to \"keyup\").",
- "memberOf" : "Roo.form.Field"
- },
- {
- "name" : "validator",
- "type" : "Function",
- "desc" : "A custom validation function to be called during field validation (defaults to null).\nIf available, this function will be called only after the basic validators all return true, and will be passed the\ncurrent field value and expected to return boolean true if the value is valid or a string error message if invalid.",
- "memberOf" : ""
- },
- {
- "name" : "value",
- "type" : "Mixed",
- "desc" : "A value to initialize this field with.",
- "memberOf" : "Roo.form.Field"
+ "desc" : "css styles to add to component\neg. text-align:right;",
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
- "name" : "vtype",
+ "name" : "tag",
"type" : "String",
- "desc" : "A validation type name as defined in {@link Roo.form.VTypes} (defaults to null)",
- "memberOf" : ""
+ "desc" : "the tag for this item (default div)",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "width",
"type" : "Number",
"desc" : "width (optional) size of component",
- "memberOf" : "Roo.BoxComponent"
+ "memberOf" : "Roo.BoxComponent",
+ "isOptional" : false,
+ "optvals" : []
}
],
"events" : [
- {
- "name" : "autosize",
- "type" : "function",
- "desc" : "Fires when the autosize function is triggered. The field may or may not have actually changed size\naccording to the default logic, but this event provides a hook for the developer to apply additional\nlogic at runtime to resize the field if needed.",
- "sig" : "function (_self, width)\n{\n\n}",
- "memberOf" : "",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.form.Field",
- "desc" : "This text field",
- "isOptional" : false
- },
- {
- "name" : "width",
- "type" : "Number",
- "desc" : "The new field width",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
{
"name" : "beforedestroy",
"type" : "function",
],
"returns" : []
},
- {
- "name" : "blur",
- "type" : "function",
- "desc" : "Fires when this field loses input focus.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.form.Field",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.form.Field",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "change",
- "type" : "function",
- "desc" : "Fires just before the field blurs if the field value has changed.",
- "sig" : "function (_self, newValue, oldValue)\n{\n\n}",
- "memberOf" : "Roo.form.Field",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.form.Field",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "newValue",
- "type" : "Mixed",
- "desc" : "The new value",
- "isOptional" : false
- },
- {
- "name" : "oldValue",
- "type" : "Mixed",
- "desc" : "The original value",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
{
"name" : "destroy",
"type" : "function",
],
"returns" : []
},
- {
- "name" : "focus",
- "type" : "function",
- "desc" : "Fires when this field receives input focus.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.form.Field",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.form.Field",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
{
"name" : "hide",
"type" : "function",
],
"returns" : []
},
- {
- "name" : "invalid",
- "type" : "function",
- "desc" : "Fires after the field has been marked as invalid.",
- "sig" : "function (_self, msg)\n{\n\n}",
- "memberOf" : "Roo.form.Field",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.form.Field",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "msg",
- "type" : "String",
- "desc" : "The validation message",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "keyup",
- "type" : "function",
- "desc" : "Fires after the key up",
- "sig" : "function (_self, e)\n{\n\n}",
- "memberOf" : "Roo.form.Field",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.form.Field",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "e",
- "type" : "Roo.EventObject",
- "desc" : "The event Object",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
{
"name" : "move",
"type" : "function",
}
],
"returns" : []
- },
- {
- "name" : "specialkey",
- "type" : "function",
- "desc" : "Fires when any key related to navigation (arrows, tab, enter, esc, etc.) is pressed. You can check\n{@link Roo.EventObject#getKey} to determine which key was pressed.",
- "sig" : "function (_self, e)\n{\n\n}",
- "memberOf" : "Roo.form.Field",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.form.Field",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "e",
- "type" : "Roo.EventObject",
- "desc" : "The event object",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "valid",
- "type" : "function",
- "desc" : "Fires after the field has been validated with no errors.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.form.Field",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.form.Field",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
}
],
"methods" : [
],
"returns" : []
},
- {
- "name" : "applyTo",
- "type" : "function",
- "desc" : "Apply the behaviors of this component to an existing element. <b>This is used instead of render().</b>",
- "sig" : "(el)",
- "static" : false,
- "memberOf" : "Roo.form.Field",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "el",
- "type" : "String/HTMLElement/Element",
- "desc" : "The id of the node, a DOM node or an existing Element",
- "isOptional" : false
- }
- ],
- "returns" : [
- {
- "name" : "",
- "type" : "Roo.form.Field",
- "desc" : "this"
- }
- ]
- },
- {
- "name" : "autoSize",
- "type" : "function",
- "desc" : "Automatically grows the field to accomodate the width of the text up to the maximum field width allowed.\nThis only takes effect if grow = true, and fires the autosize event.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
{
"name" : "capture",
"type" : "function",
],
"returns" : []
},
- {
- "name" : "clearInvalid",
- "type" : "function",
- "desc" : "Clear any invalid styles/messages for this field",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.form.Field",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
{
"name" : "destroy",
"type" : "function",
}
]
},
- {
- "name" : "getName",
- "type" : "function",
- "desc" : "Returns the name attribute of the field if available",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.form.Field",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : [
- {
- "name" : "",
- "type" : "String",
- "desc" : "name The field name"
- }
- ]
- },
{
"name" : "getPosition",
"type" : "function",
}
]
},
- {
- "name" : "getRawValue",
- "type" : "function",
- "desc" : "Returns the raw data value which may or may not be a valid, defined value. To return a normalized value see {@link #getValue}.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.form.Field",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : [
- {
- "name" : "",
- "type" : "Mixed",
- "desc" : "value The field value"
- }
- ]
- },
{
"name" : "getSize",
"type" : "function",
}
]
},
- {
- "name" : "getValue",
- "type" : "function",
- "desc" : "Returns the normalized data value (undefined or emptyText will be returned as ''). To return the raw value see {@link #getRawValue}.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.form.Field",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : [
- {
- "name" : "",
- "type" : "Mixed",
- "desc" : "value The field value"
- }
- ]
- },
- {
- "name" : "hasChanged",
- "type" : "function",
- "desc" : "checks the current value against the 'loaded' value.\nNote - will return false if 'resetHasChanged' has not been called first.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.form.Field",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
{
"name" : "hasListener",
"type" : "function",
}
]
},
- {
- "name" : "isDirty",
- "type" : "function",
- "desc" : "Returns true if this field has been changed since it was originally loaded and is not disabled.\nDEPRICATED - it never worked well - use hasChanged/resetHasChanged.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.form.Field",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
- {
- "name" : "isValid",
- "type" : "function",
- "desc" : "Returns whether or not the field value is currently valid",
- "sig" : "(preventMark)",
- "static" : false,
- "memberOf" : "Roo.form.Field",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "preventMark",
- "type" : "Boolean",
- "desc" : "True to disable marking the field invalid",
- "isOptional" : false
- }
- ],
- "returns" : [
- {
- "name" : "",
- "type" : "Boolean",
- "desc" : "True if the value is valid, else false"
- }
- ]
- },
{
"name" : "isVisible",
"type" : "function",
"params" : [],
"returns" : []
},
- {
- "name" : "markInvalid",
- "type" : "function",
- "desc" : "Mark this field as invalid",
- "sig" : "(msg)",
- "static" : false,
- "memberOf" : "Roo.form.Field",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "msg",
- "type" : "String",
- "desc" : "The validation message",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
{
"name" : "on",
"type" : "function",
],
"returns" : []
},
- {
- "name" : "reset",
- "type" : "function",
- "desc" : "Resets the current field value to the originally-loaded value and clears any validation messages.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
- {
- "name" : "resetHasChanged",
- "type" : "function",
- "desc" : "stores the current value in loadedValue",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.form.Field",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
- {
- "name" : "selectText",
- "type" : "function",
- "desc" : "Selects text in this field",
- "sig" : "(start, end)",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "start",
- "type" : "Number",
- "desc" : "(optional) The index where the selection should start (defaults to 0)",
- "isOptional" : false
- },
- {
- "name" : "end",
- "type" : "Number",
- "desc" : "(optional) The index where the selection should end (defaults to the text length)",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
{
"name" : "setDisabled",
"type" : "function",
],
"returns" : []
},
- {
- "name" : "setRawValue",
- "type" : "function",
- "desc" : "Sets the underlying DOM field's value directly, bypassing validation. To set the value with validation see {@link #setValue}.",
- "sig" : "(value)",
- "static" : false,
- "memberOf" : "Roo.form.Field",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "value",
- "type" : "Mixed",
- "desc" : "The value to set",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
{
"name" : "setSize",
"type" : "function",
}
]
},
- {
- "name" : "setValue",
- "type" : "function",
- "desc" : "Sets a data value into the field and validates it. To set the value directly without validation see {@link #setRawValue}.",
- "sig" : "(value)",
- "static" : false,
- "memberOf" : "Roo.form.Field",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "value",
- "type" : "Mixed",
- "desc" : "The value to set",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
{
"name" : "setVisible",
"type" : "function",
}
],
"returns" : []
- },
- {
- "name" : "validate",
- "type" : "function",
- "desc" : "Validates the field value",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.form.Field",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : [
- {
- "name" : "",
- "type" : "Boolean",
- "desc" : "True if the value is valid, else false"
- }
- ]
- },
- {
- "name" : "validateValue",
- "type" : "function",
- "desc" : "Validates a value according to the field's validation rules and marks the field as invalid\nif the validation fails",
- "sig" : "(value)",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "value",
- "type" : "Mixed",
- "desc" : "The value to validate",
- "isOptional" : false
- }
- ],
- "returns" : [
- {
- "name" : "",
- "type" : "Boolean",
- "desc" : "True if the value is valid, else false"
- }
- ]
}
],
"isAbstract" : false,
"isBuilderTop" : false,
- "childClasses" : {
- "Roo.form.TextArea" : [
- "Roo.form.FCKeditor"
- ],
- "Roo.form.TextField" : [
- "Roo.form.ComboBoxArray",
- "Roo.form.Hidden",
- "Roo.form.NumberField",
- "Roo.form.TextArea",
- "Roo.form.TriggerField"
- ],
- "Roo.form.ComboBox" : [
- "Roo.form.ComboCheck",
- "Roo.form.ComboNested"
- ],
- "Roo.form.TriggerField" : [
- "Roo.form.ComboBox",
- "Roo.form.DateField",
- "Roo.form.MonthField",
- "Roo.form.Select"
- ]
- },
+ "implementations" : [],
"tree_children" : [],
"tree_parent" : []
},
- "Roo.form.TextItem" : {
+ "Roo.form.TriggerField" : {
"props" : [
{
"name" : "actionMode",
"type" : "String",
- "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el' for forms you probably want to set this to fieldEl",
- "memberOf" : "Roo.Component"
+ "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el' for forms you probably want to set this to fieldEl",
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "allowBlank",
+ "type" : "Boolean",
+ "desc" : "False to validate that the value length > 0 (defaults to true)",
+ "memberOf" : "Roo.form.TextField",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "allowDomMove",
+ "type" : "Boolean",
+ "desc" : "Whether the component can move the Dom node when rendering (defaults to true).",
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "allowLeadingSpace",
+ "type" : "Boolean",
+ "desc" : "True to prevent the stripping of leading white space",
+ "memberOf" : "Roo.form.TextField",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "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" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "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",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "cls",
+ "type" : "String",
+ "desc" : "A CSS class to apply to the field's underlying element.",
+ "memberOf" : "Roo.form.Field",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "disableClass",
+ "type" : "String",
+ "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").",
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "disableKeyFilter",
+ "type" : "Boolean",
+ "desc" : "True to disable input keystroke filtering (defaults to false)",
+ "memberOf" : "Roo.form.TextField",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "disabled",
+ "type" : "Boolean",
+ "desc" : "True to disable the field (defaults to false).",
+ "memberOf" : "Roo.form.Field",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "emptyText",
+ "type" : "String",
+ "desc" : "The default text to display in an empty field - placeholder... (defaults to null).",
+ "memberOf" : "Roo.form.TextField",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "fieldClass",
+ "type" : "String",
+ "desc" : "The default CSS class for the field (defaults to \"x-form-field\")",
+ "memberOf" : "Roo.form.Field",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "fieldLabel",
+ "type" : "String",
+ "desc" : "Label to use when rendering a form.",
+ "memberOf" : "Roo.form.Field",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "focusClass",
+ "type" : "String",
+ "desc" : "The CSS class to use when the field receives focus (defaults to \"x-form-focus\")",
+ "memberOf" : "Roo.form.Field",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "height",
+ "type" : "Number",
+ "desc" : "height (optional) size of component",
+ "memberOf" : "Roo.BoxComponent",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "hideMode",
+ "type" : "String",
+ "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display",
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : [
+ "display",
+ "visibility"
+ ]
+ },
+ {
+ "name" : "hideTrigger",
+ "type" : "Boolean",
+ "desc" : "True to hide the trigger element and display only the base text field (defaults to false)",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "inputType",
+ "type" : "String",
+ "desc" : "The type attribute for input fields -- e.g. radio, text, password (defaults to \"text\").",
+ "memberOf" : "Roo.form.Field",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "invalidClass",
+ "type" : "String",
+ "desc" : "The CSS class to use when marking a field invalid (defaults to \"x-form-invalid\")",
+ "memberOf" : "Roo.form.Field",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "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",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "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",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "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",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "maxLength",
+ "type" : "Number",
+ "desc" : "Maximum input field length allowed (defaults to Number.MAX_VALUE)",
+ "memberOf" : "Roo.form.TextField",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "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",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "minLength",
+ "type" : "Number",
+ "desc" : "Minimum input field length required (defaults to 0)",
+ "memberOf" : "Roo.form.TextField",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "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",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "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",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "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",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "name",
+ "type" : "String",
+ "desc" : "The field's HTML name attribute.",
+ "memberOf" : "Roo.form.Field",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "qtip",
+ "type" : "String",
+ "desc" : "Mouse over tip",
+ "memberOf" : "Roo.form.Field",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "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",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "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",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "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",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "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",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "style",
+ "type" : "String",
+ "desc" : "css styles to add to component\neg. text-align:right;",
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
- "name" : "allowDomMove",
- "type" : "Boolean",
- "desc" : "Whether the component can move the Dom node when rendering (defaults to true).",
- "memberOf" : "Roo.Component"
+ "name" : "tabIndex",
+ "type" : "Number",
+ "desc" : "The tabIndex for this field. Note this only applies to fields that are rendered, not those which are built via applyTo (defaults to undefined).",
+ "memberOf" : "Roo.form.Field",
+ "isOptional" : false,
+ "optvals" : []
},
{
- "name" : "disableClass",
+ "name" : "triggerClass",
"type" : "String",
- "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").",
- "memberOf" : "Roo.Component"
+ "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" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
- "name" : "height",
+ "name" : "validateOnBlur",
+ "type" : "Boolean",
+ "desc" : "Whether the field should validate when it loses focus (defaults to true).",
+ "memberOf" : "Roo.form.Field",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "validationDelay",
"type" : "Number",
- "desc" : "height (optional) size of component",
- "memberOf" : "Roo.BoxComponent"
+ "desc" : "The length of time in milliseconds after user input begins until validation is initiated (defaults to 250)",
+ "memberOf" : "Roo.form.Field",
+ "isOptional" : false,
+ "optvals" : []
},
{
- "name" : "hideMode",
- "type" : "String",
- "desc" : "y)\nHow this component 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" : "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",
+ "isOptional" : false,
+ "optvals" : []
},
{
- "name" : "html",
- "type" : "String",
- "desc" : "the content for this item",
- "memberOf" : ""
+ "name" : "validator",
+ "type" : "Function",
+ "desc" : "A custom validation function to be called during field validation (defaults to null).\nIf available, this function will be called only after the basic validators all return true, and will be passed the\ncurrent field value and expected to return boolean true if the value is valid or a string error message if invalid.",
+ "memberOf" : "Roo.form.TextField",
+ "isOptional" : false,
+ "optvals" : []
},
{
- "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"
+ "name" : "value",
+ "type" : "Mixed",
+ "desc" : "A value to initialize this field with.",
+ "memberOf" : "Roo.form.Field",
+ "isOptional" : false,
+ "optvals" : []
},
{
- "name" : "tag",
+ "name" : "vtype",
"type" : "String",
- "desc" : "the tag for this item (default div)",
- "memberOf" : ""
+ "desc" : "A validation type name as defined in {@link Roo.form.VTypes} (defaults to null)",
+ "memberOf" : "Roo.form.TextField",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "width",
"type" : "Number",
"desc" : "width (optional) size of component",
- "memberOf" : "Roo.BoxComponent"
+ "memberOf" : "Roo.BoxComponent",
+ "isOptional" : false,
+ "optvals" : []
}
],
"events" : [
+ {
+ "name" : "autosize",
+ "type" : "function",
+ "desc" : "Fires when the autosize function is triggered. The field may or may not have actually changed size\naccording to the default logic, but this event provides a hook for the developer to apply additional\nlogic at runtime to resize the field if needed.",
+ "sig" : "function (_self, width)\n{\n\n}",
+ "memberOf" : "Roo.form.TextField",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.form.Field",
+ "desc" : "This text field",
+ "isOptional" : false
+ },
+ {
+ "name" : "width",
+ "type" : "Number",
+ "desc" : "The new field width",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
{
"name" : "beforedestroy",
"type" : "function",
],
"returns" : []
},
+ {
+ "name" : "blur",
+ "type" : "function",
+ "desc" : "Fires when this field loses input focus.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.form.Field",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.form.Field",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "change",
+ "type" : "function",
+ "desc" : "Fires just before the field blurs if the field value has changed.",
+ "sig" : "function (_self, newValue, oldValue)\n{\n\n}",
+ "memberOf" : "Roo.form.Field",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.form.Field",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "newValue",
+ "type" : "Mixed",
+ "desc" : "The new value",
+ "isOptional" : false
+ },
+ {
+ "name" : "oldValue",
+ "type" : "Mixed",
+ "desc" : "The original value",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
{
"name" : "destroy",
"type" : "function",
],
"returns" : []
},
+ {
+ "name" : "focus",
+ "type" : "function",
+ "desc" : "Fires when this field receives input focus.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.form.Field",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.form.Field",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
{
"name" : "hide",
"type" : "function",
],
"returns" : []
},
+ {
+ "name" : "invalid",
+ "type" : "function",
+ "desc" : "Fires after the field has been marked as invalid.",
+ "sig" : "function (_self, msg)\n{\n\n}",
+ "memberOf" : "Roo.form.Field",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.form.Field",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "msg",
+ "type" : "String",
+ "desc" : "The validation message",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "keyup",
+ "type" : "function",
+ "desc" : "Fires after the key up",
+ "sig" : "function (_self, e)\n{\n\n}",
+ "memberOf" : "Roo.form.Field",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.form.Field",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "e",
+ "type" : "Roo.EventObject",
+ "desc" : "The event Object",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
{
"name" : "move",
"type" : "function",
}
],
"returns" : []
+ },
+ {
+ "name" : "specialkey",
+ "type" : "function",
+ "desc" : "Fires when any key related to navigation (arrows, tab, enter, esc, etc.) is pressed. You can check\n{@link Roo.EventObject#getKey} to determine which key was pressed.",
+ "sig" : "function (_self, e)\n{\n\n}",
+ "memberOf" : "Roo.form.Field",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.form.Field",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "e",
+ "type" : "Roo.EventObject",
+ "desc" : "The event object",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "valid",
+ "type" : "function",
+ "desc" : "Fires after the field has been validated with no errors.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.form.Field",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.form.Field",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
}
],
"methods" : [
],
"returns" : []
},
+ {
+ "name" : "applyTo",
+ "type" : "function",
+ "desc" : "Apply the behaviors of this component to an existing element. <b>This is used instead of render().</b>",
+ "sig" : "(el)",
+ "static" : false,
+ "memberOf" : "Roo.form.Field",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "el",
+ "type" : "String/HTMLElement/Element",
+ "desc" : "The id of the node, a DOM node or an existing Element",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.form.Field",
+ "desc" : "this"
+ }
+ ]
+ },
+ {
+ "name" : "autoSize",
+ "type" : "function",
+ "desc" : "",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
{
"name" : "capture",
"type" : "function",
],
"returns" : []
},
+ {
+ "name" : "clearInvalid",
+ "type" : "function",
+ "desc" : "Clear any invalid styles/messages for this field",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.form.Field",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
{
"name" : "destroy",
"type" : "function",
}
]
},
+ {
+ "name" : "getName",
+ "type" : "function",
+ "desc" : "Returns the name attribute of the field if available",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.form.Field",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "String",
+ "desc" : "name The field name"
+ }
+ ]
+ },
{
"name" : "getPosition",
"type" : "function",
}
]
},
+ {
+ "name" : "getRawValue",
+ "type" : "function",
+ "desc" : "Returns the raw data value which may or may not be a valid, defined value. To return a normalized value see {@link #getValue}.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.form.Field",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Mixed",
+ "desc" : "value The field value"
+ }
+ ]
+ },
{
"name" : "getSize",
"type" : "function",
}
]
},
+ {
+ "name" : "getValue",
+ "type" : "function",
+ "desc" : "Returns the normalized data value (undefined or emptyText will be returned as ''). To return the raw value see {@link #getRawValue}.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.form.Field",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Mixed",
+ "desc" : "value The field value"
+ }
+ ]
+ },
+ {
+ "name" : "hasChanged",
+ "type" : "function",
+ "desc" : "checks the current value against the 'loaded' value.\nNote - will return false if 'resetHasChanged' has not been called first.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.form.Field",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
{
"name" : "hasListener",
"type" : "function",
}
]
},
+ {
+ "name" : "isDirty",
+ "type" : "function",
+ "desc" : "Returns true if this field has been changed since it was originally loaded and is not disabled.\nDEPRICATED - it never worked well - use hasChanged/resetHasChanged.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.form.Field",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
+ {
+ "name" : "isValid",
+ "type" : "function",
+ "desc" : "Returns whether or not the field value is currently valid",
+ "sig" : "(preventMark)",
+ "static" : false,
+ "memberOf" : "Roo.form.Field",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "preventMark",
+ "type" : "Boolean",
+ "desc" : "True to disable marking the field invalid",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Boolean",
+ "desc" : "True if the value is valid, else false"
+ }
+ ]
+ },
{
"name" : "isVisible",
"type" : "function",
"params" : [],
"returns" : []
},
+ {
+ "name" : "markInvalid",
+ "type" : "function",
+ "desc" : "Mark this field as invalid",
+ "sig" : "(msg)",
+ "static" : false,
+ "memberOf" : "Roo.form.Field",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "msg",
+ "type" : "String",
+ "desc" : "The validation message",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
{
"name" : "on",
"type" : "function",
],
"returns" : []
},
+ {
+ "name" : "onTriggerClick",
+ "type" : "function",
+ "desc" : "The function that should handle the trigger's click event. This method does nothing by default until overridden\nby an implementing function.",
+ "sig" : "(e)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "e",
+ "type" : "EventObject",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
{
"name" : "purgeListeners",
"type" : "function",
],
"returns" : []
},
+ {
+ "name" : "reset",
+ "type" : "function",
+ "desc" : "Resets the current field value to the originally-loaded value and clears any validation messages.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.form.TextField",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
+ {
+ "name" : "resetHasChanged",
+ "type" : "function",
+ "desc" : "stores the current value in loadedValue",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.form.Field",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
+ {
+ "name" : "selectText",
+ "type" : "function",
+ "desc" : "Selects text in this field",
+ "sig" : "(start, end)",
+ "static" : false,
+ "memberOf" : "Roo.form.TextField",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "start",
+ "type" : "Number",
+ "desc" : "(optional) The index where the selection should start (defaults to 0)",
+ "isOptional" : false
+ },
+ {
+ "name" : "end",
+ "type" : "Number",
+ "desc" : "(optional) The index where the selection should end (defaults to the text length)",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
{
"name" : "setDisabled",
"type" : "function",
],
"returns" : []
},
+ {
+ "name" : "setRawValue",
+ "type" : "function",
+ "desc" : "Sets the underlying DOM field's value directly, bypassing validation. To set the value with validation see {@link #setValue}.",
+ "sig" : "(value)",
+ "static" : false,
+ "memberOf" : "Roo.form.Field",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "value",
+ "type" : "Mixed",
+ "desc" : "The value to set",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
{
"name" : "setSize",
"type" : "function",
}
]
},
+ {
+ "name" : "setValue",
+ "type" : "function",
+ "desc" : "Sets a data value into the field and validates it. To set the value directly without validation see {@link #setRawValue}.",
+ "sig" : "(value)",
+ "static" : false,
+ "memberOf" : "Roo.form.Field",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "value",
+ "type" : "Mixed",
+ "desc" : "The value to set",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
{
"name" : "setVisible",
"type" : "function",
}
],
"returns" : []
+ },
+ {
+ "name" : "validate",
+ "type" : "function",
+ "desc" : "Validates the field value",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.form.Field",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Boolean",
+ "desc" : "True if the value is valid, else false"
+ }
+ ]
+ },
+ {
+ "name" : "validateValue",
+ "type" : "function",
+ "desc" : "Validates a value according to the field's validation rules and marks the field as invalid\nif the validation fails",
+ "sig" : "(value)",
+ "static" : false,
+ "memberOf" : "Roo.form.TextField",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "value",
+ "type" : "Mixed",
+ "desc" : "The value to validate",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Boolean",
+ "desc" : "True if the value is valid, else false"
+ }
+ ]
}
],
"isAbstract" : false,
"isBuilderTop" : false,
- "childClasses" : { },
+ "implementations" : [
+ "Roo.form.ComboBox",
+ "Roo.form.ComboCheck",
+ "Roo.form.ComboNested",
+ "Roo.form.DateField",
+ "Roo.form.MonthField",
+ "Roo.form.Select"
+ ],
"tree_children" : [],
"tree_parent" : []
},
- "Roo.form.TriggerField" : {
- "props" : [
- {
- "name" : "actionMode",
- "type" : "String",
- "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el' for forms you probably want to set this to fieldEl",
- "memberOf" : "Roo.Component"
- },
- {
- "name" : "allowBlank",
- "type" : "Boolean",
- "desc" : "False to validate that the value length > 0 (defaults to true)",
- "memberOf" : "Roo.form.TextField"
- },
- {
- "name" : "allowDomMove",
- "type" : "Boolean",
- "desc" : "Whether the component can move the Dom node when rendering (defaults to true).",
- "memberOf" : "Roo.Component"
- },
- {
- "name" : "allowLeadingSpace",
- "type" : "Boolean",
- "desc" : "True to prevent the stripping of leading white space",
- "memberOf" : "Roo.form.TextField"
- },
- {
- "name" : "autoCreate",
- "type" : "String/Object",
- "desc" : "A DomHelper element spec, or true for a default element spec (defaults to\n{tag: \"input\", type: \"text\", size: \"16\", autocomplete: \"off\"})",
- "memberOf" : ""
- },
- {
- "name" : "blankText",
- "type" : "String",
- "desc" : "Error text to display if the allow blank validation fails (defaults to \"This field is required\")",
- "memberOf" : "Roo.form.TextField"
- },
- {
- "name" : "cls",
- "type" : "String",
- "desc" : "A CSS class to apply to the field's underlying element.",
- "memberOf" : "Roo.form.Field"
- },
- {
- "name" : "disableClass",
- "type" : "String",
- "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").",
- "memberOf" : "Roo.Component"
- },
- {
- "name" : "disableKeyFilter",
- "type" : "Boolean",
- "desc" : "True to disable input keystroke filtering (defaults to false)",
- "memberOf" : "Roo.form.TextField"
- },
- {
- "name" : "disabled",
- "type" : "Boolean",
- "desc" : "True to disable the field (defaults to false).",
- "memberOf" : "Roo.form.Field"
- },
- {
- "name" : "emptyText",
- "type" : "String",
- "desc" : "The default text to display in an empty field - placeholder... (defaults to null).",
- "memberOf" : "Roo.form.TextField"
- },
- {
- "name" : "fieldClass",
- "type" : "String",
- "desc" : "The default CSS class for the field (defaults to \"x-form-field\")",
- "memberOf" : "Roo.form.Field"
- },
- {
- "name" : "fieldLabel",
- "type" : "String",
- "desc" : "Label to use when rendering a form.",
- "memberOf" : "Roo.form.Field"
- },
- {
- "name" : "focusClass",
- "type" : "String",
- "desc" : "The CSS class to use when the field receives focus (defaults to \"x-form-focus\")",
- "memberOf" : "Roo.form.Field"
- },
- {
- "name" : "height",
- "type" : "Number",
- "desc" : "height (optional) size of component",
- "memberOf" : "Roo.BoxComponent"
- },
- {
- "name" : "hideMode",
- "type" : "String",
- "desc" : "y)\nHow this component 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" : "hideTrigger",
- "type" : "Boolean",
- "desc" : "True to hide the trigger element and display only the base text field (defaults to false)",
- "memberOf" : ""
- },
- {
- "name" : "inputType",
- "type" : "String",
- "desc" : "The type attribute for input fields -- e.g. radio, text, password (defaults to \"text\").",
- "memberOf" : "Roo.form.Field"
- },
- {
- "name" : "invalidClass",
- "type" : "String",
- "desc" : "The CSS class to use when marking a field invalid (defaults to \"x-form-invalid\")",
- "memberOf" : "Roo.form.Field"
- },
- {
- "name" : "invalidText",
- "type" : "String",
- "desc" : "The error text to use when marking a field invalid and no message is provided (defaults to \"The value in this field is invalid\")",
- "memberOf" : "Roo.form.Field"
- },
- {
- "name" : "listeners",
- "type" : "Object",
- "desc" : "list of events and functions to call for this object, \nFor example :\n<pre><code>\n listeners : { \n 'click' : function(e) {\n ..... \n } ,\n .... \n } \n </code></pre>",
- "memberOf" : "Roo.util.Observable"
- },
- {
- "name" : "maskRe",
- "type" : "String",
- "desc" : "An input mask regular expression that will be used to filter keystrokes that don't match (defaults to null)",
- "memberOf" : "Roo.form.TextField"
- },
- {
- "name" : "maxLength",
- "type" : "Number",
- "desc" : "Maximum input field length allowed (defaults to Number.MAX_VALUE)",
- "memberOf" : "Roo.form.TextField"
- },
- {
- "name" : "maxLengthText",
- "type" : "String",
- "desc" : "Error text to display if the maximum length validation fails (defaults to \"The maximum length for this field is {maxLength}\")",
- "memberOf" : "Roo.form.TextField"
- },
- {
- "name" : "minLength",
- "type" : "Number",
- "desc" : "Minimum input field length required (defaults to 0)",
- "memberOf" : "Roo.form.TextField"
- },
- {
- "name" : "minLengthText",
- "type" : "String",
- "desc" : "Error text to display if the minimum length validation fails (defaults to \"The minimum length for this field is {minLength}\")",
- "memberOf" : "Roo.form.TextField"
- },
- {
- "name" : "msgFx",
- "type" : "String",
- "desc" : "<b>Experimental</b> The effect used when displaying a validation message under the field (defaults to 'normal').",
- "memberOf" : "Roo.form.Field"
- },
- {
- "name" : "msgTarget",
- "type" : "String",
- "desc" : "The location where error text should display. Should be one of the following values (defaults to 'qtip'):\n<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" : "name",
- "type" : "String",
- "desc" : "The field's HTML name attribute.",
- "memberOf" : "Roo.form.Field"
- },
- {
- "name" : "qtip",
- "type" : "String",
- "desc" : "Mouse over tip",
- "memberOf" : "Roo.form.Field"
- },
- {
- "name" : "readOnly",
- "type" : "Boolean",
- "desc" : "True to mark the field as readOnly in HTML (defaults to false) -- Note: this only sets the element's readOnly DOM attribute.",
- "memberOf" : "Roo.form.Field"
- },
- {
- "name" : "regex",
- "type" : "RegExp",
- "desc" : "A JavaScript RegExp object to be tested against the field value during validation (defaults to null).\nIf available, this regex will be evaluated only after the basic validators all return true, and will be passed the\ncurrent field value. If the test fails, the field will be marked invalid using {@link #regexText}.",
- "memberOf" : "Roo.form.TextField"
- },
- {
- "name" : "regexText",
- "type" : "String",
- "desc" : "The error text to display if {@link #regex} is used and the test fails during validation (defaults to \"\")",
- "memberOf" : "Roo.form.TextField"
- },
- {
- "name" : "selectOnFocus",
- "type" : "Boolean",
- "desc" : "True to automatically select any existing field text when the field receives input focus (defaults to false)",
- "memberOf" : "Roo.form.TextField"
- },
- {
- "name" : "tabIndex",
- "type" : "Number",
- "desc" : "The tabIndex for this field. Note this only applies to fields that are rendered, not those which are built via applyTo (defaults to undefined).",
- "memberOf" : "Roo.form.Field"
- },
- {
- "name" : "triggerClass",
- "type" : "String",
- "desc" : "An additional CSS class used to style the trigger button. The trigger will always get the\nclass 'x-form-trigger' by default and triggerClass will be <b>appended</b> if specified.",
- "memberOf" : ""
- },
- {
- "name" : "validateOnBlur",
- "type" : "Boolean",
- "desc" : "Whether the field should validate when it loses focus (defaults to true).",
- "memberOf" : "Roo.form.Field"
- },
- {
- "name" : "validationDelay",
- "type" : "Number",
- "desc" : "The length of time in milliseconds after user input begins until validation is initiated (defaults to 250)",
- "memberOf" : "Roo.form.Field"
- },
- {
- "name" : "validationEvent",
- "type" : "String/Boolean",
- "desc" : "The event that should initiate field validation. Set to false to disable\n automatic validation (defaults to \"keyup\").",
- "memberOf" : "Roo.form.Field"
- },
- {
- "name" : "validator",
- "type" : "Function",
- "desc" : "A custom validation function to be called during field validation (defaults to null).\nIf available, this function will be called only after the basic validators all return true, and will be passed the\ncurrent field value and expected to return boolean true if the value is valid or a string error message if invalid.",
- "memberOf" : "Roo.form.TextField"
- },
- {
- "name" : "value",
- "type" : "Mixed",
- "desc" : "A value to initialize this field with.",
- "memberOf" : "Roo.form.Field"
- },
- {
- "name" : "vtype",
- "type" : "String",
- "desc" : "A validation type name as defined in {@link Roo.form.VTypes} (defaults to null)",
- "memberOf" : "Roo.form.TextField"
- },
- {
- "name" : "width",
- "type" : "Number",
- "desc" : "width (optional) size of component",
- "memberOf" : "Roo.BoxComponent"
- }
- ],
- "events" : [
+ "Roo.form.VTypes" : {
+ "props" : [],
+ "events" : [],
+ "methods" : [
{
- "name" : "autosize",
+ "name" : "alpha'",
"type" : "function",
- "desc" : "Fires when the autosize function is triggered. The field may or may not have actually changed size\naccording to the default logic, but this event provides a hook for the developer to apply additional\nlogic at runtime to resize the field if needed.",
- "sig" : "function (_self, width)\n{\n\n}",
- "memberOf" : "Roo.form.TextField",
+ "desc" : "The function used to validate alpha values",
+ "sig" : "(value)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
- "name" : "this",
- "type" : "Roo.form.Field",
- "desc" : "This text field",
- "isOptional" : false
- },
- {
- "name" : "width",
- "type" : "Number",
- "desc" : "The new field width",
+ "name" : "value",
+ "type" : "String",
+ "desc" : "The value",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "beforedestroy",
+ "name" : "alphanum'",
"type" : "function",
- "desc" : "Fires before the component is destroyed. Return false to stop the destroy.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
+ "desc" : "The function used to validate alphanumeric values",
+ "sig" : "(value)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
- "name" : "this",
- "type" : "Roo.Component",
- "desc" : "",
+ "name" : "value",
+ "type" : "String",
+ "desc" : "The value",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "beforehide",
+ "name" : "email'",
"type" : "function",
- "desc" : "Fires before the component is hidden. Return false to stop the hide.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
+ "desc" : "The function used to validate email addresses",
+ "sig" : "(value)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
- "name" : "this",
- "type" : "Roo.Component",
- "desc" : "",
+ "name" : "value",
+ "type" : "String",
+ "desc" : "The email address",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "beforerender",
+ "name" : "url'",
"type" : "function",
- "desc" : "Fires before the component is rendered. Return false to stop the render.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
+ "desc" : "The function used to validate URLs",
+ "sig" : "(value)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
- "name" : "this",
- "type" : "Roo.Component",
- "desc" : "",
+ "name" : "value",
+ "type" : "String",
+ "desc" : "The URL",
"isOptional" : false
}
],
"returns" : []
- },
+ }
+ ],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "implementations" : [],
+ "tree_children" : [],
+ "tree_parent" : []
+ },
+ "Roo.grid" : {
+ "props" : [],
+ "events" : [],
+ "methods" : [],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "implementations" : [],
+ "tree_children" : [],
+ "tree_parent" : []
+ },
+ "Roo.grid.AbstractGridView" : {
+ "props" : [
{
- "name" : "beforeshow",
+ "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",
+ "isOptional" : false,
+ "optvals" : []
+ }
+ ],
+ "events" : [],
+ "methods" : [
+ {
+ "name" : "addEvents",
"type" : "function",
- "desc" : "Fires before the component is shown. Return false to stop the show.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
+ "desc" : "Used to define events on this Observable",
+ "sig" : "(object)",
+ "static" : false,
+ "memberOf" : "Roo.util.Observable",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
- "name" : "this",
- "type" : "Roo.Component",
- "desc" : "",
+ "name" : "object",
+ "type" : "Object",
+ "desc" : "The object with the events defined",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "blur",
+ "name" : "addListener",
"type" : "function",
- "desc" : "Fires when this field loses input focus.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.form.Field",
+ "desc" : "Appends an event handler to this component",
+ "sig" : "(eventName, handler, scope, options)",
+ "static" : false,
+ "memberOf" : "Roo.util.Observable",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
- "name" : "this",
- "type" : "Roo.form.Field",
- "desc" : "",
+ "name" : "eventName",
+ "type" : "String",
+ "desc" : "The type of event to listen for",
+ "isOptional" : false
+ },
+ {
+ "name" : "handler",
+ "type" : "Function",
+ "desc" : "The method the event invokes",
+ "isOptional" : false
+ },
+ {
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
+ "isOptional" : false
+ },
+ {
+ "name" : "options",
+ "type" : "Object",
+ "desc" : "(optional) An object containing handler configuration\nproperties. This may contain any of the following properties:<ul>\n<li>scope {Object} The scope in which to execute the handler function. The handler function's \"this\" context.</li>\n<li>delay {Number} The number of milliseconds to delay the invocation of the handler after te event fires.</li>\n<li>single {Boolean} True to add a handler to handle just the next firing of the event, and then remove itself.</li>\n<li>buffer {Number} Causes the handler to be scheduled to run in an {@link Roo.util.DelayedTask} delayed\nby the specified number of milliseconds. If the event fires again within that time, the original\nhandler is <em>not</em> invoked, but the new handler is scheduled in its place.</li>\n</ul><br>\n<p>\n<b>Combining Options</b><br>\nUsing the options argument, it is possible to combine different types of listeners:<br>\n<br>\nA normalized, delayed, one-time listener that auto stops the event and passes a custom argument (forumId)\n\t\t<pre><code>\n\t\tel.on('click', this.onClick, this, {\n \t\t\tsingle: true,\n \t\tdelay: 100,\n \t\tforumId: 4\n\t\t});\n\t\t</code></pre>\n<p>\n<b>Attaching multiple handlers in 1 call</b><br>\nThe method also allows for a single argument to be passed which is a config object containing properties\nwhich specify multiple handlers.\n<pre><code>\n\t\tel.on({\n\t\t\t'click': {\n \t\tfn: this.onClick,\n \t\tscope: this,\n \t\tdelay: 100\n \t\t}, \n \t\t'mouseover': {\n \t\tfn: this.onMouseOver,\n \t\tscope: this\n \t\t},\n \t\t'mouseout': {\n \t\tfn: this.onMouseOut,\n \t\tscope: this\n \t\t}\n\t\t});\n\t\t</code></pre>\n<p>\nOr a shorthand syntax which passes the same scope object to all handlers:\n \t<pre><code>\n\t\tel.on({\n\t\t\t'click': this.onClick,\n \t\t'mouseover': this.onMouseOver,\n \t\t'mouseout': this.onMouseOut,\n \t\tscope: this\n\t\t});\n\t\t</code></pre>",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "change",
+ "name" : "capture",
"type" : "function",
- "desc" : "Fires just before the field blurs if the field value has changed.",
- "sig" : "function (_self, newValue, oldValue)\n{\n\n}",
- "memberOf" : "Roo.form.Field",
+ "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\n<b>before</b> the event is fired. If the supplied function returns false,\nthe event will not fire.",
+ "sig" : "(o, fn, scope)",
+ "static" : true,
+ "memberOf" : "Roo.util.Observable",
+ "isStatic" : true,
+ "isConstructor" : false,
+ "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
- "name" : "this",
- "type" : "Roo.form.Field",
- "desc" : "",
+ "name" : "o",
+ "type" : "Observable",
+ "desc" : "The Observable to capture",
"isOptional" : false
},
{
- "name" : "newValue",
- "type" : "Mixed",
- "desc" : "The new value",
+ "name" : "fn",
+ "type" : "Function",
+ "desc" : "The function to call",
"isOptional" : false
},
{
- "name" : "oldValue",
- "type" : "Mixed",
- "desc" : "The original value",
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "(optional) The scope (this object) for the fn",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "destroy",
+ "name" : "fireEvent",
"type" : "function",
- "desc" : "Fires after the component is destroyed.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
+ "desc" : "Fires the specified event with the passed parameters (minus the event name).",
+ "sig" : "(eventName, args)",
+ "static" : false,
+ "memberOf" : "Roo.util.Observable",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
- "name" : "this",
- "type" : "Roo.Component",
+ "name" : "eventName",
+ "type" : "String",
"desc" : "",
"isOptional" : false
+ },
+ {
+ "name" : "args",
+ "type" : "Object...",
+ "desc" : "Variable number of parameters are passed to handlers",
+ "isOptional" : false
}
],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Boolean",
+ "desc" : "returns false if any of the handlers return false otherwise it returns true"
+ }
+ ]
},
{
- "name" : "disable",
+ "name" : "hasListener",
"type" : "function",
- "desc" : "Fires after the component is disabled.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
+ "desc" : "Checks to see if this object has any listeners for a specified event",
+ "sig" : "(eventName)",
+ "static" : false,
+ "memberOf" : "Roo.util.Observable",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
- "name" : "this",
- "type" : "Roo.Component",
- "desc" : "",
+ "name" : "eventName",
+ "type" : "String",
+ "desc" : "The name of the event to check for",
"isOptional" : false
}
],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Boolean",
+ "desc" : "True if the event is being listened for, else false"
+ }
+ ]
},
{
- "name" : "enable",
+ "name" : "on",
"type" : "function",
- "desc" : "Fires after the component is enabled.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
+ "desc" : "Appends an event handler to this element (shorthand for addListener)",
+ "sig" : "(eventName, handler, scope, options)",
+ "static" : false,
+ "memberOf" : "Roo.util.Observable",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
- "name" : "this",
- "type" : "Roo.Component",
- "desc" : "",
+ "name" : "eventName",
+ "type" : "String",
+ "desc" : "The type of event to listen for",
+ "isOptional" : false
+ },
+ {
+ "name" : "handler",
+ "type" : "Function",
+ "desc" : "The method the event invokes",
+ "isOptional" : false
+ },
+ {
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
+ "isOptional" : false
+ },
+ {
+ "name" : "options",
+ "type" : "Object",
+ "desc" : "(optional)",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "focus",
+ "name" : "purgeListeners",
"type" : "function",
- "desc" : "Fires when this field receives input focus.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.form.Field",
+ "desc" : "Removes all listeners for this object",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.util.Observable",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.form.Field",
- "desc" : "",
- "isOptional" : false
- }
- ],
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
"returns" : []
},
{
- "name" : "hide",
+ "name" : "releaseCapture",
"type" : "function",
- "desc" : "Fires after the component is hidden.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
+ "desc" : "Removes <b>all</b> added captures from the Observable.",
+ "sig" : "(o)",
+ "static" : true,
+ "memberOf" : "Roo.util.Observable",
+ "isStatic" : true,
+ "isConstructor" : false,
+ "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
- "name" : "this",
- "type" : "Roo.Component",
- "desc" : "",
+ "name" : "o",
+ "type" : "Observable",
+ "desc" : "The Observable to release",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "invalid",
+ "name" : "removeListener",
"type" : "function",
- "desc" : "Fires after the field has been marked as invalid.",
- "sig" : "function (_self, msg)\n{\n\n}",
- "memberOf" : "Roo.form.Field",
+ "desc" : "Removes a listener",
+ "sig" : "(eventName, handler, scope)",
+ "static" : false,
+ "memberOf" : "Roo.util.Observable",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
- "name" : "this",
- "type" : "Roo.form.Field",
- "desc" : "",
+ "name" : "eventName",
+ "type" : "String",
+ "desc" : "The type of event to listen for",
"isOptional" : false
},
{
- "name" : "msg",
- "type" : "String",
- "desc" : "The validation message",
+ "name" : "handler",
+ "type" : "Function",
+ "desc" : "The handler to remove",
+ "isOptional" : false
+ },
+ {
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "(optional) The scope (this object) for the handler",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "keyup",
+ "name" : "setCSSStyle",
"type" : "function",
- "desc" : "Fires after the key up",
- "sig" : "function (_self, e)\n{\n\n}",
- "memberOf" : "Roo.form.Field",
+ "desc" : "Set a css style for a column dynamically.",
+ "sig" : "(colIndex, name, value)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
- "name" : "this",
- "type" : "Roo.form.Field",
- "desc" : "",
+ "name" : "colIndex",
+ "type" : "Number",
+ "desc" : "The index of the column",
"isOptional" : false
},
{
- "name" : "e",
- "type" : "Roo.EventObject",
- "desc" : "The event Object",
+ "name" : "name",
+ "type" : "String",
+ "desc" : "The css property name",
+ "isOptional" : false
+ },
+ {
+ "name" : "value",
+ "type" : "String",
+ "desc" : "The css value",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "move",
+ "name" : "un",
"type" : "function",
- "desc" : "Fires after the component is moved.",
- "sig" : "function (_self, x, y)\n{\n\n}",
- "memberOf" : "Roo.BoxComponent",
+ "desc" : "Removes a listener (shorthand for removeListener)",
+ "sig" : "(eventName, handler, scope)",
+ "static" : false,
+ "memberOf" : "Roo.util.Observable",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
- "name" : "this",
- "type" : "Roo.Component",
- "desc" : "",
+ "name" : "eventName",
+ "type" : "String",
+ "desc" : "The type of event to listen for",
"isOptional" : false
},
{
- "name" : "x",
- "type" : "Number",
- "desc" : "The new x position",
+ "name" : "handler",
+ "type" : "Function",
+ "desc" : "The handler to remove",
"isOptional" : false
},
{
- "name" : "y",
- "type" : "Number",
- "desc" : "The new y position",
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "(optional) The scope (this object) for the handler",
"isOptional" : false
}
],
"returns" : []
- },
+ }
+ ],
+ "isAbstract" : true,
+ "isBuilderTop" : false,
+ "implementations" : [],
+ "tree_children" : [],
+ "tree_parent" : []
+ },
+ "Roo.grid.AbstractSelectionModel" : {
+ "props" : [
{
- "name" : "render",
+ "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",
+ "isOptional" : false,
+ "optvals" : []
+ }
+ ],
+ "events" : [],
+ "methods" : [
+ {
+ "name" : "addEvents",
"type" : "function",
- "desc" : "Fires after the component is rendered.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
+ "desc" : "Used to define events on this Observable",
+ "sig" : "(object)",
+ "static" : false,
+ "memberOf" : "Roo.util.Observable",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
- "name" : "this",
- "type" : "Roo.Component",
- "desc" : "",
+ "name" : "object",
+ "type" : "Object",
+ "desc" : "The object with the events defined",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "resize",
+ "name" : "addListener",
"type" : "function",
- "desc" : "Fires after the component is resized.",
- "sig" : "function (_self, adjWidth, adjHeight, rawWidth, rawHeight)\n{\n\n}",
- "memberOf" : "Roo.BoxComponent",
+ "desc" : "Appends an event handler to this component",
+ "sig" : "(eventName, handler, scope, options)",
+ "static" : false,
+ "memberOf" : "Roo.util.Observable",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
- "name" : "this",
- "type" : "Roo.Component",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "adjWidth",
- "type" : "Number",
- "desc" : "The box-adjusted width that was set",
+ "name" : "eventName",
+ "type" : "String",
+ "desc" : "The type of event to listen for",
"isOptional" : false
},
{
- "name" : "adjHeight",
- "type" : "Number",
- "desc" : "The box-adjusted height that was set",
+ "name" : "handler",
+ "type" : "Function",
+ "desc" : "The method the event invokes",
"isOptional" : false
},
{
- "name" : "rawWidth",
- "type" : "Number",
- "desc" : "The width that was originally specified",
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
"isOptional" : false
},
{
- "name" : "rawHeight",
- "type" : "Number",
- "desc" : "The height that was originally specified",
+ "name" : "options",
+ "type" : "Object",
+ "desc" : "(optional) An object containing handler configuration\nproperties. This may contain any of the following properties:<ul>\n<li>scope {Object} The scope in which to execute the handler function. The handler function's \"this\" context.</li>\n<li>delay {Number} The number of milliseconds to delay the invocation of the handler after te event fires.</li>\n<li>single {Boolean} True to add a handler to handle just the next firing of the event, and then remove itself.</li>\n<li>buffer {Number} Causes the handler to be scheduled to run in an {@link Roo.util.DelayedTask} delayed\nby the specified number of milliseconds. If the event fires again within that time, the original\nhandler is <em>not</em> invoked, but the new handler is scheduled in its place.</li>\n</ul><br>\n<p>\n<b>Combining Options</b><br>\nUsing the options argument, it is possible to combine different types of listeners:<br>\n<br>\nA normalized, delayed, one-time listener that auto stops the event and passes a custom argument (forumId)\n\t\t<pre><code>\n\t\tel.on('click', this.onClick, this, {\n \t\t\tsingle: true,\n \t\tdelay: 100,\n \t\tforumId: 4\n\t\t});\n\t\t</code></pre>\n<p>\n<b>Attaching multiple handlers in 1 call</b><br>\nThe method also allows for a single argument to be passed which is a config object containing properties\nwhich specify multiple handlers.\n<pre><code>\n\t\tel.on({\n\t\t\t'click': {\n \t\tfn: this.onClick,\n \t\tscope: this,\n \t\tdelay: 100\n \t\t}, \n \t\t'mouseover': {\n \t\tfn: this.onMouseOver,\n \t\tscope: this\n \t\t},\n \t\t'mouseout': {\n \t\tfn: this.onMouseOut,\n \t\tscope: this\n \t\t}\n\t\t});\n\t\t</code></pre>\n<p>\nOr a shorthand syntax which passes the same scope object to all handlers:\n \t<pre><code>\n\t\tel.on({\n\t\t\t'click': this.onClick,\n \t\t'mouseover': this.onMouseOver,\n \t\t'mouseout': this.onMouseOut,\n \t\tscope: this\n\t\t});\n\t\t</code></pre>",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "show",
+ "name" : "capture",
"type" : "function",
- "desc" : "Fires after the component is shown.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
+ "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\n<b>before</b> the event is fired. If the supplied function returns false,\nthe event will not fire.",
+ "sig" : "(o, fn, scope)",
+ "static" : true,
+ "memberOf" : "Roo.util.Observable",
+ "isStatic" : true,
+ "isConstructor" : false,
+ "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
- "name" : "this",
- "type" : "Roo.Component",
- "desc" : "",
+ "name" : "o",
+ "type" : "Observable",
+ "desc" : "The Observable to capture",
+ "isOptional" : false
+ },
+ {
+ "name" : "fn",
+ "type" : "Function",
+ "desc" : "The function to call",
+ "isOptional" : false
+ },
+ {
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "(optional) The scope (this object) for the fn",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "specialkey",
+ "name" : "fireEvent",
"type" : "function",
- "desc" : "Fires when any key related to navigation (arrows, tab, enter, esc, etc.) is pressed. You can check\n{@link Roo.EventObject#getKey} to determine which key was pressed.",
- "sig" : "function (_self, e)\n{\n\n}",
- "memberOf" : "Roo.form.Field",
+ "desc" : "Fires the specified event with the passed parameters (minus the event name).",
+ "sig" : "(eventName, args)",
+ "static" : false,
+ "memberOf" : "Roo.util.Observable",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
- "name" : "this",
- "type" : "Roo.form.Field",
+ "name" : "eventName",
+ "type" : "String",
"desc" : "",
"isOptional" : false
},
{
- "name" : "e",
- "type" : "Roo.EventObject",
- "desc" : "The event object",
+ "name" : "args",
+ "type" : "Object...",
+ "desc" : "Variable number of parameters are passed to handlers",
"isOptional" : false
}
],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Boolean",
+ "desc" : "returns false if any of the handlers return false otherwise it returns true"
+ }
+ ]
},
{
- "name" : "valid",
+ "name" : "hasListener",
"type" : "function",
- "desc" : "Fires after the field has been validated with no errors.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.form.Field",
+ "desc" : "Checks to see if this object has any listeners for a specified event",
+ "sig" : "(eventName)",
+ "static" : false,
+ "memberOf" : "Roo.util.Observable",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
- "name" : "this",
- "type" : "Roo.form.Field",
- "desc" : "",
+ "name" : "eventName",
+ "type" : "String",
+ "desc" : "The name of the event to check for",
"isOptional" : false
}
],
- "returns" : []
- }
- ],
- "methods" : [
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Boolean",
+ "desc" : "True if the event is being listened for, else false"
+ }
+ ]
+ },
{
- "name" : "addEvents",
+ "name" : "isLocked",
"type" : "function",
- "desc" : "Used to define events on this Observable",
- "sig" : "(object)",
+ "desc" : "Returns true if the selections are locked.",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.util.Observable",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
+ "params" : [],
+ "returns" : [
{
- "name" : "object",
- "type" : "Object",
- "desc" : "The object with the events defined",
- "isOptional" : false
+ "name" : "",
+ "type" : "Boolean",
+ "desc" : ""
}
- ],
+ ]
+ },
+ {
+ "name" : "lock",
+ "type" : "function",
+ "desc" : "Locks the selections.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
"returns" : []
},
{
- "name" : "addListener",
+ "name" : "on",
"type" : "function",
- "desc" : "Appends an event handler to this component",
+ "desc" : "Appends an event handler to this element (shorthand for addListener)",
"sig" : "(eventName, handler, scope, options)",
"static" : false,
"memberOf" : "Roo.util.Observable",
{
"name" : "options",
"type" : "Object",
- "desc" : "(optional) An object containing handler configuration\nproperties. This may contain any of the following properties:<ul>\n<li>scope {Object} The scope in which to execute the handler function. The handler function's \"this\" context.</li>\n<li>delay {Number} The number of milliseconds to delay the invocation of the handler after te event fires.</li>\n<li>single {Boolean} True to add a handler to handle just the next firing of the event, and then remove itself.</li>\n<li>buffer {Number} Causes the handler to be scheduled to run in an {@link Roo.util.DelayedTask} delayed\nby the specified number of milliseconds. If the event fires again within that time, the original\nhandler is <em>not</em> invoked, but the new handler is scheduled in its place.</li>\n</ul><br>\n<p>\n<b>Combining Options</b><br>\nUsing the options argument, it is possible to combine different types of listeners:<br>\n<br>\nA normalized, delayed, one-time listener that auto stops the event and passes a custom argument (forumId)\n\t\t<pre><code>\n\t\tel.on('click', this.onClick, this, {\n \t\t\tsingle: true,\n \t\tdelay: 100,\n \t\tforumId: 4\n\t\t});\n\t\t</code></pre>\n<p>\n<b>Attaching multiple handlers in 1 call</b><br>\nThe method also allows for a single argument to be passed which is a config object containing properties\nwhich specify multiple handlers.\n<pre><code>\n\t\tel.on({\n\t\t\t'click': {\n \t\tfn: this.onClick,\n \t\tscope: this,\n \t\tdelay: 100\n \t\t}, \n \t\t'mouseover': {\n \t\tfn: this.onMouseOver,\n \t\tscope: this\n \t\t},\n \t\t'mouseout': {\n \t\tfn: this.onMouseOut,\n \t\tscope: this\n \t\t}\n\t\t});\n\t\t</code></pre>\n<p>\nOr a shorthand syntax which passes the same scope object to all handlers:\n \t<pre><code>\n\t\tel.on({\n\t\t\t'click': this.onClick,\n \t\t'mouseover': this.onMouseOver,\n \t\t'mouseout': this.onMouseOut,\n \t\tscope: this\n\t\t});\n\t\t</code></pre>",
+ "desc" : "(optional)",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "applyTo",
+ "name" : "purgeListeners",
"type" : "function",
- "desc" : "Apply the behaviors of this component to an existing element. <b>This is used instead of render().</b>",
- "sig" : "(el)",
+ "desc" : "Removes all listeners for this object",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.form.Field",
+ "memberOf" : "Roo.util.Observable",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "el",
- "type" : "String/HTMLElement/Element",
- "desc" : "The id of the node, a DOM node or an existing Element",
- "isOptional" : false
- }
- ],
- "returns" : [
- {
- "name" : "",
- "type" : "Roo.form.Field",
- "desc" : "this"
- }
- ]
+ "params" : [],
+ "returns" : []
},
{
- "name" : "autoSize",
+ "name" : "releaseCapture",
"type" : "function",
- "desc" : "",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
+ "desc" : "Removes <b>all</b> added captures from the Observable.",
+ "sig" : "(o)",
+ "static" : true,
+ "memberOf" : "Roo.util.Observable",
+ "isStatic" : true,
"isConstructor" : false,
"isPrivate" : false,
"example" : "",
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
+ "params" : [
+ {
+ "name" : "o",
+ "type" : "Observable",
+ "desc" : "The Observable to release",
+ "isOptional" : false
+ }
+ ],
"returns" : []
},
{
- "name" : "capture",
+ "name" : "removeListener",
"type" : "function",
- "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\n<b>before</b> the event is fired. If the supplied function returns false,\nthe event will not fire.",
- "sig" : "(o, fn, scope)",
- "static" : true,
+ "desc" : "Removes a listener",
+ "sig" : "(eventName, handler, scope)",
+ "static" : false,
"memberOf" : "Roo.util.Observable",
- "isStatic" : true,
+ "isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"example" : "",
"requires" : "",
"params" : [
{
- "name" : "o",
- "type" : "Observable",
- "desc" : "The Observable to capture",
+ "name" : "eventName",
+ "type" : "String",
+ "desc" : "The type of event to listen for",
"isOptional" : false
},
{
- "name" : "fn",
+ "name" : "handler",
"type" : "Function",
- "desc" : "The function to call",
+ "desc" : "The handler to remove",
"isOptional" : false
},
{
"name" : "scope",
"type" : "Object",
- "desc" : "(optional) The scope (this object) for the fn",
+ "desc" : "(optional) The scope (this object) for the handler",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "clearInvalid",
+ "name" : "un",
"type" : "function",
- "desc" : "Clear any invalid styles/messages for this field",
- "sig" : "()\n{\n\n}",
+ "desc" : "Removes a listener (shorthand for removeListener)",
+ "sig" : "(eventName, handler, scope)",
"static" : false,
- "memberOf" : "Roo.form.Field",
+ "memberOf" : "Roo.util.Observable",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
+ "params" : [
+ {
+ "name" : "eventName",
+ "type" : "String",
+ "desc" : "The type of event to listen for",
+ "isOptional" : false
+ },
+ {
+ "name" : "handler",
+ "type" : "Function",
+ "desc" : "The handler to remove",
+ "isOptional" : false
+ },
+ {
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "(optional) The scope (this object) for the handler",
+ "isOptional" : false
+ }
+ ],
"returns" : []
},
{
- "name" : "destroy",
+ "name" : "unlock",
"type" : "function",
- "desc" : "Destroys this component by purging any event listeners, removing the component's element from the DOM,\nremoving the component from its {@link Roo.Container} (if applicable) and unregistering it from {@link Roo.ComponentMgr}.",
+ "desc" : "Unlocks the selections.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.Component",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [],
"returns" : []
+ }
+ ],
+ "isAbstract" : true,
+ "isBuilderTop" : false,
+ "implementations" : [
+ "Roo.grid.CellSelectionModel",
+ "Roo.grid.RowSelectionModel"
+ ],
+ "tree_children" : [],
+ "tree_parent" : []
+ },
+ "Roo.grid.Calendar" : {
+ "props" : [
+ {
+ "name" : "autoExpandColumn",
+ "type" : "String",
+ "desc" : "The id (or dataIndex) of a column in this grid that should expand to fill unused space. This id can not be 0. Default is false.",
+ "memberOf" : "Roo.grid.Grid",
+ "isOptional" : false,
+ "optvals" : []
},
{
- "name" : "disable",
+ "name" : "autoExpandMax",
+ "type" : "Number",
+ "desc" : "The maximum width the autoExpandColumn can have (if enabled). Default is 1000.",
+ "memberOf" : "Roo.grid.Grid",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "autoExpandMin",
+ "type" : "Number",
+ "desc" : "The minimum width the autoExpandColumn can have (if enabled).\nDefault is 50.",
+ "memberOf" : "Roo.grid.Grid",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "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",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "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",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "autoSizeHeaders",
+ "type" : "Boolean",
+ "desc" : "True to measure headers with column data when auto sizing columns. Default is true.",
+ "memberOf" : "Roo.grid.Grid",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "autoWidth",
+ "type" : "Boolean",
+ "desc" : "True to set the grid's width to the default total width of the grid's columns instead\nof a fixed width. Default is false.",
+ "memberOf" : "Roo.grid.Grid",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "cm[]",
+ "type" : "Roo.grid.ColumnModel",
+ "desc" : "The columns of the grid",
+ "memberOf" : "Roo.grid.Grid",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "ddGroup",
+ "type" : "String",
+ "desc" : "- drag drop group.",
+ "memberOf" : "Roo.grid.Grid",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "ddText",
+ "type" : "String",
+ "desc" : "Configures the text is the drag proxy (defaults to \"%0 selected row(s)\").\n%0 is replaced with the number of selected rows.",
+ "memberOf" : "Roo.grid.Grid",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "dragGroup",
+ "type" : "String",
+ "desc" : "- drag group (?? not sure if needed.)",
+ "memberOf" : "Roo.grid.Grid",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "dropTarget",
+ "type" : "Roo.dd.DropTarget",
+ "desc" : "An {@link Roo.dd.DropTarget} config",
+ "memberOf" : "Roo.grid.Grid",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "ds",
+ "type" : "Roo.data.Store",
+ "desc" : "The data store for the grid",
+ "memberOf" : "Roo.grid.Grid",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "enableColumnHide",
+ "type" : "Boolean",
+ "desc" : "True to enable hiding of columns with the header context menu. Default is true.",
+ "memberOf" : "Roo.grid.Grid",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "enableColumnMove",
+ "type" : "Boolean",
+ "desc" : "True to enable drag and drop reorder of columns. Default is true.",
+ "memberOf" : "Roo.grid.Grid",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "enableDrag",
+ "type" : "Boolean",
+ "desc" : "True to enable drag of rows. Default is false. (double check if this is needed?)",
+ "memberOf" : "Roo.grid.Grid",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "enableDragDrop",
+ "type" : "Boolean",
+ "desc" : "True to enable drag and drop of rows. Default is false.",
+ "memberOf" : "Roo.grid.Grid",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "enableDrop",
+ "type" : "Boolean",
+ "desc" : "True to enable drop of elements. Default is false. (double check if this is needed?)",
+ "memberOf" : "Roo.grid.Grid",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "enableRowHeightSync",
+ "type" : "Boolean",
+ "desc" : "True to manually sync row heights across locked and not locked rows. Default is false.",
+ "memberOf" : "Roo.grid.Grid",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "eventStore",
+ "type" : "Store",
+ "desc" : "The store that loads events.",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "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",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "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",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "maxHeight",
+ "type" : "Number",
+ "desc" : "Sets the maximum height of the grid - ignored if autoHeight is not on.",
+ "memberOf" : "Roo.grid.Grid",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "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",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "minColumnWidth",
+ "type" : "Number",
+ "desc" : "The minimum width a column can be resized to. Default is 25.",
+ "memberOf" : "Roo.grid.Grid",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "monitorWindowResize",
+ "type" : "Boolean",
+ "desc" : "True to autoSize the grid when the window resizes. Default is true.",
+ "memberOf" : "Roo.grid.Grid",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "sm",
+ "type" : "Roo.grid.AbstractSelectionModel",
+ "desc" : "The selection Model (default = Roo.grid.RowSelectionModel)",
+ "memberOf" : "Roo.grid.Grid",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "sortColMenu",
+ "type" : "boolean",
+ "desc" : "Sort the column order menu when it shows (usefull for long lists..) default false",
+ "memberOf" : "Roo.grid.Grid",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "stripeRows",
+ "type" : "Boolean",
+ "desc" : "True to stripe the rows. Default is true.",
+ "memberOf" : "Roo.grid.Grid",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "toolbar",
+ "type" : "Roo.Toolbar",
+ "desc" : "a toolbar for buttons etc.",
+ "memberOf" : "Roo.grid.Grid",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "trackMouseOver",
+ "type" : "Boolean",
+ "desc" : "True to highlight rows when the mouse is over. Default is true.",
+ "memberOf" : "Roo.grid.Grid",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "view",
+ "type" : "Roo.grid.GridView",
+ "desc" : "The view that renders the grid (default = Roo.grid.GridView)",
+ "memberOf" : "Roo.grid.Grid",
+ "isOptional" : false,
+ "optvals" : []
+ }
+ ],
+ "events" : [
+ {
+ "name" : "bodyscroll",
"type" : "function",
- "desc" : "Disable this component.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.Component",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
+ "desc" : "Fires when the body element is scrolled",
+ "sig" : "function (scrollLeft, scrollTop)\n{\n\n}",
+ "memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : [
+ "params" : [
{
- "name" : "",
- "type" : "Roo.Component",
- "desc" : "this"
+ "name" : "scrollLeft",
+ "type" : "Number",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "scrollTop",
+ "type" : "Number",
+ "desc" : "",
+ "isOptional" : false
}
- ]
+ ],
+ "returns" : []
},
{
- "name" : "enable",
+ "name" : "cellclick",
"type" : "function",
- "desc" : "Enable this component.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.Component",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
+ "desc" : "Fires when a cell is clicked",
+ "sig" : "function (_self, rowIndex, columnIndex, e)\n{\n\n}",
+ "memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : [
+ "params" : [
{
- "name" : "",
- "type" : "Roo.Component",
- "desc" : "this"
+ "name" : "this",
+ "type" : "Grid",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "rowIndex",
+ "type" : "Number",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "columnIndex",
+ "type" : "Number",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "e",
+ "type" : "Roo.EventObject",
+ "desc" : "",
+ "isOptional" : false
}
- ]
+ ],
+ "returns" : []
},
{
- "name" : "fireEvent",
+ "name" : "cellcontextmenu",
"type" : "function",
- "desc" : "Fires the specified event with the passed parameters (minus the event name).",
- "sig" : "(eventName, args)",
- "static" : false,
- "memberOf" : "Roo.util.Observable",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
+ "desc" : "Fires when a cell is right clicked",
+ "sig" : "function (_self, rowIndex, cellIndex, e)\n{\n\n}",
+ "memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
"params" : [
{
- "name" : "eventName",
- "type" : "String",
+ "name" : "this",
+ "type" : "Grid",
"desc" : "",
"isOptional" : false
},
{
- "name" : "args",
- "type" : "Object...",
- "desc" : "Variable number of parameters are passed to handlers",
+ "name" : "rowIndex",
+ "type" : "Number",
+ "desc" : "",
"isOptional" : false
- }
- ],
- "returns" : [
+ },
{
- "name" : "",
- "type" : "Boolean",
- "desc" : "returns false if any of the handlers return false otherwise it returns true"
+ "name" : "cellIndex",
+ "type" : "Number",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "e",
+ "type" : "Roo.EventObject",
+ "desc" : "",
+ "isOptional" : false
}
- ]
+ ],
+ "returns" : []
},
{
- "name" : "focus",
+ "name" : "celldblclick",
"type" : "function",
- "desc" : "Try to focus this component.",
- "sig" : "(selectText)",
- "static" : false,
- "memberOf" : "Roo.Component",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
+ "desc" : "Fires when a cell is double clicked",
+ "sig" : "function (_self, rowIndex, columnIndex, e)\n{\n\n}",
+ "memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
"params" : [
{
- "name" : "selectText",
- "type" : "Boolean",
- "desc" : "True to also select the text in this component (if applicable)",
+ "name" : "this",
+ "type" : "Grid",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "rowIndex",
+ "type" : "Number",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "columnIndex",
+ "type" : "Number",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "e",
+ "type" : "Roo.EventObject",
+ "desc" : "",
"isOptional" : false
}
],
- "returns" : [
- {
- "name" : "",
- "type" : "Roo.Component",
- "desc" : "this"
- }
- ]
+ "returns" : []
},
{
- "name" : "getBox",
+ "name" : "click",
"type" : "function",
- "desc" : "Gets the current box measurements of the component's underlying element.",
- "sig" : "(local)",
- "static" : false,
- "memberOf" : "Roo.BoxComponent",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
+ "desc" : "The raw click event for the entire grid.",
+ "sig" : "function (e)\n{\n\n}",
+ "memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
"params" : [
{
- "name" : "local",
- "type" : "Boolean",
- "desc" : "(optional) If true the element's left and top are returned instead of page XY (defaults to false)",
+ "name" : "e",
+ "type" : "Roo.EventObject",
+ "desc" : "",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "getEl",
+ "name" : "columnmove",
"type" : "function",
- "desc" : "Returns the underlying {@link Roo.Element}.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.Component",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
+ "desc" : "Fires when the user moves a column",
+ "sig" : "function (oldIndex, newIndex)\n{\n\n}",
+ "memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : [
+ "params" : [
{
- "name" : "",
- "type" : "Roo.Element",
- "desc" : "The element"
+ "name" : "oldIndex",
+ "type" : "Number",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "newIndex",
+ "type" : "Number",
+ "desc" : "",
+ "isOptional" : false
}
- ]
+ ],
+ "returns" : []
},
{
- "name" : "getId",
+ "name" : "columnresize",
"type" : "function",
- "desc" : "Returns the id of this component.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.Component",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
+ "desc" : "Fires when the user resizes a column",
+ "sig" : "function (columnIndex, newSize)\n{\n\n}",
+ "memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : [
+ "params" : [
{
- "name" : "",
- "type" : "String",
- "desc" : ""
+ "name" : "columnIndex",
+ "type" : "Number",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "newSize",
+ "type" : "Number",
+ "desc" : "",
+ "isOptional" : false
}
- ]
+ ],
+ "returns" : []
},
{
- "name" : "getName",
+ "name" : "contextmenu",
"type" : "function",
- "desc" : "Returns the name attribute of the field if available",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.form.Field",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
+ "desc" : "The raw contextmenu event for the entire grid.",
+ "sig" : "function (e)\n{\n\n}",
+ "memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : [
+ "params" : [
{
- "name" : "",
- "type" : "String",
- "desc" : "name The field name"
+ "name" : "e",
+ "type" : "Roo.EventObject",
+ "desc" : "",
+ "isOptional" : false
}
- ]
+ ],
+ "returns" : []
},
{
- "name" : "getPosition",
+ "name" : "dblclick",
"type" : "function",
- "desc" : "Gets the current XY position of the component's underlying element.",
- "sig" : "(local)",
- "static" : false,
- "memberOf" : "Roo.BoxComponent",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
+ "desc" : "The raw dblclick event for the entire grid.",
+ "sig" : "function (e)\n{\n\n}",
+ "memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
"params" : [
{
- "name" : "local",
- "type" : "Boolean",
- "desc" : "(optional) If true the element's left and top are returned instead of page XY (defaults to false)",
+ "name" : "e",
+ "type" : "Roo.EventObject",
+ "desc" : "",
"isOptional" : false
}
],
- "returns" : [
- {
- "name" : "",
- "type" : "Array",
- "desc" : "The XY position of the element (e.g., [100, 200])"
- }
- ]
+ "returns" : []
},
{
- "name" : "getRawValue",
+ "name" : "dragdrop",
"type" : "function",
- "desc" : "Returns the raw data value which may or may not be a valid, defined value. To return a normalized value see {@link #getValue}.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.form.Field",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
+ "desc" : "Fires when dragged row(s) are dropped on a valid DD target",
+ "sig" : "function (_self, dd, targetId, e)\n{\n\n}",
+ "memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : [
+ "params" : [
{
- "name" : "",
- "type" : "Mixed",
- "desc" : "value The field value"
+ "name" : "this",
+ "type" : "Grid",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "dd",
+ "type" : "Roo.GridDD",
+ "desc" : "The drag drop object",
+ "isOptional" : false
+ },
+ {
+ "name" : "targetId",
+ "type" : "String",
+ "desc" : "The target drag drop object",
+ "isOptional" : false
+ },
+ {
+ "name" : "e",
+ "type" : "event",
+ "desc" : "The raw browser event",
+ "isOptional" : false
}
- ]
+ ],
+ "returns" : []
},
{
- "name" : "getSize",
+ "name" : "dragenter",
"type" : "function",
- "desc" : "Gets the current size of the component's underlying element.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.BoxComponent",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
+ "desc" : "Fires when the dragged row(s) first cross another DD target while being dragged",
+ "sig" : "function (_self, dd, targetId, e)\n{\n\n}",
+ "memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : [
+ "params" : [
{
- "name" : "",
- "type" : "Object",
- "desc" : "An object containing the element's size {width: (element width), height: (element height)}"
+ "name" : "this",
+ "type" : "Grid",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "dd",
+ "type" : "Roo.GridDD",
+ "desc" : "The drag drop object",
+ "isOptional" : false
+ },
+ {
+ "name" : "targetId",
+ "type" : "String",
+ "desc" : "The target drag drop object",
+ "isOptional" : false
+ },
+ {
+ "name" : "e",
+ "type" : "event",
+ "desc" : "The raw browser event",
+ "isOptional" : false
}
- ]
+ ],
+ "returns" : []
},
{
- "name" : "getValue",
+ "name" : "dragout",
"type" : "function",
- "desc" : "Returns the normalized data value (undefined or emptyText will be returned as ''). To return the raw value see {@link #getRawValue}.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.form.Field",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
+ "desc" : "Fires when the dragged row(s) leave another DD target while being dragged",
+ "sig" : "function (_self, dd, targetId, e)\n{\n\n}",
+ "memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : [
+ "params" : [
{
- "name" : "",
- "type" : "Mixed",
- "desc" : "value The field value"
+ "name" : "this",
+ "type" : "Grid",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "dd",
+ "type" : "Roo.GridDD",
+ "desc" : "The drag drop object",
+ "isOptional" : false
+ },
+ {
+ "name" : "targetId",
+ "type" : "String",
+ "desc" : "The target drag drop object",
+ "isOptional" : false
+ },
+ {
+ "name" : "e",
+ "type" : "event",
+ "desc" : "The raw browser event",
+ "isOptional" : false
}
- ]
+ ],
+ "returns" : []
},
{
- "name" : "hasChanged",
+ "name" : "dragover",
"type" : "function",
- "desc" : "checks the current value against the 'loaded' value.\nNote - will return false if 'resetHasChanged' has not been called first.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.form.Field",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
+ "desc" : "Fires while row(s) are being dragged. \"targetId\" is the id of the Yahoo.util.DD object the selected rows are being dragged over.",
+ "sig" : "function (_self, dd, targetId, e)\n{\n\n}",
+ "memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Grid",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "dd",
+ "type" : "Roo.GridDD",
+ "desc" : "The drag drop object",
+ "isOptional" : false
+ },
+ {
+ "name" : "targetId",
+ "type" : "String",
+ "desc" : "The target drag drop object",
+ "isOptional" : false
+ },
+ {
+ "name" : "e",
+ "type" : "event",
+ "desc" : "The raw browser event",
+ "isOptional" : false
+ }
+ ],
"returns" : []
},
{
- "name" : "hasListener",
+ "name" : "enddrag",
"type" : "function",
- "desc" : "Checks to see if this object has any listeners for a specified event",
- "sig" : "(eventName)",
- "static" : false,
- "memberOf" : "Roo.util.Observable",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
+ "desc" : "Fires when a drag operation is complete",
+ "sig" : "function (_self, dd, e)\n{\n\n}",
+ "memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
"params" : [
{
- "name" : "eventName",
- "type" : "String",
- "desc" : "The name of the event to check for",
+ "name" : "this",
+ "type" : "Grid",
+ "desc" : "",
"isOptional" : false
- }
- ],
- "returns" : [
+ },
{
- "name" : "",
- "type" : "Boolean",
- "desc" : "True if the event is being listened for, else false"
+ "name" : "dd",
+ "type" : "Roo.GridDD",
+ "desc" : "The drag drop object",
+ "isOptional" : false
+ },
+ {
+ "name" : "e",
+ "type" : "event",
+ "desc" : "The raw browser event",
+ "isOptional" : false
}
- ]
+ ],
+ "returns" : []
},
{
- "name" : "hide",
+ "name" : "eventclick",
"type" : "function",
- "desc" : "Hide this component.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.Component",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
+ "desc" : "Fires when the mouse click an",
+ "sig" : "function (_self, )\n{\n\n}",
+ "memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : [
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Calendar",
+ "desc" : "",
+ "isOptional" : false
+ },
{
"name" : "",
- "type" : "Roo.Component",
- "desc" : "this"
+ "type" : "event",
+ "desc" : "",
+ "isOptional" : false
}
- ]
+ ],
+ "returns" : []
},
{
- "name" : "isDirty",
+ "name" : "evententer",
"type" : "function",
- "desc" : "Returns true if this field has been changed since it was originally loaded and is not disabled.\nDEPRICATED - it never worked well - use hasChanged/resetHasChanged.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.form.Field",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
+ "desc" : "Fires when mouse over an event",
+ "sig" : "function (_self, Event)\n{\n\n}",
+ "memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Calendar",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "Event",
+ "type" : "event",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
"returns" : []
},
{
- "name" : "isValid",
+ "name" : "eventleave",
"type" : "function",
- "desc" : "Returns whether or not the field value is currently valid",
- "sig" : "(preventMark)",
- "static" : false,
- "memberOf" : "Roo.form.Field",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
+ "desc" : "Fires when the mouse leaves an",
+ "sig" : "function (_self, )\n{\n\n}",
+ "memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
"params" : [
{
- "name" : "preventMark",
- "type" : "Boolean",
- "desc" : "True to disable marking the field invalid",
+ "name" : "this",
+ "type" : "Calendar",
+ "desc" : "",
"isOptional" : false
- }
- ],
- "returns" : [
+ },
{
"name" : "",
- "type" : "Boolean",
- "desc" : "True if the value is valid, else false"
+ "type" : "event",
+ "desc" : "",
+ "isOptional" : false
}
- ]
- },
- {
- "name" : "isVisible",
- "type" : "function",
- "desc" : "Returns true if this component is visible.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.Component",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
+ ],
"returns" : []
},
{
- "name" : "markInvalid",
+ "name" : "eventrender",
"type" : "function",
- "desc" : "Mark this field as invalid",
- "sig" : "(msg)",
- "static" : false,
- "memberOf" : "Roo.form.Field",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
+ "desc" : "Fires before each cell is rendered, so you can modify the contents, like cls / title / qtip",
+ "sig" : "function (_self, data)\n{\n\n}",
+ "memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
"params" : [
{
- "name" : "msg",
- "type" : "String",
- "desc" : "The validation message",
+ "name" : "this",
+ "type" : "Calendar",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "data",
+ "type" : "data",
+ "desc" : "to be modified",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "on",
+ "name" : "headerclick",
"type" : "function",
- "desc" : "Appends an event handler to this element (shorthand for addListener)",
- "sig" : "(eventName, handler, scope, options)",
- "static" : false,
- "memberOf" : "Roo.util.Observable",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
+ "desc" : "Fires when a header is clicked",
+ "sig" : "function (_self, columnIndex, e)\n{\n\n}",
+ "memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
"params" : [
{
- "name" : "eventName",
- "type" : "String",
- "desc" : "The type of event to listen for",
- "isOptional" : false
- },
- {
- "name" : "handler",
- "type" : "Function",
- "desc" : "The method the event invokes",
+ "name" : "this",
+ "type" : "Grid",
+ "desc" : "",
"isOptional" : false
},
{
- "name" : "scope",
- "type" : "Object",
- "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
+ "name" : "columnIndex",
+ "type" : "Number",
+ "desc" : "",
"isOptional" : false
},
{
- "name" : "options",
- "type" : "Object",
- "desc" : "(optional)",
+ "name" : "e",
+ "type" : "Roo.EventObject",
+ "desc" : "",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "onPosition",
+ "name" : "headercontextmenu",
"type" : "function",
- "desc" : "Called after the component is moved, this method is empty by default but can be implemented by any\nsubclass that needs to perform custom logic after a move occurs.",
- "sig" : "(x, y)",
- "static" : false,
- "memberOf" : "Roo.BoxComponent",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
+ "desc" : "Fires when a header is right clicked",
+ "sig" : "function (_self, columnIndex, e)\n{\n\n}",
+ "memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
"params" : [
{
- "name" : "x",
- "type" : "Number",
- "desc" : "The new x position",
+ "name" : "this",
+ "type" : "Grid",
+ "desc" : "",
"isOptional" : false
},
{
- "name" : "y",
+ "name" : "columnIndex",
"type" : "Number",
- "desc" : "The new y position",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "e",
+ "type" : "Roo.EventObject",
+ "desc" : "",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "onResize",
+ "name" : "headerdblclick",
"type" : "function",
- "desc" : "Called after the component is resized, this method is empty by default but can be implemented by any\nsubclass that needs to perform custom logic after a resize occurs.",
- "sig" : "(adjWidth, adjHeight, rawWidth, rawHeight)",
- "static" : false,
- "memberOf" : "Roo.BoxComponent",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
+ "desc" : "Fires when a header cell is double clicked",
+ "sig" : "function (_self, columnIndex, e)\n{\n\n}",
+ "memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
"params" : [
{
- "name" : "adjWidth",
- "type" : "Number",
- "desc" : "The box-adjusted width that was set",
- "isOptional" : false
- },
- {
- "name" : "adjHeight",
- "type" : "Number",
- "desc" : "The box-adjusted height that was set",
+ "name" : "this",
+ "type" : "Grid",
+ "desc" : "",
"isOptional" : false
},
{
- "name" : "rawWidth",
+ "name" : "columnIndex",
"type" : "Number",
- "desc" : "The width that was originally specified",
+ "desc" : "",
"isOptional" : false
},
{
- "name" : "rawHeight",
- "type" : "Number",
- "desc" : "The height that was originally specified",
+ "name" : "e",
+ "type" : "Roo.EventObject",
+ "desc" : "",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "onTriggerClick",
+ "name" : "keydown",
"type" : "function",
- "desc" : "The function that should handle the trigger's click event. This method does nothing by default until overridden\nby an implementing function.",
- "sig" : "(e)",
- "static" : false,
+ "desc" : "The raw keydown event for the entire grid.",
+ "sig" : "function (e)\n{\n\n}",
"memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
"params" : [
{
"name" : "e",
- "type" : "EventObject",
+ "type" : "Roo.EventObject",
"desc" : "",
"isOptional" : false
}
"returns" : []
},
{
- "name" : "purgeListeners",
- "type" : "function",
- "desc" : "Removes all listeners for this object",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.util.Observable",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
- {
- "name" : "releaseCapture",
+ "name" : "keypress",
"type" : "function",
- "desc" : "Removes <b>all</b> added captures from the Observable.",
- "sig" : "(o)",
- "static" : true,
- "memberOf" : "Roo.util.Observable",
- "isStatic" : true,
- "isConstructor" : false,
- "isPrivate" : false,
+ "desc" : "The raw keypress event for the entire grid.",
+ "sig" : "function (e)\n{\n\n}",
+ "memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
"params" : [
{
- "name" : "o",
- "type" : "Observable",
- "desc" : "The Observable to release",
+ "name" : "e",
+ "type" : "Roo.EventObject",
+ "desc" : "",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "removeListener",
+ "name" : "monthchange",
"type" : "function",
- "desc" : "Removes a listener",
- "sig" : "(eventName, handler, scope)",
- "static" : false,
- "memberOf" : "Roo.util.Observable",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
+ "desc" : "Fires when the displayed month changes",
+ "sig" : "function (_self, date)\n{\n\n}",
+ "memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
"params" : [
{
- "name" : "eventName",
- "type" : "String",
- "desc" : "The type of event to listen for",
- "isOptional" : false
- },
- {
- "name" : "handler",
- "type" : "Function",
- "desc" : "The handler to remove",
+ "name" : "this",
+ "type" : "DatePicker",
+ "desc" : "",
"isOptional" : false
},
{
- "name" : "scope",
- "type" : "Object",
- "desc" : "(optional) The scope (this object) for the handler",
+ "name" : "date",
+ "type" : "Date",
+ "desc" : "The selected month",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "render",
+ "name" : "mousedown",
"type" : "function",
- "desc" : "If this is a lazy rendering component, render it to its container element.",
- "sig" : "(container)",
- "static" : false,
- "memberOf" : "Roo.Component",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
+ "desc" : "The raw mousedown event for the entire grid.",
+ "sig" : "function (e)\n{\n\n}",
+ "memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
"params" : [
{
- "name" : "container",
- "type" : "String/HTMLElement/Element",
- "desc" : "(optional) The element this component should be rendered into. If it is being applied to existing markup, this should be left off.",
+ "name" : "e",
+ "type" : "Roo.EventObject",
+ "desc" : "",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "reset",
+ "name" : "mouseout",
"type" : "function",
- "desc" : "Resets the current field value to the originally-loaded value and clears any validation messages.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.form.TextField",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
+ "desc" : "The raw mouseout event for the entire grid.",
+ "sig" : "function (e)\n{\n\n}",
+ "memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
+ "params" : [
+ {
+ "name" : "e",
+ "type" : "Roo.EventObject",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
"returns" : []
},
{
- "name" : "resetHasChanged",
+ "name" : "mouseover",
"type" : "function",
- "desc" : "stores the current value in loadedValue",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.form.Field",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
+ "desc" : "The raw mouseover event for the entire grid.",
+ "sig" : "function (e)\n{\n\n}",
+ "memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
+ "params" : [
+ {
+ "name" : "e",
+ "type" : "Roo.EventObject",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
"returns" : []
},
{
- "name" : "selectText",
+ "name" : "mouseup",
"type" : "function",
- "desc" : "Selects text in this field",
- "sig" : "(start, end)",
- "static" : false,
- "memberOf" : "Roo.form.TextField",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
+ "desc" : "The raw mouseup event for the entire grid.",
+ "sig" : "function (e)\n{\n\n}",
+ "memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
"params" : [
{
- "name" : "start",
- "type" : "Number",
- "desc" : "(optional) The index where the selection should start (defaults to 0)",
- "isOptional" : false
- },
- {
- "name" : "end",
- "type" : "Number",
- "desc" : "(optional) The index where the selection should end (defaults to the text length)",
+ "name" : "e",
+ "type" : "Roo.EventObject",
+ "desc" : "",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "setDisabled",
+ "name" : "render",
"type" : "function",
- "desc" : "Convenience function for setting disabled/enabled by boolean.",
- "sig" : "(disabled)",
- "static" : false,
- "memberOf" : "Roo.Component",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
+ "desc" : "Fires when the grid is rendered",
+ "sig" : "function (grid)\n{\n\n}",
+ "memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
"params" : [
{
- "name" : "disabled",
- "type" : "Boolean",
+ "name" : "grid",
+ "type" : "Grid",
"desc" : "",
"isOptional" : false
}
"returns" : []
},
{
- "name" : "setPagePosition",
+ "name" : "rowclass",
"type" : "function",
- "desc" : "Sets the page XY position of the component. To set the left and top instead, use {@link #setPosition}.\nThis method fires the move event.",
- "sig" : "(x, y)",
- "static" : false,
- "memberOf" : "Roo.BoxComponent",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
+ "desc" : "Fires when a row is rendered, so you can change add a style to it.",
+ "sig" : "function (gridview, rowcfg)\n{\n\n}",
+ "memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
"params" : [
{
- "name" : "x",
- "type" : "Number",
- "desc" : "The new x position",
+ "name" : "gridview",
+ "type" : "GridView",
+ "desc" : "The grid view",
"isOptional" : false
},
{
- "name" : "y",
- "type" : "Number",
- "desc" : "The new y position",
+ "name" : "rowcfg",
+ "type" : "Object",
+ "desc" : "contains record rowIndex and rowClass - set rowClass to add a style.",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "setPosition",
+ "name" : "rowclick",
"type" : "function",
- "desc" : "Sets the left and top of the component. To set the page XY position instead, use {@link #setPagePosition}.\nThis method fires the move event.",
- "sig" : "(left, top)",
- "static" : false,
- "memberOf" : "Roo.BoxComponent",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
+ "desc" : "Fires when a row is clicked",
+ "sig" : "function (_self, rowIndex, e)\n{\n\n}",
+ "memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
"params" : [
{
- "name" : "left",
- "type" : "Number",
- "desc" : "The new left",
+ "name" : "this",
+ "type" : "Grid",
+ "desc" : "",
"isOptional" : false
},
{
- "name" : "top",
+ "name" : "rowIndex",
"type" : "Number",
- "desc" : "The new top",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "e",
+ "type" : "Roo.EventObject",
+ "desc" : "",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "setRawValue",
+ "name" : "rowcontextmenu",
"type" : "function",
- "desc" : "Sets the underlying DOM field's value directly, bypassing validation. To set the value with validation see {@link #setValue}.",
- "sig" : "(value)",
- "static" : false,
- "memberOf" : "Roo.form.Field",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
+ "desc" : "Fires when a row is right clicked",
+ "sig" : "function (_self, rowIndex, e)\n{\n\n}",
+ "memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
"params" : [
{
- "name" : "value",
- "type" : "Mixed",
- "desc" : "The value to set",
+ "name" : "this",
+ "type" : "Grid",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "rowIndex",
+ "type" : "Number",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "e",
+ "type" : "Roo.EventObject",
+ "desc" : "",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "setSize",
+ "name" : "rowdblclick",
"type" : "function",
- "desc" : "Sets the width and height of the component. This method fires the resize event. This method can accept\neither width and height as separate numeric arguments, or you can pass a size object like {width:10, height:20}.",
- "sig" : "(width, height)",
- "static" : false,
- "memberOf" : "Roo.BoxComponent",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
+ "desc" : "Fires when a row is double clicked",
+ "sig" : "function (_self, rowIndex, e)\n{\n\n}",
+ "memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
"params" : [
{
- "name" : "width",
- "type" : "Number/Object",
- "desc" : "The new width to set, or a size object in the format {width, height}",
+ "name" : "this",
+ "type" : "Grid",
+ "desc" : "",
"isOptional" : false
},
{
- "name" : "height",
+ "name" : "rowIndex",
"type" : "Number",
- "desc" : "The new height to set (not required if a size object is passed as the first arg)",
+ "desc" : "",
"isOptional" : false
- }
- ],
- "returns" : [
+ },
{
- "name" : "",
- "type" : "Roo.BoxComponent",
- "desc" : "this"
+ "name" : "e",
+ "type" : "Roo.EventObject",
+ "desc" : "",
+ "isOptional" : false
}
- ]
+ ],
+ "returns" : []
},
{
- "name" : "setValue",
+ "name" : "select",
"type" : "function",
- "desc" : "Sets a data value into the field and validates it. To set the value directly without validation see {@link #setRawValue}.",
- "sig" : "(value)",
- "static" : false,
- "memberOf" : "Roo.form.Field",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
+ "desc" : "Fires when a date is selected",
+ "sig" : "function (_self, date)\n{\n\n}",
+ "memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
"params" : [
{
- "name" : "value",
- "type" : "Mixed",
- "desc" : "The value to set",
+ "name" : "this",
+ "type" : "DatePicker",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "date",
+ "type" : "Date",
+ "desc" : "The selected date",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "setVisible",
+ "name" : "startdrag",
"type" : "function",
- "desc" : "Convenience function to hide or show this component by boolean.",
- "sig" : "(visible)",
- "static" : false,
- "memberOf" : "Roo.Component",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
+ "desc" : "Fires when row(s) start being dragged",
+ "sig" : "function (_self, dd, e)\n{\n\n}",
+ "memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
"params" : [
{
- "name" : "visible",
- "type" : "Boolean",
- "desc" : "True to show, false to hide",
+ "name" : "this",
+ "type" : "Grid",
+ "desc" : "",
"isOptional" : false
- }
- ],
- "returns" : [
+ },
{
- "name" : "",
- "type" : "Roo.Component",
- "desc" : "this"
+ "name" : "dd",
+ "type" : "Roo.GridDD",
+ "desc" : "The drag drop object",
+ "isOptional" : false
+ },
+ {
+ "name" : "e",
+ "type" : "event",
+ "desc" : "The raw browser event",
+ "isOptional" : false
}
- ]
- },
+ ],
+ "returns" : []
+ }
+ ],
+ "methods" : [
{
- "name" : "show",
+ "name" : "addColumns",
"type" : "function",
- "desc" : "Show this component.",
- "sig" : "()\n{\n\n}",
+ "desc" : "addColumns\nAdd's a column, default at the end..",
+ "sig" : "(position, of)",
"static" : false,
- "memberOf" : "Roo.Component",
+ "memberOf" : "Roo.grid.Grid",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
- "returns" : [
+ "params" : [
{
- "name" : "",
- "type" : "Roo.Component",
- "desc" : "this"
+ "name" : "position",
+ "type" : "int",
+ "desc" : "to add (default end)",
+ "isOptional" : false
+ },
+ {
+ "name" : "of",
+ "type" : "Array",
+ "desc" : "objects of column configuration see {@link Roo.grid.ColumnModel}",
+ "isOptional" : false
}
- ]
+ ],
+ "returns" : []
},
{
- "name" : "syncSize",
+ "name" : "addEvents",
"type" : "function",
- "desc" : "Force the component's size to recalculate based on the underlying element's current height and width.",
- "sig" : "()\n{\n\n}",
+ "desc" : "Used to define events on this Observable",
+ "sig" : "(object)",
"static" : false,
- "memberOf" : "Roo.BoxComponent",
+ "memberOf" : "Roo.util.Observable",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
+ "params" : [
+ {
+ "name" : "object",
+ "type" : "Object",
+ "desc" : "The object with the events defined",
+ "isOptional" : false
+ }
+ ],
"returns" : []
},
{
- "name" : "un",
+ "name" : "addListener",
"type" : "function",
- "desc" : "Removes a listener (shorthand for removeListener)",
- "sig" : "(eventName, handler, scope)",
+ "desc" : "Appends an event handler to this component",
+ "sig" : "(eventName, handler, scope, options)",
"static" : false,
"memberOf" : "Roo.util.Observable",
"isStatic" : false,
{
"name" : "handler",
"type" : "Function",
- "desc" : "The handler to remove",
+ "desc" : "The method the event invokes",
"isOptional" : false
},
{
"name" : "scope",
"type" : "Object",
- "desc" : "(optional) The scope (this object) for the handler",
+ "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
"isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "updateBox",
- "type" : "function",
- "desc" : "Sets the current box measurements of the component's underlying element.",
- "sig" : "(box)",
- "static" : false,
- "memberOf" : "Roo.BoxComponent",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
+ },
{
- "name" : "box",
+ "name" : "options",
"type" : "Object",
- "desc" : "An object in the format {x, y, width, height}",
+ "desc" : "(optional) An object containing handler configuration\nproperties. This may contain any of the following properties:<ul>\n<li>scope {Object} The scope in which to execute the handler function. The handler function's \"this\" context.</li>\n<li>delay {Number} The number of milliseconds to delay the invocation of the handler after te event fires.</li>\n<li>single {Boolean} True to add a handler to handle just the next firing of the event, and then remove itself.</li>\n<li>buffer {Number} Causes the handler to be scheduled to run in an {@link Roo.util.DelayedTask} delayed\nby the specified number of milliseconds. If the event fires again within that time, the original\nhandler is <em>not</em> invoked, but the new handler is scheduled in its place.</li>\n</ul><br>\n<p>\n<b>Combining Options</b><br>\nUsing the options argument, it is possible to combine different types of listeners:<br>\n<br>\nA normalized, delayed, one-time listener that auto stops the event and passes a custom argument (forumId)\n\t\t<pre><code>\n\t\tel.on('click', this.onClick, this, {\n \t\t\tsingle: true,\n \t\tdelay: 100,\n \t\tforumId: 4\n\t\t});\n\t\t</code></pre>\n<p>\n<b>Attaching multiple handlers in 1 call</b><br>\nThe method also allows for a single argument to be passed which is a config object containing properties\nwhich specify multiple handlers.\n<pre><code>\n\t\tel.on({\n\t\t\t'click': {\n \t\tfn: this.onClick,\n \t\tscope: this,\n \t\tdelay: 100\n \t\t}, \n \t\t'mouseover': {\n \t\tfn: this.onMouseOver,\n \t\tscope: this\n \t\t},\n \t\t'mouseout': {\n \t\tfn: this.onMouseOut,\n \t\tscope: this\n \t\t}\n\t\t});\n\t\t</code></pre>\n<p>\nOr a shorthand syntax which passes the same scope object to all handlers:\n \t<pre><code>\n\t\tel.on({\n\t\t\t'click': this.onClick,\n \t\t'mouseover': this.onMouseOver,\n \t\t'mouseout': this.onMouseOut,\n \t\tscope: this\n\t\t});\n\t\t</code></pre>",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "validate",
+ "name" : "autoSize",
"type" : "function",
- "desc" : "Validates the field value",
+ "desc" : "Causes the grid to manually recalculate its dimensions. Generally this is done automatically,\nbut if manual update is required this method will initiate it.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.form.Field",
+ "memberOf" : "Roo.grid.Grid",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"exceptions" : "",
"requires" : "",
"params" : [],
- "returns" : [
- {
- "name" : "",
- "type" : "Boolean",
- "desc" : "True if the value is valid, else false"
- }
- ]
+ "returns" : []
},
{
- "name" : "validateValue",
+ "name" : "capture",
"type" : "function",
- "desc" : "Validates a value according to the field's validation rules and marks the field as invalid\nif the validation fails",
- "sig" : "(value)",
- "static" : false,
- "memberOf" : "Roo.form.TextField",
- "isStatic" : false,
+ "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\n<b>before</b> the event is fired. If the supplied function returns false,\nthe event will not fire.",
+ "sig" : "(o, fn, scope)",
+ "static" : true,
+ "memberOf" : "Roo.util.Observable",
+ "isStatic" : true,
"isConstructor" : false,
"isPrivate" : false,
"example" : "",
"requires" : "",
"params" : [
{
- "name" : "value",
- "type" : "Mixed",
- "desc" : "The value to validate",
+ "name" : "o",
+ "type" : "Observable",
+ "desc" : "The Observable to capture",
"isOptional" : false
- }
- ],
- "returns" : [
+ },
{
- "name" : "",
- "type" : "Boolean",
- "desc" : "True if the value is valid, else false"
+ "name" : "fn",
+ "type" : "Function",
+ "desc" : "The function to call",
+ "isOptional" : false
+ },
+ {
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "(optional) The scope (this object) for the fn",
+ "isOptional" : false
}
- ]
- }
- ],
- "isAbstract" : false,
- "isBuilderTop" : false,
- "childClasses" : {
- "Roo.form.ComboBox" : [
- "Roo.form.ComboCheck",
- "Roo.form.ComboNested"
- ],
- "Roo.form.TriggerField" : [
- "Roo.form.ComboBox",
- "Roo.form.DateField",
- "Roo.form.MonthField",
- "Roo.form.Select"
- ]
- },
- "tree_children" : [],
- "tree_parent" : []
- },
- "Roo.form.VTypes" : {
- "props" : [],
- "events" : [],
- "methods" : [
+ ],
+ "returns" : []
+ },
{
- "name" : "alpha'",
+ "name" : "destroy",
"type" : "function",
- "desc" : "The function used to validate alpha values",
- "sig" : "(value)",
+ "desc" : "Destroy this grid.",
+ "sig" : "(removeEl)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.grid.Grid",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "value",
- "type" : "String",
- "desc" : "The value",
+ "name" : "removeEl",
+ "type" : "Boolean",
+ "desc" : "True to remove the element",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "alphanum'",
+ "name" : "fireEvent",
"type" : "function",
- "desc" : "The function used to validate alphanumeric values",
- "sig" : "(value)",
+ "desc" : "Fires the specified event with the passed parameters (minus the event name).",
+ "sig" : "(eventName, args)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.util.Observable",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "value",
+ "name" : "eventName",
"type" : "String",
- "desc" : "The value",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "args",
+ "type" : "Object...",
+ "desc" : "Variable number of parameters are passed to handlers",
"isOptional" : false
}
],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Boolean",
+ "desc" : "returns false if any of the handlers return false otherwise it returns true"
+ }
+ ]
},
{
- "name" : "email'",
+ "name" : "getColumnModel",
"type" : "function",
- "desc" : "The function used to validate email addresses",
- "sig" : "(value)",
+ "desc" : "Returns the grid's ColumnModel.",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.grid.Grid",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
+ "params" : [],
+ "returns" : [
{
- "name" : "value",
- "type" : "String",
- "desc" : "The email address",
- "isOptional" : false
+ "name" : "",
+ "type" : "ColumnModel",
+ "desc" : ""
}
- ],
- "returns" : []
+ ]
},
{
- "name" : "url'",
+ "name" : "getDataSource",
"type" : "function",
- "desc" : "The function used to validate URLs",
- "sig" : "(value)",
+ "desc" : "Returns the grid's DataSource.",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.grid.Grid",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
+ "params" : [],
+ "returns" : [
{
- "name" : "value",
- "type" : "String",
- "desc" : "The URL",
- "isOptional" : false
+ "name" : "",
+ "type" : "DataSource",
+ "desc" : ""
}
- ],
- "returns" : []
- }
- ],
- "isAbstract" : false,
- "isBuilderTop" : false,
- "childClasses" : { },
- "tree_children" : [],
- "tree_parent" : []
- },
- "Roo.grid" : {
- "props" : [],
- "events" : [],
- "methods" : [],
- "isAbstract" : false,
- "isBuilderTop" : false,
- "childClasses" : { },
- "tree_children" : [],
- "tree_parent" : []
- },
- "Roo.grid.AbstractGridView" : {
- "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" : [],
- "methods" : [
+ ]
+ },
{
- "name" : "addEvents",
+ "name" : "getDragDropText",
"type" : "function",
- "desc" : "Used to define events on this Observable",
- "sig" : "(object)",
+ "desc" : "Called to get grid's drag proxy text, by default returns this.ddText.\nOverride this to put something different in the dragged text.",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.util.Observable",
+ "memberOf" : "Roo.grid.Grid",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
+ "params" : [],
+ "returns" : [
{
- "name" : "object",
- "type" : "Object",
- "desc" : "The object with the events defined",
- "isOptional" : false
+ "name" : "",
+ "type" : "String",
+ "desc" : ""
}
- ],
- "returns" : []
+ ]
},
{
- "name" : "addListener",
+ "name" : "getGridEl",
"type" : "function",
- "desc" : "Appends an event handler to this component",
- "sig" : "(eventName, handler, scope, options)",
+ "desc" : "Returns the grid's underlying element.",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.util.Observable",
+ "memberOf" : "Roo.grid.Grid",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "eventName",
- "type" : "String",
- "desc" : "The type of event to listen for",
- "isOptional" : false
- },
- {
- "name" : "handler",
- "type" : "Function",
- "desc" : "The method the event invokes",
- "isOptional" : false
- },
- {
- "name" : "scope",
- "type" : "Object",
- "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
- "isOptional" : false
- },
+ "params" : [],
+ "returns" : [
{
- "name" : "options",
- "type" : "Object",
- "desc" : "(optional) An object containing handler configuration\nproperties. This may contain any of the following properties:<ul>\n<li>scope {Object} The scope in which to execute the handler function. The handler function's \"this\" context.</li>\n<li>delay {Number} The number of milliseconds to delay the invocation of the handler after te event fires.</li>\n<li>single {Boolean} True to add a handler to handle just the next firing of the event, and then remove itself.</li>\n<li>buffer {Number} Causes the handler to be scheduled to run in an {@link Roo.util.DelayedTask} delayed\nby the specified number of milliseconds. If the event fires again within that time, the original\nhandler is <em>not</em> invoked, but the new handler is scheduled in its place.</li>\n</ul><br>\n<p>\n<b>Combining Options</b><br>\nUsing the options argument, it is possible to combine different types of listeners:<br>\n<br>\nA normalized, delayed, one-time listener that auto stops the event and passes a custom argument (forumId)\n\t\t<pre><code>\n\t\tel.on('click', this.onClick, this, {\n \t\t\tsingle: true,\n \t\tdelay: 100,\n \t\tforumId: 4\n\t\t});\n\t\t</code></pre>\n<p>\n<b>Attaching multiple handlers in 1 call</b><br>\nThe method also allows for a single argument to be passed which is a config object containing properties\nwhich specify multiple handlers.\n<pre><code>\n\t\tel.on({\n\t\t\t'click': {\n \t\tfn: this.onClick,\n \t\tscope: this,\n \t\tdelay: 100\n \t\t}, \n \t\t'mouseover': {\n \t\tfn: this.onMouseOver,\n \t\tscope: this\n \t\t},\n \t\t'mouseout': {\n \t\tfn: this.onMouseOut,\n \t\tscope: this\n \t\t}\n\t\t});\n\t\t</code></pre>\n<p>\nOr a shorthand syntax which passes the same scope object to all handlers:\n \t<pre><code>\n\t\tel.on({\n\t\t\t'click': this.onClick,\n \t\t'mouseover': this.onMouseOver,\n \t\t'mouseout': this.onMouseOut,\n \t\tscope: this\n\t\t});\n\t\t</code></pre>",
- "isOptional" : false
+ "name" : "",
+ "type" : "Element",
+ "desc" : "The element"
}
- ],
- "returns" : []
+ ]
},
{
- "name" : "capture",
+ "name" : "getSelectionModel",
"type" : "function",
- "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\n<b>before</b> the event is fired. If the supplied function returns false,\nthe event will not fire.",
- "sig" : "(o, fn, scope)",
- "static" : true,
- "memberOf" : "Roo.util.Observable",
- "isStatic" : true,
+ "desc" : "Returns the grid's SelectionModel.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"example" : "",
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "o",
- "type" : "Observable",
- "desc" : "The Observable to capture",
- "isOptional" : false
- },
- {
- "name" : "fn",
- "type" : "Function",
- "desc" : "The function to call",
- "isOptional" : false
- },
+ "params" : [],
+ "returns" : [
{
- "name" : "scope",
- "type" : "Object",
- "desc" : "(optional) The scope (this object) for the fn",
- "isOptional" : false
+ "name" : "",
+ "type" : "SelectionModel",
+ "desc" : ""
}
- ],
- "returns" : []
+ ]
},
{
- "name" : "fireEvent",
+ "name" : "getView",
"type" : "function",
- "desc" : "Fires the specified event with the passed parameters (minus the event name).",
- "sig" : "(eventName, args)",
+ "desc" : "Returns the grid's GridView object.",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.util.Observable",
+ "memberOf" : "Roo.grid.Grid",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "eventName",
- "type" : "String",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "args",
- "type" : "Object...",
- "desc" : "Variable number of parameters are passed to handlers",
- "isOptional" : false
- }
- ],
+ "params" : [],
"returns" : [
{
"name" : "",
- "type" : "Boolean",
- "desc" : "returns false if any of the handlers return false otherwise it returns true"
+ "type" : "GridView",
+ "desc" : ""
}
]
},
"params" : [],
"returns" : []
},
+ {
+ "name" : "reconfigure",
+ "type" : "function",
+ "desc" : "Reconfigures the grid to use a different Store and Column Model.\nThe View will be bound to the new objects and refreshed.",
+ "sig" : "(dataSource, The)",
+ "static" : false,
+ "memberOf" : "Roo.grid.Grid",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "dataSource",
+ "type" : "Roo.data.Store",
+ "desc" : "The new {@link Roo.data.Store} object",
+ "isOptional" : false
+ },
+ {
+ "name" : "The",
+ "type" : "Roo.grid.ColumnModel",
+ "desc" : "new {@link Roo.grid.ColumnModel} object",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
{
"name" : "releaseCapture",
"type" : "function",
"returns" : []
},
{
- "name" : "setCSSStyle",
+ "name" : "render",
"type" : "function",
- "desc" : "Set a css style for a column dynamically.",
- "sig" : "(colIndex, name, value)",
+ "desc" : "Called once after all setup has been completed and the grid is ready to be rendered.",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.grid.Grid",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "colIndex",
- "type" : "Number",
- "desc" : "The index of the column",
- "isOptional" : false
- },
- {
- "name" : "name",
- "type" : "String",
- "desc" : "The css property name",
- "isOptional" : false
- },
+ "params" : [],
+ "returns" : [
{
- "name" : "value",
- "type" : "String",
- "desc" : "The css value",
- "isOptional" : false
+ "name" : "",
+ "type" : "Roo.grid.Grid",
+ "desc" : "this"
}
- ],
- "returns" : []
+ ]
},
{
"name" : "un",
"returns" : []
}
],
- "isAbstract" : true,
+ "isAbstract" : false,
"isBuilderTop" : false,
- "childClasses" : { },
+ "implementations" : [],
"tree_children" : [],
"tree_parent" : []
},
- "Roo.grid.AbstractSelectionModel" : {
+ "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" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
{
"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"
+ "memberOf" : "Roo.util.Observable",
+ "isOptional" : false,
+ "optvals" : []
}
],
- "events" : [],
- "methods" : [
+ "events" : [
{
- "name" : "addEvents",
+ "name" : "beforeeditnext",
"type" : "function",
- "desc" : "Used to define events on this Observable",
- "sig" : "(object)",
- "static" : false,
- "memberOf" : "Roo.util.Observable",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
+ "desc" : "Fires before the next editable sell is made active\nYou can use this to skip to another cell or fire the tabend\n if you set cell to false",
+ "sig" : "function (eventdata)\n{\n\n}",
+ "memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
"params" : [
{
- "name" : "object",
+ "name" : "eventdata",
"type" : "Object",
- "desc" : "The object with the events defined",
+ "desc" : "object : { cell : [ row, col ] }",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "addListener",
+ "name" : "beforerowselect",
"type" : "function",
- "desc" : "Appends an event handler to this component",
- "sig" : "(eventName, handler, scope, options)",
- "static" : false,
- "memberOf" : "Roo.util.Observable",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
+ "desc" : "Fires before a cell is selected.",
+ "sig" : "function (_self, rowIndex, colIndex)\n{\n\n}",
+ "memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
"params" : [
{
- "name" : "eventName",
- "type" : "String",
- "desc" : "The type of event to listen for",
- "isOptional" : false
- },
- {
- "name" : "handler",
- "type" : "Function",
- "desc" : "The method the event invokes",
+ "name" : "this",
+ "type" : "SelectionModel",
+ "desc" : "",
"isOptional" : false
},
{
- "name" : "scope",
- "type" : "Object",
- "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
+ "name" : "rowIndex",
+ "type" : "Number",
+ "desc" : "The selected row index",
"isOptional" : false
},
{
- "name" : "options",
- "type" : "Object",
- "desc" : "(optional) An object containing handler configuration\nproperties. This may contain any of the following properties:<ul>\n<li>scope {Object} The scope in which to execute the handler function. The handler function's \"this\" context.</li>\n<li>delay {Number} The number of milliseconds to delay the invocation of the handler after te event fires.</li>\n<li>single {Boolean} True to add a handler to handle just the next firing of the event, and then remove itself.</li>\n<li>buffer {Number} Causes the handler to be scheduled to run in an {@link Roo.util.DelayedTask} delayed\nby the specified number of milliseconds. If the event fires again within that time, the original\nhandler is <em>not</em> invoked, but the new handler is scheduled in its place.</li>\n</ul><br>\n<p>\n<b>Combining Options</b><br>\nUsing the options argument, it is possible to combine different types of listeners:<br>\n<br>\nA normalized, delayed, one-time listener that auto stops the event and passes a custom argument (forumId)\n\t\t<pre><code>\n\t\tel.on('click', this.onClick, this, {\n \t\t\tsingle: true,\n \t\tdelay: 100,\n \t\tforumId: 4\n\t\t});\n\t\t</code></pre>\n<p>\n<b>Attaching multiple handlers in 1 call</b><br>\nThe method also allows for a single argument to be passed which is a config object containing properties\nwhich specify multiple handlers.\n<pre><code>\n\t\tel.on({\n\t\t\t'click': {\n \t\tfn: this.onClick,\n \t\tscope: this,\n \t\tdelay: 100\n \t\t}, \n \t\t'mouseover': {\n \t\tfn: this.onMouseOver,\n \t\tscope: this\n \t\t},\n \t\t'mouseout': {\n \t\tfn: this.onMouseOut,\n \t\tscope: this\n \t\t}\n\t\t});\n\t\t</code></pre>\n<p>\nOr a shorthand syntax which passes the same scope object to all handlers:\n \t<pre><code>\n\t\tel.on({\n\t\t\t'click': this.onClick,\n \t\t'mouseover': this.onMouseOver,\n \t\t'mouseout': this.onMouseOut,\n \t\tscope: this\n\t\t});\n\t\t</code></pre>",
+ "name" : "colIndex",
+ "type" : "Number",
+ "desc" : "The selected cell index",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "capture",
+ "name" : "cellselect",
"type" : "function",
- "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\n<b>before</b> the event is fired. If the supplied function returns false,\nthe event will not fire.",
- "sig" : "(o, fn, scope)",
- "static" : true,
- "memberOf" : "Roo.util.Observable",
- "isStatic" : true,
- "isConstructor" : false,
- "isPrivate" : false,
+ "desc" : "Fires when a cell is selected.",
+ "sig" : "function (_self, rowIndex, colIndex)\n{\n\n}",
+ "memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
"params" : [
{
- "name" : "o",
- "type" : "Observable",
- "desc" : "The Observable to capture",
+ "name" : "this",
+ "type" : "SelectionModel",
+ "desc" : "",
"isOptional" : false
},
{
- "name" : "fn",
- "type" : "Function",
- "desc" : "The function to call",
+ "name" : "rowIndex",
+ "type" : "Number",
+ "desc" : "The selected row index",
"isOptional" : false
},
{
- "name" : "scope",
- "type" : "Object",
- "desc" : "(optional) The scope (this object) for the fn",
+ "name" : "colIndex",
+ "type" : "Number",
+ "desc" : "The selected cell index",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "fireEvent",
+ "name" : "selectionchange",
"type" : "function",
- "desc" : "Fires the specified event with the passed parameters (minus the event name).",
- "sig" : "(eventName, args)",
- "static" : false,
- "memberOf" : "Roo.util.Observable",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
+ "desc" : "Fires when the active selection changes.",
+ "sig" : "function (_self, selection)\n{\n\n}",
+ "memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
"params" : [
{
- "name" : "eventName",
- "type" : "String",
+ "name" : "this",
+ "type" : "SelectionModel",
"desc" : "",
"isOptional" : false
},
{
- "name" : "args",
- "type" : "Object...",
- "desc" : "Variable number of parameters are passed to handlers",
+ "name" : "selection",
+ "type" : "Object",
+ "desc" : "null for no selection or an object (o) with two properties\n\t <ul>\n\t <li>o.record: the record object for the row the selection is in</li>\n\t <li>o.cell: An array of [rowIndex, columnIndex]</li>\n\t </ul>",
"isOptional" : false
}
],
- "returns" : [
- {
- "name" : "",
- "type" : "Boolean",
- "desc" : "returns false if any of the handlers return false otherwise it returns true"
- }
- ]
+ "returns" : []
},
{
- "name" : "hasListener",
+ "name" : "tabend",
"type" : "function",
- "desc" : "Checks to see if this object has any listeners for a specified event",
- "sig" : "(eventName)",
- "static" : false,
- "memberOf" : "Roo.util.Observable",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
+ "desc" : "Fires when the tab (or enter) was pressed on the last editable cell\nYou can use this to trigger add new row.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
"params" : [
{
- "name" : "eventName",
- "type" : "String",
- "desc" : "The name of the event to check for",
+ "name" : "this",
+ "type" : "SelectionModel",
+ "desc" : "",
"isOptional" : false
}
],
- "returns" : [
- {
- "name" : "",
- "type" : "Boolean",
- "desc" : "True if the event is being listened for, else false"
- }
- ]
- },
+ "returns" : []
+ }
+ ],
+ "methods" : [
{
- "name" : "isLocked",
+ "name" : "addEvents",
"type" : "function",
- "desc" : "Returns true if the selections are locked.",
- "sig" : "()\n{\n\n}",
+ "desc" : "Used to define events on this Observable",
+ "sig" : "(object)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.util.Observable",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
- "returns" : [
+ "params" : [
{
- "name" : "",
- "type" : "Boolean",
- "desc" : ""
+ "name" : "object",
+ "type" : "Object",
+ "desc" : "The object with the events defined",
+ "isOptional" : false
}
- ]
- },
- {
- "name" : "lock",
- "type" : "function",
- "desc" : "Locks the selections.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
+ ],
"returns" : []
},
{
- "name" : "on",
+ "name" : "addListener",
"type" : "function",
- "desc" : "Appends an event handler to this element (shorthand for addListener)",
+ "desc" : "Appends an event handler to this component",
"sig" : "(eventName, handler, scope, options)",
"static" : false,
"memberOf" : "Roo.util.Observable",
{
"name" : "options",
"type" : "Object",
- "desc" : "(optional)",
+ "desc" : "(optional) An object containing handler configuration\nproperties. This may contain any of the following properties:<ul>\n<li>scope {Object} The scope in which to execute the handler function. The handler function's \"this\" context.</li>\n<li>delay {Number} The number of milliseconds to delay the invocation of the handler after te event fires.</li>\n<li>single {Boolean} True to add a handler to handle just the next firing of the event, and then remove itself.</li>\n<li>buffer {Number} Causes the handler to be scheduled to run in an {@link Roo.util.DelayedTask} delayed\nby the specified number of milliseconds. If the event fires again within that time, the original\nhandler is <em>not</em> invoked, but the new handler is scheduled in its place.</li>\n</ul><br>\n<p>\n<b>Combining Options</b><br>\nUsing the options argument, it is possible to combine different types of listeners:<br>\n<br>\nA normalized, delayed, one-time listener that auto stops the event and passes a custom argument (forumId)\n\t\t<pre><code>\n\t\tel.on('click', this.onClick, this, {\n \t\t\tsingle: true,\n \t\tdelay: 100,\n \t\tforumId: 4\n\t\t});\n\t\t</code></pre>\n<p>\n<b>Attaching multiple handlers in 1 call</b><br>\nThe method also allows for a single argument to be passed which is a config object containing properties\nwhich specify multiple handlers.\n<pre><code>\n\t\tel.on({\n\t\t\t'click': {\n \t\tfn: this.onClick,\n \t\tscope: this,\n \t\tdelay: 100\n \t\t}, \n \t\t'mouseover': {\n \t\tfn: this.onMouseOver,\n \t\tscope: this\n \t\t},\n \t\t'mouseout': {\n \t\tfn: this.onMouseOut,\n \t\tscope: this\n \t\t}\n\t\t});\n\t\t</code></pre>\n<p>\nOr a shorthand syntax which passes the same scope object to all handlers:\n \t<pre><code>\n\t\tel.on({\n\t\t\t'click': this.onClick,\n \t\t'mouseover': this.onMouseOver,\n \t\t'mouseout': this.onMouseOut,\n \t\tscope: this\n\t\t});\n\t\t</code></pre>",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "purgeListeners",
- "type" : "function",
- "desc" : "Removes all listeners for this object",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.util.Observable",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
- {
- "name" : "releaseCapture",
+ "name" : "capture",
"type" : "function",
- "desc" : "Removes <b>all</b> added captures from the Observable.",
- "sig" : "(o)",
+ "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\n<b>before</b> the event is fired. If the supplied function returns false,\nthe event will not fire.",
+ "sig" : "(o, fn, scope)",
"static" : true,
"memberOf" : "Roo.util.Observable",
"isStatic" : true,
{
"name" : "o",
"type" : "Observable",
- "desc" : "The Observable to release",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "removeListener",
- "type" : "function",
- "desc" : "Removes a listener",
- "sig" : "(eventName, handler, scope)",
- "static" : false,
- "memberOf" : "Roo.util.Observable",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "eventName",
- "type" : "String",
- "desc" : "The type of event to listen for",
+ "desc" : "The Observable to capture",
"isOptional" : false
},
{
- "name" : "handler",
+ "name" : "fn",
"type" : "Function",
- "desc" : "The handler to remove",
+ "desc" : "The function to call",
"isOptional" : false
},
{
"name" : "scope",
"type" : "Object",
- "desc" : "(optional) The scope (this object) for the handler",
+ "desc" : "(optional) The scope (this object) for the fn",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "un",
+ "name" : "clearSelections",
"type" : "function",
- "desc" : "Removes a listener (shorthand for removeListener)",
- "sig" : "(eventName, handler, scope)",
+ "desc" : "Clears all selections.",
+ "sig" : "(true)",
"static" : false,
- "memberOf" : "Roo.util.Observable",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "eventName",
- "type" : "String",
- "desc" : "The type of event to listen for",
- "isOptional" : false
- },
- {
- "name" : "handler",
- "type" : "Function",
- "desc" : "The handler to remove",
- "isOptional" : false
- },
- {
- "name" : "scope",
- "type" : "Object",
- "desc" : "(optional) The scope (this object) for the handler",
+ "name" : "true",
+ "type" : "Boolean",
+ "desc" : "to prevent the gridview from being notified about the change.",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "unlock",
+ "name" : "fireEvent",
"type" : "function",
- "desc" : "Unlocks the selections.",
- "sig" : "()\n{\n\n}",
+ "desc" : "Fires the specified event with the passed parameters (minus the event name).",
+ "sig" : "(eventName, args)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.util.Observable",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
- "returns" : []
- }
- ],
- "isAbstract" : true,
- "isBuilderTop" : false,
- "childClasses" : {
- "Roo.grid.AbstractSelectionModel" : [
- "Roo.grid.CellSelectionModel",
- "Roo.grid.RowSelectionModel"
- ]
- },
- "tree_children" : [],
- "tree_parent" : []
- },
- "Roo.grid.Calendar" : {
- "props" : [
- {
- "name" : "autoExpandColumn",
- "type" : "String",
- "desc" : "The id (or dataIndex) of a column in this grid that should expand to fill unused space. This id can not be 0. Default is false.",
- "memberOf" : "Roo.grid.Grid"
- },
- {
- "name" : "autoExpandMax",
- "type" : "Number",
- "desc" : "The maximum width the autoExpandColumn can have (if enabled). Default is 1000.",
- "memberOf" : "Roo.grid.Grid"
- },
- {
- "name" : "autoExpandMin",
- "type" : "Number",
- "desc" : "The minimum width the autoExpandColumn can have (if enabled).\nDefault is 50.",
- "memberOf" : "Roo.grid.Grid"
- },
- {
- "name" : "autoHeight",
- "type" : "Boolean",
- "desc" : "True to fit the height of the grid container to the height of the data. Default is false.",
- "memberOf" : "Roo.grid.Grid"
- },
- {
- "name" : "autoSizeColumns",
- "type" : "Boolean",
- "desc" : "True to automatically resize the columns to fit their content\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" : "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" : "cm[]",
- "type" : "Roo.grid.ColumnModel",
- "desc" : "The columns of the grid",
- "memberOf" : "Roo.grid.Grid"
- },
- {
- "name" : "ddGroup",
- "type" : "String",
- "desc" : "- drag drop group.",
- "memberOf" : "Roo.grid.Grid"
- },
- {
- "name" : "ddText",
- "type" : "String",
- "desc" : "Configures the text is the drag proxy (defaults to \"%0 selected row(s)\").\n%0 is replaced with the number of selected rows.",
- "memberOf" : "Roo.grid.Grid"
- },
- {
- "name" : "dragGroup",
- "type" : "String",
- "desc" : "- drag group (?? not sure if needed.)",
- "memberOf" : "Roo.grid.Grid"
- },
- {
- "name" : "dropTarget",
- "type" : "Roo.dd.DropTarget",
- "desc" : "An {@link Roo.dd.DropTarget} config",
- "memberOf" : "Roo.grid.Grid"
- },
- {
- "name" : "ds",
- "type" : "Roo.grid.Store",
- "desc" : "The data store for the grid",
- "memberOf" : "Roo.grid.Grid"
- },
- {
- "name" : "enableColumnHide",
- "type" : "Boolean",
- "desc" : "True to enable hiding of columns with the header context menu. Default is true.",
- "memberOf" : "Roo.grid.Grid"
- },
- {
- "name" : "enableColumnMove",
- "type" : "Boolean",
- "desc" : "True to enable drag and drop reorder of columns. Default is true.",
- "memberOf" : "Roo.grid.Grid"
- },
- {
- "name" : "enableDrag",
- "type" : "Boolean",
- "desc" : "True to enable drag of rows. Default is false. (double check if this is needed?)",
- "memberOf" : "Roo.grid.Grid"
- },
- {
- "name" : "enableDragDrop",
- "type" : "Boolean",
- "desc" : "True to enable drag and drop of rows. Default is false.",
- "memberOf" : "Roo.grid.Grid"
- },
- {
- "name" : "enableDrop",
- "type" : "Boolean",
- "desc" : "True to enable drop of elements. Default is false. (double check if this is needed?)",
- "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" : "eventStore",
- "type" : "Store",
- "desc" : "The store that loads events.",
- "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"
- },
- {
- "name" : "loadMask",
- "type" : "Object",
- "desc" : "An {@link Roo.LoadMask} config or true to mask the grid while loading. Default is false.",
- "memberOf" : "Roo.grid.Grid"
- },
- {
- "name" : "maxHeight",
- "type" : "Number",
- "desc" : "Sets the maximum height of the grid - ignored if autoHeight is not on.",
- "memberOf" : "Roo.grid.Grid"
- },
- {
- "name" : "maxRowsToMeasure",
- "type" : "Boolean",
- "desc" : "If autoSizeColumns is on, maxRowsToMeasure can be used to limit the number of\nrows measured to get a columns size. Default is 0 (all rows).",
- "memberOf" : "Roo.grid.Grid"
- },
- {
- "name" : "minColumnWidth",
- "type" : "Number",
- "desc" : "The minimum width a column can be resized to. Default is 25.",
- "memberOf" : "Roo.grid.Grid"
- },
- {
- "name" : "monitorWindowResize",
- "type" : "Boolean",
- "desc" : "True to autoSize the grid when the window resizes. Default is true.",
- "memberOf" : "Roo.grid.Grid"
- },
- {
- "name" : "sm",
- "type" : "Roo.grid.AbstractSelectionModel",
- "desc" : "The selection Model (default = Roo.grid.RowSelectionModel)",
- "memberOf" : "Roo.grid.Grid"
- },
- {
- "name" : "stripeRows",
- "type" : "Boolean",
- "desc" : "True to stripe the rows. Default is true.",
- "memberOf" : "Roo.grid.Grid"
- },
- {
- "name" : "toolbar",
- "type" : "Roo.Toolbar",
- "desc" : "a toolbar for buttons etc.",
- "memberOf" : "Roo.grid.Grid"
- },
- {
- "name" : "trackMouseOver",
- "type" : "Boolean",
- "desc" : "True to highlight rows when the mouse is over. Default is true.",
- "memberOf" : "Roo.grid.Grid"
- },
- {
- "name" : "view",
- "type" : "Roo.grid.GridView",
- "desc" : "The view that renders the grid (default = Roo.grid.GridView)",
- "memberOf" : "Roo.grid.Grid"
- }
- ],
- "events" : [
- {
- "name" : "bodyscroll",
- "type" : "function",
- "desc" : "Fires when the body element is scrolled",
- "sig" : "function (scrollLeft, scrollTop)\n{\n\n}",
- "memberOf" : "",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "scrollLeft",
- "type" : "Number",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "scrollTop",
- "type" : "Number",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "cellclick",
- "type" : "function",
- "desc" : "Fires when a cell is clicked",
- "sig" : "function (_self, rowIndex, columnIndex, e)\n{\n\n}",
- "memberOf" : "",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Grid",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "rowIndex",
- "type" : "Number",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "columnIndex",
- "type" : "Number",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "e",
- "type" : "Roo.EventObject",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "cellcontextmenu",
- "type" : "function",
- "desc" : "Fires when a cell is right clicked",
- "sig" : "function (_self, rowIndex, cellIndex, e)\n{\n\n}",
- "memberOf" : "",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
"params" : [
{
- "name" : "this",
- "type" : "Grid",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "rowIndex",
- "type" : "Number",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "cellIndex",
- "type" : "Number",
+ "name" : "eventName",
+ "type" : "String",
"desc" : "",
"isOptional" : false
},
{
- "name" : "e",
- "type" : "Roo.EventObject",
- "desc" : "",
+ "name" : "args",
+ "type" : "Object...",
+ "desc" : "Variable number of parameters are passed to handlers",
"isOptional" : false
}
],
- "returns" : []
- },
- {
- "name" : "celldblclick",
- "type" : "function",
- "desc" : "Fires when a cell is double clicked",
- "sig" : "function (_self, rowIndex, columnIndex, e)\n{\n\n}",
- "memberOf" : "",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Grid",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "rowIndex",
- "type" : "Number",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "columnIndex",
- "type" : "Number",
- "desc" : "",
- "isOptional" : false
- },
+ "returns" : [
{
- "name" : "e",
- "type" : "Roo.EventObject",
- "desc" : "",
- "isOptional" : false
+ "name" : "",
+ "type" : "Boolean",
+ "desc" : "returns false if any of the handlers return false otherwise it returns true"
}
- ],
- "returns" : []
+ ]
},
{
- "name" : "click",
+ "name" : "getSelectedCell",
"type" : "function",
- "desc" : "The raw click event for the entire grid.",
- "sig" : "function (e)\n{\n\n}",
+ "desc" : "Returns the currently selected cell,.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
"memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "params" : [
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : [
{
- "name" : "e",
- "type" : "Roo.EventObject",
- "desc" : "",
- "isOptional" : false
+ "name" : "",
+ "type" : "Array",
+ "desc" : "The selected cell (row, column) or null if none selected."
}
- ],
- "returns" : []
+ ]
},
{
- "name" : "columnmove",
+ "name" : "hasListener",
"type" : "function",
- "desc" : "Fires when the user moves a column",
- "sig" : "function (oldIndex, newIndex)\n{\n\n}",
- "memberOf" : "",
+ "desc" : "Checks to see if this object has any listeners for a specified event",
+ "sig" : "(eventName)",
+ "static" : false,
+ "memberOf" : "Roo.util.Observable",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
- "name" : "oldIndex",
- "type" : "Number",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "newIndex",
- "type" : "Number",
- "desc" : "",
+ "name" : "eventName",
+ "type" : "String",
+ "desc" : "The name of the event to check for",
"isOptional" : false
}
],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Boolean",
+ "desc" : "True if the event is being listened for, else false"
+ }
+ ]
},
{
- "name" : "columnresize",
+ "name" : "hasSelection",
"type" : "function",
- "desc" : "Fires when the user resizes a column",
- "sig" : "function (columnIndex, newSize)\n{\n\n}",
+ "desc" : "Returns true if there is a selection.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
"memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "params" : [
- {
- "name" : "columnIndex",
- "type" : "Number",
- "desc" : "",
- "isOptional" : false
- },
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : [
{
- "name" : "newSize",
- "type" : "Number",
- "desc" : "",
- "isOptional" : false
+ "name" : "",
+ "type" : "Boolean",
+ "desc" : ""
}
- ],
- "returns" : []
+ ]
},
{
- "name" : "contextmenu",
+ "name" : "isLocked",
"type" : "function",
- "desc" : "The raw contextmenu event for the entire grid.",
- "sig" : "function (e)\n{\n\n}",
- "memberOf" : "",
+ "desc" : "Returns true if the selections are locked.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.grid.AbstractSelectionModel",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "params" : [
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : [
{
- "name" : "e",
- "type" : "Roo.EventObject",
- "desc" : "",
- "isOptional" : false
+ "name" : "",
+ "type" : "Boolean",
+ "desc" : ""
}
- ],
- "returns" : []
+ ]
},
{
- "name" : "dblclick",
+ "name" : "lock",
"type" : "function",
- "desc" : "The raw dblclick event for the entire grid.",
- "sig" : "function (e)\n{\n\n}",
- "memberOf" : "",
+ "desc" : "Locks the selections.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.grid.AbstractSelectionModel",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "params" : [
- {
- "name" : "e",
- "type" : "Roo.EventObject",
- "desc" : "",
- "isOptional" : false
- }
- ],
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
"returns" : []
},
{
- "name" : "dragdrop",
+ "name" : "on",
"type" : "function",
- "desc" : "Fires when dragged row(s) are dropped on a valid DD target",
- "sig" : "function (_self, dd, targetId, e)\n{\n\n}",
- "memberOf" : "",
+ "desc" : "Appends an event handler to this element (shorthand for addListener)",
+ "sig" : "(eventName, handler, scope, options)",
+ "static" : false,
+ "memberOf" : "Roo.util.Observable",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
- "name" : "this",
- "type" : "Grid",
- "desc" : "",
+ "name" : "eventName",
+ "type" : "String",
+ "desc" : "The type of event to listen for",
"isOptional" : false
},
{
- "name" : "dd",
- "type" : "Roo.GridDD",
- "desc" : "The drag drop object",
+ "name" : "handler",
+ "type" : "Function",
+ "desc" : "The method the event invokes",
"isOptional" : false
},
{
- "name" : "targetId",
- "type" : "String",
- "desc" : "The target drag drop object",
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
"isOptional" : false
},
{
- "name" : "e",
- "type" : "event",
- "desc" : "The raw browser event",
+ "name" : "options",
+ "type" : "Object",
+ "desc" : "(optional)",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "dragenter",
+ "name" : "onEditorKey",
"type" : "function",
- "desc" : "Fires when the dragged row(s) first cross another DD target while being dragged",
- "sig" : "function (_self, dd, targetId, e)\n{\n\n}",
+ "desc" : "Selects a cell.",
+ "sig" : "(field, e)",
+ "static" : false,
"memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
- "name" : "this",
- "type" : "Grid",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "dd",
- "type" : "Roo.GridDD",
- "desc" : "The drag drop object",
- "isOptional" : false
- },
- {
- "name" : "targetId",
- "type" : "String",
- "desc" : "The target drag drop object",
+ "name" : "field",
+ "type" : "Number",
+ "desc" : "(not used) - as it's normally used as a listener",
"isOptional" : false
},
{
"name" : "e",
- "type" : "event",
- "desc" : "The raw browser event",
+ "type" : "Number",
+ "desc" : "- event - fake it by using\n\nvar e = Roo.EventObjectImpl.prototype;\ne.keyCode = e.TAB",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "dragout",
+ "name" : "purgeListeners",
"type" : "function",
- "desc" : "Fires when the dragged row(s) leave another DD target while being dragged",
- "sig" : "function (_self, dd, targetId, e)\n{\n\n}",
- "memberOf" : "",
+ "desc" : "Removes all listeners for this object",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.util.Observable",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Grid",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "dd",
- "type" : "Roo.GridDD",
- "desc" : "The drag drop object",
- "isOptional" : false
- },
- {
- "name" : "targetId",
- "type" : "String",
- "desc" : "The target drag drop object",
- "isOptional" : false
- },
- {
- "name" : "e",
- "type" : "event",
- "desc" : "The raw browser event",
- "isOptional" : false
- }
- ],
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
"returns" : []
},
{
- "name" : "dragover",
+ "name" : "releaseCapture",
"type" : "function",
- "desc" : "Fires while row(s) are being dragged. \"targetId\" is the id of the Yahoo.util.DD object the selected rows are being dragged over.",
- "sig" : "function (_self, dd, targetId, e)\n{\n\n}",
- "memberOf" : "",
+ "desc" : "Removes <b>all</b> added captures from the Observable.",
+ "sig" : "(o)",
+ "static" : true,
+ "memberOf" : "Roo.util.Observable",
+ "isStatic" : true,
+ "isConstructor" : false,
+ "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
- "name" : "this",
- "type" : "Grid",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "dd",
- "type" : "Roo.GridDD",
- "desc" : "The drag drop object",
- "isOptional" : false
- },
- {
- "name" : "targetId",
- "type" : "String",
- "desc" : "The target drag drop object",
- "isOptional" : false
- },
- {
- "name" : "e",
- "type" : "event",
- "desc" : "The raw browser event",
+ "name" : "o",
+ "type" : "Observable",
+ "desc" : "The Observable to release",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "enddrag",
+ "name" : "removeListener",
"type" : "function",
- "desc" : "Fires when a drag operation is complete",
- "sig" : "function (_self, dd, e)\n{\n\n}",
- "memberOf" : "",
+ "desc" : "Removes a listener",
+ "sig" : "(eventName, handler, scope)",
+ "static" : false,
+ "memberOf" : "Roo.util.Observable",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
- "name" : "this",
- "type" : "Grid",
- "desc" : "",
+ "name" : "eventName",
+ "type" : "String",
+ "desc" : "The type of event to listen for",
"isOptional" : false
},
{
- "name" : "dd",
- "type" : "Roo.GridDD",
- "desc" : "The drag drop object",
+ "name" : "handler",
+ "type" : "Function",
+ "desc" : "The handler to remove",
"isOptional" : false
},
{
- "name" : "e",
- "type" : "event",
- "desc" : "The raw browser event",
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "(optional) The scope (this object) for the handler",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "eventclick",
+ "name" : "select",
"type" : "function",
- "desc" : "Fires when the mouse click an",
- "sig" : "function (_self, )\n{\n\n}",
+ "desc" : "Selects a cell.",
+ "sig" : "(rowIndex, collIndex)",
+ "static" : false,
"memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
- "name" : "this",
- "type" : "Calendar",
+ "name" : "rowIndex",
+ "type" : "Number",
"desc" : "",
"isOptional" : false
},
{
- "name" : "",
- "type" : "event",
+ "name" : "collIndex",
+ "type" : "Number",
"desc" : "",
"isOptional" : false
}
"returns" : []
},
{
- "name" : "evententer",
+ "name" : "un",
"type" : "function",
- "desc" : "Fires when mouse over an event",
- "sig" : "function (_self, Event)\n{\n\n}",
- "memberOf" : "",
+ "desc" : "Removes a listener (shorthand for removeListener)",
+ "sig" : "(eventName, handler, scope)",
+ "static" : false,
+ "memberOf" : "Roo.util.Observable",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
- "name" : "this",
- "type" : "Calendar",
- "desc" : "",
+ "name" : "eventName",
+ "type" : "String",
+ "desc" : "The type of event to listen for",
"isOptional" : false
},
{
- "name" : "Event",
- "type" : "event",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "eventleave",
- "type" : "function",
- "desc" : "Fires when the mouse leaves an",
- "sig" : "function (_self, )\n{\n\n}",
- "memberOf" : "",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Calendar",
- "desc" : "",
+ "name" : "handler",
+ "type" : "Function",
+ "desc" : "The handler to remove",
"isOptional" : false
},
{
- "name" : "",
- "type" : "event",
- "desc" : "",
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "(optional) The scope (this object) for the handler",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "eventrender",
+ "name" : "unlock",
"type" : "function",
- "desc" : "Fires before each cell is rendered, so you can modify the contents, like cls / title / qtip",
- "sig" : "function (_self, data)\n{\n\n}",
- "memberOf" : "",
+ "desc" : "Unlocks the selections.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.grid.AbstractSelectionModel",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Calendar",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "data",
- "type" : "data",
- "desc" : "to be modified",
- "isOptional" : false
- }
- ],
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
"returns" : []
+ }
+ ],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "implementations" : [],
+ "tree_children" : [],
+ "tree_parent" : []
+ },
+ "Roo.grid.ColumnModel" : {
+ "props" : [
+ {
+ "name" : "align",
+ "type" : "String",
+ "desc" : "t) Set the CSS text-align property of the column. Defaults to undefined (left",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : [
+ "left",
+ "right"
+ ]
},
{
- "name" : "headerclick",
+ "name" : "cursor",
+ "type" : "String",
+ "desc" : "",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : [
+ "auto",
+ "default",
+ "none",
+ "context-menu",
+ "help",
+ "pointer",
+ "progress",
+ "wait",
+ "cell",
+ "crosshair",
+ "text",
+ "vertical-text",
+ "alias",
+ "copy",
+ "move",
+ "no-drop",
+ "not-allowed",
+ "e-resize",
+ "n-resize",
+ "ne-resize",
+ "nw-resize",
+ "s-resize",
+ "se-resize",
+ "sw-resize",
+ "w-resize",
+ "ew-resize",
+ "ns-resize",
+ "nesw-resize",
+ "nwse-resize",
+ "col-resize",
+ "row-resize",
+ "all-scroll",
+ "zoom-in",
+ "zoom-out",
+ "grab",
+ "grabbing"
+ ]
+ },
+ {
+ "name" : "dataIndex",
+ "type" : "String",
+ "desc" : "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" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "editor",
+ "type" : "Roo.grid.GridEditor",
+ "desc" : "For grid editors - returns the grid editor",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "fixed",
+ "type" : "Boolean",
+ "desc" : "True if the column width cannot be changed. Defaults to false.",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "header",
+ "type" : "String",
+ "desc" : "The header text to display in the Grid view.",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "hidden",
+ "type" : "Boolean",
+ "desc" : "True to hide the column. Defaults to false.",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "lg",
+ "type" : "Number",
+ "desc" : "can be '0' for hidden at this size (number less than 12)",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "lgHeader",
+ "type" : "String",
+ "desc" : "Header at Bootsrap Large width",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "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",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "locked",
+ "type" : "Boolean",
+ "desc" : "True to lock the column in place while scrolling the Grid. Defaults to false.",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "md",
+ "type" : "Number",
+ "desc" : "can be '0' for hidden at this size (number less than 12)",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "mdHeader",
+ "type" : "String",
+ "desc" : "Header at Bootsrap Medium width",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "renderer",
+ "type" : "Function",
+ "desc" : "A function used to generate HTML markup for a cell\ngiven the cell's data value. See {@link #setRenderer}. If not specified, the\ndefault renderer returns the escaped data value. If an object is returned (bootstrap only)\nthen it is treated as a Roo Component object instance, and it is rendered after the initial row is rendered",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "resizable",
+ "type" : "Boolean",
+ "desc" : "False to disable column resizing. Defaults to true.",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "sm",
+ "type" : "Number",
+ "desc" : "can be '0' for hidden at this size (number less than 12)",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "smHeader",
+ "type" : "String",
+ "desc" : "Header at Bootsrap Small width",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "sortable",
+ "type" : "Boolean",
+ "desc" : "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" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "tooltip",
+ "type" : "String",
+ "desc" : "mouse over tooltip text",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "valign",
+ "type" : "String",
+ "desc" : "e) Set the CSS vertical-align property of the column (eg. middle, top, bottom etc). Defaults to undefined (middl",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : [
+ "top",
+ "bottom",
+ "middle"
+ ]
+ },
+ {
+ "name" : "width",
+ "type" : "Number",
+ "desc" : "The initial width in pixels of the column. Using this\ninstead of {@link Roo.grid.Grid#autoSizeColumns} is more efficient.",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "xl",
+ "type" : "Number",
+ "desc" : "can be '0' for hidden at this size (number less than 12)",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "xlHeader",
+ "type" : "String",
+ "desc" : "Header at Bootsrap extra Large width",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "xs",
+ "type" : "Number",
+ "desc" : "can be '0' for hidden at this size (number less than 12)",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "xsHeader",
+ "type" : "String",
+ "desc" : "Header at Bootsrap Extra Small width (default for all)",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ }
+ ],
+ "events" : [
+ {
+ "name" : "columlockchange",
"type" : "function",
- "desc" : "Fires when a header is clicked",
- "sig" : "function (_self, columnIndex, e)\n{\n\n}",
+ "desc" : "Fires when a column's locked state is changed",
+ "sig" : "function (_self, colIndex, locked)\n{\n\n}",
"memberOf" : "",
"example" : "",
"deprecated" : "",
"params" : [
{
"name" : "this",
- "type" : "Grid",
+ "type" : "ColumnModel",
"desc" : "",
"isOptional" : false
},
{
- "name" : "columnIndex",
+ "name" : "colIndex",
"type" : "Number",
"desc" : "",
"isOptional" : false
},
{
- "name" : "e",
- "type" : "Roo.EventObject",
- "desc" : "",
+ "name" : "locked",
+ "type" : "Boolean",
+ "desc" : "true if locked",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "headercontextmenu",
+ "name" : "columnmoved",
"type" : "function",
- "desc" : "Fires when a header is right clicked",
- "sig" : "function (_self, columnIndex, e)\n{\n\n}",
+ "desc" : "Fires when a column is moved.",
+ "sig" : "function (_self, oldIndex, newIndex)\n{\n\n}",
"memberOf" : "",
"example" : "",
"deprecated" : "",
"params" : [
{
"name" : "this",
- "type" : "Grid",
+ "type" : "ColumnModel",
"desc" : "",
"isOptional" : false
},
{
- "name" : "columnIndex",
+ "name" : "oldIndex",
"type" : "Number",
"desc" : "",
"isOptional" : false
},
{
- "name" : "e",
- "type" : "Roo.EventObject",
+ "name" : "newIndex",
+ "type" : "Number",
"desc" : "",
"isOptional" : false
}
"returns" : []
},
{
- "name" : "headerdblclick",
+ "name" : "headerchange",
"type" : "function",
- "desc" : "Fires when a header cell is double clicked",
- "sig" : "function (_self, columnIndex, e)\n{\n\n}",
+ "desc" : "Fires when the text of a header changes.",
+ "sig" : "function (_self, columnIndex, newText)\n{\n\n}",
"memberOf" : "",
"example" : "",
"deprecated" : "",
"params" : [
{
"name" : "this",
- "type" : "Grid",
+ "type" : "ColumnModel",
"desc" : "",
"isOptional" : false
},
{
"name" : "columnIndex",
"type" : "Number",
- "desc" : "",
+ "desc" : "The column index",
"isOptional" : false
},
{
- "name" : "e",
- "type" : "Roo.EventObject",
- "desc" : "",
+ "name" : "newText",
+ "type" : "Number",
+ "desc" : "The new header text",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "keydown",
+ "name" : "hiddenchange",
"type" : "function",
- "desc" : "The raw keydown event for the entire grid.",
- "sig" : "function (e)\n{\n\n}",
+ "desc" : "Fires when a column is hidden or \"unhidden\".",
+ "sig" : "function (_self, columnIndex, hidden)\n{\n\n}",
"memberOf" : "",
"example" : "",
"deprecated" : "",
"see" : "",
"params" : [
{
- "name" : "e",
- "type" : "Roo.EventObject",
+ "name" : "this",
+ "type" : "ColumnModel",
"desc" : "",
"isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "keypress",
- "type" : "function",
- "desc" : "The raw keypress event for the entire grid.",
- "sig" : "function (e)\n{\n\n}",
- "memberOf" : "",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
+ },
{
- "name" : "e",
- "type" : "Roo.EventObject",
- "desc" : "",
+ "name" : "columnIndex",
+ "type" : "Number",
+ "desc" : "The column index",
+ "isOptional" : false
+ },
+ {
+ "name" : "hidden",
+ "type" : "Boolean",
+ "desc" : "true if hidden, false otherwise",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "monthchange",
+ "name" : "widthchange",
"type" : "function",
- "desc" : "Fires when the displayed month changes",
- "sig" : "function (_self, date)\n{\n\n}",
+ "desc" : "Fires when the width of a column changes.",
+ "sig" : "function (_self, columnIndex, newWidth)\n{\n\n}",
"memberOf" : "",
"example" : "",
"deprecated" : "",
"params" : [
{
"name" : "this",
- "type" : "DatePicker",
+ "type" : "ColumnModel",
"desc" : "",
"isOptional" : false
},
{
- "name" : "date",
- "type" : "Date",
- "desc" : "The selected month",
+ "name" : "columnIndex",
+ "type" : "Number",
+ "desc" : "The column index",
+ "isOptional" : false
+ },
+ {
+ "name" : "newWidth",
+ "type" : "Number",
+ "desc" : "The new width",
"isOptional" : false
}
],
"returns" : []
- },
+ }
+ ],
+ "methods" : [
{
- "name" : "mousedown",
+ "name" : "addColumn",
"type" : "function",
- "desc" : "The raw mousedown event for the entire grid.",
- "sig" : "function (e)\n{\n\n}",
+ "desc" : "Add a column (experimental...) - defaults to adding to the end..",
+ "sig" : "(config)",
+ "static" : false,
"memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
- "name" : "e",
- "type" : "Roo.EventObject",
+ "name" : "config",
+ "type" : "Object",
"desc" : "",
"isOptional" : false
}
"returns" : []
},
{
- "name" : "mouseout",
+ "name" : "addEvents",
"type" : "function",
- "desc" : "The raw mouseout event for the entire grid.",
- "sig" : "function (e)\n{\n\n}",
- "memberOf" : "",
+ "desc" : "Used to define events on this Observable",
+ "sig" : "(object)",
+ "static" : false,
+ "memberOf" : "Roo.util.Observable",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
- "name" : "e",
- "type" : "Roo.EventObject",
- "desc" : "",
+ "name" : "object",
+ "type" : "Object",
+ "desc" : "The object with the events defined",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "mouseover",
+ "name" : "addListener",
"type" : "function",
- "desc" : "The raw mouseover event for the entire grid.",
- "sig" : "function (e)\n{\n\n}",
- "memberOf" : "",
+ "desc" : "Appends an event handler to this component",
+ "sig" : "(eventName, handler, scope, options)",
+ "static" : false,
+ "memberOf" : "Roo.util.Observable",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
- "name" : "e",
- "type" : "Roo.EventObject",
- "desc" : "",
+ "name" : "eventName",
+ "type" : "String",
+ "desc" : "The type of event to listen for",
+ "isOptional" : false
+ },
+ {
+ "name" : "handler",
+ "type" : "Function",
+ "desc" : "The method the event invokes",
+ "isOptional" : false
+ },
+ {
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
+ "isOptional" : false
+ },
+ {
+ "name" : "options",
+ "type" : "Object",
+ "desc" : "(optional) An object containing handler configuration\nproperties. This may contain any of the following properties:<ul>\n<li>scope {Object} The scope in which to execute the handler function. The handler function's \"this\" context.</li>\n<li>delay {Number} The number of milliseconds to delay the invocation of the handler after te event fires.</li>\n<li>single {Boolean} True to add a handler to handle just the next firing of the event, and then remove itself.</li>\n<li>buffer {Number} Causes the handler to be scheduled to run in an {@link Roo.util.DelayedTask} delayed\nby the specified number of milliseconds. If the event fires again within that time, the original\nhandler is <em>not</em> invoked, but the new handler is scheduled in its place.</li>\n</ul><br>\n<p>\n<b>Combining Options</b><br>\nUsing the options argument, it is possible to combine different types of listeners:<br>\n<br>\nA normalized, delayed, one-time listener that auto stops the event and passes a custom argument (forumId)\n\t\t<pre><code>\n\t\tel.on('click', this.onClick, this, {\n \t\t\tsingle: true,\n \t\tdelay: 100,\n \t\tforumId: 4\n\t\t});\n\t\t</code></pre>\n<p>\n<b>Attaching multiple handlers in 1 call</b><br>\nThe method also allows for a single argument to be passed which is a config object containing properties\nwhich specify multiple handlers.\n<pre><code>\n\t\tel.on({\n\t\t\t'click': {\n \t\tfn: this.onClick,\n \t\tscope: this,\n \t\tdelay: 100\n \t\t}, \n \t\t'mouseover': {\n \t\tfn: this.onMouseOver,\n \t\tscope: this\n \t\t},\n \t\t'mouseout': {\n \t\tfn: this.onMouseOut,\n \t\tscope: this\n \t\t}\n\t\t});\n\t\t</code></pre>\n<p>\nOr a shorthand syntax which passes the same scope object to all handlers:\n \t<pre><code>\n\t\tel.on({\n\t\t\t'click': this.onClick,\n \t\t'mouseover': this.onMouseOver,\n \t\t'mouseout': this.onMouseOut,\n \t\tscope: this\n\t\t});\n\t\t</code></pre>",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "mouseup",
+ "name" : "capture",
"type" : "function",
- "desc" : "The raw mouseup event for the entire grid.",
- "sig" : "function (e)\n{\n\n}",
- "memberOf" : "",
+ "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\n<b>before</b> the event is fired. If the supplied function returns false,\nthe event will not fire.",
+ "sig" : "(o, fn, scope)",
+ "static" : true,
+ "memberOf" : "Roo.util.Observable",
+ "isStatic" : true,
+ "isConstructor" : false,
+ "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
- "name" : "e",
- "type" : "Roo.EventObject",
- "desc" : "",
+ "name" : "o",
+ "type" : "Observable",
+ "desc" : "The Observable to capture",
+ "isOptional" : false
+ },
+ {
+ "name" : "fn",
+ "type" : "Function",
+ "desc" : "The function to call",
+ "isOptional" : false
+ },
+ {
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "(optional) The scope (this object) for the fn",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "render",
+ "name" : "findColumnIndex",
"type" : "function",
- "desc" : "Fires when the grid is rendered",
- "sig" : "function (grid)\n{\n\n}",
+ "desc" : "Returns the index for a specified column dataIndex.",
+ "sig" : "(dataIndex)",
+ "static" : false,
"memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
- "name" : "grid",
- "type" : "Grid",
- "desc" : "",
+ "name" : "dataIndex",
+ "type" : "String",
+ "desc" : "The column dataIndex",
"isOptional" : false
}
],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Number",
+ "desc" : "the index, or -1 if not found"
+ }
+ ]
},
{
- "name" : "rowclass",
+ "name" : "fireEvent",
"type" : "function",
- "desc" : "Fires when a row is rendered, so you can change add a style to it.",
- "sig" : "function (gridview, rowcfg)\n{\n\n}",
- "memberOf" : "",
+ "desc" : "Fires the specified event with the passed parameters (minus the event name).",
+ "sig" : "(eventName, args)",
+ "static" : false,
+ "memberOf" : "Roo.util.Observable",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
- "name" : "gridview",
- "type" : "GridView",
- "desc" : "The grid view",
+ "name" : "eventName",
+ "type" : "String",
+ "desc" : "",
"isOptional" : false
},
{
- "name" : "rowcfg",
- "type" : "Object",
- "desc" : "contains record rowIndex and rowClass - set rowClass to add a style.",
+ "name" : "args",
+ "type" : "Object...",
+ "desc" : "Variable number of parameters are passed to handlers",
"isOptional" : false
}
],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Boolean",
+ "desc" : "returns false if any of the handlers return false otherwise it returns true"
+ }
+ ]
},
{
- "name" : "rowclick",
+ "name" : "getCellEditor",
"type" : "function",
- "desc" : "Fires when a row is clicked",
- "sig" : "function (_self, rowIndex, e)\n{\n\n}",
+ "desc" : "Returns the editor defined for the cell/column.\nreturn false or null to disable editing.",
+ "sig" : "(colIndex, rowIndex)",
+ "static" : false,
"memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
- "name" : "this",
- "type" : "Grid",
- "desc" : "",
+ "name" : "colIndex",
+ "type" : "Number",
+ "desc" : "The column index",
"isOptional" : false
},
{
"name" : "rowIndex",
"type" : "Number",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "e",
- "type" : "Roo.EventObject",
- "desc" : "",
+ "desc" : "The row index",
"isOptional" : false
}
],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Object",
+ "desc" : ""
+ }
+ ]
},
{
- "name" : "rowcontextmenu",
+ "name" : "getColumnByDataIndex",
"type" : "function",
- "desc" : "Fires when a row is right clicked",
- "sig" : "function (_self, rowIndex, e)\n{\n\n}",
+ "desc" : "Returns the column Object for a specified dataIndex.",
+ "sig" : "(dataIndex)",
+ "static" : false,
"memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
- "name" : "this",
- "type" : "Grid",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "rowIndex",
- "type" : "Number",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "e",
- "type" : "Roo.EventObject",
- "desc" : "",
+ "name" : "dataIndex",
+ "type" : "String",
+ "desc" : "The column dataIndex",
"isOptional" : false
}
],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Object|Boolean",
+ "desc" : "the column or false if not found"
+ }
+ ]
},
{
- "name" : "rowdblclick",
+ "name" : "getColumnById",
"type" : "function",
- "desc" : "Fires when a row is double clicked",
- "sig" : "function (_self, rowIndex, e)\n{\n\n}",
+ "desc" : "Returns the column for a specified id.",
+ "sig" : "(id)",
+ "static" : false,
"memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
- "name" : "this",
- "type" : "Grid",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "rowIndex",
- "type" : "Number",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "e",
- "type" : "Roo.EventObject",
- "desc" : "",
+ "name" : "id",
+ "type" : "String",
+ "desc" : "The column id",
"isOptional" : false
}
],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Object",
+ "desc" : "the column"
+ }
+ ]
},
{
- "name" : "select",
+ "name" : "getColumnCount",
"type" : "function",
- "desc" : "Fires when a date is selected",
- "sig" : "function (_self, date)\n{\n\n}",
+ "desc" : "Returns the number of columns.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
"memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "DatePicker",
- "desc" : "",
- "isOptional" : false
- },
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : [
{
- "name" : "date",
- "type" : "Date",
- "desc" : "The selected date",
- "isOptional" : false
+ "name" : "",
+ "type" : "Number",
+ "desc" : ""
}
- ],
- "returns" : []
+ ]
},
{
- "name" : "startdrag",
+ "name" : "getColumnHeader",
"type" : "function",
- "desc" : "Fires when row(s) start being dragged",
- "sig" : "function (_self, dd, e)\n{\n\n}",
+ "desc" : "Returns the header for the specified column.",
+ "sig" : "(col)",
+ "static" : false,
"memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
- "name" : "this",
- "type" : "Grid",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "dd",
- "type" : "Roo.GridDD",
- "desc" : "The drag drop object",
- "isOptional" : false
- },
- {
- "name" : "e",
- "type" : "event",
- "desc" : "The raw browser event",
+ "name" : "col",
+ "type" : "Number",
+ "desc" : "The column index",
"isOptional" : false
}
],
- "returns" : []
- }
- ],
- "methods" : [
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "String",
+ "desc" : ""
+ }
+ ]
+ },
{
- "name" : "addColumns",
+ "name" : "getColumnId",
"type" : "function",
- "desc" : "addColumns\nAdd's a column, default at the end..",
- "sig" : "(position, of)",
+ "desc" : "Returns the id of the column at the specified index.",
+ "sig" : "(index)",
"static" : false,
- "memberOf" : "Roo.grid.Grid",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "position",
- "type" : "int",
- "desc" : "to add (default end)",
- "isOptional" : false
- },
- {
- "name" : "of",
- "type" : "Array",
- "desc" : "objects of column configuration see {@link Roo.grid.ColumnModel}",
+ "name" : "index",
+ "type" : "Number",
+ "desc" : "The column index",
"isOptional" : false
}
],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "String",
+ "desc" : "the id"
+ }
+ ]
},
{
- "name" : "addEvents",
+ "name" : "getColumnTooltip",
"type" : "function",
- "desc" : "Used to define events on this Observable",
- "sig" : "(object)",
+ "desc" : "Returns the tooltip for the specified column.",
+ "sig" : "(col)",
"static" : false,
- "memberOf" : "Roo.util.Observable",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "object",
- "type" : "Object",
- "desc" : "The object with the events defined",
+ "name" : "col",
+ "type" : "Number",
+ "desc" : "The column index",
"isOptional" : false
}
],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "String",
+ "desc" : ""
+ }
+ ]
},
{
- "name" : "addListener",
+ "name" : "getColumnWidth",
"type" : "function",
- "desc" : "Appends an event handler to this component",
- "sig" : "(eventName, handler, scope, options)",
+ "desc" : "Returns the width for the specified column.",
+ "sig" : "(col, (optional))",
"static" : false,
- "memberOf" : "Roo.util.Observable",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "eventName",
- "type" : "String",
- "desc" : "The type of event to listen for",
- "isOptional" : false
- },
- {
- "name" : "handler",
- "type" : "Function",
- "desc" : "The method the event invokes",
- "isOptional" : false
- },
- {
- "name" : "scope",
- "type" : "Object",
- "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
+ "name" : "col",
+ "type" : "Number",
+ "desc" : "The column index",
"isOptional" : false
},
{
- "name" : "options",
- "type" : "Object",
- "desc" : "(optional) An object containing handler configuration\nproperties. This may contain any of the following properties:<ul>\n<li>scope {Object} The scope in which to execute the handler function. The handler function's \"this\" context.</li>\n<li>delay {Number} The number of milliseconds to delay the invocation of the handler after te event fires.</li>\n<li>single {Boolean} True to add a handler to handle just the next firing of the event, and then remove itself.</li>\n<li>buffer {Number} Causes the handler to be scheduled to run in an {@link Roo.util.DelayedTask} delayed\nby the specified number of milliseconds. If the event fires again within that time, the original\nhandler is <em>not</em> invoked, but the new handler is scheduled in its place.</li>\n</ul><br>\n<p>\n<b>Combining Options</b><br>\nUsing the options argument, it is possible to combine different types of listeners:<br>\n<br>\nA normalized, delayed, one-time listener that auto stops the event and passes a custom argument (forumId)\n\t\t<pre><code>\n\t\tel.on('click', this.onClick, this, {\n \t\t\tsingle: true,\n \t\tdelay: 100,\n \t\tforumId: 4\n\t\t});\n\t\t</code></pre>\n<p>\n<b>Attaching multiple handlers in 1 call</b><br>\nThe method also allows for a single argument to be passed which is a config object containing properties\nwhich specify multiple handlers.\n<pre><code>\n\t\tel.on({\n\t\t\t'click': {\n \t\tfn: this.onClick,\n \t\tscope: this,\n \t\tdelay: 100\n \t\t}, \n \t\t'mouseover': {\n \t\tfn: this.onMouseOver,\n \t\tscope: this\n \t\t},\n \t\t'mouseout': {\n \t\tfn: this.onMouseOut,\n \t\tscope: this\n \t\t}\n\t\t});\n\t\t</code></pre>\n<p>\nOr a shorthand syntax which passes the same scope object to all handlers:\n \t<pre><code>\n\t\tel.on({\n\t\t\t'click': this.onClick,\n \t\t'mouseover': this.onMouseOver,\n \t\t'mouseout': this.onMouseOut,\n \t\tscope: this\n\t\t});\n\t\t</code></pre>",
+ "name" : "(optional)",
+ "type" : "",
+ "desc" : "{String} gridSize bootstrap width size.",
"isOptional" : false
}
],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Number",
+ "desc" : ""
+ }
+ ]
},
{
- "name" : "autoSize",
+ "name" : "getColumnsBy",
"type" : "function",
- "desc" : "Causes the grid to manually recalculate its dimensions. Generally this is done automatically,\nbut if manual update is required this method will initiate it.",
- "sig" : "()\n{\n\n}",
+ "desc" : "Returns the column configs that return true by the passed function that is called with (columnConfig, index)",
+ "sig" : "(fn, scope)",
"static" : false,
- "memberOf" : "Roo.grid.Grid",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
- "returns" : []
- },
- {
- "name" : "capture",
- "type" : "function",
- "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\n<b>before</b> the event is fired. If the supplied function returns false,\nthe event will not fire.",
- "sig" : "(o, fn, scope)",
- "static" : true,
- "memberOf" : "Roo.util.Observable",
- "isStatic" : true,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
"params" : [
- {
- "name" : "o",
- "type" : "Observable",
- "desc" : "The Observable to capture",
- "isOptional" : false
- },
{
"name" : "fn",
"type" : "Function",
- "desc" : "The function to call",
+ "desc" : "",
"isOptional" : false
},
{
"name" : "scope",
"type" : "Object",
- "desc" : "(optional) The scope (this object) for the fn",
+ "desc" : "(optional)",
"isOptional" : false
}
],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Array",
+ "desc" : "result"
+ }
+ ]
},
{
- "name" : "destroy",
+ "name" : "getDataIndex",
"type" : "function",
- "desc" : "Destroy this grid.",
- "sig" : "(removeEl)",
+ "desc" : "Returns the dataIndex for the specified column.",
+ "sig" : "(col)",
"static" : false,
- "memberOf" : "Roo.grid.Grid",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "removeEl",
- "type" : "Boolean",
- "desc" : "True to remove the element",
+ "name" : "col",
+ "type" : "Number",
+ "desc" : "The column index",
"isOptional" : false
}
],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Number",
+ "desc" : ""
+ }
+ ]
},
{
- "name" : "fireEvent",
+ "name" : "getIndexById",
"type" : "function",
- "desc" : "Fires the specified event with the passed parameters (minus the event name).",
- "sig" : "(eventName, args)",
+ "desc" : "Returns the index for a specified column id.",
+ "sig" : "(id)",
"static" : false,
- "memberOf" : "Roo.util.Observable",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "eventName",
+ "name" : "id",
"type" : "String",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "args",
- "type" : "Object...",
- "desc" : "Variable number of parameters are passed to handlers",
+ "desc" : "The column id",
"isOptional" : false
}
],
"returns" : [
{
"name" : "",
- "type" : "Boolean",
- "desc" : "returns false if any of the handlers return false otherwise it returns true"
+ "type" : "Number",
+ "desc" : "the index, or -1 if not found"
}
]
},
{
- "name" : "getColumnModel",
+ "name" : "getRenderer",
"type" : "function",
- "desc" : "Returns the grid's ColumnModel.",
- "sig" : "()\n{\n\n}",
+ "desc" : "Returns the rendering (formatting) function defined for the column.",
+ "sig" : "(col)",
"static" : false,
- "memberOf" : "Roo.grid.Grid",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
+ "params" : [
+ {
+ "name" : "col",
+ "type" : "Number",
+ "desc" : "The column index.",
+ "isOptional" : false
+ }
+ ],
"returns" : [
{
"name" : "",
- "type" : "ColumnModel",
- "desc" : ""
+ "type" : "Function",
+ "desc" : "The function used to render the cell. See {@link #setRenderer}."
}
]
},
{
- "name" : "getDataSource",
+ "name" : "getTotalWidth",
"type" : "function",
- "desc" : "Returns the grid's DataSource.",
- "sig" : "()\n{\n\n}",
+ "desc" : "Returns the total width of all columns.",
+ "sig" : "(includeHidden)",
"static" : false,
- "memberOf" : "Roo.grid.Grid",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
+ "params" : [
+ {
+ "name" : "includeHidden",
+ "type" : "Boolean",
+ "desc" : "True to include hidden column widths",
+ "isOptional" : false
+ }
+ ],
"returns" : [
{
"name" : "",
- "type" : "DataSource",
+ "type" : "Number",
"desc" : ""
}
]
},
{
- "name" : "getDragDropText",
+ "name" : "hasListener",
"type" : "function",
- "desc" : "Called to get grid's drag proxy text, by default returns this.ddText.\nOverride this to put something different in the dragged text.",
- "sig" : "()\n{\n\n}",
+ "desc" : "Checks to see if this object has any listeners for a specified event",
+ "sig" : "(eventName)",
"static" : false,
- "memberOf" : "Roo.grid.Grid",
+ "memberOf" : "Roo.util.Observable",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
+ "params" : [
+ {
+ "name" : "eventName",
+ "type" : "String",
+ "desc" : "The name of the event to check for",
+ "isOptional" : false
+ }
+ ],
"returns" : [
{
"name" : "",
- "type" : "String",
- "desc" : ""
+ "type" : "Boolean",
+ "desc" : "True if the event is being listened for, else false"
}
]
},
{
- "name" : "getGridEl",
+ "name" : "isCellEditable",
"type" : "function",
- "desc" : "Returns the grid's underlying element.",
- "sig" : "()\n{\n\n}",
+ "desc" : "Returns true if the cell is editable.",
+ "sig" : "(colIndex, rowIndex)",
"static" : false,
- "memberOf" : "Roo.grid.Grid",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
+ "params" : [
+ {
+ "name" : "colIndex",
+ "type" : "Number",
+ "desc" : "The column index",
+ "isOptional" : false
+ },
+ {
+ "name" : "rowIndex",
+ "type" : "Number",
+ "desc" : "The row index - this is nto actually used..?",
+ "isOptional" : false
+ }
+ ],
"returns" : [
{
"name" : "",
- "type" : "Element",
- "desc" : "The element"
+ "type" : "Boolean",
+ "desc" : ""
}
]
},
{
- "name" : "getSelectionModel",
+ "name" : "isFixed",
"type" : "function",
- "desc" : "Returns the grid's SelectionModel.",
+ "desc" : "Returns true if the column width cannot be changed",
"sig" : "()\n{\n\n}",
"static" : false,
"memberOf" : "",
"exceptions" : "",
"requires" : "",
"params" : [],
+ "returns" : []
+ },
+ {
+ "name" : "isHidden",
+ "type" : "function",
+ "desc" : "Returns true if the column is hidden.",
+ "sig" : "(colIndex)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "colIndex",
+ "type" : "Number",
+ "desc" : "The column index",
+ "isOptional" : false
+ }
+ ],
"returns" : [
{
"name" : "",
- "type" : "SelectionModel",
+ "type" : "Boolean",
"desc" : ""
}
]
},
{
- "name" : "getView",
+ "name" : "isResizable",
"type" : "function",
- "desc" : "Returns the grid's GridView object.",
+ "desc" : "Returns true if the column can be resized",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.grid.Grid",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"returns" : [
{
"name" : "",
- "type" : "GridView",
+ "type" : "Boolean",
"desc" : ""
}
]
},
{
- "name" : "hasListener",
+ "name" : "isSortable",
"type" : "function",
- "desc" : "Checks to see if this object has any listeners for a specified event",
- "sig" : "(eventName)",
+ "desc" : "Returns true if the specified column is sortable.",
+ "sig" : "(col)",
"static" : false,
- "memberOf" : "Roo.util.Observable",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "eventName",
- "type" : "String",
- "desc" : "The name of the event to check for",
+ "name" : "col",
+ "type" : "Number",
+ "desc" : "The column index",
"isOptional" : false
}
],
{
"name" : "",
"type" : "Boolean",
- "desc" : "True if the event is being listened for, else false"
+ "desc" : ""
}
]
},
"params" : [],
"returns" : []
},
- {
- "name" : "reconfigure",
- "type" : "function",
- "desc" : "Reconfigures the grid to use a different Store and Column Model.\nThe View will be bound to the new objects and refreshed.",
- "sig" : "(dataSource, The)",
- "static" : false,
- "memberOf" : "Roo.grid.Grid",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "dataSource",
- "type" : "Roo.data.Store",
- "desc" : "The new {@link Roo.data.Store} object",
- "isOptional" : false
- },
- {
- "name" : "The",
- "type" : "Roo.grid.ColumnModel",
- "desc" : "new {@link Roo.grid.ColumnModel} object",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
{
"name" : "releaseCapture",
"type" : "function",
"returns" : []
},
{
- "name" : "render",
+ "name" : "setColumnHeader",
"type" : "function",
- "desc" : "Called once after all setup has been completed and the grid is ready to be rendered.",
- "sig" : "()\n{\n\n}",
+ "desc" : "Sets the header for a column.",
+ "sig" : "(col, header)",
"static" : false,
- "memberOf" : "Roo.grid.Grid",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
- "returns" : [
+ "params" : [
{
- "name" : "",
- "type" : "Roo.grid.Grid",
- "desc" : "this"
+ "name" : "col",
+ "type" : "Number",
+ "desc" : "The column index",
+ "isOptional" : false
+ },
+ {
+ "name" : "header",
+ "type" : "String",
+ "desc" : "The new header",
+ "isOptional" : false
}
- ]
+ ],
+ "returns" : []
},
{
- "name" : "un",
+ "name" : "setColumnTooltip",
"type" : "function",
- "desc" : "Removes a listener (shorthand for removeListener)",
- "sig" : "(eventName, handler, scope)",
+ "desc" : "Sets the tooltip for a column.",
+ "sig" : "(col, tooltip)",
"static" : false,
- "memberOf" : "Roo.util.Observable",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "eventName",
- "type" : "String",
- "desc" : "The type of event to listen for",
- "isOptional" : false
- },
- {
- "name" : "handler",
- "type" : "Function",
- "desc" : "The handler to remove",
+ "name" : "col",
+ "type" : "Number",
+ "desc" : "The column index",
"isOptional" : false
},
{
- "name" : "scope",
- "type" : "Object",
- "desc" : "(optional) The scope (this object) for the handler",
+ "name" : "tooltip",
+ "type" : "String",
+ "desc" : "The new tooltip",
"isOptional" : false
}
],
"returns" : []
- }
- ],
- "isAbstract" : false,
- "isBuilderTop" : false,
- "childClasses" : { },
- "tree_children" : [],
- "tree_parent" : []
- },
- "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" : "beforeeditnext",
+ "name" : "setColumnWidth",
"type" : "function",
- "desc" : "Fires before the next editable sell is made active\nYou can use this to skip to another cell or fire the tabend\n if you set cell to false",
- "sig" : "function (eventdata)\n{\n\n}",
+ "desc" : "Sets the width for a column.",
+ "sig" : "(col, width)",
+ "static" : false,
"memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
- "name" : "eventdata",
- "type" : "Object",
- "desc" : "object : { cell : [ row, col ] }",
+ "name" : "col",
+ "type" : "Number",
+ "desc" : "The column index",
+ "isOptional" : false
+ },
+ {
+ "name" : "width",
+ "type" : "Number",
+ "desc" : "The new width",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "beforerowselect",
+ "name" : "setDataIndex",
"type" : "function",
- "desc" : "Fires before a cell is selected.",
- "sig" : "function (_self, rowIndex, colIndex)\n{\n\n}",
+ "desc" : "Sets the dataIndex for a column.",
+ "sig" : "(col, dataIndex)",
+ "static" : false,
"memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
- "name" : "this",
- "type" : "SelectionModel",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "rowIndex",
+ "name" : "col",
"type" : "Number",
- "desc" : "The selected row index",
+ "desc" : "The column index",
"isOptional" : false
},
{
- "name" : "colIndex",
+ "name" : "dataIndex",
"type" : "Number",
- "desc" : "The selected cell index",
+ "desc" : "The new dataIndex",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "cellselect",
+ "name" : "setEditable",
"type" : "function",
- "desc" : "Fires when a cell is selected.",
- "sig" : "function (_self, rowIndex, colIndex)\n{\n\n}",
+ "desc" : "Sets if a column is editable.",
+ "sig" : "(col, editable)",
+ "static" : false,
"memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
- "name" : "this",
- "type" : "SelectionModel",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "rowIndex",
+ "name" : "col",
"type" : "Number",
- "desc" : "The selected row index",
+ "desc" : "The column index",
"isOptional" : false
},
{
- "name" : "colIndex",
- "type" : "Number",
- "desc" : "The selected cell index",
+ "name" : "editable",
+ "type" : "Boolean",
+ "desc" : "True if the column is editable",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "selectionchange",
+ "name" : "setEditor",
"type" : "function",
- "desc" : "Fires when the active selection changes.",
- "sig" : "function (_self, selection)\n{\n\n}",
+ "desc" : "Sets the editor for a column.",
+ "sig" : "(col, editor)",
+ "static" : false,
"memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
- "name" : "this",
- "type" : "SelectionModel",
- "desc" : "",
+ "name" : "col",
+ "type" : "Number",
+ "desc" : "The column index",
"isOptional" : false
},
{
- "name" : "selection",
+ "name" : "editor",
"type" : "Object",
- "desc" : "null for no selection or an object (o) with two properties\n\t <ul>\n\t <li>o.record: the record object for the row the selection is in</li>\n\t <li>o.cell: An array of [rowIndex, columnIndex]</li>\n\t </ul>",
+ "desc" : "The editor object",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "tabend",
+ "name" : "setHidden",
"type" : "function",
- "desc" : "Fires when the tab (or enter) was pressed on the last editable cell\nYou can use this to trigger add new row.",
- "sig" : "function (_self)\n{\n\n}",
+ "desc" : "Sets if a column is hidden.",
+ "sig" : "(colIndex, hidden)",
+ "static" : false,
"memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
- "name" : "this",
- "type" : "SelectionModel",
- "desc" : "",
+ "name" : "colIndex",
+ "type" : "Number",
+ "desc" : "The column index",
+ "isOptional" : false
+ },
+ {
+ "name" : "hidden",
+ "type" : "Boolean",
+ "desc" : "True if the column is hidden",
"isOptional" : false
}
],
"returns" : []
- }
- ],
- "methods" : [
+ },
{
- "name" : "addEvents",
+ "name" : "setRenderer",
"type" : "function",
- "desc" : "Used to define events on this Observable",
- "sig" : "(object)",
+ "desc" : "Sets the rendering (formatting) function for a column.",
+ "sig" : "(col, fn)",
"static" : false,
- "memberOf" : "Roo.util.Observable",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "object",
- "type" : "Object",
- "desc" : "The object with the events defined",
+ "name" : "col",
+ "type" : "Number",
+ "desc" : "The column index",
+ "isOptional" : false
+ },
+ {
+ "name" : "fn",
+ "type" : "Function",
+ "desc" : "The function to use to process the cell's raw data\nto return HTML markup for the grid view. The render function is called with\nthe following parameters:<ul>\n<li>Data value.</li>\n<li>Cell metadata. An object in which you may set the following attributes:<ul>\n<li>css A CSS style string to apply to the table cell.</li>\n<li>attr An HTML attribute definition string to apply to the data container element <i>within</i> the table cell.</li></ul>\n<li>The {@link Roo.data.Record} from which the data was extracted.</li>\n<li>Row index</li>\n<li>Column index</li>\n<li>The {@link Roo.data.Store} object from which the Record was extracted</li></ul>",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "addListener",
+ "name" : "un",
"type" : "function",
- "desc" : "Appends an event handler to this component",
- "sig" : "(eventName, handler, scope, options)",
+ "desc" : "Removes a listener (shorthand for removeListener)",
+ "sig" : "(eventName, handler, scope)",
"static" : false,
"memberOf" : "Roo.util.Observable",
"isStatic" : false,
{
"name" : "handler",
"type" : "Function",
- "desc" : "The method the event invokes",
+ "desc" : "The handler to remove",
"isOptional" : false
},
{
"name" : "scope",
"type" : "Object",
- "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
- "isOptional" : false
- },
- {
- "name" : "options",
- "type" : "Object",
- "desc" : "(optional) An object containing handler configuration\nproperties. This may contain any of the following properties:<ul>\n<li>scope {Object} The scope in which to execute the handler function. The handler function's \"this\" context.</li>\n<li>delay {Number} The number of milliseconds to delay the invocation of the handler after te event fires.</li>\n<li>single {Boolean} True to add a handler to handle just the next firing of the event, and then remove itself.</li>\n<li>buffer {Number} Causes the handler to be scheduled to run in an {@link Roo.util.DelayedTask} delayed\nby the specified number of milliseconds. If the event fires again within that time, the original\nhandler is <em>not</em> invoked, but the new handler is scheduled in its place.</li>\n</ul><br>\n<p>\n<b>Combining Options</b><br>\nUsing the options argument, it is possible to combine different types of listeners:<br>\n<br>\nA normalized, delayed, one-time listener that auto stops the event and passes a custom argument (forumId)\n\t\t<pre><code>\n\t\tel.on('click', this.onClick, this, {\n \t\t\tsingle: true,\n \t\tdelay: 100,\n \t\tforumId: 4\n\t\t});\n\t\t</code></pre>\n<p>\n<b>Attaching multiple handlers in 1 call</b><br>\nThe method also allows for a single argument to be passed which is a config object containing properties\nwhich specify multiple handlers.\n<pre><code>\n\t\tel.on({\n\t\t\t'click': {\n \t\tfn: this.onClick,\n \t\tscope: this,\n \t\tdelay: 100\n \t\t}, \n \t\t'mouseover': {\n \t\tfn: this.onMouseOver,\n \t\tscope: this\n \t\t},\n \t\t'mouseout': {\n \t\tfn: this.onMouseOut,\n \t\tscope: this\n \t\t}\n\t\t});\n\t\t</code></pre>\n<p>\nOr a shorthand syntax which passes the same scope object to all handlers:\n \t<pre><code>\n\t\tel.on({\n\t\t\t'click': this.onClick,\n \t\t'mouseover': this.onMouseOver,\n \t\t'mouseout': this.onMouseOut,\n \t\tscope: this\n\t\t});\n\t\t</code></pre>",
+ "desc" : "(optional) The scope (this object) for the handler",
"isOptional" : false
}
],
"returns" : []
+ }
+ ],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "implementations" : [],
+ "tree_children" : [],
+ "tree_parent" : []
+ },
+ "Roo.grid.EditorGrid" : {
+ "props" : [
+ {
+ "name" : "autoExpandColumn",
+ "type" : "String",
+ "desc" : "The id (or dataIndex) of a column in this grid that should expand to fill unused space. This id can not be 0. Default is false.",
+ "memberOf" : "Roo.grid.Grid",
+ "isOptional" : false,
+ "optvals" : []
},
{
- "name" : "capture",
- "type" : "function",
- "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\n<b>before</b> the event is fired. If the supplied function returns false,\nthe event will not fire.",
- "sig" : "(o, fn, scope)",
- "static" : true,
+ "name" : "autoExpandMax",
+ "type" : "Number",
+ "desc" : "The maximum width the autoExpandColumn can have (if enabled). Default is 1000.",
+ "memberOf" : "Roo.grid.Grid",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "autoExpandMin",
+ "type" : "Number",
+ "desc" : "The minimum width the autoExpandColumn can have (if enabled).\nDefault is 50.",
+ "memberOf" : "Roo.grid.Grid",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "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",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "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",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "autoSizeHeaders",
+ "type" : "Boolean",
+ "desc" : "True to measure headers with column data when auto sizing columns. Default is true.",
+ "memberOf" : "Roo.grid.Grid",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "autoWidth",
+ "type" : "Boolean",
+ "desc" : "True to set the grid's width to the default total width of the grid's columns instead\nof a fixed width. Default is false.",
+ "memberOf" : "Roo.grid.Grid",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "clicksToEdit",
+ "type" : "Number",
+ "desc" : "The number of clicks on a cell required to display the cell's editor (defaults to 2)",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "cm[]",
+ "type" : "Roo.grid.ColumnModel",
+ "desc" : "The columns of the grid",
+ "memberOf" : "Roo.grid.Grid",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "ddGroup",
+ "type" : "String",
+ "desc" : "- drag drop group.",
+ "memberOf" : "Roo.grid.Grid",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "ddText",
+ "type" : "String",
+ "desc" : "Configures the text is the drag proxy (defaults to \"%0 selected row(s)\").\n%0 is replaced with the number of selected rows.",
+ "memberOf" : "Roo.grid.Grid",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "dragGroup",
+ "type" : "String",
+ "desc" : "- drag group (?? not sure if needed.)",
+ "memberOf" : "Roo.grid.Grid",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "dropTarget",
+ "type" : "Roo.dd.DropTarget",
+ "desc" : "An {@link Roo.dd.DropTarget} config",
+ "memberOf" : "Roo.grid.Grid",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "ds",
+ "type" : "Roo.data.Store",
+ "desc" : "The data store for the grid",
+ "memberOf" : "Roo.grid.Grid",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "enableColumnHide",
+ "type" : "Boolean",
+ "desc" : "True to enable hiding of columns with the header context menu. Default is true.",
+ "memberOf" : "Roo.grid.Grid",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "enableColumnMove",
+ "type" : "Boolean",
+ "desc" : "True to enable drag and drop reorder of columns. Default is true.",
+ "memberOf" : "Roo.grid.Grid",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "enableDrag",
+ "type" : "Boolean",
+ "desc" : "True to enable drag of rows. Default is false. (double check if this is needed?)",
+ "memberOf" : "Roo.grid.Grid",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "enableDragDrop",
+ "type" : "Boolean",
+ "desc" : "True to enable drag and drop of rows. Default is false.",
+ "memberOf" : "Roo.grid.Grid",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "enableDrop",
+ "type" : "Boolean",
+ "desc" : "True to enable drop of elements. Default is false. (double check if this is needed?)",
+ "memberOf" : "Roo.grid.Grid",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "enableRowHeightSync",
+ "type" : "Boolean",
+ "desc" : "True to manually sync row heights across locked and not locked rows. Default is false.",
+ "memberOf" : "Roo.grid.Grid",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "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",
- "isStatic" : true,
- "isConstructor" : false,
- "isPrivate" : false,
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "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",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "maxHeight",
+ "type" : "Number",
+ "desc" : "Sets the maximum height of the grid - ignored if autoHeight is not on.",
+ "memberOf" : "Roo.grid.Grid",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "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",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "minColumnWidth",
+ "type" : "Number",
+ "desc" : "The minimum width a column can be resized to. Default is 25.",
+ "memberOf" : "Roo.grid.Grid",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "monitorWindowResize",
+ "type" : "Boolean",
+ "desc" : "True to autoSize the grid when the window resizes. Default is true.",
+ "memberOf" : "Roo.grid.Grid",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "sm",
+ "type" : "Roo.grid.AbstractSelectionModel",
+ "desc" : "The selection Model (default = Roo.grid.RowSelectionModel)",
+ "memberOf" : "Roo.grid.Grid",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "sortColMenu",
+ "type" : "boolean",
+ "desc" : "Sort the column order menu when it shows (usefull for long lists..) default false",
+ "memberOf" : "Roo.grid.Grid",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "stripeRows",
+ "type" : "Boolean",
+ "desc" : "True to stripe the rows. Default is true.",
+ "memberOf" : "Roo.grid.Grid",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "toolbar",
+ "type" : "Roo.Toolbar",
+ "desc" : "a toolbar for buttons etc.",
+ "memberOf" : "Roo.grid.Grid",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "trackMouseOver",
+ "type" : "Boolean",
+ "desc" : "True to highlight rows when the mouse is over. Default is true.",
+ "memberOf" : "Roo.grid.Grid",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "view",
+ "type" : "Roo.grid.GridView",
+ "desc" : "The view that renders the grid (default = Roo.grid.GridView)",
+ "memberOf" : "Roo.grid.Grid",
+ "isOptional" : false,
+ "optvals" : []
+ }
+ ],
+ "events" : [
+ {
+ "name" : "afteredit",
+ "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>",
+ "sig" : "function (e)\n{\n\n}",
+ "memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
"params" : [
{
- "name" : "o",
- "type" : "Observable",
- "desc" : "The Observable to capture",
- "isOptional" : false
- },
- {
- "name" : "fn",
- "type" : "Function",
- "desc" : "The function to call",
- "isOptional" : false
- },
- {
- "name" : "scope",
+ "name" : "e",
"type" : "Object",
- "desc" : "(optional) The scope (this object) for the fn",
+ "desc" : "An edit event (see above for description)",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "clearSelections",
+ "name" : "beforeedit",
"type" : "function",
- "desc" : "Clears all selections.",
- "sig" : "(true)",
- "static" : false,
+ "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>",
+ "sig" : "function (e)\n{\n\n}",
"memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
"params" : [
{
- "name" : "true",
- "type" : "Boolean",
- "desc" : "to prevent the gridview from being notified about the change.",
+ "name" : "e",
+ "type" : "Object",
+ "desc" : "An edit event (see above for description)",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "fireEvent",
+ "name" : "bodyscroll",
"type" : "function",
- "desc" : "Fires the specified event with the passed parameters (minus the event name).",
- "sig" : "(eventName, args)",
- "static" : false,
- "memberOf" : "Roo.util.Observable",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
+ "desc" : "Fires when the body element is scrolled",
+ "sig" : "function (scrollLeft, scrollTop)\n{\n\n}",
+ "memberOf" : "Roo.grid.Grid",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
"params" : [
{
- "name" : "eventName",
- "type" : "String",
+ "name" : "scrollLeft",
+ "type" : "Number",
"desc" : "",
"isOptional" : false
},
{
- "name" : "args",
- "type" : "Object...",
- "desc" : "Variable number of parameters are passed to handlers",
+ "name" : "scrollTop",
+ "type" : "Number",
+ "desc" : "",
"isOptional" : false
}
],
- "returns" : [
- {
- "name" : "",
- "type" : "Boolean",
- "desc" : "returns false if any of the handlers return false otherwise it returns true"
- }
- ]
+ "returns" : []
},
{
- "name" : "getSelectedCell",
+ "name" : "cellclick",
"type" : "function",
- "desc" : "Returns the currently selected cell,.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
+ "desc" : "Fires when a cell is clicked",
+ "sig" : "function (_self, rowIndex, columnIndex, e)\n{\n\n}",
+ "memberOf" : "Roo.grid.Grid",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : [
+ "params" : [
{
- "name" : "",
- "type" : "Array",
- "desc" : "The selected cell (row, column) or null if none selected."
+ "name" : "this",
+ "type" : "Grid",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "rowIndex",
+ "type" : "Number",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "columnIndex",
+ "type" : "Number",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "e",
+ "type" : "Roo.EventObject",
+ "desc" : "",
+ "isOptional" : false
}
- ]
+ ],
+ "returns" : []
},
{
- "name" : "hasListener",
+ "name" : "cellcontextmenu",
"type" : "function",
- "desc" : "Checks to see if this object has any listeners for a specified event",
- "sig" : "(eventName)",
- "static" : false,
- "memberOf" : "Roo.util.Observable",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
+ "desc" : "Fires when a cell is right clicked",
+ "sig" : "function (_self, rowIndex, cellIndex, e)\n{\n\n}",
+ "memberOf" : "Roo.grid.Grid",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
"params" : [
{
- "name" : "eventName",
- "type" : "String",
- "desc" : "The name of the event to check for",
+ "name" : "this",
+ "type" : "Grid",
+ "desc" : "",
"isOptional" : false
- }
- ],
- "returns" : [
+ },
{
- "name" : "",
- "type" : "Boolean",
- "desc" : "True if the event is being listened for, else false"
- }
- ]
- },
- {
- "name" : "hasSelection",
- "type" : "function",
- "desc" : "Returns true if there is a selection.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : [
+ "name" : "rowIndex",
+ "type" : "Number",
+ "desc" : "",
+ "isOptional" : false
+ },
{
- "name" : "",
- "type" : "Boolean",
- "desc" : ""
+ "name" : "cellIndex",
+ "type" : "Number",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "e",
+ "type" : "Roo.EventObject",
+ "desc" : "",
+ "isOptional" : false
}
- ]
+ ],
+ "returns" : []
},
{
- "name" : "isLocked",
+ "name" : "celldblclick",
"type" : "function",
- "desc" : "Returns true if the selections are locked.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.grid.AbstractSelectionModel",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
+ "desc" : "Fires when a cell is double clicked",
+ "sig" : "function (_self, rowIndex, columnIndex, e)\n{\n\n}",
+ "memberOf" : "Roo.grid.Grid",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : [
+ "params" : [
{
- "name" : "",
- "type" : "Boolean",
- "desc" : ""
+ "name" : "this",
+ "type" : "Grid",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "rowIndex",
+ "type" : "Number",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "columnIndex",
+ "type" : "Number",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "e",
+ "type" : "Roo.EventObject",
+ "desc" : "",
+ "isOptional" : false
}
- ]
+ ],
+ "returns" : []
},
{
- "name" : "lock",
+ "name" : "click",
"type" : "function",
- "desc" : "Locks the selections.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.grid.AbstractSelectionModel",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
+ "desc" : "The raw click event for the entire grid.",
+ "sig" : "function (e)\n{\n\n}",
+ "memberOf" : "Roo.grid.Grid",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
+ "params" : [
+ {
+ "name" : "e",
+ "type" : "Roo.EventObject",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
"returns" : []
},
{
- "name" : "on",
+ "name" : "columnmove",
"type" : "function",
- "desc" : "Appends an event handler to this element (shorthand for addListener)",
- "sig" : "(eventName, handler, scope, options)",
- "static" : false,
- "memberOf" : "Roo.util.Observable",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
+ "desc" : "Fires when the user moves a column",
+ "sig" : "function (oldIndex, newIndex)\n{\n\n}",
+ "memberOf" : "Roo.grid.Grid",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
"params" : [
{
- "name" : "eventName",
- "type" : "String",
- "desc" : "The type of event to listen for",
- "isOptional" : false
- },
- {
- "name" : "handler",
- "type" : "Function",
- "desc" : "The method the event invokes",
- "isOptional" : false
- },
- {
- "name" : "scope",
- "type" : "Object",
- "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
+ "name" : "oldIndex",
+ "type" : "Number",
+ "desc" : "",
"isOptional" : false
},
{
- "name" : "options",
- "type" : "Object",
- "desc" : "(optional)",
+ "name" : "newIndex",
+ "type" : "Number",
+ "desc" : "",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "onEditorKey",
+ "name" : "columnresize",
"type" : "function",
- "desc" : "Selects a cell.",
- "sig" : "(field, e)",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
+ "desc" : "Fires when the user resizes a column",
+ "sig" : "function (columnIndex, newSize)\n{\n\n}",
+ "memberOf" : "Roo.grid.Grid",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
"params" : [
{
- "name" : "field",
+ "name" : "columnIndex",
"type" : "Number",
- "desc" : "(not used) - as it's normally used as a listener",
+ "desc" : "",
"isOptional" : false
},
{
- "name" : "e",
+ "name" : "newSize",
"type" : "Number",
- "desc" : "- event - fake it by using\n\nvar e = Roo.EventObjectImpl.prototype;\ne.keyCode = e.TAB",
+ "desc" : "",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "purgeListeners",
+ "name" : "contextmenu",
"type" : "function",
- "desc" : "Removes all listeners for this object",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.util.Observable",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
+ "desc" : "The raw contextmenu event for the entire grid.",
+ "sig" : "function (e)\n{\n\n}",
+ "memberOf" : "Roo.grid.Grid",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
+ "params" : [
+ {
+ "name" : "e",
+ "type" : "Roo.EventObject",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
"returns" : []
},
{
- "name" : "releaseCapture",
+ "name" : "dblclick",
"type" : "function",
- "desc" : "Removes <b>all</b> added captures from the Observable.",
- "sig" : "(o)",
- "static" : true,
- "memberOf" : "Roo.util.Observable",
- "isStatic" : true,
- "isConstructor" : false,
- "isPrivate" : false,
+ "desc" : "The raw dblclick event for the entire grid.",
+ "sig" : "function (e)\n{\n\n}",
+ "memberOf" : "Roo.grid.Grid",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
"params" : [
{
- "name" : "o",
- "type" : "Observable",
- "desc" : "The Observable to release",
+ "name" : "e",
+ "type" : "Roo.EventObject",
+ "desc" : "",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "removeListener",
+ "name" : "dragdrop",
"type" : "function",
- "desc" : "Removes a listener",
- "sig" : "(eventName, handler, scope)",
- "static" : false,
- "memberOf" : "Roo.util.Observable",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
+ "desc" : "Fires when dragged row(s) are dropped on a valid DD target",
+ "sig" : "function (_self, dd, targetId, e)\n{\n\n}",
+ "memberOf" : "Roo.grid.Grid",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
"params" : [
{
- "name" : "eventName",
- "type" : "String",
- "desc" : "The type of event to listen for",
+ "name" : "this",
+ "type" : "Grid",
+ "desc" : "",
"isOptional" : false
},
{
- "name" : "handler",
- "type" : "Function",
- "desc" : "The handler to remove",
+ "name" : "dd",
+ "type" : "Roo.GridDD",
+ "desc" : "The drag drop object",
"isOptional" : false
},
{
- "name" : "scope",
- "type" : "Object",
- "desc" : "(optional) The scope (this object) for the handler",
+ "name" : "targetId",
+ "type" : "String",
+ "desc" : "The target drag drop object",
+ "isOptional" : false
+ },
+ {
+ "name" : "e",
+ "type" : "event",
+ "desc" : "The raw browser event",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "select",
+ "name" : "dragenter",
"type" : "function",
- "desc" : "Selects a cell.",
- "sig" : "(rowIndex, collIndex)",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
+ "desc" : "Fires when the dragged row(s) first cross another DD target while being dragged",
+ "sig" : "function (_self, dd, targetId, e)\n{\n\n}",
+ "memberOf" : "Roo.grid.Grid",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
"params" : [
{
- "name" : "rowIndex",
- "type" : "Number",
+ "name" : "this",
+ "type" : "Grid",
"desc" : "",
"isOptional" : false
},
{
- "name" : "collIndex",
- "type" : "Number",
- "desc" : "",
+ "name" : "dd",
+ "type" : "Roo.GridDD",
+ "desc" : "The drag drop object",
+ "isOptional" : false
+ },
+ {
+ "name" : "targetId",
+ "type" : "String",
+ "desc" : "The target drag drop object",
+ "isOptional" : false
+ },
+ {
+ "name" : "e",
+ "type" : "event",
+ "desc" : "The raw browser event",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "un",
+ "name" : "dragout",
"type" : "function",
- "desc" : "Removes a listener (shorthand for removeListener)",
- "sig" : "(eventName, handler, scope)",
- "static" : false,
- "memberOf" : "Roo.util.Observable",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
+ "desc" : "Fires when the dragged row(s) leave another DD target while being dragged",
+ "sig" : "function (_self, dd, targetId, e)\n{\n\n}",
+ "memberOf" : "Roo.grid.Grid",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
"params" : [
{
- "name" : "eventName",
- "type" : "String",
- "desc" : "The type of event to listen for",
+ "name" : "this",
+ "type" : "Grid",
+ "desc" : "",
"isOptional" : false
},
{
- "name" : "handler",
- "type" : "Function",
- "desc" : "The handler to remove",
+ "name" : "dd",
+ "type" : "Roo.GridDD",
+ "desc" : "The drag drop object",
"isOptional" : false
},
{
- "name" : "scope",
- "type" : "Object",
- "desc" : "(optional) The scope (this object) for the handler",
+ "name" : "targetId",
+ "type" : "String",
+ "desc" : "The target drag drop object",
+ "isOptional" : false
+ },
+ {
+ "name" : "e",
+ "type" : "event",
+ "desc" : "The raw browser event",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "unlock",
- "type" : "function",
- "desc" : "Unlocks the selections.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.grid.AbstractSelectionModel",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- }
- ],
- "isAbstract" : false,
- "isBuilderTop" : false,
- "childClasses" : { },
- "tree_children" : [],
- "tree_parent" : []
- },
- "Roo.grid.ColumnModel" : {
- "props" : [
- {
- "name" : "align",
- "type" : "String",
- "desc" : "(Optional) Set the CSS text-align property of the column. Defaults to undefined.",
- "memberOf" : ""
- },
- {
- "name" : "cursor",
- "type" : "String",
- "desc" : "(Optional)",
- "memberOf" : ""
- },
- {
- "name" : "dataIndex",
- "type" : "String",
- "desc" : "(Optional) The name of the field in the grid's {@link Roo.data.Store}'s\n{@link Roo.data.Record} definition from which to draw the column's value. If not\nspecified, the column's index is used as an index into the Record's data Array.",
- "memberOf" : ""
- },
- {
- "name" : "editor",
- "type" : "Roo.grid.GridEditor",
- "desc" : "(Optional) For grid editors - returns the grid editor",
- "memberOf" : ""
- },
- {
- "name" : "fixed",
- "type" : "Boolean",
- "desc" : "(Optional) True if the column width cannot be changed. Defaults to false.",
- "memberOf" : ""
- },
- {
- "name" : "header",
- "type" : "String",
- "desc" : "The header text to display in the Grid view.",
- "memberOf" : ""
- },
- {
- "name" : "hidden",
- "type" : "Boolean",
- "desc" : "(Optional) True to hide the column. Defaults to false.",
- "memberOf" : ""
- },
- {
- "name" : "lg",
- "type" : "Number",
- "desc" : "(Optional) can be '0' for hidden at this size (number less than 12)",
- "memberOf" : ""
- },
- {
- "name" : "lgHeader",
- "type" : "String",
- "desc" : "Header at Bootsrap Large width",
- "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"
- },
- {
- "name" : "locked",
- "type" : "Boolean",
- "desc" : "(Optional) True to lock the column in place while scrolling the Grid. Defaults to false.",
- "memberOf" : ""
- },
- {
- "name" : "md",
- "type" : "Number",
- "desc" : "(Optional) can be '0' for hidden at this size (number less than 12)",
- "memberOf" : ""
- },
- {
- "name" : "mdHeader",
- "type" : "String",
- "desc" : "Header at Bootsrap Medium width",
- "memberOf" : ""
- },
- {
- "name" : "renderer",
- "type" : "Function",
- "desc" : "(Optional) A function used to generate HTML markup for a cell\ngiven the cell's data value. See {@link #setRenderer}. If not specified, the\ndefault renderer returns the escaped data value. If an object is returned (bootstrap only)\nthen it is treated as a Roo Component object instance, and it is rendered after the initial row is rendered",
- "memberOf" : ""
- },
- {
- "name" : "resizable",
- "type" : "Boolean",
- "desc" : "(Optional) False to disable column resizing. Defaults to true.",
- "memberOf" : ""
- },
- {
- "name" : "sm",
- "type" : "Number",
- "desc" : "(Optional) can be '0' for hidden at this size (number less than 12)",
- "memberOf" : ""
- },
- {
- "name" : "smHeader",
- "type" : "String",
- "desc" : "Header at Bootsrap Small width",
- "memberOf" : ""
- },
- {
- "name" : "sortable",
- "type" : "Boolean",
- "desc" : "(Optional) True if sorting is to be allowed on this column.\nDefaults to the value of the {@link #defaultSortable} property.\nWhether local/remote sorting is used is specified in {@link Roo.data.Store#remoteSort}.",
- "memberOf" : ""
- },
- {
- "name" : "tooltip",
- "type" : "String",
- "desc" : "(Optional)",
- "memberOf" : ""
- },
- {
- "name" : "valign",
- "type" : "String",
- "desc" : "(Optional) Set the CSS vertical-align property of the column (eg. middle, top, bottom etc). Defaults to undefined.",
- "memberOf" : ""
- },
- {
- "name" : "width",
- "type" : "Number",
- "desc" : "(Optional) The initial width in pixels of the column. Using this\ninstead of {@link Roo.grid.Grid#autoSizeColumns} is more efficient.",
- "memberOf" : ""
- },
- {
- "name" : "xl",
- "type" : "Number",
- "desc" : "(Optional) can be '0' for hidden at this size (number less than 12)",
- "memberOf" : ""
- },
- {
- "name" : "xlHeader",
- "type" : "String",
- "desc" : "Header at Bootsrap extra Large width",
- "memberOf" : ""
- },
- {
- "name" : "xs",
- "type" : "Number",
- "desc" : "(Optional) can be '0' for hidden at this size (number less than 12)",
- "memberOf" : ""
- },
- {
- "name" : "xsHeader",
- "type" : "String",
- "desc" : "Header at Bootsrap Extra Small width (default for all)",
- "memberOf" : ""
- }
- ],
- "events" : [
- {
- "name" : "columlockchange",
+ "name" : "dragover",
"type" : "function",
- "desc" : "Fires when a column's locked state is changed",
- "sig" : "function (_self, colIndex, locked)\n{\n\n}",
- "memberOf" : "",
+ "desc" : "Fires while row(s) are being dragged. \"targetId\" is the id of the Yahoo.util.DD object the selected rows are being dragged over.",
+ "sig" : "function (_self, dd, targetId, e)\n{\n\n}",
+ "memberOf" : "Roo.grid.Grid",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "ColumnModel",
+ "type" : "Grid",
"desc" : "",
"isOptional" : false
},
{
- "name" : "colIndex",
- "type" : "Number",
- "desc" : "",
+ "name" : "dd",
+ "type" : "Roo.GridDD",
+ "desc" : "The drag drop object",
"isOptional" : false
},
{
- "name" : "locked",
- "type" : "Boolean",
- "desc" : "true if locked",
+ "name" : "targetId",
+ "type" : "String",
+ "desc" : "The target drag drop object",
+ "isOptional" : false
+ },
+ {
+ "name" : "e",
+ "type" : "event",
+ "desc" : "The raw browser event",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "columnmoved",
+ "name" : "enddrag",
"type" : "function",
- "desc" : "Fires when a column is moved.",
- "sig" : "function (_self, oldIndex, newIndex)\n{\n\n}",
- "memberOf" : "",
+ "desc" : "Fires when a drag operation is complete",
+ "sig" : "function (_self, dd, e)\n{\n\n}",
+ "memberOf" : "Roo.grid.Grid",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "ColumnModel",
+ "type" : "Grid",
"desc" : "",
"isOptional" : false
},
{
- "name" : "oldIndex",
- "type" : "Number",
- "desc" : "",
+ "name" : "dd",
+ "type" : "Roo.GridDD",
+ "desc" : "The drag drop object",
"isOptional" : false
},
{
- "name" : "newIndex",
- "type" : "Number",
- "desc" : "",
+ "name" : "e",
+ "type" : "event",
+ "desc" : "The raw browser event",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "headerchange",
+ "name" : "headerclick",
"type" : "function",
- "desc" : "Fires when the text of a header changes.",
- "sig" : "function (_self, columnIndex, newText)\n{\n\n}",
- "memberOf" : "",
+ "desc" : "Fires when a header is clicked",
+ "sig" : "function (_self, columnIndex, e)\n{\n\n}",
+ "memberOf" : "Roo.grid.Grid",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "ColumnModel",
+ "type" : "Grid",
"desc" : "",
"isOptional" : false
},
{
"name" : "columnIndex",
"type" : "Number",
- "desc" : "The column index",
+ "desc" : "",
"isOptional" : false
},
{
- "name" : "newText",
- "type" : "Number",
- "desc" : "The new header text",
+ "name" : "e",
+ "type" : "Roo.EventObject",
+ "desc" : "",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "hiddenchange",
+ "name" : "headercontextmenu",
"type" : "function",
- "desc" : "Fires when a column is hidden or \"unhidden\".",
- "sig" : "function (_self, columnIndex, hidden)\n{\n\n}",
- "memberOf" : "",
+ "desc" : "Fires when a header is right clicked",
+ "sig" : "function (_self, columnIndex, e)\n{\n\n}",
+ "memberOf" : "Roo.grid.Grid",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "ColumnModel",
+ "type" : "Grid",
"desc" : "",
"isOptional" : false
},
{
"name" : "columnIndex",
"type" : "Number",
- "desc" : "The column index",
+ "desc" : "",
"isOptional" : false
},
{
- "name" : "hidden",
- "type" : "Boolean",
- "desc" : "true if hidden, false otherwise",
+ "name" : "e",
+ "type" : "Roo.EventObject",
+ "desc" : "",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "widthchange",
+ "name" : "headerdblclick",
"type" : "function",
- "desc" : "Fires when the width of a column changes.",
- "sig" : "function (_self, columnIndex, newWidth)\n{\n\n}",
- "memberOf" : "",
+ "desc" : "Fires when a header cell is double clicked",
+ "sig" : "function (_self, columnIndex, e)\n{\n\n}",
+ "memberOf" : "Roo.grid.Grid",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "ColumnModel",
+ "type" : "Grid",
"desc" : "",
"isOptional" : false
},
{
"name" : "columnIndex",
"type" : "Number",
- "desc" : "The column index",
+ "desc" : "",
"isOptional" : false
},
{
- "name" : "newWidth",
- "type" : "Number",
- "desc" : "The new width",
+ "name" : "e",
+ "type" : "Roo.EventObject",
+ "desc" : "",
"isOptional" : false
}
],
"returns" : []
- }
- ],
- "methods" : [
+ },
{
- "name" : "addColumn",
+ "name" : "keydown",
"type" : "function",
- "desc" : "Add a column (experimental...) - defaults to adding to the end..",
- "sig" : "(config)",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
+ "desc" : "The raw keydown event for the entire grid.",
+ "sig" : "function (e)\n{\n\n}",
+ "memberOf" : "Roo.grid.Grid",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
"params" : [
{
- "name" : "config",
- "type" : "Object",
+ "name" : "e",
+ "type" : "Roo.EventObject",
"desc" : "",
"isOptional" : false
}
"returns" : []
},
{
- "name" : "addEvents",
+ "name" : "keypress",
"type" : "function",
- "desc" : "Used to define events on this Observable",
- "sig" : "(object)",
- "static" : false,
- "memberOf" : "Roo.util.Observable",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
+ "desc" : "The raw keypress event for the entire grid.",
+ "sig" : "function (e)\n{\n\n}",
+ "memberOf" : "Roo.grid.Grid",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
"params" : [
{
- "name" : "object",
- "type" : "Object",
- "desc" : "The object with the events defined",
+ "name" : "e",
+ "type" : "Roo.EventObject",
+ "desc" : "",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "addListener",
+ "name" : "mousedown",
"type" : "function",
- "desc" : "Appends an event handler to this component",
- "sig" : "(eventName, handler, scope, options)",
- "static" : false,
- "memberOf" : "Roo.util.Observable",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
+ "desc" : "The raw mousedown event for the entire grid.",
+ "sig" : "function (e)\n{\n\n}",
+ "memberOf" : "Roo.grid.Grid",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
"params" : [
{
- "name" : "eventName",
- "type" : "String",
- "desc" : "The type of event to listen for",
- "isOptional" : false
- },
- {
- "name" : "handler",
- "type" : "Function",
- "desc" : "The method the event invokes",
- "isOptional" : false
- },
- {
- "name" : "scope",
- "type" : "Object",
- "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
- "isOptional" : false
- },
- {
- "name" : "options",
- "type" : "Object",
- "desc" : "(optional) An object containing handler configuration\nproperties. This may contain any of the following properties:<ul>\n<li>scope {Object} The scope in which to execute the handler function. The handler function's \"this\" context.</li>\n<li>delay {Number} The number of milliseconds to delay the invocation of the handler after te event fires.</li>\n<li>single {Boolean} True to add a handler to handle just the next firing of the event, and then remove itself.</li>\n<li>buffer {Number} Causes the handler to be scheduled to run in an {@link Roo.util.DelayedTask} delayed\nby the specified number of milliseconds. If the event fires again within that time, the original\nhandler is <em>not</em> invoked, but the new handler is scheduled in its place.</li>\n</ul><br>\n<p>\n<b>Combining Options</b><br>\nUsing the options argument, it is possible to combine different types of listeners:<br>\n<br>\nA normalized, delayed, one-time listener that auto stops the event and passes a custom argument (forumId)\n\t\t<pre><code>\n\t\tel.on('click', this.onClick, this, {\n \t\t\tsingle: true,\n \t\tdelay: 100,\n \t\tforumId: 4\n\t\t});\n\t\t</code></pre>\n<p>\n<b>Attaching multiple handlers in 1 call</b><br>\nThe method also allows for a single argument to be passed which is a config object containing properties\nwhich specify multiple handlers.\n<pre><code>\n\t\tel.on({\n\t\t\t'click': {\n \t\tfn: this.onClick,\n \t\tscope: this,\n \t\tdelay: 100\n \t\t}, \n \t\t'mouseover': {\n \t\tfn: this.onMouseOver,\n \t\tscope: this\n \t\t},\n \t\t'mouseout': {\n \t\tfn: this.onMouseOut,\n \t\tscope: this\n \t\t}\n\t\t});\n\t\t</code></pre>\n<p>\nOr a shorthand syntax which passes the same scope object to all handlers:\n \t<pre><code>\n\t\tel.on({\n\t\t\t'click': this.onClick,\n \t\t'mouseover': this.onMouseOver,\n \t\t'mouseout': this.onMouseOut,\n \t\tscope: this\n\t\t});\n\t\t</code></pre>",
+ "name" : "e",
+ "type" : "Roo.EventObject",
+ "desc" : "",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "capture",
+ "name" : "mouseout",
"type" : "function",
- "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\n<b>before</b> the event is fired. If the supplied function returns false,\nthe event will not fire.",
- "sig" : "(o, fn, scope)",
- "static" : true,
- "memberOf" : "Roo.util.Observable",
- "isStatic" : true,
- "isConstructor" : false,
- "isPrivate" : false,
+ "desc" : "The raw mouseout event for the entire grid.",
+ "sig" : "function (e)\n{\n\n}",
+ "memberOf" : "Roo.grid.Grid",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
"params" : [
{
- "name" : "o",
- "type" : "Observable",
- "desc" : "The Observable to capture",
- "isOptional" : false
- },
- {
- "name" : "fn",
- "type" : "Function",
- "desc" : "The function to call",
+ "name" : "e",
+ "type" : "Roo.EventObject",
+ "desc" : "",
"isOptional" : false
- },
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "mouseover",
+ "type" : "function",
+ "desc" : "The raw mouseover event for the entire grid.",
+ "sig" : "function (e)\n{\n\n}",
+ "memberOf" : "Roo.grid.Grid",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
{
- "name" : "scope",
- "type" : "Object",
- "desc" : "(optional) The scope (this object) for the fn",
+ "name" : "e",
+ "type" : "Roo.EventObject",
+ "desc" : "",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "findColumnIndex",
+ "name" : "mouseup",
"type" : "function",
- "desc" : "Returns the index for a specified column dataIndex.",
- "sig" : "(dataIndex)",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
+ "desc" : "The raw mouseup event for the entire grid.",
+ "sig" : "function (e)\n{\n\n}",
+ "memberOf" : "Roo.grid.Grid",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
"params" : [
{
- "name" : "dataIndex",
- "type" : "String",
- "desc" : "The column dataIndex",
+ "name" : "e",
+ "type" : "Roo.EventObject",
+ "desc" : "",
"isOptional" : false
}
],
- "returns" : [
+ "returns" : []
+ },
+ {
+ "name" : "render",
+ "type" : "function",
+ "desc" : "Fires when the grid is rendered",
+ "sig" : "function (grid)\n{\n\n}",
+ "memberOf" : "Roo.grid.Grid",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
{
- "name" : "",
- "type" : "Number",
- "desc" : "the index, or -1 if not found"
+ "name" : "grid",
+ "type" : "Grid",
+ "desc" : "",
+ "isOptional" : false
}
- ]
+ ],
+ "returns" : []
},
{
- "name" : "fireEvent",
+ "name" : "rowclass",
"type" : "function",
- "desc" : "Fires the specified event with the passed parameters (minus the event name).",
- "sig" : "(eventName, args)",
- "static" : false,
- "memberOf" : "Roo.util.Observable",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
+ "desc" : "Fires when a row is rendered, so you can change add a style to it.",
+ "sig" : "function (gridview, rowcfg)\n{\n\n}",
+ "memberOf" : "Roo.grid.Grid",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
"params" : [
{
- "name" : "eventName",
- "type" : "String",
- "desc" : "",
+ "name" : "gridview",
+ "type" : "GridView",
+ "desc" : "The grid view",
"isOptional" : false
},
{
- "name" : "args",
- "type" : "Object...",
- "desc" : "Variable number of parameters are passed to handlers",
+ "name" : "rowcfg",
+ "type" : "Object",
+ "desc" : "contains record rowIndex and rowClass - set rowClass to add a style.",
"isOptional" : false
}
],
- "returns" : [
- {
- "name" : "",
- "type" : "Boolean",
- "desc" : "returns false if any of the handlers return false otherwise it returns true"
- }
- ]
+ "returns" : []
},
{
- "name" : "getCellEditor",
+ "name" : "rowclick",
"type" : "function",
- "desc" : "Returns the editor defined for the cell/column.\nreturn false or null to disable editing.",
- "sig" : "(colIndex, rowIndex)",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
+ "desc" : "Fires when a row is clicked",
+ "sig" : "function (_self, rowIndex, e)\n{\n\n}",
+ "memberOf" : "Roo.grid.Grid",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
"params" : [
{
- "name" : "colIndex",
- "type" : "Number",
- "desc" : "The column index",
+ "name" : "this",
+ "type" : "Grid",
+ "desc" : "",
"isOptional" : false
},
{
"name" : "rowIndex",
"type" : "Number",
- "desc" : "The row index",
+ "desc" : "",
"isOptional" : false
- }
- ],
- "returns" : [
+ },
{
- "name" : "",
- "type" : "Object",
- "desc" : ""
+ "name" : "e",
+ "type" : "Roo.EventObject",
+ "desc" : "",
+ "isOptional" : false
}
- ]
+ ],
+ "returns" : []
},
{
- "name" : "getColumnByDataIndex",
+ "name" : "rowcontextmenu",
"type" : "function",
- "desc" : "Returns the column Object for a specified dataIndex.",
- "sig" : "(dataIndex)",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
+ "desc" : "Fires when a row is right clicked",
+ "sig" : "function (_self, rowIndex, e)\n{\n\n}",
+ "memberOf" : "Roo.grid.Grid",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
"params" : [
{
- "name" : "dataIndex",
- "type" : "String",
- "desc" : "The column dataIndex",
+ "name" : "this",
+ "type" : "Grid",
+ "desc" : "",
"isOptional" : false
- }
- ],
- "returns" : [
+ },
{
- "name" : "",
- "type" : "Object|Boolean",
- "desc" : "the column or false if not found"
+ "name" : "rowIndex",
+ "type" : "Number",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "e",
+ "type" : "Roo.EventObject",
+ "desc" : "",
+ "isOptional" : false
}
- ]
+ ],
+ "returns" : []
},
{
- "name" : "getColumnById",
+ "name" : "rowdblclick",
"type" : "function",
- "desc" : "Returns the column for a specified id.",
- "sig" : "(id)",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
+ "desc" : "Fires when a row is double clicked",
+ "sig" : "function (_self, rowIndex, e)\n{\n\n}",
+ "memberOf" : "Roo.grid.Grid",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
"params" : [
{
- "name" : "id",
- "type" : "String",
- "desc" : "The column id",
+ "name" : "this",
+ "type" : "Grid",
+ "desc" : "",
"isOptional" : false
- }
- ],
- "returns" : [
+ },
{
- "name" : "",
- "type" : "Object",
- "desc" : "the column"
+ "name" : "rowIndex",
+ "type" : "Number",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "e",
+ "type" : "Roo.EventObject",
+ "desc" : "",
+ "isOptional" : false
}
- ]
+ ],
+ "returns" : []
},
{
- "name" : "getColumnCount",
+ "name" : "startdrag",
"type" : "function",
- "desc" : "Returns the number of columns.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
+ "desc" : "Fires when row(s) start being dragged",
+ "sig" : "function (_self, dd, e)\n{\n\n}",
+ "memberOf" : "Roo.grid.Grid",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : [
+ "params" : [
{
- "name" : "",
- "type" : "Number",
- "desc" : ""
+ "name" : "this",
+ "type" : "Grid",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "dd",
+ "type" : "Roo.GridDD",
+ "desc" : "The drag drop object",
+ "isOptional" : false
+ },
+ {
+ "name" : "e",
+ "type" : "event",
+ "desc" : "The raw browser event",
+ "isOptional" : false
}
- ]
+ ],
+ "returns" : []
},
{
- "name" : "getColumnHeader",
+ "name" : "validateedit",
"type" : "function",
- "desc" : "Returns the header for the specified column.",
- "sig" : "(col)",
- "static" : false,
+ "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>",
+ "sig" : "function (e)\n{\n\n}",
"memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
"params" : [
{
- "name" : "col",
- "type" : "Number",
- "desc" : "The column index",
+ "name" : "e",
+ "type" : "Object",
+ "desc" : "An edit event (see above for description)",
"isOptional" : false
}
],
- "returns" : [
- {
- "name" : "",
- "type" : "String",
- "desc" : ""
- }
- ]
- },
+ "returns" : []
+ }
+ ],
+ "methods" : [
{
- "name" : "getColumnId",
+ "name" : "addColumns",
"type" : "function",
- "desc" : "Returns the id of the column at the specified index.",
- "sig" : "(index)",
+ "desc" : "addColumns\nAdd's a column, default at the end..",
+ "sig" : "(position, of)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.grid.Grid",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "index",
- "type" : "Number",
- "desc" : "The column index",
+ "name" : "position",
+ "type" : "int",
+ "desc" : "to add (default end)",
"isOptional" : false
- }
- ],
- "returns" : [
+ },
{
- "name" : "",
- "type" : "String",
- "desc" : "the id"
+ "name" : "of",
+ "type" : "Array",
+ "desc" : "objects of column configuration see {@link Roo.grid.ColumnModel}",
+ "isOptional" : false
}
- ]
+ ],
+ "returns" : []
},
{
- "name" : "getColumnTooltip",
+ "name" : "addEvents",
"type" : "function",
- "desc" : "Returns the tooltip for the specified column.",
- "sig" : "(col)",
+ "desc" : "Used to define events on this Observable",
+ "sig" : "(object)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.util.Observable",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "col",
- "type" : "Number",
- "desc" : "The column index",
+ "name" : "object",
+ "type" : "Object",
+ "desc" : "The object with the events defined",
"isOptional" : false
}
],
- "returns" : [
- {
- "name" : "",
- "type" : "String",
- "desc" : ""
- }
- ]
+ "returns" : []
},
{
- "name" : "getColumnWidth",
+ "name" : "addListener",
"type" : "function",
- "desc" : "Returns the width for the specified column.",
- "sig" : "(col, (optional))",
+ "desc" : "Appends an event handler to this component",
+ "sig" : "(eventName, handler, scope, options)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.util.Observable",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "col",
- "type" : "Number",
- "desc" : "The column index",
+ "name" : "eventName",
+ "type" : "String",
+ "desc" : "The type of event to listen for",
"isOptional" : false
},
{
- "name" : "(optional)",
- "type" : "",
- "desc" : "{String} gridSize bootstrap width size.",
+ "name" : "handler",
+ "type" : "Function",
+ "desc" : "The method the event invokes",
"isOptional" : false
- }
- ],
- "returns" : [
+ },
{
- "name" : "",
- "type" : "Number",
- "desc" : ""
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
+ "isOptional" : false
+ },
+ {
+ "name" : "options",
+ "type" : "Object",
+ "desc" : "(optional) An object containing handler configuration\nproperties. This may contain any of the following properties:<ul>\n<li>scope {Object} The scope in which to execute the handler function. The handler function's \"this\" context.</li>\n<li>delay {Number} The number of milliseconds to delay the invocation of the handler after te event fires.</li>\n<li>single {Boolean} True to add a handler to handle just the next firing of the event, and then remove itself.</li>\n<li>buffer {Number} Causes the handler to be scheduled to run in an {@link Roo.util.DelayedTask} delayed\nby the specified number of milliseconds. If the event fires again within that time, the original\nhandler is <em>not</em> invoked, but the new handler is scheduled in its place.</li>\n</ul><br>\n<p>\n<b>Combining Options</b><br>\nUsing the options argument, it is possible to combine different types of listeners:<br>\n<br>\nA normalized, delayed, one-time listener that auto stops the event and passes a custom argument (forumId)\n\t\t<pre><code>\n\t\tel.on('click', this.onClick, this, {\n \t\t\tsingle: true,\n \t\tdelay: 100,\n \t\tforumId: 4\n\t\t});\n\t\t</code></pre>\n<p>\n<b>Attaching multiple handlers in 1 call</b><br>\nThe method also allows for a single argument to be passed which is a config object containing properties\nwhich specify multiple handlers.\n<pre><code>\n\t\tel.on({\n\t\t\t'click': {\n \t\tfn: this.onClick,\n \t\tscope: this,\n \t\tdelay: 100\n \t\t}, \n \t\t'mouseover': {\n \t\tfn: this.onMouseOver,\n \t\tscope: this\n \t\t},\n \t\t'mouseout': {\n \t\tfn: this.onMouseOut,\n \t\tscope: this\n \t\t}\n\t\t});\n\t\t</code></pre>\n<p>\nOr a shorthand syntax which passes the same scope object to all handlers:\n \t<pre><code>\n\t\tel.on({\n\t\t\t'click': this.onClick,\n \t\t'mouseover': this.onMouseOver,\n \t\t'mouseout': this.onMouseOut,\n \t\tscope: this\n\t\t});\n\t\t</code></pre>",
+ "isOptional" : false
}
- ]
+ ],
+ "returns" : []
},
{
- "name" : "getColumnsBy",
+ "name" : "autoSize",
"type" : "function",
- "desc" : "Returns the column configs that return true by the passed function that is called with (columnConfig, index)",
- "sig" : "(fn, scope)",
+ "desc" : "Causes the grid to manually recalculate its dimensions. Generally this is done automatically,\nbut if manual update is required this method will initiate it.",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.grid.Grid",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "fn",
- "type" : "Function",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "scope",
- "type" : "Object",
- "desc" : "(optional)",
- "isOptional" : false
- }
- ],
- "returns" : [
- {
- "name" : "",
- "type" : "Array",
- "desc" : "result"
- }
- ]
+ "params" : [],
+ "returns" : []
},
{
- "name" : "getDataIndex",
+ "name" : "capture",
"type" : "function",
- "desc" : "Returns the dataIndex for the specified column.",
- "sig" : "(col)",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
+ "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\n<b>before</b> the event is fired. If the supplied function returns false,\nthe event will not fire.",
+ "sig" : "(o, fn, scope)",
+ "static" : true,
+ "memberOf" : "Roo.util.Observable",
+ "isStatic" : true,
"isConstructor" : false,
"isPrivate" : false,
"example" : "",
"requires" : "",
"params" : [
{
- "name" : "col",
- "type" : "Number",
- "desc" : "The column index",
+ "name" : "o",
+ "type" : "Observable",
+ "desc" : "The Observable to capture",
+ "isOptional" : false
+ },
+ {
+ "name" : "fn",
+ "type" : "Function",
+ "desc" : "The function to call",
+ "isOptional" : false
+ },
+ {
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "(optional) The scope (this object) for the fn",
"isOptional" : false
}
],
- "returns" : [
- {
- "name" : "",
- "type" : "Number",
- "desc" : ""
- }
- ]
+ "returns" : []
},
{
- "name" : "getIndexById",
+ "name" : "destroy",
"type" : "function",
- "desc" : "Returns the index for a specified column id.",
- "sig" : "(id)",
+ "desc" : "Destroy this grid.",
+ "sig" : "(removeEl)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.grid.Grid",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "id",
- "type" : "String",
- "desc" : "The column id",
+ "name" : "removeEl",
+ "type" : "Boolean",
+ "desc" : "True to remove the element",
"isOptional" : false
}
],
- "returns" : [
- {
- "name" : "",
- "type" : "Number",
- "desc" : "the index, or -1 if not found"
- }
- ]
+ "returns" : []
},
{
- "name" : "getRenderer",
+ "name" : "fireEvent",
"type" : "function",
- "desc" : "Returns the rendering (formatting) function defined for the column.",
- "sig" : "(col)",
+ "desc" : "Fires the specified event with the passed parameters (minus the event name).",
+ "sig" : "(eventName, args)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.util.Observable",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "col",
- "type" : "Number",
- "desc" : "The column index.",
+ "name" : "eventName",
+ "type" : "String",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "args",
+ "type" : "Object...",
+ "desc" : "Variable number of parameters are passed to handlers",
"isOptional" : false
}
],
"returns" : [
{
"name" : "",
- "type" : "Function",
- "desc" : "The function used to render the cell. See {@link #setRenderer}."
+ "type" : "Boolean",
+ "desc" : "returns false if any of the handlers return false otherwise it returns true"
}
]
},
{
- "name" : "getTotalWidth",
+ "name" : "getColumnModel",
"type" : "function",
- "desc" : "Returns the total width of all columns.",
- "sig" : "(includeHidden)",
+ "desc" : "Returns the grid's ColumnModel.",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.grid.Grid",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "includeHidden",
- "type" : "Boolean",
- "desc" : "True to include hidden column widths",
- "isOptional" : false
- }
- ],
+ "params" : [],
"returns" : [
{
"name" : "",
- "type" : "Number",
+ "type" : "ColumnModel",
"desc" : ""
}
]
},
{
- "name" : "hasListener",
+ "name" : "getDataSource",
"type" : "function",
- "desc" : "Checks to see if this object has any listeners for a specified event",
- "sig" : "(eventName)",
+ "desc" : "Returns the grid's DataSource.",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.util.Observable",
+ "memberOf" : "Roo.grid.Grid",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "eventName",
- "type" : "String",
- "desc" : "The name of the event to check for",
- "isOptional" : false
- }
- ],
+ "params" : [],
"returns" : [
{
"name" : "",
- "type" : "Boolean",
- "desc" : "True if the event is being listened for, else false"
+ "type" : "DataSource",
+ "desc" : ""
}
]
},
{
- "name" : "isCellEditable",
+ "name" : "getDragDropText",
"type" : "function",
- "desc" : "Returns true if the cell is editable.",
- "sig" : "(colIndex, rowIndex)",
+ "desc" : "Called to get grid's drag proxy text, by default returns this.ddText.",
+ "sig" : "()\n{\n\n}",
"static" : false,
"memberOf" : "",
"isStatic" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "colIndex",
- "type" : "Number",
- "desc" : "The column index",
- "isOptional" : false
- },
- {
- "name" : "rowIndex",
- "type" : "Number",
- "desc" : "The row index - this is nto actually used..?",
- "isOptional" : false
- }
- ],
+ "params" : [],
"returns" : [
{
"name" : "",
- "type" : "Boolean",
+ "type" : "String",
"desc" : ""
}
]
},
{
- "name" : "isFixed",
+ "name" : "getGridEl",
"type" : "function",
- "desc" : "Returns true if the column width cannot be changed",
+ "desc" : "Returns the grid's underlying element.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.grid.Grid",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"exceptions" : "",
"requires" : "",
"params" : [],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Element",
+ "desc" : "The element"
+ }
+ ]
},
{
- "name" : "isHidden",
+ "name" : "getSelectionModel",
"type" : "function",
- "desc" : "Returns true if the column is hidden.",
- "sig" : "(colIndex)",
+ "desc" : "Returns the grid's SelectionModel.",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.grid.Grid",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "colIndex",
- "type" : "Number",
- "desc" : "The column index",
- "isOptional" : false
- }
- ],
+ "params" : [],
"returns" : [
{
"name" : "",
- "type" : "Boolean",
+ "type" : "SelectionModel",
"desc" : ""
}
]
},
{
- "name" : "isResizable",
+ "name" : "getView",
"type" : "function",
- "desc" : "Returns true if the column can be resized",
+ "desc" : "Returns the grid's GridView object.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.grid.Grid",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"returns" : [
{
"name" : "",
- "type" : "Boolean",
+ "type" : "GridView",
"desc" : ""
}
]
},
{
- "name" : "isSortable",
+ "name" : "hasListener",
"type" : "function",
- "desc" : "Returns true if the specified column is sortable.",
- "sig" : "(col)",
+ "desc" : "Checks to see if this object has any listeners for a specified event",
+ "sig" : "(eventName)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.util.Observable",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "col",
- "type" : "Number",
- "desc" : "The column index",
+ "name" : "eventName",
+ "type" : "String",
+ "desc" : "The name of the event to check for",
"isOptional" : false
}
],
{
"name" : "",
"type" : "Boolean",
- "desc" : ""
+ "desc" : "True if the event is being listened for, else false"
}
]
},
"returns" : []
},
{
- "name" : "releaseCapture",
- "type" : "function",
- "desc" : "Removes <b>all</b> added captures from the Observable.",
- "sig" : "(o)",
- "static" : true,
- "memberOf" : "Roo.util.Observable",
- "isStatic" : true,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "o",
- "type" : "Observable",
- "desc" : "The Observable to release",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "removeListener",
+ "name" : "reconfigure",
"type" : "function",
- "desc" : "Removes a listener",
- "sig" : "(eventName, handler, scope)",
+ "desc" : "Reconfigures the grid to use a different Store and Column Model.\nThe View will be bound to the new objects and refreshed.",
+ "sig" : "(dataSource, The)",
"static" : false,
- "memberOf" : "Roo.util.Observable",
+ "memberOf" : "Roo.grid.Grid",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "eventName",
- "type" : "String",
- "desc" : "The type of event to listen for",
- "isOptional" : false
- },
- {
- "name" : "handler",
- "type" : "Function",
- "desc" : "The handler to remove",
+ "name" : "dataSource",
+ "type" : "Roo.data.Store",
+ "desc" : "The new {@link Roo.data.Store} object",
"isOptional" : false
},
{
- "name" : "scope",
- "type" : "Object",
- "desc" : "(optional) The scope (this object) for the handler",
+ "name" : "The",
+ "type" : "Roo.grid.ColumnModel",
+ "desc" : "new {@link Roo.grid.ColumnModel} object",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "setColumnHeader",
+ "name" : "releaseCapture",
"type" : "function",
- "desc" : "Sets the header for a column.",
- "sig" : "(col, header)",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
+ "desc" : "Removes <b>all</b> added captures from the Observable.",
+ "sig" : "(o)",
+ "static" : true,
+ "memberOf" : "Roo.util.Observable",
+ "isStatic" : true,
"isConstructor" : false,
"isPrivate" : false,
"example" : "",
"requires" : "",
"params" : [
{
- "name" : "col",
- "type" : "Number",
- "desc" : "The column index",
- "isOptional" : false
- },
- {
- "name" : "header",
- "type" : "String",
- "desc" : "The new header",
+ "name" : "o",
+ "type" : "Observable",
+ "desc" : "The Observable to release",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "setColumnTooltip",
+ "name" : "removeListener",
"type" : "function",
- "desc" : "Sets the tooltip for a column.",
- "sig" : "(col, tooltip)",
+ "desc" : "Removes a listener",
+ "sig" : "(eventName, handler, scope)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.util.Observable",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "col",
- "type" : "Number",
- "desc" : "The column index",
- "isOptional" : false
- },
- {
- "name" : "tooltip",
+ "name" : "eventName",
"type" : "String",
- "desc" : "The new tooltip",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "setColumnWidth",
- "type" : "function",
- "desc" : "Sets the width for a column.",
- "sig" : "(col, width)",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "col",
- "type" : "Number",
- "desc" : "The column index",
+ "desc" : "The type of event to listen for",
"isOptional" : false
},
{
- "name" : "width",
- "type" : "Number",
- "desc" : "The new width",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "setDataIndex",
- "type" : "function",
- "desc" : "Sets the dataIndex for a column.",
- "sig" : "(col, dataIndex)",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "col",
- "type" : "Number",
- "desc" : "The column index",
+ "name" : "handler",
+ "type" : "Function",
+ "desc" : "The handler to remove",
"isOptional" : false
},
{
- "name" : "dataIndex",
- "type" : "Number",
- "desc" : "The new dataIndex",
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "(optional) The scope (this object) for the handler",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "setEditable",
+ "name" : "render",
"type" : "function",
- "desc" : "Sets if a column is editable.",
- "sig" : "(col, editable)",
+ "desc" : "Called once after all setup has been completed and the grid is ready to be rendered.",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.grid.Grid",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "col",
- "type" : "Number",
- "desc" : "The column index",
- "isOptional" : false
- },
+ "params" : [],
+ "returns" : [
{
- "name" : "editable",
- "type" : "Boolean",
- "desc" : "True if the column is editable",
- "isOptional" : false
+ "name" : "",
+ "type" : "Roo.grid.Grid",
+ "desc" : "this"
}
- ],
- "returns" : []
+ ]
},
{
- "name" : "setEditor",
+ "name" : "startEditing",
"type" : "function",
- "desc" : "Sets the editor for a column.",
- "sig" : "(col, editor)",
+ "desc" : "Starts editing the specified for the specified row/column",
+ "sig" : "(rowIndex, colIndex)",
"static" : false,
"memberOf" : "",
"isStatic" : false,
"requires" : "",
"params" : [
{
- "name" : "col",
+ "name" : "rowIndex",
"type" : "Number",
- "desc" : "The column index",
+ "desc" : "",
"isOptional" : false
},
- {
- "name" : "editor",
- "type" : "Object",
- "desc" : "The editor object",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "setHidden",
- "type" : "function",
- "desc" : "Sets if a column is hidden.",
- "sig" : "(colIndex, hidden)",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
{
"name" : "colIndex",
"type" : "Number",
- "desc" : "The column index",
- "isOptional" : false
- },
- {
- "name" : "hidden",
- "type" : "Boolean",
- "desc" : "True if the column is hidden",
+ "desc" : "",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "setRenderer",
+ "name" : "stopEditing",
"type" : "function",
- "desc" : "Sets the rendering (formatting) function for a column.",
- "sig" : "(col, fn)",
+ "desc" : "Stops any active editing",
+ "sig" : "()\n{\n\n}",
"static" : false,
"memberOf" : "",
"isStatic" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "col",
- "type" : "Number",
- "desc" : "The column index",
- "isOptional" : false
- },
- {
- "name" : "fn",
- "type" : "Function",
- "desc" : "The function to use to process the cell's raw data\nto return HTML markup for the grid view. The render function is called with\nthe following parameters:<ul>\n<li>Data value.</li>\n<li>Cell metadata. An object in which you may set the following attributes:<ul>\n<li>css A CSS style string to apply to the table cell.</li>\n<li>attr An HTML attribute definition string to apply to the data container element <i>within</i> the table cell.</li></ul>\n<li>The {@link Roo.data.Record} from which the data was extracted.</li>\n<li>Row index</li>\n<li>Column index</li>\n<li>The {@link Roo.data.Store} object from which the Record was extracted</li></ul>",
- "isOptional" : false
- }
- ],
+ "params" : [],
"returns" : []
},
{
],
"isAbstract" : false,
"isBuilderTop" : false,
- "childClasses" : { },
+ "implementations" : [
+ "Roo.grid.PropertyGrid"
+ ],
"tree_children" : [],
"tree_parent" : []
},
- "Roo.grid.EditorGrid" : {
+ "Roo.grid.Grid" : {
"props" : [
{
"name" : "autoExpandColumn",
"type" : "String",
"desc" : "The id (or dataIndex) of a column in this grid that should expand to fill unused space. This id can not be 0. Default is false.",
- "memberOf" : "Roo.grid.Grid"
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "autoExpandMax",
"type" : "Number",
"desc" : "The maximum width the autoExpandColumn can have (if enabled). Default is 1000.",
- "memberOf" : "Roo.grid.Grid"
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "autoExpandMin",
"type" : "Number",
"desc" : "The minimum width the autoExpandColumn can have (if enabled).\nDefault is 50.",
- "memberOf" : "Roo.grid.Grid"
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"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"
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"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"
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "autoSizeHeaders",
"type" : "Boolean",
"desc" : "True to measure headers with column data when auto sizing columns. Default is true.",
- "memberOf" : "Roo.grid.Grid"
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "autoWidth",
"type" : "Boolean",
"desc" : "True to set the grid's width to the default total width of the grid's columns instead\nof a fixed width. Default is false.",
- "memberOf" : "Roo.grid.Grid"
- },
- {
- "name" : "clicksToEdit",
- "type" : "Number",
- "desc" : "The number of clicks on a cell required to display the cell's editor (defaults to 2)",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "cm[]",
"type" : "Roo.grid.ColumnModel",
"desc" : "The columns of the grid",
- "memberOf" : "Roo.grid.Grid"
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "ddGroup",
"type" : "String",
"desc" : "- drag drop group.",
- "memberOf" : "Roo.grid.Grid"
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "ddText",
"type" : "String",
"desc" : "Configures the text is the drag proxy (defaults to \"%0 selected row(s)\").\n%0 is replaced with the number of selected rows.",
- "memberOf" : "Roo.grid.Grid"
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "dragGroup",
"type" : "String",
"desc" : "- drag group (?? not sure if needed.)",
- "memberOf" : "Roo.grid.Grid"
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "dropTarget",
"type" : "Roo.dd.DropTarget",
"desc" : "An {@link Roo.dd.DropTarget} config",
- "memberOf" : "Roo.grid.Grid"
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "ds",
- "type" : "Roo.grid.Store",
+ "type" : "Roo.data.Store",
"desc" : "The data store for the grid",
- "memberOf" : "Roo.grid.Grid"
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "enableColumnHide",
"type" : "Boolean",
"desc" : "True to enable hiding of columns with the header context menu. Default is true.",
- "memberOf" : "Roo.grid.Grid"
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "enableColumnMove",
"type" : "Boolean",
"desc" : "True to enable drag and drop reorder of columns. Default is true.",
- "memberOf" : "Roo.grid.Grid"
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "enableDrag",
"type" : "Boolean",
"desc" : "True to enable drag of rows. Default is false. (double check if this is needed?)",
- "memberOf" : "Roo.grid.Grid"
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "enableDragDrop",
"type" : "Boolean",
"desc" : "True to enable drag and drop of rows. Default is false.",
- "memberOf" : "Roo.grid.Grid"
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "enableDrop",
"type" : "Boolean",
"desc" : "True to enable drop of elements. Default is false. (double check if this is needed?)",
- "memberOf" : "Roo.grid.Grid"
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "enableRowHeightSync",
"type" : "Boolean",
"desc" : "True to manually sync row heights across locked and not locked rows. Default is false.",
- "memberOf" : "Roo.grid.Grid"
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"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"
+ "memberOf" : "Roo.util.Observable",
+ "isOptional" : false,
+ "optvals" : []
},
{
"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"
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "maxHeight",
"type" : "Number",
"desc" : "Sets the maximum height of the grid - ignored if autoHeight is not on.",
- "memberOf" : "Roo.grid.Grid"
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"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"
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "minColumnWidth",
"type" : "Number",
"desc" : "The minimum width a column can be resized to. Default is 25.",
- "memberOf" : "Roo.grid.Grid"
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "monitorWindowResize",
"type" : "Boolean",
"desc" : "True to autoSize the grid when the window resizes. Default is true.",
- "memberOf" : "Roo.grid.Grid"
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "sm",
"type" : "Roo.grid.AbstractSelectionModel",
"desc" : "The selection Model (default = Roo.grid.RowSelectionModel)",
- "memberOf" : "Roo.grid.Grid"
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "sortColMenu",
+ "type" : "boolean",
+ "desc" : "Sort the column order menu when it shows (usefull for long lists..) default false",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "stripeRows",
"type" : "Boolean",
"desc" : "True to stripe the rows. Default is true.",
- "memberOf" : "Roo.grid.Grid"
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "toolbar",
"type" : "Roo.Toolbar",
"desc" : "a toolbar for buttons etc.",
- "memberOf" : "Roo.grid.Grid"
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "trackMouseOver",
"type" : "Boolean",
"desc" : "True to highlight rows when the mouse is over. Default is true.",
- "memberOf" : "Roo.grid.Grid"
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "view",
+ "type" : "Roo.grid.GridView",
+ "desc" : "The view that renders the grid (default = Roo.grid.GridView)",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ }
+ ],
+ "events" : [
+ {
+ "name" : "bodyscroll",
+ "type" : "function",
+ "desc" : "Fires when the body element is scrolled",
+ "sig" : "function (scrollLeft, scrollTop)\n{\n\n}",
+ "memberOf" : "",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "scrollLeft",
+ "type" : "Number",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "scrollTop",
+ "type" : "Number",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "cellclick",
+ "type" : "function",
+ "desc" : "Fires when a cell is clicked",
+ "sig" : "function (_self, rowIndex, columnIndex, e)\n{\n\n}",
+ "memberOf" : "",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Grid",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "rowIndex",
+ "type" : "Number",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "columnIndex",
+ "type" : "Number",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "e",
+ "type" : "Roo.EventObject",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "cellcontextmenu",
+ "type" : "function",
+ "desc" : "Fires when a cell is right clicked",
+ "sig" : "function (_self, rowIndex, cellIndex, e)\n{\n\n}",
+ "memberOf" : "",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Grid",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "rowIndex",
+ "type" : "Number",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "cellIndex",
+ "type" : "Number",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "e",
+ "type" : "Roo.EventObject",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "celldblclick",
+ "type" : "function",
+ "desc" : "Fires when a cell is double clicked",
+ "sig" : "function (_self, rowIndex, columnIndex, e)\n{\n\n}",
+ "memberOf" : "",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Grid",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "rowIndex",
+ "type" : "Number",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "columnIndex",
+ "type" : "Number",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "e",
+ "type" : "Roo.EventObject",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "click",
+ "type" : "function",
+ "desc" : "The raw click event for the entire grid.",
+ "sig" : "function (e)\n{\n\n}",
+ "memberOf" : "",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "e",
+ "type" : "Roo.EventObject",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "columnmove",
+ "type" : "function",
+ "desc" : "Fires when the user moves a column",
+ "sig" : "function (oldIndex, newIndex)\n{\n\n}",
+ "memberOf" : "",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "oldIndex",
+ "type" : "Number",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "newIndex",
+ "type" : "Number",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "columnresize",
+ "type" : "function",
+ "desc" : "Fires when the user resizes a column",
+ "sig" : "function (columnIndex, newSize)\n{\n\n}",
+ "memberOf" : "",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "columnIndex",
+ "type" : "Number",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "newSize",
+ "type" : "Number",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "contextmenu",
+ "type" : "function",
+ "desc" : "The raw contextmenu event for the entire grid.",
+ "sig" : "function (e)\n{\n\n}",
+ "memberOf" : "",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "e",
+ "type" : "Roo.EventObject",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "dblclick",
+ "type" : "function",
+ "desc" : "The raw dblclick event for the entire grid.",
+ "sig" : "function (e)\n{\n\n}",
+ "memberOf" : "",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "e",
+ "type" : "Roo.EventObject",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "dragdrop",
+ "type" : "function",
+ "desc" : "Fires when dragged row(s) are dropped on a valid DD target",
+ "sig" : "function (_self, dd, targetId, e)\n{\n\n}",
+ "memberOf" : "",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Grid",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "dd",
+ "type" : "Roo.GridDD",
+ "desc" : "The drag drop object",
+ "isOptional" : false
+ },
+ {
+ "name" : "targetId",
+ "type" : "String",
+ "desc" : "The target drag drop object",
+ "isOptional" : false
+ },
+ {
+ "name" : "e",
+ "type" : "event",
+ "desc" : "The raw browser event",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "dragenter",
+ "type" : "function",
+ "desc" : "Fires when the dragged row(s) first cross another DD target while being dragged",
+ "sig" : "function (_self, dd, targetId, e)\n{\n\n}",
+ "memberOf" : "",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Grid",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "dd",
+ "type" : "Roo.GridDD",
+ "desc" : "The drag drop object",
+ "isOptional" : false
+ },
+ {
+ "name" : "targetId",
+ "type" : "String",
+ "desc" : "The target drag drop object",
+ "isOptional" : false
+ },
+ {
+ "name" : "e",
+ "type" : "event",
+ "desc" : "The raw browser event",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "dragout",
+ "type" : "function",
+ "desc" : "Fires when the dragged row(s) leave another DD target while being dragged",
+ "sig" : "function (_self, dd, targetId, e)\n{\n\n}",
+ "memberOf" : "",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Grid",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "dd",
+ "type" : "Roo.GridDD",
+ "desc" : "The drag drop object",
+ "isOptional" : false
+ },
+ {
+ "name" : "targetId",
+ "type" : "String",
+ "desc" : "The target drag drop object",
+ "isOptional" : false
+ },
+ {
+ "name" : "e",
+ "type" : "event",
+ "desc" : "The raw browser event",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "dragover",
+ "type" : "function",
+ "desc" : "Fires while row(s) are being dragged. \"targetId\" is the id of the Yahoo.util.DD object the selected rows are being dragged over.",
+ "sig" : "function (_self, dd, targetId, e)\n{\n\n}",
+ "memberOf" : "",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Grid",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "dd",
+ "type" : "Roo.GridDD",
+ "desc" : "The drag drop object",
+ "isOptional" : false
+ },
+ {
+ "name" : "targetId",
+ "type" : "String",
+ "desc" : "The target drag drop object",
+ "isOptional" : false
+ },
+ {
+ "name" : "e",
+ "type" : "event",
+ "desc" : "The raw browser event",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "enddrag",
+ "type" : "function",
+ "desc" : "Fires when a drag operation is complete",
+ "sig" : "function (_self, dd, e)\n{\n\n}",
+ "memberOf" : "",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Grid",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "dd",
+ "type" : "Roo.GridDD",
+ "desc" : "The drag drop object",
+ "isOptional" : false
+ },
+ {
+ "name" : "e",
+ "type" : "event",
+ "desc" : "The raw browser event",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "headerclick",
+ "type" : "function",
+ "desc" : "Fires when a header is clicked",
+ "sig" : "function (_self, columnIndex, e)\n{\n\n}",
+ "memberOf" : "",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Grid",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "columnIndex",
+ "type" : "Number",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "e",
+ "type" : "Roo.EventObject",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "headercontextmenu",
+ "type" : "function",
+ "desc" : "Fires when a header is right clicked",
+ "sig" : "function (_self, columnIndex, e)\n{\n\n}",
+ "memberOf" : "",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Grid",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "columnIndex",
+ "type" : "Number",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "e",
+ "type" : "Roo.EventObject",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "headerdblclick",
+ "type" : "function",
+ "desc" : "Fires when a header cell is double clicked",
+ "sig" : "function (_self, columnIndex, e)\n{\n\n}",
+ "memberOf" : "",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Grid",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "columnIndex",
+ "type" : "Number",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "e",
+ "type" : "Roo.EventObject",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "keydown",
+ "type" : "function",
+ "desc" : "The raw keydown event for the entire grid.",
+ "sig" : "function (e)\n{\n\n}",
+ "memberOf" : "",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "e",
+ "type" : "Roo.EventObject",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
},
{
- "name" : "view",
- "type" : "Roo.grid.GridView",
- "desc" : "The view that renders the grid (default = Roo.grid.GridView)",
- "memberOf" : "Roo.grid.Grid"
- }
- ],
- "events" : [
- {
- "name" : "afteredit",
+ "name" : "keypress",
"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" : "The raw keypress event for the entire grid.",
"sig" : "function (e)\n{\n\n}",
"memberOf" : "",
"example" : "",
"params" : [
{
"name" : "e",
- "type" : "Object",
- "desc" : "An edit event (see above for description)",
+ "type" : "Roo.EventObject",
+ "desc" : "",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "beforeedit",
+ "name" : "mousedown",
"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" : "The raw mousedown event for the entire grid.",
"sig" : "function (e)\n{\n\n}",
"memberOf" : "",
"example" : "",
"params" : [
{
"name" : "e",
- "type" : "Object",
- "desc" : "An edit event (see above for description)",
+ "type" : "Roo.EventObject",
+ "desc" : "",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "bodyscroll",
+ "name" : "mouseout",
"type" : "function",
- "desc" : "Fires when the body element is scrolled",
- "sig" : "function (scrollLeft, scrollTop)\n{\n\n}",
- "memberOf" : "Roo.grid.Grid",
+ "desc" : "The raw mouseout event for the entire grid.",
+ "sig" : "function (e)\n{\n\n}",
+ "memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
"params" : [
{
- "name" : "scrollLeft",
- "type" : "Number",
+ "name" : "e",
+ "type" : "Roo.EventObject",
"desc" : "",
"isOptional" : false
- },
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "mouseover",
+ "type" : "function",
+ "desc" : "The raw mouseover event for the entire grid.",
+ "sig" : "function (e)\n{\n\n}",
+ "memberOf" : "",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
{
- "name" : "scrollTop",
- "type" : "Number",
+ "name" : "e",
+ "type" : "Roo.EventObject",
"desc" : "",
"isOptional" : false
}
"returns" : []
},
{
- "name" : "cellclick",
+ "name" : "mouseup",
"type" : "function",
- "desc" : "Fires when a cell is clicked",
- "sig" : "function (_self, rowIndex, columnIndex, e)\n{\n\n}",
- "memberOf" : "Roo.grid.Grid",
+ "desc" : "The raw mouseup event for the entire grid.",
+ "sig" : "function (e)\n{\n\n}",
+ "memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
"params" : [
{
- "name" : "this",
- "type" : "Grid",
+ "name" : "e",
+ "type" : "Roo.EventObject",
"desc" : "",
"isOptional" : false
- },
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "render",
+ "type" : "function",
+ "desc" : "Fires when the grid is rendered",
+ "sig" : "function (grid)\n{\n\n}",
+ "memberOf" : "",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
{
- "name" : "rowIndex",
- "type" : "Number",
+ "name" : "grid",
+ "type" : "Grid",
"desc" : "",
"isOptional" : false
- },
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "rowclass",
+ "type" : "function",
+ "desc" : "Fires when a row is rendered, so you can change add a style to it.",
+ "sig" : "function (gridview, rowcfg)\n{\n\n}",
+ "memberOf" : "",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
{
- "name" : "columnIndex",
- "type" : "Number",
- "desc" : "",
+ "name" : "gridview",
+ "type" : "GridView",
+ "desc" : "The grid view",
"isOptional" : false
},
{
- "name" : "e",
- "type" : "Roo.EventObject",
- "desc" : "",
+ "name" : "rowcfg",
+ "type" : "Object",
+ "desc" : "contains record rowIndex and rowClass - set rowClass to add a style.",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "cellcontextmenu",
+ "name" : "rowclick",
"type" : "function",
- "desc" : "Fires when a cell is right clicked",
- "sig" : "function (_self, rowIndex, cellIndex, e)\n{\n\n}",
- "memberOf" : "Roo.grid.Grid",
+ "desc" : "Fires when a row is clicked",
+ "sig" : "function (_self, rowIndex, e)\n{\n\n}",
+ "memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
"desc" : "",
"isOptional" : false
},
- {
- "name" : "cellIndex",
- "type" : "Number",
- "desc" : "",
- "isOptional" : false
- },
{
"name" : "e",
"type" : "Roo.EventObject",
"returns" : []
},
{
- "name" : "celldblclick",
+ "name" : "rowcontextmenu",
"type" : "function",
- "desc" : "Fires when a cell is double clicked",
- "sig" : "function (_self, rowIndex, columnIndex, e)\n{\n\n}",
- "memberOf" : "Roo.grid.Grid",
+ "desc" : "Fires when a row is right clicked",
+ "sig" : "function (_self, rowIndex, e)\n{\n\n}",
+ "memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
"desc" : "",
"isOptional" : false
},
- {
- "name" : "columnIndex",
- "type" : "Number",
- "desc" : "",
- "isOptional" : false
- },
{
"name" : "e",
"type" : "Roo.EventObject",
"returns" : []
},
{
- "name" : "click",
+ "name" : "rowdblclick",
"type" : "function",
- "desc" : "The raw click event for the entire grid.",
- "sig" : "function (e)\n{\n\n}",
- "memberOf" : "Roo.grid.Grid",
+ "desc" : "Fires when a row is double clicked",
+ "sig" : "function (_self, rowIndex, e)\n{\n\n}",
+ "memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
"params" : [
{
- "name" : "e",
- "type" : "Roo.EventObject",
+ "name" : "this",
+ "type" : "Grid",
"desc" : "",
"isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "columnmove",
- "type" : "function",
- "desc" : "Fires when the user moves a column",
- "sig" : "function (oldIndex, newIndex)\n{\n\n}",
- "memberOf" : "Roo.grid.Grid",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
+ },
{
- "name" : "oldIndex",
+ "name" : "rowIndex",
"type" : "Number",
"desc" : "",
"isOptional" : false
},
{
- "name" : "newIndex",
- "type" : "Number",
+ "name" : "e",
+ "type" : "Roo.EventObject",
"desc" : "",
"isOptional" : false
}
"returns" : []
},
{
- "name" : "columnresize",
+ "name" : "startdrag",
"type" : "function",
- "desc" : "Fires when the user resizes a column",
- "sig" : "function (columnIndex, newSize)\n{\n\n}",
- "memberOf" : "Roo.grid.Grid",
+ "desc" : "Fires when row(s) start being dragged",
+ "sig" : "function (_self, dd, e)\n{\n\n}",
+ "memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
"params" : [
{
- "name" : "columnIndex",
- "type" : "Number",
+ "name" : "this",
+ "type" : "Grid",
"desc" : "",
"isOptional" : false
},
{
- "name" : "newSize",
- "type" : "Number",
- "desc" : "",
+ "name" : "dd",
+ "type" : "Roo.GridDD",
+ "desc" : "The drag drop object",
+ "isOptional" : false
+ },
+ {
+ "name" : "e",
+ "type" : "event",
+ "desc" : "The raw browser event",
"isOptional" : false
}
],
"returns" : []
- },
+ }
+ ],
+ "methods" : [
{
- "name" : "contextmenu",
+ "name" : "addColumns",
"type" : "function",
- "desc" : "The raw contextmenu event for the entire grid.",
- "sig" : "function (e)\n{\n\n}",
- "memberOf" : "Roo.grid.Grid",
+ "desc" : "addColumns\nAdd's a column, default at the end..",
+ "sig" : "(position, of)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
- "name" : "e",
- "type" : "Roo.EventObject",
- "desc" : "",
+ "name" : "position",
+ "type" : "int",
+ "desc" : "to add (default end)",
+ "isOptional" : false
+ },
+ {
+ "name" : "of",
+ "type" : "Array",
+ "desc" : "objects of column configuration see {@link Roo.grid.ColumnModel}",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "dblclick",
+ "name" : "addEvents",
"type" : "function",
- "desc" : "The raw dblclick event for the entire grid.",
- "sig" : "function (e)\n{\n\n}",
- "memberOf" : "Roo.grid.Grid",
+ "desc" : "Used to define events on this Observable",
+ "sig" : "(object)",
+ "static" : false,
+ "memberOf" : "Roo.util.Observable",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
- "name" : "e",
- "type" : "Roo.EventObject",
- "desc" : "",
+ "name" : "object",
+ "type" : "Object",
+ "desc" : "The object with the events defined",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "dragdrop",
+ "name" : "addListener",
"type" : "function",
- "desc" : "Fires when dragged row(s) are dropped on a valid DD target",
- "sig" : "function (_self, dd, targetId, e)\n{\n\n}",
- "memberOf" : "Roo.grid.Grid",
+ "desc" : "Appends an event handler to this component",
+ "sig" : "(eventName, handler, scope, options)",
+ "static" : false,
+ "memberOf" : "Roo.util.Observable",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
- "name" : "this",
- "type" : "Grid",
- "desc" : "",
+ "name" : "eventName",
+ "type" : "String",
+ "desc" : "The type of event to listen for",
"isOptional" : false
},
{
- "name" : "dd",
- "type" : "Roo.GridDD",
- "desc" : "The drag drop object",
+ "name" : "handler",
+ "type" : "Function",
+ "desc" : "The method the event invokes",
"isOptional" : false
},
{
- "name" : "targetId",
- "type" : "String",
- "desc" : "The target drag drop object",
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
"isOptional" : false
},
{
- "name" : "e",
- "type" : "event",
- "desc" : "The raw browser event",
+ "name" : "options",
+ "type" : "Object",
+ "desc" : "(optional) An object containing handler configuration\nproperties. This may contain any of the following properties:<ul>\n<li>scope {Object} The scope in which to execute the handler function. The handler function's \"this\" context.</li>\n<li>delay {Number} The number of milliseconds to delay the invocation of the handler after te event fires.</li>\n<li>single {Boolean} True to add a handler to handle just the next firing of the event, and then remove itself.</li>\n<li>buffer {Number} Causes the handler to be scheduled to run in an {@link Roo.util.DelayedTask} delayed\nby the specified number of milliseconds. If the event fires again within that time, the original\nhandler is <em>not</em> invoked, but the new handler is scheduled in its place.</li>\n</ul><br>\n<p>\n<b>Combining Options</b><br>\nUsing the options argument, it is possible to combine different types of listeners:<br>\n<br>\nA normalized, delayed, one-time listener that auto stops the event and passes a custom argument (forumId)\n\t\t<pre><code>\n\t\tel.on('click', this.onClick, this, {\n \t\t\tsingle: true,\n \t\tdelay: 100,\n \t\tforumId: 4\n\t\t});\n\t\t</code></pre>\n<p>\n<b>Attaching multiple handlers in 1 call</b><br>\nThe method also allows for a single argument to be passed which is a config object containing properties\nwhich specify multiple handlers.\n<pre><code>\n\t\tel.on({\n\t\t\t'click': {\n \t\tfn: this.onClick,\n \t\tscope: this,\n \t\tdelay: 100\n \t\t}, \n \t\t'mouseover': {\n \t\tfn: this.onMouseOver,\n \t\tscope: this\n \t\t},\n \t\t'mouseout': {\n \t\tfn: this.onMouseOut,\n \t\tscope: this\n \t\t}\n\t\t});\n\t\t</code></pre>\n<p>\nOr a shorthand syntax which passes the same scope object to all handlers:\n \t<pre><code>\n\t\tel.on({\n\t\t\t'click': this.onClick,\n \t\t'mouseover': this.onMouseOver,\n \t\t'mouseout': this.onMouseOut,\n \t\tscope: this\n\t\t});\n\t\t</code></pre>",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "dragenter",
+ "name" : "autoSize",
"type" : "function",
- "desc" : "Fires when the dragged row(s) first cross another DD target while being dragged",
- "sig" : "function (_self, dd, targetId, e)\n{\n\n}",
- "memberOf" : "Roo.grid.Grid",
+ "desc" : "Causes the grid to manually recalculate its dimensions. Generally this is done automatically,\nbut if manual update is required this method will initiate it.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
+ {
+ "name" : "capture",
+ "type" : "function",
+ "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\n<b>before</b> the event is fired. If the supplied function returns false,\nthe event will not fire.",
+ "sig" : "(o, fn, scope)",
+ "static" : true,
+ "memberOf" : "Roo.util.Observable",
+ "isStatic" : true,
+ "isConstructor" : false,
+ "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
- "name" : "this",
- "type" : "Grid",
- "desc" : "",
+ "name" : "o",
+ "type" : "Observable",
+ "desc" : "The Observable to capture",
"isOptional" : false
},
{
- "name" : "dd",
- "type" : "Roo.GridDD",
- "desc" : "The drag drop object",
+ "name" : "fn",
+ "type" : "Function",
+ "desc" : "The function to call",
"isOptional" : false
},
{
- "name" : "targetId",
- "type" : "String",
- "desc" : "The target drag drop object",
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "(optional) The scope (this object) for the fn",
"isOptional" : false
- },
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "destroy",
+ "type" : "function",
+ "desc" : "Destroy this grid.",
+ "sig" : "(removeEl)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
{
- "name" : "e",
- "type" : "event",
- "desc" : "The raw browser event",
+ "name" : "removeEl",
+ "type" : "Boolean",
+ "desc" : "True to remove the element",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "dragout",
+ "name" : "fireEvent",
"type" : "function",
- "desc" : "Fires when the dragged row(s) leave another DD target while being dragged",
- "sig" : "function (_self, dd, targetId, e)\n{\n\n}",
- "memberOf" : "Roo.grid.Grid",
+ "desc" : "Fires the specified event with the passed parameters (minus the event name).",
+ "sig" : "(eventName, args)",
+ "static" : false,
+ "memberOf" : "Roo.util.Observable",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
- "name" : "this",
- "type" : "Grid",
+ "name" : "eventName",
+ "type" : "String",
"desc" : "",
"isOptional" : false
},
{
- "name" : "dd",
- "type" : "Roo.GridDD",
- "desc" : "The drag drop object",
+ "name" : "args",
+ "type" : "Object...",
+ "desc" : "Variable number of parameters are passed to handlers",
"isOptional" : false
- },
+ }
+ ],
+ "returns" : [
{
- "name" : "targetId",
+ "name" : "",
+ "type" : "Boolean",
+ "desc" : "returns false if any of the handlers return false otherwise it returns true"
+ }
+ ]
+ },
+ {
+ "name" : "getColumnModel",
+ "type" : "function",
+ "desc" : "Returns the grid's ColumnModel.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "ColumnModel",
+ "desc" : ""
+ }
+ ]
+ },
+ {
+ "name" : "getDataSource",
+ "type" : "function",
+ "desc" : "Returns the grid's DataSource.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "DataSource",
+ "desc" : ""
+ }
+ ]
+ },
+ {
+ "name" : "getDragDropText",
+ "type" : "function",
+ "desc" : "Called to get grid's drag proxy text, by default returns this.ddText.\nOverride this to put something different in the dragged text.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : [
+ {
+ "name" : "",
"type" : "String",
- "desc" : "The target drag drop object",
- "isOptional" : false
- },
+ "desc" : ""
+ }
+ ]
+ },
+ {
+ "name" : "getGridEl",
+ "type" : "function",
+ "desc" : "Returns the grid's underlying element.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : [
{
- "name" : "e",
- "type" : "event",
- "desc" : "The raw browser event",
+ "name" : "",
+ "type" : "Element",
+ "desc" : "The element"
+ }
+ ]
+ },
+ {
+ "name" : "getSelectionModel",
+ "type" : "function",
+ "desc" : "Returns the grid's SelectionModel.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "SelectionModel",
+ "desc" : ""
+ }
+ ]
+ },
+ {
+ "name" : "getView",
+ "type" : "function",
+ "desc" : "Returns the grid's GridView object.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "GridView",
+ "desc" : ""
+ }
+ ]
+ },
+ {
+ "name" : "hasListener",
+ "type" : "function",
+ "desc" : "Checks to see if this object has any listeners for a specified event",
+ "sig" : "(eventName)",
+ "static" : false,
+ "memberOf" : "Roo.util.Observable",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "eventName",
+ "type" : "String",
+ "desc" : "The name of the event to check for",
"isOptional" : false
}
],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Boolean",
+ "desc" : "True if the event is being listened for, else false"
+ }
+ ]
},
{
- "name" : "dragover",
+ "name" : "on",
"type" : "function",
- "desc" : "Fires while row(s) are being dragged. \"targetId\" is the id of the Yahoo.util.DD object the selected rows are being dragged over.",
- "sig" : "function (_self, dd, targetId, e)\n{\n\n}",
- "memberOf" : "Roo.grid.Grid",
+ "desc" : "Appends an event handler to this element (shorthand for addListener)",
+ "sig" : "(eventName, handler, scope, options)",
+ "static" : false,
+ "memberOf" : "Roo.util.Observable",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
- "name" : "this",
- "type" : "Grid",
- "desc" : "",
+ "name" : "eventName",
+ "type" : "String",
+ "desc" : "The type of event to listen for",
"isOptional" : false
},
{
- "name" : "dd",
- "type" : "Roo.GridDD",
- "desc" : "The drag drop object",
+ "name" : "handler",
+ "type" : "Function",
+ "desc" : "The method the event invokes",
"isOptional" : false
},
{
- "name" : "targetId",
- "type" : "String",
- "desc" : "The target drag drop object",
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
"isOptional" : false
},
{
- "name" : "e",
- "type" : "event",
- "desc" : "The raw browser event",
+ "name" : "options",
+ "type" : "Object",
+ "desc" : "(optional)",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "enddrag",
+ "name" : "purgeListeners",
"type" : "function",
- "desc" : "Fires when a drag operation is complete",
- "sig" : "function (_self, dd, e)\n{\n\n}",
- "memberOf" : "Roo.grid.Grid",
+ "desc" : "Removes all listeners for this object",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.util.Observable",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
+ {
+ "name" : "reconfigure",
+ "type" : "function",
+ "desc" : "Reconfigures the grid to use a different Store and Column Model.\nThe View will be bound to the new objects and refreshed.",
+ "sig" : "(dataSource, The)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
- "name" : "this",
- "type" : "Grid",
- "desc" : "",
+ "name" : "dataSource",
+ "type" : "Roo.data.Store",
+ "desc" : "The new {@link Roo.data.Store} object",
"isOptional" : false
},
{
- "name" : "dd",
- "type" : "Roo.GridDD",
- "desc" : "The drag drop object",
+ "name" : "The",
+ "type" : "Roo.grid.ColumnModel",
+ "desc" : "new {@link Roo.grid.ColumnModel} object",
"isOptional" : false
- },
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "releaseCapture",
+ "type" : "function",
+ "desc" : "Removes <b>all</b> added captures from the Observable.",
+ "sig" : "(o)",
+ "static" : true,
+ "memberOf" : "Roo.util.Observable",
+ "isStatic" : true,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
{
- "name" : "e",
- "type" : "event",
- "desc" : "The raw browser event",
+ "name" : "o",
+ "type" : "Observable",
+ "desc" : "The Observable to release",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "headerclick",
+ "name" : "removeListener",
"type" : "function",
- "desc" : "Fires when a header is clicked",
- "sig" : "function (_self, columnIndex, e)\n{\n\n}",
- "memberOf" : "Roo.grid.Grid",
+ "desc" : "Removes a listener",
+ "sig" : "(eventName, handler, scope)",
+ "static" : false,
+ "memberOf" : "Roo.util.Observable",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
- "name" : "this",
- "type" : "Grid",
- "desc" : "",
+ "name" : "eventName",
+ "type" : "String",
+ "desc" : "The type of event to listen for",
"isOptional" : false
},
{
- "name" : "columnIndex",
- "type" : "Number",
- "desc" : "",
+ "name" : "handler",
+ "type" : "Function",
+ "desc" : "The handler to remove",
"isOptional" : false
},
{
- "name" : "e",
- "type" : "Roo.EventObject",
- "desc" : "",
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "(optional) The scope (this object) for the handler",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "headercontextmenu",
+ "name" : "render",
"type" : "function",
- "desc" : "Fires when a header is right clicked",
- "sig" : "function (_self, columnIndex, e)\n{\n\n}",
- "memberOf" : "Roo.grid.Grid",
+ "desc" : "Called once after all setup has been completed and the grid is ready to be rendered.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.grid.Grid",
+ "desc" : "this"
+ }
+ ]
+ },
+ {
+ "name" : "un",
+ "type" : "function",
+ "desc" : "Removes a listener (shorthand for removeListener)",
+ "sig" : "(eventName, handler, scope)",
+ "static" : false,
+ "memberOf" : "Roo.util.Observable",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
- "name" : "this",
- "type" : "Grid",
- "desc" : "",
+ "name" : "eventName",
+ "type" : "String",
+ "desc" : "The type of event to listen for",
"isOptional" : false
},
{
- "name" : "columnIndex",
- "type" : "Number",
- "desc" : "",
+ "name" : "handler",
+ "type" : "Function",
+ "desc" : "The handler to remove",
"isOptional" : false
},
{
- "name" : "e",
- "type" : "Roo.EventObject",
- "desc" : "",
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "(optional) The scope (this object) for the handler",
"isOptional" : false
}
],
"returns" : []
+ }
+ ],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "implementations" : [
+ "Roo.grid.Calendar",
+ "Roo.grid.EditorGrid",
+ "Roo.grid.PropertyGrid"
+ ],
+ "tree_children" : [],
+ "tree_parent" : []
+ },
+ "Roo.grid.GridEditor" : {
+ "props" : [
+ {
+ "name" : "actionMode",
+ "type" : "String",
+ "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el' for forms you probably want to set this to fieldEl",
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
- "name" : "headerdblclick",
+ "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",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "allowDomMove",
+ "type" : "Boolean",
+ "desc" : "Whether the component can move the Dom node when rendering (defaults to true).",
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "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",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "cancelOnEsc",
+ "type" : "Boolean",
+ "desc" : "True to cancel the edit when the escape key is pressed (defaults to false)",
+ "memberOf" : "Roo.Editor",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "completeOnEnter",
+ "type" : "Boolean",
+ "desc" : "True to complete the edit when the enter key is pressed (defaults to false)",
+ "memberOf" : "Roo.Editor",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "constrain",
+ "type" : "Boolean",
+ "desc" : "True to constrain the editor to the viewport",
+ "memberOf" : "Roo.Editor",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "disableClass",
+ "type" : "String",
+ "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").",
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "field",
+ "type" : "Roo.form.Field",
+ "desc" : "Field to wrap (or xtyped)",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "hideEl",
+ "type" : "Boolean",
+ "desc" : "False to keep the bound element visible while the editor is displayed (defaults to true)",
+ "memberOf" : "Roo.Editor",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "hideMode",
+ "type" : "String",
+ "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display",
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : [
+ "display",
+ "visibility"
+ ]
+ },
+ {
+ "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",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "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",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "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",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "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",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "style",
+ "type" : "String",
+ "desc" : "css styles to add to component\neg. text-align:right;",
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "updateEl",
+ "type" : "Boolean",
+ "desc" : "True to update the innerHTML of the bound element when the update completes (defaults to false)",
+ "memberOf" : "Roo.Editor",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "value",
+ "type" : "Mixed",
+ "desc" : "The data value of the underlying field (defaults to \"\")",
+ "memberOf" : "Roo.Editor",
+ "isOptional" : false,
+ "optvals" : []
+ }
+ ],
+ "events" : [
+ {
+ "name" : "beforecomplete",
"type" : "function",
- "desc" : "Fires when a header cell is double clicked",
- "sig" : "function (_self, columnIndex, e)\n{\n\n}",
- "memberOf" : "Roo.grid.Grid",
+ "desc" : "Fires after a change has been made to the field, but before the change is reflected in the underlying\nfield. Saving the change to the field can be canceled by returning false from the handler of this event.\nNote that if the value has not changed and ignoreNoChange = true, the editing will still end but this\nevent will not fire since no edit actually occurred.",
+ "sig" : "function (_self, value, startValue)\n{\n\n}",
+ "memberOf" : "Roo.Editor",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Grid",
+ "type" : "Editor",
"desc" : "",
"isOptional" : false
},
{
- "name" : "columnIndex",
- "type" : "Number",
- "desc" : "",
+ "name" : "value",
+ "type" : "Mixed",
+ "desc" : "The current field value",
"isOptional" : false
},
{
- "name" : "e",
- "type" : "Roo.EventObject",
- "desc" : "",
+ "name" : "startValue",
+ "type" : "Mixed",
+ "desc" : "The original field value",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "keydown",
+ "name" : "beforedestroy",
"type" : "function",
- "desc" : "The raw keydown event for the entire grid.",
- "sig" : "function (e)\n{\n\n}",
- "memberOf" : "Roo.grid.Grid",
+ "desc" : "Fires before the component is destroyed. Return false to stop the destroy.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
"params" : [
{
- "name" : "e",
- "type" : "Roo.EventObject",
+ "name" : "this",
+ "type" : "Roo.Component",
"desc" : "",
"isOptional" : false
}
"returns" : []
},
{
- "name" : "keypress",
+ "name" : "beforehide",
"type" : "function",
- "desc" : "The raw keypress event for the entire grid.",
- "sig" : "function (e)\n{\n\n}",
- "memberOf" : "Roo.grid.Grid",
+ "desc" : "Fires before the component is hidden. Return false to stop the hide.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
"params" : [
{
- "name" : "e",
- "type" : "Roo.EventObject",
+ "name" : "this",
+ "type" : "Roo.Component",
"desc" : "",
"isOptional" : false
}
"returns" : []
},
{
- "name" : "mousedown",
+ "name" : "beforerender",
"type" : "function",
- "desc" : "The raw mousedown event for the entire grid.",
- "sig" : "function (e)\n{\n\n}",
- "memberOf" : "Roo.grid.Grid",
+ "desc" : "Fires before the component is rendered. Return false to stop the render.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
"params" : [
{
- "name" : "e",
- "type" : "Roo.EventObject",
+ "name" : "this",
+ "type" : "Roo.Component",
"desc" : "",
"isOptional" : false
}
"returns" : []
},
{
- "name" : "mouseout",
+ "name" : "beforeshow",
"type" : "function",
- "desc" : "The raw mouseout event for the entire grid.",
- "sig" : "function (e)\n{\n\n}",
- "memberOf" : "Roo.grid.Grid",
+ "desc" : "Fires before the component is shown. Return false to stop the show.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
"params" : [
{
- "name" : "e",
- "type" : "Roo.EventObject",
+ "name" : "this",
+ "type" : "Roo.Component",
"desc" : "",
"isOptional" : false
}
"returns" : []
},
{
- "name" : "mouseover",
+ "name" : "beforestartedit",
"type" : "function",
- "desc" : "The raw mouseover event for the entire grid.",
- "sig" : "function (e)\n{\n\n}",
- "memberOf" : "Roo.grid.Grid",
+ "desc" : "Fires when editing is initiated, but before the value changes. Editing can be canceled by returning\nfalse from the handler of this event.",
+ "sig" : "function (_self, boundEl, value)\n{\n\n}",
+ "memberOf" : "Roo.Editor",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
"params" : [
{
- "name" : "e",
- "type" : "Roo.EventObject",
+ "name" : "this",
+ "type" : "Editor",
"desc" : "",
"isOptional" : false
+ },
+ {
+ "name" : "boundEl",
+ "type" : "Roo.Element",
+ "desc" : "The underlying element bound to this editor",
+ "isOptional" : false
+ },
+ {
+ "name" : "value",
+ "type" : "Mixed",
+ "desc" : "The field value being set",
+ "isOptional" : false
}
],
"returns" : []
},
{
- "name" : "mouseup",
+ "name" : "complete",
"type" : "function",
- "desc" : "The raw mouseup event for the entire grid.",
- "sig" : "function (e)\n{\n\n}",
- "memberOf" : "Roo.grid.Grid",
+ "desc" : "Fires after editing is complete and any changed value has been written to the underlying field.",
+ "sig" : "function (_self, value, startValue)\n{\n\n}",
+ "memberOf" : "Roo.Editor",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
"params" : [
{
- "name" : "e",
- "type" : "Roo.EventObject",
+ "name" : "this",
+ "type" : "Editor",
"desc" : "",
"isOptional" : false
+ },
+ {
+ "name" : "value",
+ "type" : "Mixed",
+ "desc" : "The current field value",
+ "isOptional" : false
+ },
+ {
+ "name" : "startValue",
+ "type" : "Mixed",
+ "desc" : "The original field value",
+ "isOptional" : false
}
],
"returns" : []
},
{
- "name" : "render",
+ "name" : "destroy",
"type" : "function",
- "desc" : "Fires when the grid is rendered",
- "sig" : "function (grid)\n{\n\n}",
- "memberOf" : "Roo.grid.Grid",
+ "desc" : "Fires after the component is destroyed.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
"params" : [
{
- "name" : "grid",
- "type" : "Grid",
+ "name" : "this",
+ "type" : "Roo.Component",
"desc" : "",
"isOptional" : false
}
"returns" : []
},
{
- "name" : "rowclass",
+ "name" : "disable",
"type" : "function",
- "desc" : "Fires when a row is rendered, so you can change add a style to it.",
- "sig" : "function (gridview, rowcfg)\n{\n\n}",
- "memberOf" : "Roo.grid.Grid",
+ "desc" : "Fires after the component is disabled.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
"params" : [
{
- "name" : "gridview",
- "type" : "GridView",
- "desc" : "The grid view",
- "isOptional" : false
- },
- {
- "name" : "rowcfg",
- "type" : "Object",
- "desc" : "contains record rowIndex and rowClass - set rowClass to add a style.",
+ "name" : "this",
+ "type" : "Roo.Component",
+ "desc" : "",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "rowclick",
+ "name" : "enable",
"type" : "function",
- "desc" : "Fires when a row is clicked",
- "sig" : "function (_self, rowIndex, e)\n{\n\n}",
- "memberOf" : "Roo.grid.Grid",
+ "desc" : "Fires after the component is enabled.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Grid",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "rowIndex",
- "type" : "Number",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "e",
- "type" : "Roo.EventObject",
+ "type" : "Roo.Component",
"desc" : "",
"isOptional" : false
}
"returns" : []
},
{
- "name" : "rowcontextmenu",
+ "name" : "hide",
"type" : "function",
- "desc" : "Fires when a row is right clicked",
- "sig" : "function (_self, rowIndex, e)\n{\n\n}",
- "memberOf" : "Roo.grid.Grid",
+ "desc" : "Fires after the component is hidden.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Grid",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "rowIndex",
- "type" : "Number",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "e",
- "type" : "Roo.EventObject",
+ "type" : "Roo.Component",
"desc" : "",
"isOptional" : false
}
"returns" : []
},
{
- "name" : "rowdblclick",
+ "name" : "render",
"type" : "function",
- "desc" : "Fires when a row is double clicked",
- "sig" : "function (_self, rowIndex, e)\n{\n\n}",
- "memberOf" : "Roo.grid.Grid",
+ "desc" : "Fires after the component is rendered.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Grid",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "rowIndex",
- "type" : "Number",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "e",
- "type" : "Roo.EventObject",
+ "type" : "Roo.Component",
"desc" : "",
"isOptional" : false
}
"returns" : []
},
{
- "name" : "startdrag",
+ "name" : "show",
"type" : "function",
- "desc" : "Fires when row(s) start being dragged",
- "sig" : "function (_self, dd, e)\n{\n\n}",
- "memberOf" : "Roo.grid.Grid",
+ "desc" : "Fires after the component is shown.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Grid",
+ "type" : "Roo.Component",
"desc" : "",
"isOptional" : false
- },
- {
- "name" : "dd",
- "type" : "Roo.GridDD",
- "desc" : "The drag drop object",
- "isOptional" : false
- },
- {
- "name" : "e",
- "type" : "event",
- "desc" : "The raw browser event",
- "isOptional" : false
}
],
"returns" : []
},
{
- "name" : "validateedit",
+ "name" : "specialkey",
"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>",
- "sig" : "function (e)\n{\n\n}",
- "memberOf" : "",
+ "desc" : "Fires when any key related to navigation (arrows, tab, enter, esc, etc.) is pressed. You can check\n{@link Roo.EventObject#getKey} to determine which key was pressed.",
+ "sig" : "function (_self, e)\n{\n\n}",
+ "memberOf" : "Roo.Editor",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
"params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.form.Field",
+ "desc" : "",
+ "isOptional" : false
+ },
{
"name" : "e",
- "type" : "Object",
- "desc" : "An edit event (see above for description)",
+ "type" : "Roo.EventObject",
+ "desc" : "The event object",
"isOptional" : false
}
],
"returns" : []
- }
- ],
- "methods" : [
+ },
{
- "name" : "addColumns",
+ "name" : "startedit",
"type" : "function",
- "desc" : "addColumns\nAdd's a column, default at the end..",
- "sig" : "(position, of)",
- "static" : false,
- "memberOf" : "Roo.grid.Grid",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
+ "desc" : "Fires when this editor is displayed",
+ "sig" : "function (boundEl, value)\n{\n\n}",
+ "memberOf" : "Roo.Editor",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
"params" : [
{
- "name" : "position",
- "type" : "int",
- "desc" : "to add (default end)",
+ "name" : "boundEl",
+ "type" : "Roo.Element",
+ "desc" : "The underlying element bound to this editor",
"isOptional" : false
},
{
- "name" : "of",
- "type" : "Array",
- "desc" : "objects of column configuration see {@link Roo.grid.ColumnModel}",
+ "name" : "value",
+ "type" : "Mixed",
+ "desc" : "The starting field value",
"isOptional" : false
}
],
"returns" : []
- },
+ }
+ ],
+ "methods" : [
{
"name" : "addEvents",
"type" : "function",
"returns" : []
},
{
- "name" : "autoSize",
+ "name" : "cancelEdit",
"type" : "function",
- "desc" : "Causes the grid to manually recalculate its dimensions. Generally this is done automatically,\nbut if manual update is required this method will initiate it.",
- "sig" : "()\n{\n\n}",
+ "desc" : "Cancels the editing process and hides the editor without persisting any changes. The field value will be\nreverted to the original starting value.",
+ "sig" : "(remainVisible)",
"static" : false,
- "memberOf" : "Roo.grid.Grid",
+ "memberOf" : "Roo.Editor",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
+ "params" : [
+ {
+ "name" : "remainVisible",
+ "type" : "Boolean",
+ "desc" : "Override the default behavior and keep the editor visible after\ncancel (defaults to false)",
+ "isOptional" : false
+ }
+ ],
"returns" : []
},
{
"returns" : []
},
{
- "name" : "destroy",
+ "name" : "completeEdit",
"type" : "function",
- "desc" : "Destroy this grid.",
- "sig" : "(removeEl)",
+ "desc" : "Ends the editing process, persists the changed value to the underlying field, and hides the editor.",
+ "sig" : "(remainVisible)",
"static" : false,
- "memberOf" : "Roo.grid.Grid",
+ "memberOf" : "Roo.Editor",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "removeEl",
+ "name" : "remainVisible",
"type" : "Boolean",
- "desc" : "True to remove the element",
+ "desc" : "Override the default behavior and keep the editor visible after edit (defaults to false)",
"isOptional" : false
}
],
"returns" : []
},
+ {
+ "name" : "destroy",
+ "type" : "function",
+ "desc" : "Destroys this component by purging any event listeners, removing the component's element from the DOM,\nremoving the component from its {@link Roo.Container} (if applicable) and unregistering it from {@link Roo.ComponentMgr}.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.Component",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
+ {
+ "name" : "disable",
+ "type" : "function",
+ "desc" : "Disable this component.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.Component",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.Component",
+ "desc" : "this"
+ }
+ ]
+ },
+ {
+ "name" : "enable",
+ "type" : "function",
+ "desc" : "Enable this component.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.Component",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.Component",
+ "desc" : "this"
+ }
+ ]
+ },
{
"name" : "fireEvent",
"type" : "function",
]
},
{
- "name" : "getColumnModel",
+ "name" : "focus",
"type" : "function",
- "desc" : "Returns the grid's ColumnModel.",
- "sig" : "()\n{\n\n}",
+ "desc" : "Try to focus this component.",
+ "sig" : "(selectText)",
"static" : false,
- "memberOf" : "Roo.grid.Grid",
+ "memberOf" : "Roo.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
+ "params" : [
+ {
+ "name" : "selectText",
+ "type" : "Boolean",
+ "desc" : "True to also select the text in this component (if applicable)",
+ "isOptional" : false
+ }
+ ],
"returns" : [
{
"name" : "",
- "type" : "ColumnModel",
- "desc" : ""
+ "type" : "Roo.Component",
+ "desc" : "this"
}
]
},
{
- "name" : "getDataSource",
+ "name" : "getEl",
"type" : "function",
- "desc" : "Returns the grid's DataSource.",
+ "desc" : "Returns the underlying {@link Roo.Element}.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.grid.Grid",
+ "memberOf" : "Roo.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"returns" : [
{
"name" : "",
- "type" : "DataSource",
- "desc" : ""
+ "type" : "Roo.Element",
+ "desc" : "The element"
}
]
},
{
- "name" : "getDragDropText",
+ "name" : "getId",
"type" : "function",
- "desc" : "Called to get grid's drag proxy text, by default returns this.ddText.",
+ "desc" : "Returns the id of this component.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
]
},
{
- "name" : "getGridEl",
+ "name" : "getValue",
"type" : "function",
- "desc" : "Returns the grid's underlying element.",
+ "desc" : "Gets the data value of the editor",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.grid.Grid",
+ "memberOf" : "Roo.Editor",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"returns" : [
{
"name" : "",
- "type" : "Element",
- "desc" : "The element"
+ "type" : "Mixed",
+ "desc" : "The data value"
}
]
},
{
- "name" : "getSelectionModel",
+ "name" : "hasListener",
"type" : "function",
- "desc" : "Returns the grid's SelectionModel.",
- "sig" : "()\n{\n\n}",
+ "desc" : "Checks to see if this object has any listeners for a specified event",
+ "sig" : "(eventName)",
"static" : false,
- "memberOf" : "Roo.grid.Grid",
+ "memberOf" : "Roo.util.Observable",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
+ "params" : [
+ {
+ "name" : "eventName",
+ "type" : "String",
+ "desc" : "The name of the event to check for",
+ "isOptional" : false
+ }
+ ],
"returns" : [
{
"name" : "",
- "type" : "SelectionModel",
- "desc" : ""
+ "type" : "Boolean",
+ "desc" : "True if the event is being listened for, else false"
}
]
},
{
- "name" : "getView",
+ "name" : "hide",
"type" : "function",
- "desc" : "Returns the grid's GridView object.",
+ "desc" : "Hide this component.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.grid.Grid",
+ "memberOf" : "Roo.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"returns" : [
{
"name" : "",
- "type" : "GridView",
- "desc" : ""
+ "type" : "Roo.Component",
+ "desc" : "this"
}
]
},
{
- "name" : "hasListener",
+ "name" : "isVisible",
"type" : "function",
- "desc" : "Checks to see if this object has any listeners for a specified event",
- "sig" : "(eventName)",
+ "desc" : "Returns true if this component is visible.",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.util.Observable",
+ "memberOf" : "Roo.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "eventName",
- "type" : "String",
- "desc" : "The name of the event to check for",
- "isOptional" : false
- }
- ],
- "returns" : [
- {
- "name" : "",
- "type" : "Boolean",
- "desc" : "True if the event is being listened for, else false"
- }
- ]
+ "params" : [],
+ "returns" : []
},
{
"name" : "on",
"returns" : []
},
{
- "name" : "reconfigure",
+ "name" : "realign",
"type" : "function",
- "desc" : "Reconfigures the grid to use a different Store and Column Model.\nThe View will be bound to the new objects and refreshed.",
- "sig" : "(dataSource, The)",
+ "desc" : "Realigns the editor to the bound field based on the current alignment config value.",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.grid.Grid",
+ "memberOf" : "Roo.Editor",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "dataSource",
- "type" : "Roo.data.Store",
- "desc" : "The new {@link Roo.data.Store} object",
- "isOptional" : false
- },
- {
- "name" : "The",
- "type" : "Roo.grid.ColumnModel",
- "desc" : "new {@link Roo.grid.ColumnModel} object",
- "isOptional" : false
- }
- ],
+ "params" : [],
"returns" : []
},
{
{
"name" : "render",
"type" : "function",
- "desc" : "Called once after all setup has been completed and the grid is ready to be rendered.",
- "sig" : "()\n{\n\n}",
+ "desc" : "If this is a lazy rendering component, render it to its container element.",
+ "sig" : "(container)",
"static" : false,
- "memberOf" : "Roo.grid.Grid",
+ "memberOf" : "Roo.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
- "returns" : [
+ "params" : [
{
- "name" : "",
- "type" : "Roo.grid.Grid",
- "desc" : "this"
+ "name" : "container",
+ "type" : "String/HTMLElement/Element",
+ "desc" : "(optional) The element this component should be rendered into. If it is being applied to existing markup, this should be left off.",
+ "isOptional" : false
}
- ]
+ ],
+ "returns" : []
},
{
- "name" : "startEditing",
+ "name" : "setDisabled",
"type" : "function",
- "desc" : "Starts editing the specified for the specified row/column",
- "sig" : "(rowIndex, colIndex)",
+ "desc" : "Convenience function for setting disabled/enabled by boolean.",
+ "sig" : "(disabled)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "rowIndex",
- "type" : "Number",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "colIndex",
- "type" : "Number",
+ "name" : "disabled",
+ "type" : "Boolean",
"desc" : "",
"isOptional" : false
}
"returns" : []
},
{
- "name" : "stopEditing",
- "type" : "function",
- "desc" : "Stops any active editing",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
- {
- "name" : "un",
+ "name" : "setSize",
"type" : "function",
- "desc" : "Removes a listener (shorthand for removeListener)",
- "sig" : "(eventName, handler, scope)",
+ "desc" : "Sets the height and width of this editor.",
+ "sig" : "(width, height)",
"static" : false,
- "memberOf" : "Roo.util.Observable",
+ "memberOf" : "Roo.Editor",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "eventName",
- "type" : "String",
- "desc" : "The type of event to listen for",
- "isOptional" : false
- },
- {
- "name" : "handler",
- "type" : "Function",
- "desc" : "The handler to remove",
- "isOptional" : false
- },
- {
- "name" : "scope",
- "type" : "Object",
- "desc" : "(optional) The scope (this object) for the handler",
- "isOptional" : false
- }
- ],
- "returns" : []
- }
- ],
- "isAbstract" : false,
- "isBuilderTop" : false,
- "childClasses" : {
- "Roo.grid.EditorGrid" : [
- "Roo.grid.PropertyGrid"
- ]
- },
- "tree_children" : [],
- "tree_parent" : []
- },
- "Roo.grid.Grid" : {
- "props" : [
- {
- "name" : "autoExpandColumn",
- "type" : "String",
- "desc" : "The id (or dataIndex) of a column in this grid that should expand to fill unused space. This id can not be 0. Default is false.",
- "memberOf" : ""
- },
- {
- "name" : "autoExpandMax",
- "type" : "Number",
- "desc" : "The maximum width the autoExpandColumn can have (if enabled). Default is 1000.",
- "memberOf" : ""
- },
- {
- "name" : "autoExpandMin",
- "type" : "Number",
- "desc" : "The minimum width the autoExpandColumn can have (if enabled).\nDefault is 50.",
- "memberOf" : ""
- },
- {
- "name" : "autoHeight",
- "type" : "Boolean",
- "desc" : "True to fit the height of the grid container to the height of the data. Default is false.",
- "memberOf" : ""
- },
- {
- "name" : "autoSizeColumns",
- "type" : "Boolean",
- "desc" : "True to automatically resize the columns to fit their content\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" : "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" : "cm[]",
- "type" : "Roo.grid.ColumnModel",
- "desc" : "The columns of the grid",
- "memberOf" : ""
- },
- {
- "name" : "ddGroup",
- "type" : "String",
- "desc" : "- drag drop group.",
- "memberOf" : ""
- },
- {
- "name" : "ddText",
- "type" : "String",
- "desc" : "Configures the text is the drag proxy (defaults to \"%0 selected row(s)\").\n%0 is replaced with the number of selected rows.",
- "memberOf" : ""
- },
- {
- "name" : "dragGroup",
- "type" : "String",
- "desc" : "- drag group (?? not sure if needed.)",
- "memberOf" : ""
- },
- {
- "name" : "dropTarget",
- "type" : "Roo.dd.DropTarget",
- "desc" : "An {@link Roo.dd.DropTarget} config",
- "memberOf" : ""
- },
- {
- "name" : "ds",
- "type" : "Roo.grid.Store",
- "desc" : "The data store for the grid",
- "memberOf" : ""
- },
- {
- "name" : "enableColumnHide",
- "type" : "Boolean",
- "desc" : "True to enable hiding of columns with the header context menu. Default is true.",
- "memberOf" : ""
- },
- {
- "name" : "enableColumnMove",
- "type" : "Boolean",
- "desc" : "True to enable drag and drop reorder of columns. Default is true.",
- "memberOf" : ""
- },
- {
- "name" : "enableDrag",
- "type" : "Boolean",
- "desc" : "True to enable drag of rows. Default is false. (double check if this is needed?)",
- "memberOf" : ""
- },
- {
- "name" : "enableDragDrop",
- "type" : "Boolean",
- "desc" : "True to enable drag and drop of rows. Default is false.",
- "memberOf" : ""
- },
- {
- "name" : "enableDrop",
- "type" : "Boolean",
- "desc" : "True to enable drop of elements. Default is false. (double check if this is needed?)",
- "memberOf" : ""
- },
- {
- "name" : "enableRowHeightSync",
- "type" : "Boolean",
- "desc" : "True to manually sync row heights across locked and not locked rows. Default is false.",
- "memberOf" : ""
- },
- {
- "name" : "listeners",
- "type" : "Object",
- "desc" : "list of events and functions to call for this object, \nFor example :\n<pre><code>\n listeners : { \n 'click' : function(e) {\n ..... \n } ,\n .... \n } \n </code></pre>",
- "memberOf" : "Roo.util.Observable"
- },
- {
- "name" : "loadMask",
- "type" : "Object",
- "desc" : "An {@link Roo.LoadMask} config or true to mask the grid while loading. Default is false.",
- "memberOf" : ""
- },
- {
- "name" : "maxHeight",
- "type" : "Number",
- "desc" : "Sets the maximum height of the grid - ignored if autoHeight is not on.",
- "memberOf" : ""
- },
- {
- "name" : "maxRowsToMeasure",
- "type" : "Boolean",
- "desc" : "If autoSizeColumns is on, maxRowsToMeasure can be used to limit the number of\nrows measured to get a columns size. Default is 0 (all rows).",
- "memberOf" : ""
- },
- {
- "name" : "minColumnWidth",
- "type" : "Number",
- "desc" : "The minimum width a column can be resized to. Default is 25.",
- "memberOf" : ""
- },
- {
- "name" : "monitorWindowResize",
- "type" : "Boolean",
- "desc" : "True to autoSize the grid when the window resizes. Default is true.",
- "memberOf" : ""
- },
- {
- "name" : "sm",
- "type" : "Roo.grid.AbstractSelectionModel",
- "desc" : "The selection Model (default = Roo.grid.RowSelectionModel)",
- "memberOf" : ""
- },
- {
- "name" : "stripeRows",
- "type" : "Boolean",
- "desc" : "True to stripe the rows. Default is true.",
- "memberOf" : ""
- },
- {
- "name" : "toolbar",
- "type" : "Roo.Toolbar",
- "desc" : "a toolbar for buttons etc.",
- "memberOf" : ""
- },
- {
- "name" : "trackMouseOver",
- "type" : "Boolean",
- "desc" : "True to highlight rows when the mouse is over. Default is true.",
- "memberOf" : ""
- },
- {
- "name" : "view",
- "type" : "Roo.grid.GridView",
- "desc" : "The view that renders the grid (default = Roo.grid.GridView)",
- "memberOf" : ""
- }
- ],
- "events" : [
- {
- "name" : "bodyscroll",
- "type" : "function",
- "desc" : "Fires when the body element is scrolled",
- "sig" : "function (scrollLeft, scrollTop)\n{\n\n}",
- "memberOf" : "",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "scrollLeft",
- "type" : "Number",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "scrollTop",
- "type" : "Number",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "cellclick",
- "type" : "function",
- "desc" : "Fires when a cell is clicked",
- "sig" : "function (_self, rowIndex, columnIndex, e)\n{\n\n}",
- "memberOf" : "",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Grid",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "rowIndex",
- "type" : "Number",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "columnIndex",
- "type" : "Number",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "e",
- "type" : "Roo.EventObject",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "cellcontextmenu",
- "type" : "function",
- "desc" : "Fires when a cell is right clicked",
- "sig" : "function (_self, rowIndex, cellIndex, e)\n{\n\n}",
- "memberOf" : "",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Grid",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "rowIndex",
- "type" : "Number",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "cellIndex",
- "type" : "Number",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "e",
- "type" : "Roo.EventObject",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "celldblclick",
- "type" : "function",
- "desc" : "Fires when a cell is double clicked",
- "sig" : "function (_self, rowIndex, columnIndex, e)\n{\n\n}",
- "memberOf" : "",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Grid",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "rowIndex",
+ "name" : "width",
"type" : "Number",
- "desc" : "",
+ "desc" : "The new width",
"isOptional" : false
},
{
- "name" : "columnIndex",
+ "name" : "height",
"type" : "Number",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "e",
- "type" : "Roo.EventObject",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "click",
- "type" : "function",
- "desc" : "The raw click event for the entire grid.",
- "sig" : "function (e)\n{\n\n}",
- "memberOf" : "",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "e",
- "type" : "Roo.EventObject",
- "desc" : "",
+ "desc" : "The new height",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "columnmove",
+ "name" : "setValue",
"type" : "function",
- "desc" : "Fires when the user moves a column",
- "sig" : "function (oldIndex, newIndex)\n{\n\n}",
- "memberOf" : "",
+ "desc" : "Sets the data value of the editor",
+ "sig" : "(value)",
+ "static" : false,
+ "memberOf" : "Roo.Editor",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
- "name" : "oldIndex",
- "type" : "Number",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "newIndex",
- "type" : "Number",
- "desc" : "",
+ "name" : "value",
+ "type" : "Mixed",
+ "desc" : "Any valid value supported by the underlying field",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "columnresize",
+ "name" : "setVisible",
"type" : "function",
- "desc" : "Fires when the user resizes a column",
- "sig" : "function (columnIndex, newSize)\n{\n\n}",
- "memberOf" : "",
+ "desc" : "Convenience function to hide or show this component by boolean.",
+ "sig" : "(visible)",
+ "static" : false,
+ "memberOf" : "Roo.Component",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
- "name" : "columnIndex",
- "type" : "Number",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "newSize",
- "type" : "Number",
- "desc" : "",
+ "name" : "visible",
+ "type" : "Boolean",
+ "desc" : "True to show, false to hide",
"isOptional" : false
}
],
- "returns" : []
- },
- {
- "name" : "contextmenu",
- "type" : "function",
- "desc" : "The raw contextmenu event for the entire grid.",
- "sig" : "function (e)\n{\n\n}",
- "memberOf" : "",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
+ "returns" : [
{
- "name" : "e",
- "type" : "Roo.EventObject",
- "desc" : "",
- "isOptional" : false
+ "name" : "",
+ "type" : "Roo.Component",
+ "desc" : "this"
}
- ],
- "returns" : []
+ ]
},
{
- "name" : "dblclick",
+ "name" : "show",
"type" : "function",
- "desc" : "The raw dblclick event for the entire grid.",
- "sig" : "function (e)\n{\n\n}",
- "memberOf" : "",
+ "desc" : "Show this component.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.Component",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "params" : [
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : [
{
- "name" : "e",
- "type" : "Roo.EventObject",
- "desc" : "",
- "isOptional" : false
+ "name" : "",
+ "type" : "Roo.Component",
+ "desc" : "this"
}
- ],
- "returns" : []
+ ]
},
{
- "name" : "dragdrop",
+ "name" : "startEdit",
"type" : "function",
- "desc" : "Fires when dragged row(s) are dropped on a valid DD target",
- "sig" : "function (_self, dd, targetId, e)\n{\n\n}",
- "memberOf" : "",
+ "desc" : "Starts the editing process and shows the editor.",
+ "sig" : "(el, value)",
+ "static" : false,
+ "memberOf" : "Roo.Editor",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
- "name" : "this",
- "type" : "Grid",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "dd",
- "type" : "Roo.GridDD",
- "desc" : "The drag drop object",
+ "name" : "el",
+ "type" : "String/HTMLElement/Element",
+ "desc" : "The element to edit",
"isOptional" : false
},
{
- "name" : "targetId",
+ "name" : "value",
"type" : "String",
- "desc" : "The target drag drop object",
- "isOptional" : false
- },
- {
- "name" : "e",
- "type" : "event",
- "desc" : "The raw browser event",
+ "desc" : "(optional) A value to initialize the editor with. If a value is not provided, it defaults\nto the innerHTML of el.",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "dragenter",
+ "name" : "un",
"type" : "function",
- "desc" : "Fires when the dragged row(s) first cross another DD target while being dragged",
- "sig" : "function (_self, dd, targetId, e)\n{\n\n}",
- "memberOf" : "",
+ "desc" : "Removes a listener (shorthand for removeListener)",
+ "sig" : "(eventName, handler, scope)",
+ "static" : false,
+ "memberOf" : "Roo.util.Observable",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
- "name" : "this",
- "type" : "Grid",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "dd",
- "type" : "Roo.GridDD",
- "desc" : "The drag drop object",
+ "name" : "eventName",
+ "type" : "String",
+ "desc" : "The type of event to listen for",
"isOptional" : false
},
{
- "name" : "targetId",
- "type" : "String",
- "desc" : "The target drag drop object",
+ "name" : "handler",
+ "type" : "Function",
+ "desc" : "The handler to remove",
"isOptional" : false
},
{
- "name" : "e",
- "type" : "event",
- "desc" : "The raw browser event",
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "(optional) The scope (this object) for the handler",
"isOptional" : false
}
],
"returns" : []
- },
+ }
+ ],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "implementations" : [],
+ "tree_children" : [],
+ "tree_parent" : []
+ },
+ "Roo.grid.GridView" : {
+ "props" : [
{
- "name" : "dragout",
+ "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",
+ "isOptional" : false,
+ "optvals" : []
+ }
+ ],
+ "events" : [],
+ "methods" : [
+ {
+ "name" : "addEvents",
"type" : "function",
- "desc" : "Fires when the dragged row(s) leave another DD target while being dragged",
- "sig" : "function (_self, dd, targetId, e)\n{\n\n}",
- "memberOf" : "",
+ "desc" : "Used to define events on this Observable",
+ "sig" : "(object)",
+ "static" : false,
+ "memberOf" : "Roo.util.Observable",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Grid",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "dd",
- "type" : "Roo.GridDD",
- "desc" : "The drag drop object",
- "isOptional" : false
- },
- {
- "name" : "targetId",
- "type" : "String",
- "desc" : "The target drag drop object",
- "isOptional" : false
- },
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
{
- "name" : "e",
- "type" : "event",
- "desc" : "The raw browser event",
+ "name" : "object",
+ "type" : "Object",
+ "desc" : "The object with the events defined",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "dragover",
+ "name" : "addListener",
"type" : "function",
- "desc" : "Fires while row(s) are being dragged. \"targetId\" is the id of the Yahoo.util.DD object the selected rows are being dragged over.",
- "sig" : "function (_self, dd, targetId, e)\n{\n\n}",
- "memberOf" : "",
+ "desc" : "Appends an event handler to this component",
+ "sig" : "(eventName, handler, scope, options)",
+ "static" : false,
+ "memberOf" : "Roo.util.Observable",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
- "name" : "this",
- "type" : "Grid",
- "desc" : "",
+ "name" : "eventName",
+ "type" : "String",
+ "desc" : "The type of event to listen for",
"isOptional" : false
},
{
- "name" : "dd",
- "type" : "Roo.GridDD",
- "desc" : "The drag drop object",
+ "name" : "handler",
+ "type" : "Function",
+ "desc" : "The method the event invokes",
"isOptional" : false
},
{
- "name" : "targetId",
- "type" : "String",
- "desc" : "The target drag drop object",
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
"isOptional" : false
},
{
- "name" : "e",
- "type" : "event",
- "desc" : "The raw browser event",
+ "name" : "options",
+ "type" : "Object",
+ "desc" : "(optional) An object containing handler configuration\nproperties. This may contain any of the following properties:<ul>\n<li>scope {Object} The scope in which to execute the handler function. The handler function's \"this\" context.</li>\n<li>delay {Number} The number of milliseconds to delay the invocation of the handler after te event fires.</li>\n<li>single {Boolean} True to add a handler to handle just the next firing of the event, and then remove itself.</li>\n<li>buffer {Number} Causes the handler to be scheduled to run in an {@link Roo.util.DelayedTask} delayed\nby the specified number of milliseconds. If the event fires again within that time, the original\nhandler is <em>not</em> invoked, but the new handler is scheduled in its place.</li>\n</ul><br>\n<p>\n<b>Combining Options</b><br>\nUsing the options argument, it is possible to combine different types of listeners:<br>\n<br>\nA normalized, delayed, one-time listener that auto stops the event and passes a custom argument (forumId)\n\t\t<pre><code>\n\t\tel.on('click', this.onClick, this, {\n \t\t\tsingle: true,\n \t\tdelay: 100,\n \t\tforumId: 4\n\t\t});\n\t\t</code></pre>\n<p>\n<b>Attaching multiple handlers in 1 call</b><br>\nThe method also allows for a single argument to be passed which is a config object containing properties\nwhich specify multiple handlers.\n<pre><code>\n\t\tel.on({\n\t\t\t'click': {\n \t\tfn: this.onClick,\n \t\tscope: this,\n \t\tdelay: 100\n \t\t}, \n \t\t'mouseover': {\n \t\tfn: this.onMouseOver,\n \t\tscope: this\n \t\t},\n \t\t'mouseout': {\n \t\tfn: this.onMouseOut,\n \t\tscope: this\n \t\t}\n\t\t});\n\t\t</code></pre>\n<p>\nOr a shorthand syntax which passes the same scope object to all handlers:\n \t<pre><code>\n\t\tel.on({\n\t\t\t'click': this.onClick,\n \t\t'mouseover': this.onMouseOver,\n \t\t'mouseout': this.onMouseOut,\n \t\tscope: this\n\t\t});\n\t\t</code></pre>",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "enddrag",
+ "name" : "autoSizeColumn",
"type" : "function",
- "desc" : "Fires when a drag operation is complete",
- "sig" : "function (_self, dd, e)\n{\n\n}",
+ "desc" : "Autofit a column to its content.",
+ "sig" : "(colIndex, forceMinSize)",
+ "static" : false,
"memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
- "name" : "this",
- "type" : "Grid",
+ "name" : "colIndex",
+ "type" : "Number",
"desc" : "",
"isOptional" : false
},
{
- "name" : "dd",
- "type" : "Roo.GridDD",
- "desc" : "The drag drop object",
- "isOptional" : false
- },
- {
- "name" : "e",
- "type" : "event",
- "desc" : "The raw browser event",
+ "name" : "forceMinSize",
+ "type" : "Boolean",
+ "desc" : "true to force the column to go smaller if possible",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "headerclick",
+ "name" : "autoSizeColumns",
"type" : "function",
- "desc" : "Fires when a header is clicked",
- "sig" : "function (_self, columnIndex, e)\n{\n\n}",
+ "desc" : "Autofits all columns to their content and then expands to fit any extra space in the grid",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
"memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Grid",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "columnIndex",
- "type" : "Number",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "e",
- "type" : "Roo.EventObject",
- "desc" : "",
- "isOptional" : false
- }
- ],
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
"returns" : []
},
{
- "name" : "headercontextmenu",
+ "name" : "capture",
"type" : "function",
- "desc" : "Fires when a header is right clicked",
- "sig" : "function (_self, columnIndex, e)\n{\n\n}",
- "memberOf" : "",
+ "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\n<b>before</b> the event is fired. If the supplied function returns false,\nthe event will not fire.",
+ "sig" : "(o, fn, scope)",
+ "static" : true,
+ "memberOf" : "Roo.util.Observable",
+ "isStatic" : true,
+ "isConstructor" : false,
+ "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
- "name" : "this",
- "type" : "Grid",
- "desc" : "",
+ "name" : "o",
+ "type" : "Observable",
+ "desc" : "The Observable to capture",
"isOptional" : false
},
{
- "name" : "columnIndex",
- "type" : "Number",
- "desc" : "",
+ "name" : "fn",
+ "type" : "Function",
+ "desc" : "The function to call",
"isOptional" : false
},
{
- "name" : "e",
- "type" : "Roo.EventObject",
- "desc" : "",
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "(optional) The scope (this object) for the fn",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "headerdblclick",
+ "name" : "ensureVisible",
"type" : "function",
- "desc" : "Fires when a header cell is double clicked",
- "sig" : "function (_self, columnIndex, e)\n{\n\n}",
+ "desc" : "Scrolls the specified cell into view",
+ "sig" : "(row, col, hscroll)",
+ "static" : false,
"memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
- "name" : "this",
- "type" : "Grid",
- "desc" : "",
+ "name" : "row",
+ "type" : "Number",
+ "desc" : "The row index",
"isOptional" : false
},
{
- "name" : "columnIndex",
+ "name" : "col",
"type" : "Number",
- "desc" : "",
+ "desc" : "The column index",
"isOptional" : false
},
{
- "name" : "e",
- "type" : "Roo.EventObject",
- "desc" : "",
+ "name" : "hscroll",
+ "type" : "Boolean",
+ "desc" : "false to disable horizontal scrolling",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "keydown",
+ "name" : "fireEvent",
"type" : "function",
- "desc" : "The raw keydown event for the entire grid.",
- "sig" : "function (e)\n{\n\n}",
- "memberOf" : "",
+ "desc" : "Fires the specified event with the passed parameters (minus the event name).",
+ "sig" : "(eventName, args)",
+ "static" : false,
+ "memberOf" : "Roo.util.Observable",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
- "name" : "e",
- "type" : "Roo.EventObject",
+ "name" : "eventName",
+ "type" : "String",
"desc" : "",
"isOptional" : false
+ },
+ {
+ "name" : "args",
+ "type" : "Object...",
+ "desc" : "Variable number of parameters are passed to handlers",
+ "isOptional" : false
}
],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Boolean",
+ "desc" : "returns false if any of the handlers return false otherwise it returns true"
+ }
+ ]
},
{
- "name" : "keypress",
+ "name" : "fitColumns",
"type" : "function",
- "desc" : "The raw keypress event for the entire grid.",
- "sig" : "function (e)\n{\n\n}",
+ "desc" : "Autofits all columns to the grid's width proportionate with their current size",
+ "sig" : "(reserveScrollSpace)",
+ "static" : false,
"memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
- "name" : "e",
- "type" : "Roo.EventObject",
- "desc" : "",
+ "name" : "reserveScrollSpace",
+ "type" : "Boolean",
+ "desc" : "Reserve space for a scrollbar",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "mousedown",
+ "name" : "focusCell",
"type" : "function",
- "desc" : "The raw mousedown event for the entire grid.",
- "sig" : "function (e)\n{\n\n}",
+ "desc" : "Focuses the specified cell.",
+ "sig" : "(row, col, hscroll)",
+ "static" : false,
"memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
- "name" : "e",
- "type" : "Roo.EventObject",
- "desc" : "",
+ "name" : "row",
+ "type" : "Number",
+ "desc" : "The row index",
+ "isOptional" : false
+ },
+ {
+ "name" : "col",
+ "type" : "Number",
+ "desc" : "The column index",
+ "isOptional" : false
+ },
+ {
+ "name" : "hscroll",
+ "type" : "Boolean",
+ "desc" : "false to disable horizontal scrolling",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "mouseout",
+ "name" : "focusRow",
"type" : "function",
- "desc" : "The raw mouseout event for the entire grid.",
- "sig" : "function (e)\n{\n\n}",
+ "desc" : "Focuses the specified row.",
+ "sig" : "(row)",
+ "static" : false,
"memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
- "name" : "e",
- "type" : "Roo.EventObject",
- "desc" : "",
+ "name" : "row",
+ "type" : "Number",
+ "desc" : "The row index",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "mouseover",
+ "name" : "getCell",
"type" : "function",
- "desc" : "The raw mouseover event for the entire grid.",
- "sig" : "function (e)\n{\n\n}",
+ "desc" : "Gets the 'td' of the cell",
+ "sig" : "(rowIndex, colIndex)",
+ "static" : false,
"memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
- "name" : "e",
- "type" : "Roo.EventObject",
- "desc" : "",
+ "name" : "rowIndex",
+ "type" : "Integer",
+ "desc" : "row to select",
+ "isOptional" : false
+ },
+ {
+ "name" : "colIndex",
+ "type" : "Integer",
+ "desc" : "column to select",
"isOptional" : false
}
],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Object",
+ "desc" : ""
+ }
+ ]
},
{
- "name" : "mouseup",
+ "name" : "getFooterPanel",
"type" : "function",
- "desc" : "The raw mouseup event for the entire grid.",
- "sig" : "function (e)\n{\n\n}",
+ "desc" : "Gets a panel in the footer of the grid that can be used for toolbars etc.\nAfter modifying the contents of this panel a call to grid.autoSize() may be\nrequired to register any changes in size.",
+ "sig" : "(doShow)",
+ "static" : false,
"memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
- "name" : "e",
- "type" : "Roo.EventObject",
- "desc" : "",
+ "name" : "doShow",
+ "type" : "Boolean",
+ "desc" : "By default the footer is hidden. Pass true to show the panel",
"isOptional" : false
}
],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "",
+ "desc" : "Roo.Element"
+ }
+ ]
},
{
- "name" : "render",
+ "name" : "getHeaderPanel",
"type" : "function",
- "desc" : "Fires when the grid is rendered",
- "sig" : "function (grid)\n{\n\n}",
+ "desc" : "Gets a panel in the header of the grid that can be used for toolbars etc.\nAfter modifying the contents of this panel a call to grid.autoSize() may be\nrequired to register any changes in size.",
+ "sig" : "(doShow)",
+ "static" : false,
"memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
- "name" : "grid",
- "type" : "Grid",
- "desc" : "",
+ "name" : "doShow",
+ "type" : "Boolean",
+ "desc" : "By default the header is hidden. Pass true to show the panel",
"isOptional" : false
}
],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "",
+ "desc" : "Roo.Element"
+ }
+ ]
},
{
- "name" : "rowclass",
+ "name" : "hasListener",
"type" : "function",
- "desc" : "Fires when a row is rendered, so you can change add a style to it.",
- "sig" : "function (gridview, rowcfg)\n{\n\n}",
- "memberOf" : "",
+ "desc" : "Checks to see if this object has any listeners for a specified event",
+ "sig" : "(eventName)",
+ "static" : false,
+ "memberOf" : "Roo.util.Observable",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
- "name" : "gridview",
- "type" : "GridView",
- "desc" : "The grid view",
- "isOptional" : false
- },
- {
- "name" : "rowcfg",
- "type" : "Object",
- "desc" : "contains record rowIndex and rowClass - set rowClass to add a style.",
+ "name" : "eventName",
+ "type" : "String",
+ "desc" : "The name of the event to check for",
"isOptional" : false
}
],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Boolean",
+ "desc" : "True if the event is being listened for, else false"
+ }
+ ]
},
{
- "name" : "rowclick",
+ "name" : "on",
"type" : "function",
- "desc" : "Fires when a row is clicked",
- "sig" : "function (_self, rowIndex, e)\n{\n\n}",
- "memberOf" : "",
+ "desc" : "Appends an event handler to this element (shorthand for addListener)",
+ "sig" : "(eventName, handler, scope, options)",
+ "static" : false,
+ "memberOf" : "Roo.util.Observable",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
- "name" : "this",
- "type" : "Grid",
- "desc" : "",
+ "name" : "eventName",
+ "type" : "String",
+ "desc" : "The type of event to listen for",
"isOptional" : false
},
{
- "name" : "rowIndex",
- "type" : "Number",
- "desc" : "",
+ "name" : "handler",
+ "type" : "Function",
+ "desc" : "The method the event invokes",
"isOptional" : false
},
{
- "name" : "e",
- "type" : "Roo.EventObject",
- "desc" : "",
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
+ "isOptional" : false
+ },
+ {
+ "name" : "options",
+ "type" : "Object",
+ "desc" : "(optional)",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "rowcontextmenu",
+ "name" : "purgeListeners",
"type" : "function",
- "desc" : "Fires when a row is right clicked",
- "sig" : "function (_self, rowIndex, e)\n{\n\n}",
- "memberOf" : "",
+ "desc" : "Removes all listeners for this object",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.util.Observable",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Grid",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "rowIndex",
- "type" : "Number",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "e",
- "type" : "Roo.EventObject",
- "desc" : "",
- "isOptional" : false
- }
- ],
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
"returns" : []
},
{
- "name" : "rowdblclick",
+ "name" : "refresh",
"type" : "function",
- "desc" : "Fires when a row is double clicked",
- "sig" : "function (_self, rowIndex, e)\n{\n\n}",
+ "desc" : "Refreshes the grid",
+ "sig" : "(headersToo)",
+ "static" : false,
"memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
- "name" : "this",
- "type" : "Grid",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "rowIndex",
- "type" : "Number",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "e",
- "type" : "Roo.EventObject",
+ "name" : "headersToo",
+ "type" : "Boolean",
"desc" : "",
"isOptional" : false
}
"returns" : []
},
{
- "name" : "startdrag",
+ "name" : "releaseCapture",
"type" : "function",
- "desc" : "Fires when row(s) start being dragged",
- "sig" : "function (_self, dd, e)\n{\n\n}",
- "memberOf" : "",
+ "desc" : "Removes <b>all</b> added captures from the Observable.",
+ "sig" : "(o)",
+ "static" : true,
+ "memberOf" : "Roo.util.Observable",
+ "isStatic" : true,
+ "isConstructor" : false,
+ "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
- "name" : "this",
- "type" : "Grid",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "dd",
- "type" : "Roo.GridDD",
- "desc" : "The drag drop object",
- "isOptional" : false
- },
- {
- "name" : "e",
- "type" : "event",
- "desc" : "The raw browser event",
+ "name" : "o",
+ "type" : "Observable",
+ "desc" : "The Observable to release",
"isOptional" : false
}
],
"returns" : []
- }
- ],
- "methods" : [
+ },
{
- "name" : "addColumns",
+ "name" : "removeListener",
"type" : "function",
- "desc" : "addColumns\nAdd's a column, default at the end..",
- "sig" : "(position, of)",
+ "desc" : "Removes a listener",
+ "sig" : "(eventName, handler, scope)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.util.Observable",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "position",
- "type" : "int",
- "desc" : "to add (default end)",
+ "name" : "eventName",
+ "type" : "String",
+ "desc" : "The type of event to listen for",
"isOptional" : false
},
{
- "name" : "of",
- "type" : "Array",
- "desc" : "objects of column configuration see {@link Roo.grid.ColumnModel}",
+ "name" : "handler",
+ "type" : "Function",
+ "desc" : "The handler to remove",
+ "isOptional" : false
+ },
+ {
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "(optional) The scope (this object) for the handler",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "addEvents",
+ "name" : "scrollToTop",
"type" : "function",
- "desc" : "Used to define events on this Observable",
- "sig" : "(object)",
+ "desc" : "Scrolls the grid to the top",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.util.Observable",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "object",
- "type" : "Object",
- "desc" : "The object with the events defined",
- "isOptional" : false
- }
- ],
+ "params" : [],
"returns" : []
},
{
- "name" : "addListener",
+ "name" : "un",
"type" : "function",
- "desc" : "Appends an event handler to this component",
- "sig" : "(eventName, handler, scope, options)",
+ "desc" : "Removes a listener (shorthand for removeListener)",
+ "sig" : "(eventName, handler, scope)",
"static" : false,
"memberOf" : "Roo.util.Observable",
"isStatic" : false,
{
"name" : "handler",
"type" : "Function",
- "desc" : "The method the event invokes",
+ "desc" : "The handler to remove",
"isOptional" : false
},
{
"name" : "scope",
"type" : "Object",
- "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
+ "desc" : "(optional) The scope (this object) for the handler",
"isOptional" : false
- },
+ }
+ ],
+ "returns" : []
+ }
+ ],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "implementations" : [],
+ "tree_children" : [],
+ "tree_parent" : []
+ },
+ "Roo.grid.PropertyGrid" : {
+ "props" : [
+ {
+ "name" : "autoExpandColumn",
+ "type" : "String",
+ "desc" : "The id (or dataIndex) of a column in this grid that should expand to fill unused space. This id can not be 0. Default is false.",
+ "memberOf" : "Roo.grid.Grid",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "autoExpandMax",
+ "type" : "Number",
+ "desc" : "The maximum width the autoExpandColumn can have (if enabled). Default is 1000.",
+ "memberOf" : "Roo.grid.Grid",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "autoExpandMin",
+ "type" : "Number",
+ "desc" : "The minimum width the autoExpandColumn can have (if enabled).\nDefault is 50.",
+ "memberOf" : "Roo.grid.Grid",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "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",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "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",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "autoSizeHeaders",
+ "type" : "Boolean",
+ "desc" : "True to measure headers with column data when auto sizing columns. Default is true.",
+ "memberOf" : "Roo.grid.Grid",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "autoWidth",
+ "type" : "Boolean",
+ "desc" : "True to set the grid's width to the default total width of the grid's columns instead\nof a fixed width. Default is false.",
+ "memberOf" : "Roo.grid.Grid",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "clicksToEdit",
+ "type" : "Number",
+ "desc" : "The number of clicks on a cell required to display the cell's editor (defaults to 2)",
+ "memberOf" : "Roo.grid.EditorGrid",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "cm[]",
+ "type" : "Roo.grid.ColumnModel",
+ "desc" : "The columns of the grid",
+ "memberOf" : "Roo.grid.Grid",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "customEditors",
+ "type" : "Object",
+ "desc" : "map of colnames=> custom editors.\nthe custom editor can be one of the standard ones (date|string|number|int|boolean), or a\ngrid editor eg. Roo.grid.GridEditor(new Roo.form.TextArea({selectOnFocus:true})),\nfalse disables editing of the field.",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "ddGroup",
+ "type" : "String",
+ "desc" : "- drag drop group.",
+ "memberOf" : "Roo.grid.Grid",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "ddText",
+ "type" : "String",
+ "desc" : "Configures the text is the drag proxy (defaults to \"%0 selected row(s)\").\n%0 is replaced with the number of selected rows.",
+ "memberOf" : "Roo.grid.Grid",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "dragGroup",
+ "type" : "String",
+ "desc" : "- drag group (?? not sure if needed.)",
+ "memberOf" : "Roo.grid.Grid",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "dropTarget",
+ "type" : "Roo.dd.DropTarget",
+ "desc" : "An {@link Roo.dd.DropTarget} config",
+ "memberOf" : "Roo.grid.Grid",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "ds",
+ "type" : "Roo.data.Store",
+ "desc" : "The data store for the grid",
+ "memberOf" : "Roo.grid.Grid",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "enableColumnHide",
+ "type" : "Boolean",
+ "desc" : "True to enable hiding of columns with the header context menu. Default is true.",
+ "memberOf" : "Roo.grid.Grid",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "enableColumnMove",
+ "type" : "Boolean",
+ "desc" : "True to enable drag and drop reorder of columns. Default is true.",
+ "memberOf" : "Roo.grid.Grid",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "enableDrag",
+ "type" : "Boolean",
+ "desc" : "True to enable drag of rows. Default is false. (double check if this is needed?)",
+ "memberOf" : "Roo.grid.Grid",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "enableDragDrop",
+ "type" : "Boolean",
+ "desc" : "True to enable drag and drop of rows. Default is false.",
+ "memberOf" : "Roo.grid.Grid",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "enableDrop",
+ "type" : "Boolean",
+ "desc" : "True to enable drop of elements. Default is false. (double check if this is needed?)",
+ "memberOf" : "Roo.grid.Grid",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "enableRowHeightSync",
+ "type" : "Boolean",
+ "desc" : "True to manually sync row heights across locked and not locked rows. Default is false.",
+ "memberOf" : "Roo.grid.Grid",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "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",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "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",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "maxHeight",
+ "type" : "Number",
+ "desc" : "Sets the maximum height of the grid - ignored if autoHeight is not on.",
+ "memberOf" : "Roo.grid.Grid",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "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",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "minColumnWidth",
+ "type" : "Number",
+ "desc" : "The minimum width a column can be resized to. Default is 25.",
+ "memberOf" : "Roo.grid.Grid",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "monitorWindowResize",
+ "type" : "Boolean",
+ "desc" : "True to autoSize the grid when the window resizes. Default is true.",
+ "memberOf" : "Roo.grid.Grid",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "propertyNames",
+ "type" : "Object",
+ "desc" : "map of property Names to their displayed value",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "sm",
+ "type" : "Roo.grid.AbstractSelectionModel",
+ "desc" : "The selection Model (default = Roo.grid.RowSelectionModel)",
+ "memberOf" : "Roo.grid.Grid",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "sortColMenu",
+ "type" : "boolean",
+ "desc" : "Sort the column order menu when it shows (usefull for long lists..) default false",
+ "memberOf" : "Roo.grid.Grid",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "stripeRows",
+ "type" : "Boolean",
+ "desc" : "True to stripe the rows. Default is true.",
+ "memberOf" : "Roo.grid.Grid",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "toolbar",
+ "type" : "Roo.Toolbar",
+ "desc" : "a toolbar for buttons etc.",
+ "memberOf" : "Roo.grid.Grid",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "trackMouseOver",
+ "type" : "Boolean",
+ "desc" : "True to highlight rows when the mouse is over. Default is true.",
+ "memberOf" : "Roo.grid.Grid",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "view",
+ "type" : "Roo.grid.GridView",
+ "desc" : "The view that renders the grid (default = Roo.grid.GridView)",
+ "memberOf" : "Roo.grid.Grid",
+ "isOptional" : false,
+ "optvals" : []
+ }
+ ],
+ "events" : [
+ {
+ "name" : "afteredit",
+ "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>",
+ "sig" : "function (e)\n{\n\n}",
+ "memberOf" : "Roo.grid.EditorGrid",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
{
- "name" : "options",
+ "name" : "e",
"type" : "Object",
- "desc" : "(optional) An object containing handler configuration\nproperties. This may contain any of the following properties:<ul>\n<li>scope {Object} The scope in which to execute the handler function. The handler function's \"this\" context.</li>\n<li>delay {Number} The number of milliseconds to delay the invocation of the handler after te event fires.</li>\n<li>single {Boolean} True to add a handler to handle just the next firing of the event, and then remove itself.</li>\n<li>buffer {Number} Causes the handler to be scheduled to run in an {@link Roo.util.DelayedTask} delayed\nby the specified number of milliseconds. If the event fires again within that time, the original\nhandler is <em>not</em> invoked, but the new handler is scheduled in its place.</li>\n</ul><br>\n<p>\n<b>Combining Options</b><br>\nUsing the options argument, it is possible to combine different types of listeners:<br>\n<br>\nA normalized, delayed, one-time listener that auto stops the event and passes a custom argument (forumId)\n\t\t<pre><code>\n\t\tel.on('click', this.onClick, this, {\n \t\t\tsingle: true,\n \t\tdelay: 100,\n \t\tforumId: 4\n\t\t});\n\t\t</code></pre>\n<p>\n<b>Attaching multiple handlers in 1 call</b><br>\nThe method also allows for a single argument to be passed which is a config object containing properties\nwhich specify multiple handlers.\n<pre><code>\n\t\tel.on({\n\t\t\t'click': {\n \t\tfn: this.onClick,\n \t\tscope: this,\n \t\tdelay: 100\n \t\t}, \n \t\t'mouseover': {\n \t\tfn: this.onMouseOver,\n \t\tscope: this\n \t\t},\n \t\t'mouseout': {\n \t\tfn: this.onMouseOut,\n \t\tscope: this\n \t\t}\n\t\t});\n\t\t</code></pre>\n<p>\nOr a shorthand syntax which passes the same scope object to all handlers:\n \t<pre><code>\n\t\tel.on({\n\t\t\t'click': this.onClick,\n \t\t'mouseover': this.onMouseOver,\n \t\t'mouseout': this.onMouseOut,\n \t\tscope: this\n\t\t});\n\t\t</code></pre>",
+ "desc" : "An edit event (see above for description)",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "autoSize",
+ "name" : "beforeedit",
"type" : "function",
- "desc" : "Causes the grid to manually recalculate its dimensions. Generally this is done automatically,\nbut if manual update is required this method will initiate it.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
+ "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>",
+ "sig" : "function (e)\n{\n\n}",
+ "memberOf" : "Roo.grid.EditorGrid",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
+ "params" : [
+ {
+ "name" : "e",
+ "type" : "Object",
+ "desc" : "An edit event (see above for description)",
+ "isOptional" : false
+ }
+ ],
"returns" : []
},
{
- "name" : "capture",
+ "name" : "beforepropertychange",
"type" : "function",
- "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\n<b>before</b> the event is fired. If the supplied function returns false,\nthe event will not fire.",
- "sig" : "(o, fn, scope)",
- "static" : true,
- "memberOf" : "Roo.util.Observable",
- "isStatic" : true,
- "isConstructor" : false,
- "isPrivate" : false,
+ "desc" : "Fires before a property changes (return false to stop?)",
+ "sig" : "function (grid, id, newval, oldval)\n{\n\n}",
+ "memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
"params" : [
{
- "name" : "o",
- "type" : "Observable",
- "desc" : "The Observable to capture",
+ "name" : "grid",
+ "type" : "Roo.grid.PropertyGrid",
+ "desc" : "property grid? (check could be store)",
"isOptional" : false
},
{
- "name" : "fn",
- "type" : "Function",
- "desc" : "The function to call",
+ "name" : "id",
+ "type" : "String",
+ "desc" : "Record Id",
"isOptional" : false
},
{
- "name" : "scope",
- "type" : "Object",
- "desc" : "(optional) The scope (this object) for the fn",
+ "name" : "newval",
+ "type" : "String",
+ "desc" : "New Value",
+ "isOptional" : false
+ },
+ {
+ "name" : "oldval",
+ "type" : "String",
+ "desc" : "Old Value",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "destroy",
+ "name" : "bodyscroll",
"type" : "function",
- "desc" : "Destroy this grid.",
- "sig" : "(removeEl)",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
+ "desc" : "Fires when the body element is scrolled",
+ "sig" : "function (scrollLeft, scrollTop)\n{\n\n}",
+ "memberOf" : "Roo.grid.Grid",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
"params" : [
{
- "name" : "removeEl",
- "type" : "Boolean",
- "desc" : "True to remove the element",
+ "name" : "scrollLeft",
+ "type" : "Number",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "scrollTop",
+ "type" : "Number",
+ "desc" : "",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "fireEvent",
+ "name" : "cellclick",
"type" : "function",
- "desc" : "Fires the specified event with the passed parameters (minus the event name).",
- "sig" : "(eventName, args)",
- "static" : false,
- "memberOf" : "Roo.util.Observable",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
+ "desc" : "Fires when a cell is clicked",
+ "sig" : "function (_self, rowIndex, columnIndex, e)\n{\n\n}",
+ "memberOf" : "Roo.grid.Grid",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
"params" : [
{
- "name" : "eventName",
- "type" : "String",
+ "name" : "this",
+ "type" : "Grid",
"desc" : "",
"isOptional" : false
},
{
- "name" : "args",
- "type" : "Object...",
- "desc" : "Variable number of parameters are passed to handlers",
+ "name" : "rowIndex",
+ "type" : "Number",
+ "desc" : "",
"isOptional" : false
- }
- ],
- "returns" : [
+ },
{
- "name" : "",
- "type" : "Boolean",
- "desc" : "returns false if any of the handlers return false otherwise it returns true"
+ "name" : "columnIndex",
+ "type" : "Number",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "e",
+ "type" : "Roo.EventObject",
+ "desc" : "",
+ "isOptional" : false
}
- ]
+ ],
+ "returns" : []
},
{
- "name" : "getColumnModel",
+ "name" : "cellcontextmenu",
"type" : "function",
- "desc" : "Returns the grid's ColumnModel.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
+ "desc" : "Fires when a cell is right clicked",
+ "sig" : "function (_self, rowIndex, cellIndex, e)\n{\n\n}",
+ "memberOf" : "Roo.grid.Grid",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : [
+ "params" : [
{
- "name" : "",
- "type" : "ColumnModel",
- "desc" : ""
+ "name" : "this",
+ "type" : "Grid",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "rowIndex",
+ "type" : "Number",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "cellIndex",
+ "type" : "Number",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "e",
+ "type" : "Roo.EventObject",
+ "desc" : "",
+ "isOptional" : false
}
- ]
+ ],
+ "returns" : []
},
{
- "name" : "getDataSource",
+ "name" : "celldblclick",
"type" : "function",
- "desc" : "Returns the grid's DataSource.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
+ "desc" : "Fires when a cell is double clicked",
+ "sig" : "function (_self, rowIndex, columnIndex, e)\n{\n\n}",
+ "memberOf" : "Roo.grid.Grid",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : [
+ "params" : [
{
- "name" : "",
- "type" : "DataSource",
- "desc" : ""
+ "name" : "this",
+ "type" : "Grid",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "rowIndex",
+ "type" : "Number",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "columnIndex",
+ "type" : "Number",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "e",
+ "type" : "Roo.EventObject",
+ "desc" : "",
+ "isOptional" : false
}
- ]
+ ],
+ "returns" : []
},
{
- "name" : "getDragDropText",
+ "name" : "click",
"type" : "function",
- "desc" : "Called to get grid's drag proxy text, by default returns this.ddText.\nOverride this to put something different in the dragged text.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
+ "desc" : "The raw click event for the entire grid.",
+ "sig" : "function (e)\n{\n\n}",
+ "memberOf" : "Roo.grid.Grid",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : [
+ "params" : [
{
- "name" : "",
- "type" : "String",
- "desc" : ""
+ "name" : "e",
+ "type" : "Roo.EventObject",
+ "desc" : "",
+ "isOptional" : false
}
- ]
+ ],
+ "returns" : []
},
{
- "name" : "getGridEl",
+ "name" : "columnmove",
"type" : "function",
- "desc" : "Returns the grid's underlying element.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
+ "desc" : "Fires when the user moves a column",
+ "sig" : "function (oldIndex, newIndex)\n{\n\n}",
+ "memberOf" : "Roo.grid.Grid",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : [
+ "params" : [
{
- "name" : "",
- "type" : "Element",
- "desc" : "The element"
+ "name" : "oldIndex",
+ "type" : "Number",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "newIndex",
+ "type" : "Number",
+ "desc" : "",
+ "isOptional" : false
}
- ]
+ ],
+ "returns" : []
},
{
- "name" : "getSelectionModel",
+ "name" : "columnresize",
"type" : "function",
- "desc" : "Returns the grid's SelectionModel.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
+ "desc" : "Fires when the user resizes a column",
+ "sig" : "function (columnIndex, newSize)\n{\n\n}",
+ "memberOf" : "Roo.grid.Grid",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : [
+ "params" : [
{
- "name" : "",
- "type" : "SelectionModel",
- "desc" : ""
+ "name" : "columnIndex",
+ "type" : "Number",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "newSize",
+ "type" : "Number",
+ "desc" : "",
+ "isOptional" : false
}
- ]
+ ],
+ "returns" : []
},
{
- "name" : "getView",
+ "name" : "contextmenu",
"type" : "function",
- "desc" : "Returns the grid's GridView object.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
+ "desc" : "The raw contextmenu event for the entire grid.",
+ "sig" : "function (e)\n{\n\n}",
+ "memberOf" : "Roo.grid.Grid",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : [
+ "params" : [
{
- "name" : "",
- "type" : "GridView",
- "desc" : ""
+ "name" : "e",
+ "type" : "Roo.EventObject",
+ "desc" : "",
+ "isOptional" : false
}
- ]
+ ],
+ "returns" : []
},
{
- "name" : "hasListener",
+ "name" : "dblclick",
"type" : "function",
- "desc" : "Checks to see if this object has any listeners for a specified event",
- "sig" : "(eventName)",
- "static" : false,
- "memberOf" : "Roo.util.Observable",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
+ "desc" : "The raw dblclick event for the entire grid.",
+ "sig" : "function (e)\n{\n\n}",
+ "memberOf" : "Roo.grid.Grid",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
"params" : [
{
- "name" : "eventName",
- "type" : "String",
- "desc" : "The name of the event to check for",
+ "name" : "e",
+ "type" : "Roo.EventObject",
+ "desc" : "",
"isOptional" : false
}
],
- "returns" : [
- {
- "name" : "",
- "type" : "Boolean",
- "desc" : "True if the event is being listened for, else false"
- }
- ]
+ "returns" : []
},
{
- "name" : "on",
+ "name" : "dragdrop",
"type" : "function",
- "desc" : "Appends an event handler to this element (shorthand for addListener)",
- "sig" : "(eventName, handler, scope, options)",
- "static" : false,
- "memberOf" : "Roo.util.Observable",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
+ "desc" : "Fires when dragged row(s) are dropped on a valid DD target",
+ "sig" : "function (_self, dd, targetId, e)\n{\n\n}",
+ "memberOf" : "Roo.grid.Grid",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
"params" : [
{
- "name" : "eventName",
- "type" : "String",
- "desc" : "The type of event to listen for",
+ "name" : "this",
+ "type" : "Grid",
+ "desc" : "",
"isOptional" : false
},
{
- "name" : "handler",
- "type" : "Function",
- "desc" : "The method the event invokes",
+ "name" : "dd",
+ "type" : "Roo.GridDD",
+ "desc" : "The drag drop object",
"isOptional" : false
},
{
- "name" : "scope",
- "type" : "Object",
- "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
+ "name" : "targetId",
+ "type" : "String",
+ "desc" : "The target drag drop object",
"isOptional" : false
},
{
- "name" : "options",
- "type" : "Object",
- "desc" : "(optional)",
+ "name" : "e",
+ "type" : "event",
+ "desc" : "The raw browser event",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "purgeListeners",
+ "name" : "dragenter",
"type" : "function",
- "desc" : "Removes all listeners for this object",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.util.Observable",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
+ "desc" : "Fires when the dragged row(s) first cross another DD target while being dragged",
+ "sig" : "function (_self, dd, targetId, e)\n{\n\n}",
+ "memberOf" : "Roo.grid.Grid",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Grid",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "dd",
+ "type" : "Roo.GridDD",
+ "desc" : "The drag drop object",
+ "isOptional" : false
+ },
+ {
+ "name" : "targetId",
+ "type" : "String",
+ "desc" : "The target drag drop object",
+ "isOptional" : false
+ },
+ {
+ "name" : "e",
+ "type" : "event",
+ "desc" : "The raw browser event",
+ "isOptional" : false
+ }
+ ],
"returns" : []
},
{
- "name" : "reconfigure",
+ "name" : "dragout",
"type" : "function",
- "desc" : "Reconfigures the grid to use a different Store and Column Model.\nThe View will be bound to the new objects and refreshed.",
- "sig" : "(dataSource, The)",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
+ "desc" : "Fires when the dragged row(s) leave another DD target while being dragged",
+ "sig" : "function (_self, dd, targetId, e)\n{\n\n}",
+ "memberOf" : "Roo.grid.Grid",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
"params" : [
{
- "name" : "dataSource",
- "type" : "Roo.data.Store",
- "desc" : "The new {@link Roo.data.Store} object",
+ "name" : "this",
+ "type" : "Grid",
+ "desc" : "",
"isOptional" : false
},
{
- "name" : "The",
- "type" : "Roo.grid.ColumnModel",
- "desc" : "new {@link Roo.grid.ColumnModel} object",
+ "name" : "dd",
+ "type" : "Roo.GridDD",
+ "desc" : "The drag drop object",
+ "isOptional" : false
+ },
+ {
+ "name" : "targetId",
+ "type" : "String",
+ "desc" : "The target drag drop object",
+ "isOptional" : false
+ },
+ {
+ "name" : "e",
+ "type" : "event",
+ "desc" : "The raw browser event",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "releaseCapture",
+ "name" : "dragover",
"type" : "function",
- "desc" : "Removes <b>all</b> added captures from the Observable.",
- "sig" : "(o)",
- "static" : true,
- "memberOf" : "Roo.util.Observable",
- "isStatic" : true,
- "isConstructor" : false,
- "isPrivate" : false,
+ "desc" : "Fires while row(s) are being dragged. \"targetId\" is the id of the Yahoo.util.DD object the selected rows are being dragged over.",
+ "sig" : "function (_self, dd, targetId, e)\n{\n\n}",
+ "memberOf" : "Roo.grid.Grid",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
"params" : [
{
- "name" : "o",
- "type" : "Observable",
- "desc" : "The Observable to release",
+ "name" : "this",
+ "type" : "Grid",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "dd",
+ "type" : "Roo.GridDD",
+ "desc" : "The drag drop object",
+ "isOptional" : false
+ },
+ {
+ "name" : "targetId",
+ "type" : "String",
+ "desc" : "The target drag drop object",
+ "isOptional" : false
+ },
+ {
+ "name" : "e",
+ "type" : "event",
+ "desc" : "The raw browser event",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "removeListener",
+ "name" : "enddrag",
"type" : "function",
- "desc" : "Removes a listener",
- "sig" : "(eventName, handler, scope)",
- "static" : false,
- "memberOf" : "Roo.util.Observable",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
+ "desc" : "Fires when a drag operation is complete",
+ "sig" : "function (_self, dd, e)\n{\n\n}",
+ "memberOf" : "Roo.grid.Grid",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
"params" : [
{
- "name" : "eventName",
- "type" : "String",
- "desc" : "The type of event to listen for",
+ "name" : "this",
+ "type" : "Grid",
+ "desc" : "",
"isOptional" : false
},
{
- "name" : "handler",
- "type" : "Function",
- "desc" : "The handler to remove",
+ "name" : "dd",
+ "type" : "Roo.GridDD",
+ "desc" : "The drag drop object",
"isOptional" : false
},
{
- "name" : "scope",
- "type" : "Object",
- "desc" : "(optional) The scope (this object) for the handler",
+ "name" : "e",
+ "type" : "event",
+ "desc" : "The raw browser event",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "render",
+ "name" : "headerclick",
"type" : "function",
- "desc" : "Called once after all setup has been completed and the grid is ready to be rendered.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
+ "desc" : "Fires when a header is clicked",
+ "sig" : "function (_self, columnIndex, e)\n{\n\n}",
+ "memberOf" : "Roo.grid.Grid",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : [
+ "params" : [
{
- "name" : "",
- "type" : "Roo.grid.Grid",
- "desc" : "this"
+ "name" : "this",
+ "type" : "Grid",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "columnIndex",
+ "type" : "Number",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "e",
+ "type" : "Roo.EventObject",
+ "desc" : "",
+ "isOptional" : false
}
- ]
+ ],
+ "returns" : []
},
{
- "name" : "un",
+ "name" : "headercontextmenu",
"type" : "function",
- "desc" : "Removes a listener (shorthand for removeListener)",
- "sig" : "(eventName, handler, scope)",
- "static" : false,
- "memberOf" : "Roo.util.Observable",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
+ "desc" : "Fires when a header is right clicked",
+ "sig" : "function (_self, columnIndex, e)\n{\n\n}",
+ "memberOf" : "Roo.grid.Grid",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
"params" : [
{
- "name" : "eventName",
- "type" : "String",
- "desc" : "The type of event to listen for",
+ "name" : "this",
+ "type" : "Grid",
+ "desc" : "",
"isOptional" : false
},
{
- "name" : "handler",
- "type" : "Function",
- "desc" : "The handler to remove",
+ "name" : "columnIndex",
+ "type" : "Number",
+ "desc" : "",
"isOptional" : false
},
{
- "name" : "scope",
- "type" : "Object",
- "desc" : "(optional) The scope (this object) for the handler",
+ "name" : "e",
+ "type" : "Roo.EventObject",
+ "desc" : "",
"isOptional" : false
}
],
"returns" : []
- }
- ],
- "isAbstract" : false,
- "isBuilderTop" : false,
- "childClasses" : {
- "Roo.grid.EditorGrid" : [
- "Roo.grid.PropertyGrid"
- ],
- "Roo.grid.Grid" : [
- "Roo.grid.Calendar",
- "Roo.grid.EditorGrid"
- ]
- },
- "tree_children" : [],
- "tree_parent" : []
- },
- "Roo.grid.GridEditor" : {
- "props" : [
- {
- "name" : "actionMode",
- "type" : "String",
- "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el' for forms you probably want to set this to fieldEl",
- "memberOf" : "Roo.Component"
- },
- {
- "name" : "alignment",
- "type" : "String",
- "desc" : "The position to align to (see {@link Roo.Element#alignTo} for more details, defaults to \"c-c?\").",
- "memberOf" : "Roo.Editor"
- },
- {
- "name" : "allowDomMove",
- "type" : "Boolean",
- "desc" : "Whether the component can move the Dom node when rendering (defaults to true).",
- "memberOf" : "Roo.Component"
- },
- {
- "name" : "autosize",
- "type" : "Boolean/String",
- "desc" : "True for the editor to automatically adopt the size of the underlying field, \"width\" to adopt the width only,\nor \"height\" to adopt the height only (defaults to false)",
- "memberOf" : "Roo.Editor"
- },
- {
- "name" : "cancelOnEsc",
- "type" : "Boolean",
- "desc" : "True to cancel the edit when the escape key is pressed (defaults to false)",
- "memberOf" : "Roo.Editor"
- },
- {
- "name" : "completeOnEnter",
- "type" : "Boolean",
- "desc" : "True to complete the edit when the enter key is pressed (defaults to false)",
- "memberOf" : "Roo.Editor"
- },
- {
- "name" : "constrain",
- "type" : "Boolean",
- "desc" : "True to constrain the editor to the viewport",
- "memberOf" : "Roo.Editor"
- },
- {
- "name" : "disableClass",
- "type" : "String",
- "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").",
- "memberOf" : "Roo.Component"
- },
- {
- "name" : "field",
- "type" : "Roo.form.Field",
- "desc" : "Field to wrap (or xtyped)",
- "memberOf" : ""
- },
- {
- "name" : "hideEl",
- "type" : "Boolean",
- "desc" : "False to keep the bound element visible while the editor is displayed (defaults to true)",
- "memberOf" : "Roo.Editor"
- },
- {
- "name" : "hideMode",
- "type" : "String",
- "desc" : "y)\nHow this component 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" : "ignoreNoChange",
- "type" : "Boolean",
- "desc" : "True to skip the the edit completion process (no save, no events fired) if the user completes an edit and\nthe value has not changed (defaults to false). Applies only to string values - edits for other data types\nwill never be ignored.",
- "memberOf" : "Roo.Editor"
- },
- {
- "name" : "listeners",
- "type" : "Object",
- "desc" : "list of events and functions to call for this object, \nFor example :\n<pre><code>\n listeners : { \n 'click' : function(e) {\n ..... \n } ,\n .... \n } \n </code></pre>",
- "memberOf" : "Roo.util.Observable"
- },
- {
- "name" : "revertInvalid",
- "type" : "Boolean",
- "desc" : "True to automatically revert the field value and cancel the edit when the user completes an edit and the field\nvalidation fails (defaults to true)",
- "memberOf" : "Roo.Editor"
- },
- {
- "name" : "shadow",
- "type" : "Boolean/String",
- "desc" : "\"sides\" for sides/bottom only, \"frame\" for 4-way shadow, and \"drop\"\nfor bottom-right shadow (defaults to \"frame\")",
- "memberOf" : "Roo.Editor"
- },
- {
- "name" : "updateEl",
- "type" : "Boolean",
- "desc" : "True to update the innerHTML of the bound element when the update completes (defaults to false)",
- "memberOf" : "Roo.Editor"
},
{
- "name" : "value",
- "type" : "Mixed",
- "desc" : "The data value of the underlying field (defaults to \"\")",
- "memberOf" : "Roo.Editor"
- }
- ],
- "events" : [
- {
- "name" : "beforecomplete",
+ "name" : "headerdblclick",
"type" : "function",
- "desc" : "Fires after a change has been made to the field, but before the change is reflected in the underlying\nfield. Saving the change to the field can be canceled by returning false from the handler of this event.\nNote that if the value has not changed and ignoreNoChange = true, the editing will still end but this\nevent will not fire since no edit actually occurred.",
- "sig" : "function (_self, value, startValue)\n{\n\n}",
- "memberOf" : "Roo.Editor",
+ "desc" : "Fires when a header cell is double clicked",
+ "sig" : "function (_self, columnIndex, e)\n{\n\n}",
+ "memberOf" : "Roo.grid.Grid",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Editor",
+ "type" : "Grid",
"desc" : "",
"isOptional" : false
},
{
- "name" : "value",
- "type" : "Mixed",
- "desc" : "The current field value",
+ "name" : "columnIndex",
+ "type" : "Number",
+ "desc" : "",
"isOptional" : false
},
{
- "name" : "startValue",
- "type" : "Mixed",
- "desc" : "The original field value",
+ "name" : "e",
+ "type" : "Roo.EventObject",
+ "desc" : "",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "beforedestroy",
+ "name" : "keydown",
"type" : "function",
- "desc" : "Fires before the component is destroyed. Return false to stop the destroy.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
+ "desc" : "The raw keydown event for the entire grid.",
+ "sig" : "function (e)\n{\n\n}",
+ "memberOf" : "Roo.grid.Grid",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
"params" : [
{
- "name" : "this",
- "type" : "Roo.Component",
+ "name" : "e",
+ "type" : "Roo.EventObject",
"desc" : "",
"isOptional" : false
}
"returns" : []
},
{
- "name" : "beforehide",
+ "name" : "keypress",
"type" : "function",
- "desc" : "Fires before the component is hidden. Return false to stop the hide.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
+ "desc" : "The raw keypress event for the entire grid.",
+ "sig" : "function (e)\n{\n\n}",
+ "memberOf" : "Roo.grid.Grid",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
"params" : [
{
- "name" : "this",
- "type" : "Roo.Component",
+ "name" : "e",
+ "type" : "Roo.EventObject",
"desc" : "",
"isOptional" : false
}
"returns" : []
},
{
- "name" : "beforerender",
+ "name" : "mousedown",
"type" : "function",
- "desc" : "Fires before the component is rendered. Return false to stop the render.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
+ "desc" : "The raw mousedown event for the entire grid.",
+ "sig" : "function (e)\n{\n\n}",
+ "memberOf" : "Roo.grid.Grid",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
"params" : [
{
- "name" : "this",
- "type" : "Roo.Component",
+ "name" : "e",
+ "type" : "Roo.EventObject",
"desc" : "",
"isOptional" : false
}
"returns" : []
},
{
- "name" : "beforeshow",
+ "name" : "mouseout",
"type" : "function",
- "desc" : "Fires before the component is shown. Return false to stop the show.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
+ "desc" : "The raw mouseout event for the entire grid.",
+ "sig" : "function (e)\n{\n\n}",
+ "memberOf" : "Roo.grid.Grid",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
"params" : [
{
- "name" : "this",
- "type" : "Roo.Component",
+ "name" : "e",
+ "type" : "Roo.EventObject",
"desc" : "",
"isOptional" : false
}
"returns" : []
},
{
- "name" : "beforestartedit",
+ "name" : "mouseover",
"type" : "function",
- "desc" : "Fires when editing is initiated, but before the value changes. Editing can be canceled by returning\nfalse from the handler of this event.",
- "sig" : "function (_self, boundEl, value)\n{\n\n}",
- "memberOf" : "Roo.Editor",
+ "desc" : "The raw mouseover event for the entire grid.",
+ "sig" : "function (e)\n{\n\n}",
+ "memberOf" : "Roo.grid.Grid",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
"params" : [
{
- "name" : "this",
- "type" : "Editor",
+ "name" : "e",
+ "type" : "Roo.EventObject",
"desc" : "",
"isOptional" : false
- },
- {
- "name" : "boundEl",
- "type" : "Roo.Element",
- "desc" : "The underlying element bound to this editor",
- "isOptional" : false
- },
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "mouseup",
+ "type" : "function",
+ "desc" : "The raw mouseup event for the entire grid.",
+ "sig" : "function (e)\n{\n\n}",
+ "memberOf" : "Roo.grid.Grid",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
{
- "name" : "value",
- "type" : "Mixed",
- "desc" : "The field value being set",
+ "name" : "e",
+ "type" : "Roo.EventObject",
+ "desc" : "",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "complete",
+ "name" : "propertychange",
"type" : "function",
- "desc" : "Fires after editing is complete and any changed value has been written to the underlying field.",
- "sig" : "function (_self, value, startValue)\n{\n\n}",
- "memberOf" : "Roo.Editor",
+ "desc" : "Fires after a property changes",
+ "sig" : "function (grid, id, newval, oldval)\n{\n\n}",
+ "memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
"params" : [
{
- "name" : "this",
- "type" : "Editor",
- "desc" : "",
+ "name" : "grid",
+ "type" : "Roo.grid.PropertyGrid",
+ "desc" : "property grid? (check could be store)",
"isOptional" : false
},
{
- "name" : "value",
- "type" : "Mixed",
- "desc" : "The current field value",
+ "name" : "id",
+ "type" : "String",
+ "desc" : "Record Id",
"isOptional" : false
},
{
- "name" : "startValue",
- "type" : "Mixed",
- "desc" : "The original field value",
+ "name" : "newval",
+ "type" : "String",
+ "desc" : "New Value",
+ "isOptional" : false
+ },
+ {
+ "name" : "oldval",
+ "type" : "String",
+ "desc" : "Old Value",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "destroy",
+ "name" : "render",
"type" : "function",
- "desc" : "Fires after the component is destroyed.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
+ "desc" : "Fires when the grid is rendered",
+ "sig" : "function (grid)\n{\n\n}",
+ "memberOf" : "Roo.grid.Grid",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
"params" : [
{
- "name" : "this",
- "type" : "Roo.Component",
+ "name" : "grid",
+ "type" : "Grid",
"desc" : "",
"isOptional" : false
}
"returns" : []
},
{
- "name" : "disable",
+ "name" : "rowclass",
"type" : "function",
- "desc" : "Fires after the component is disabled.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
+ "desc" : "Fires when a row is rendered, so you can change add a style to it.",
+ "sig" : "function (gridview, rowcfg)\n{\n\n}",
+ "memberOf" : "Roo.grid.Grid",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
"params" : [
{
- "name" : "this",
- "type" : "Roo.Component",
- "desc" : "",
+ "name" : "gridview",
+ "type" : "GridView",
+ "desc" : "The grid view",
+ "isOptional" : false
+ },
+ {
+ "name" : "rowcfg",
+ "type" : "Object",
+ "desc" : "contains record rowIndex and rowClass - set rowClass to add a style.",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "enable",
+ "name" : "rowclick",
"type" : "function",
- "desc" : "Fires after the component is enabled.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
+ "desc" : "Fires when a row is clicked",
+ "sig" : "function (_self, rowIndex, e)\n{\n\n}",
+ "memberOf" : "Roo.grid.Grid",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.Component",
+ "type" : "Grid",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "rowIndex",
+ "type" : "Number",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "e",
+ "type" : "Roo.EventObject",
"desc" : "",
"isOptional" : false
}
"returns" : []
},
{
- "name" : "hide",
+ "name" : "rowcontextmenu",
"type" : "function",
- "desc" : "Fires after the component is hidden.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
+ "desc" : "Fires when a row is right clicked",
+ "sig" : "function (_self, rowIndex, e)\n{\n\n}",
+ "memberOf" : "Roo.grid.Grid",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.Component",
+ "type" : "Grid",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "rowIndex",
+ "type" : "Number",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "e",
+ "type" : "Roo.EventObject",
"desc" : "",
"isOptional" : false
}
"returns" : []
},
{
- "name" : "render",
+ "name" : "rowdblclick",
"type" : "function",
- "desc" : "Fires after the component is rendered.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
+ "desc" : "Fires when a row is double clicked",
+ "sig" : "function (_self, rowIndex, e)\n{\n\n}",
+ "memberOf" : "Roo.grid.Grid",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.Component",
+ "type" : "Grid",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "rowIndex",
+ "type" : "Number",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "e",
+ "type" : "Roo.EventObject",
"desc" : "",
"isOptional" : false
}
"returns" : []
},
{
- "name" : "show",
+ "name" : "startdrag",
"type" : "function",
- "desc" : "Fires after the component is shown.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
+ "desc" : "Fires when row(s) start being dragged",
+ "sig" : "function (_self, dd, e)\n{\n\n}",
+ "memberOf" : "Roo.grid.Grid",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.Component",
+ "type" : "Grid",
"desc" : "",
"isOptional" : false
+ },
+ {
+ "name" : "dd",
+ "type" : "Roo.GridDD",
+ "desc" : "The drag drop object",
+ "isOptional" : false
+ },
+ {
+ "name" : "e",
+ "type" : "event",
+ "desc" : "The raw browser event",
+ "isOptional" : false
}
],
"returns" : []
},
{
- "name" : "specialkey",
+ "name" : "validateedit",
"type" : "function",
- "desc" : "Fires when any key related to navigation (arrows, tab, enter, esc, etc.) is pressed. You can check\n{@link Roo.EventObject#getKey} to determine which key was pressed.",
- "sig" : "function (_self, e)\n{\n\n}",
- "memberOf" : "Roo.Editor",
+ "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>",
+ "sig" : "function (e)\n{\n\n}",
+ "memberOf" : "Roo.grid.EditorGrid",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
"params" : [
- {
- "name" : "this",
- "type" : "Roo.form.Field",
- "desc" : "",
- "isOptional" : false
- },
{
"name" : "e",
- "type" : "Roo.EventObject",
- "desc" : "The event object",
+ "type" : "Object",
+ "desc" : "An edit event (see above for description)",
"isOptional" : false
}
],
"returns" : []
- },
+ }
+ ],
+ "methods" : [
{
- "name" : "startedit",
+ "name" : "addColumns",
"type" : "function",
- "desc" : "Fires when this editor is displayed",
- "sig" : "function (boundEl, value)\n{\n\n}",
- "memberOf" : "Roo.Editor",
+ "desc" : "addColumns\nAdd's a column, default at the end..",
+ "sig" : "(position, of)",
+ "static" : false,
+ "memberOf" : "Roo.grid.Grid",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
- "name" : "boundEl",
- "type" : "Roo.Element",
- "desc" : "The underlying element bound to this editor",
+ "name" : "position",
+ "type" : "int",
+ "desc" : "to add (default end)",
"isOptional" : false
},
{
- "name" : "value",
- "type" : "Mixed",
- "desc" : "The starting field value",
+ "name" : "of",
+ "type" : "Array",
+ "desc" : "objects of column configuration see {@link Roo.grid.ColumnModel}",
"isOptional" : false
}
],
"returns" : []
- }
- ],
- "methods" : [
+ },
{
"name" : "addEvents",
"type" : "function",
"returns" : []
},
{
- "name" : "cancelEdit",
+ "name" : "autoSize",
"type" : "function",
- "desc" : "Cancels the editing process and hides the editor without persisting any changes. The field value will be\nreverted to the original starting value.",
- "sig" : "(remainVisible)",
+ "desc" : "Causes the grid to manually recalculate its dimensions. Generally this is done automatically,\nbut if manual update is required this method will initiate it.",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.Editor",
+ "memberOf" : "Roo.grid.Grid",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "remainVisible",
- "type" : "Boolean",
- "desc" : "Override the default behavior and keep the editor visible after\ncancel (defaults to false)",
- "isOptional" : false
- }
- ],
+ "params" : [],
"returns" : []
},
{
"returns" : []
},
{
- "name" : "completeEdit",
+ "name" : "destroy",
"type" : "function",
- "desc" : "Ends the editing process, persists the changed value to the underlying field, and hides the editor.",
- "sig" : "(remainVisible)",
+ "desc" : "Destroy this grid.",
+ "sig" : "(removeEl)",
"static" : false,
- "memberOf" : "Roo.Editor",
+ "memberOf" : "Roo.grid.Grid",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "remainVisible",
+ "name" : "removeEl",
"type" : "Boolean",
- "desc" : "Override the default behavior and keep the editor visible after edit (defaults to false)",
+ "desc" : "True to remove the element",
"isOptional" : false
}
],
"returns" : []
},
- {
- "name" : "destroy",
- "type" : "function",
- "desc" : "Destroys this component by purging any event listeners, removing the component's element from the DOM,\nremoving the component from its {@link Roo.Container} (if applicable) and unregistering it from {@link Roo.ComponentMgr}.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.Component",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
- {
- "name" : "disable",
- "type" : "function",
- "desc" : "Disable this component.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.Component",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : [
- {
- "name" : "",
- "type" : "Roo.Component",
- "desc" : "this"
- }
- ]
- },
- {
- "name" : "enable",
- "type" : "function",
- "desc" : "Enable this component.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.Component",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : [
- {
- "name" : "",
- "type" : "Roo.Component",
- "desc" : "this"
- }
- ]
- },
{
"name" : "fireEvent",
"type" : "function",
]
},
{
- "name" : "focus",
+ "name" : "getColumnModel",
"type" : "function",
- "desc" : "Try to focus this component.",
- "sig" : "(selectText)",
+ "desc" : "Returns the grid's ColumnModel.",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.Component",
+ "memberOf" : "Roo.grid.Grid",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "selectText",
- "type" : "Boolean",
- "desc" : "True to also select the text in this component (if applicable)",
- "isOptional" : false
- }
- ],
+ "params" : [],
"returns" : [
{
"name" : "",
- "type" : "Roo.Component",
- "desc" : "this"
+ "type" : "ColumnModel",
+ "desc" : ""
}
]
},
{
- "name" : "getEl",
+ "name" : "getDataSource",
"type" : "function",
- "desc" : "Returns the underlying {@link Roo.Element}.",
+ "desc" : "Returns the grid's DataSource.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.Component",
+ "memberOf" : "Roo.grid.Grid",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"returns" : [
{
"name" : "",
- "type" : "Roo.Element",
- "desc" : "The element"
+ "type" : "DataSource",
+ "desc" : ""
}
]
},
{
- "name" : "getId",
+ "name" : "getDragDropText",
"type" : "function",
- "desc" : "Returns the id of this component.",
+ "desc" : "Called to get grid's drag proxy text, by default returns this.ddText.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.Component",
+ "memberOf" : "Roo.grid.EditorGrid",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
]
},
{
- "name" : "getValue",
+ "name" : "getGridEl",
"type" : "function",
- "desc" : "Gets the data value of the editor",
+ "desc" : "Returns the grid's underlying element.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.Editor",
+ "memberOf" : "Roo.grid.Grid",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"returns" : [
{
"name" : "",
- "type" : "Mixed",
- "desc" : "The data value"
+ "type" : "Element",
+ "desc" : "The element"
}
]
},
{
- "name" : "hasListener",
+ "name" : "getSelectionModel",
"type" : "function",
- "desc" : "Checks to see if this object has any listeners for a specified event",
- "sig" : "(eventName)",
+ "desc" : "Returns the grid's SelectionModel.",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.util.Observable",
+ "memberOf" : "Roo.grid.Grid",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "eventName",
- "type" : "String",
- "desc" : "The name of the event to check for",
- "isOptional" : false
- }
- ],
+ "params" : [],
"returns" : [
{
"name" : "",
- "type" : "Boolean",
- "desc" : "True if the event is being listened for, else false"
+ "type" : "SelectionModel",
+ "desc" : ""
}
]
},
{
- "name" : "hide",
+ "name" : "getSource",
"type" : "function",
- "desc" : "Hide this component.",
+ "desc" : "Gets all the data from the grid.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.Component",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"returns" : [
{
"name" : "",
- "type" : "Roo.Component",
- "desc" : "this"
+ "type" : "Object",
+ "desc" : "data data stored in grid"
}
]
},
{
- "name" : "isVisible",
+ "name" : "getView",
"type" : "function",
- "desc" : "Returns true if this component is visible.",
+ "desc" : "Returns the grid's GridView object.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.Component",
+ "memberOf" : "Roo.grid.Grid",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"exceptions" : "",
"requires" : "",
"params" : [],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "GridView",
+ "desc" : ""
+ }
+ ]
+ },
+ {
+ "name" : "hasListener",
+ "type" : "function",
+ "desc" : "Checks to see if this object has any listeners for a specified event",
+ "sig" : "(eventName)",
+ "static" : false,
+ "memberOf" : "Roo.util.Observable",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "eventName",
+ "type" : "String",
+ "desc" : "The name of the event to check for",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Boolean",
+ "desc" : "True if the event is being listened for, else false"
+ }
+ ]
},
{
"name" : "on",
"returns" : []
},
{
- "name" : "realign",
+ "name" : "reconfigure",
"type" : "function",
- "desc" : "Realigns the editor to the bound field based on the current alignment config value.",
- "sig" : "()\n{\n\n}",
+ "desc" : "Reconfigures the grid to use a different Store and Column Model.\nThe View will be bound to the new objects and refreshed.",
+ "sig" : "(dataSource, The)",
"static" : false,
- "memberOf" : "Roo.Editor",
+ "memberOf" : "Roo.grid.Grid",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
+ "params" : [
+ {
+ "name" : "dataSource",
+ "type" : "Roo.data.Store",
+ "desc" : "The new {@link Roo.data.Store} object",
+ "isOptional" : false
+ },
+ {
+ "name" : "The",
+ "type" : "Roo.grid.ColumnModel",
+ "desc" : "new {@link Roo.grid.ColumnModel} object",
+ "isOptional" : false
+ }
+ ],
"returns" : []
},
{
{
"name" : "render",
"type" : "function",
- "desc" : "If this is a lazy rendering component, render it to its container element.",
- "sig" : "(container)",
+ "desc" : "Called once after all setup has been completed and the grid is ready to be rendered.",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.Component",
+ "memberOf" : "Roo.grid.Grid",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
+ "params" : [],
+ "returns" : [
{
- "name" : "container",
- "type" : "String/HTMLElement/Element",
- "desc" : "(optional) The element this component should be rendered into. If it is being applied to existing markup, this should be left off.",
- "isOptional" : false
+ "name" : "",
+ "type" : "Roo.grid.Grid",
+ "desc" : "this"
}
- ],
- "returns" : []
+ ]
},
{
- "name" : "setDisabled",
+ "name" : "setSource",
"type" : "function",
- "desc" : "Convenience function for setting disabled/enabled by boolean.",
- "sig" : "(disabled)",
+ "desc" : "Sets the data for the Grid\naccepts a Key => Value object of all the elements avaiable.",
+ "sig" : "(data)",
"static" : false,
- "memberOf" : "Roo.Component",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "disabled",
- "type" : "Boolean",
- "desc" : "",
+ "name" : "data",
+ "type" : "Object",
+ "desc" : "to appear in grid.",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "setSize",
+ "name" : "startEditing",
"type" : "function",
- "desc" : "Sets the height and width of this editor.",
- "sig" : "(width, height)",
+ "desc" : "Starts editing the specified for the specified row/column",
+ "sig" : "(rowIndex, colIndex)",
"static" : false,
- "memberOf" : "Roo.Editor",
+ "memberOf" : "Roo.grid.EditorGrid",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "width",
+ "name" : "rowIndex",
"type" : "Number",
- "desc" : "The new width",
+ "desc" : "",
"isOptional" : false
},
{
- "name" : "height",
+ "name" : "colIndex",
"type" : "Number",
- "desc" : "The new height",
+ "desc" : "",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "setValue",
+ "name" : "stopEditing",
"type" : "function",
- "desc" : "Sets the data value of the editor",
- "sig" : "(value)",
+ "desc" : "Stops any active editing",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.Editor",
+ "memberOf" : "Roo.grid.EditorGrid",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "value",
- "type" : "Mixed",
- "desc" : "Any valid value supported by the underlying field",
- "isOptional" : false
- }
- ],
+ "params" : [],
"returns" : []
},
{
- "name" : "setVisible",
+ "name" : "un",
"type" : "function",
- "desc" : "Convenience function to hide or show this component by boolean.",
- "sig" : "(visible)",
+ "desc" : "Removes a listener (shorthand for removeListener)",
+ "sig" : "(eventName, handler, scope)",
"static" : false,
- "memberOf" : "Roo.Component",
+ "memberOf" : "Roo.util.Observable",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "visible",
- "type" : "Boolean",
- "desc" : "True to show, false to hide",
+ "name" : "eventName",
+ "type" : "String",
+ "desc" : "The type of event to listen for",
+ "isOptional" : false
+ },
+ {
+ "name" : "handler",
+ "type" : "Function",
+ "desc" : "The handler to remove",
+ "isOptional" : false
+ },
+ {
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "(optional) The scope (this object) for the handler",
"isOptional" : false
}
],
- "returns" : [
+ "returns" : []
+ }
+ ],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "implementations" : [],
+ "tree_children" : [],
+ "tree_parent" : []
+ },
+ "Roo.grid.RowSelectionModel" : {
+ "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",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "singleSelect",
+ "type" : "Boolean",
+ "desc" : "True to allow selection of only one row at a time (defaults to false)",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ }
+ ],
+ "events" : [
+ {
+ "name" : "afterselectionchange",
+ "type" : "function",
+ "desc" : "Fires after the selection changes (eg. by key press or clicking)",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
{
- "name" : "",
- "type" : "Roo.Component",
- "desc" : "this"
+ "name" : "this",
+ "type" : "SelectionModel",
+ "desc" : "",
+ "isOptional" : false
}
- ]
+ ],
+ "returns" : []
},
{
- "name" : "show",
+ "name" : "beforerowselect",
"type" : "function",
- "desc" : "Show this component.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.Component",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
+ "desc" : "Fires when a row is selected being selected, return false to cancel.",
+ "sig" : "function (_self, rowIndex, keepExisting)\n{\n\n}",
+ "memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : [
+ "params" : [
{
- "name" : "",
- "type" : "Roo.Component",
- "desc" : "this"
+ "name" : "this",
+ "type" : "SelectionModel",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "rowIndex",
+ "type" : "Number",
+ "desc" : "The selected index",
+ "isOptional" : false
+ },
+ {
+ "name" : "keepExisting",
+ "type" : "Boolean",
+ "desc" : "False if other selections will be cleared",
+ "isOptional" : false
}
- ]
+ ],
+ "returns" : []
},
{
- "name" : "startEdit",
+ "name" : "rowdeselect",
"type" : "function",
- "desc" : "Starts the editing process and shows the editor.",
- "sig" : "(el, value)",
- "static" : false,
- "memberOf" : "Roo.Editor",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
+ "desc" : "Fires when a row is deselected.",
+ "sig" : "function (_self, rowIndex)\n{\n\n}",
+ "memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
"params" : [
{
- "name" : "el",
- "type" : "String/HTMLElement/Element",
- "desc" : "The element to edit",
+ "name" : "this",
+ "type" : "SelectionModel",
+ "desc" : "",
"isOptional" : false
},
{
- "name" : "value",
- "type" : "String",
- "desc" : "(optional) A value to initialize the editor with. If a value is not provided, it defaults\nto the innerHTML of el.",
+ "name" : "rowIndex",
+ "type" : "Number",
+ "desc" : "The selected index",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "un",
+ "name" : "rowselect",
"type" : "function",
- "desc" : "Removes a listener (shorthand for removeListener)",
- "sig" : "(eventName, handler, scope)",
- "static" : false,
- "memberOf" : "Roo.util.Observable",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
+ "desc" : "Fires when a row is selected.",
+ "sig" : "function (_self, rowIndex, r)\n{\n\n}",
+ "memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
"params" : [
{
- "name" : "eventName",
- "type" : "String",
- "desc" : "The type of event to listen for",
+ "name" : "this",
+ "type" : "SelectionModel",
+ "desc" : "",
"isOptional" : false
},
{
- "name" : "handler",
- "type" : "Function",
- "desc" : "The handler to remove",
+ "name" : "rowIndex",
+ "type" : "Number",
+ "desc" : "The selected index",
"isOptional" : false
},
{
- "name" : "scope",
- "type" : "Object",
- "desc" : "(optional) The scope (this object) for the handler",
+ "name" : "r",
+ "type" : "Roo.data.Record",
+ "desc" : "The record",
"isOptional" : false
}
],
"returns" : []
- }
- ],
- "isAbstract" : false,
- "isBuilderTop" : false,
- "childClasses" : { },
- "tree_children" : [],
- "tree_parent" : []
- },
- "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"
+ "name" : "selectionchange",
+ "type" : "function",
+ "desc" : "Fires when the selection changes",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "SelectionModel",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
}
],
- "events" : [],
"methods" : [
{
"name" : "addEvents",
"returns" : []
},
{
- "name" : "autoSizeColumn",
+ "name" : "capture",
"type" : "function",
- "desc" : "Autofit a column to its content.",
- "sig" : "(colIndex, forceMinSize)",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
+ "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\n<b>before</b> the event is fired. If the supplied function returns false,\nthe event will not fire.",
+ "sig" : "(o, fn, scope)",
+ "static" : true,
+ "memberOf" : "Roo.util.Observable",
+ "isStatic" : true,
"isConstructor" : false,
"isPrivate" : false,
"example" : "",
"requires" : "",
"params" : [
{
- "name" : "colIndex",
- "type" : "Number",
- "desc" : "",
+ "name" : "o",
+ "type" : "Observable",
+ "desc" : "The Observable to capture",
"isOptional" : false
},
{
- "name" : "forceMinSize",
- "type" : "Boolean",
- "desc" : "true to force the column to go smaller if possible",
+ "name" : "fn",
+ "type" : "Function",
+ "desc" : "The function to call",
+ "isOptional" : false
+ },
+ {
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "(optional) The scope (this object) for the fn",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "autoSizeColumns",
+ "name" : "clearSelections",
"type" : "function",
- "desc" : "Autofits all columns to their content and then expands to fit any extra space in the grid",
+ "desc" : "Clears all selections.",
"sig" : "()\n{\n\n}",
"static" : false,
"memberOf" : "",
"returns" : []
},
{
- "name" : "capture",
+ "name" : "deselectRange",
"type" : "function",
- "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\n<b>before</b> the event is fired. If the supplied function returns false,\nthe event will not fire.",
- "sig" : "(o, fn, scope)",
- "static" : true,
- "memberOf" : "Roo.util.Observable",
- "isStatic" : true,
+ "desc" : "Deselects a range of rows. All rows in between startRow and endRow are also deselected.",
+ "sig" : "(startRow, endRow)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"example" : "",
"requires" : "",
"params" : [
{
- "name" : "o",
- "type" : "Observable",
- "desc" : "The Observable to capture",
- "isOptional" : false
- },
- {
- "name" : "fn",
- "type" : "Function",
- "desc" : "The function to call",
+ "name" : "startRow",
+ "type" : "Number",
+ "desc" : "The index of the first row in the range",
"isOptional" : false
},
{
- "name" : "scope",
- "type" : "Object",
- "desc" : "(optional) The scope (this object) for the fn",
+ "name" : "endRow",
+ "type" : "Number",
+ "desc" : "The index of the last row in the range",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "ensureVisible",
+ "name" : "deselectRow",
"type" : "function",
- "desc" : "Scrolls the specified cell into view",
- "sig" : "(row, col, hscroll)",
+ "desc" : "Deselects a row.",
+ "sig" : "(row)",
"static" : false,
"memberOf" : "",
"isStatic" : false,
{
"name" : "row",
"type" : "Number",
- "desc" : "The row index",
- "isOptional" : false
- },
- {
- "name" : "col",
- "type" : "Number",
- "desc" : "The column index",
- "isOptional" : false
- },
- {
- "name" : "hscroll",
- "type" : "Boolean",
- "desc" : "false to disable horizontal scrolling",
+ "desc" : "The index of the row to deselect",
"isOptional" : false
}
],
]
},
{
- "name" : "fitColumns",
+ "name" : "getCount",
"type" : "function",
- "desc" : "Autofits all columns to the grid's width proportionate with their current size",
- "sig" : "(reserveScrollSpace)",
+ "desc" : "Gets the number of selected rows.",
+ "sig" : "()\n{\n\n}",
"static" : false,
"memberOf" : "",
"isStatic" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
+ "params" : [],
+ "returns" : [
{
- "name" : "reserveScrollSpace",
- "type" : "Boolean",
- "desc" : "Reserve space for a scrollbar",
- "isOptional" : false
+ "name" : "",
+ "type" : "Number",
+ "desc" : ""
}
- ],
- "returns" : []
+ ]
},
{
- "name" : "focusCell",
+ "name" : "getSelected",
"type" : "function",
- "desc" : "Focuses the specified cell.",
- "sig" : "(row, col, hscroll)",
+ "desc" : "Returns the first selected record.",
+ "sig" : "()\n{\n\n}",
"static" : false,
"memberOf" : "",
"isStatic" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "row",
- "type" : "Number",
- "desc" : "The row index",
- "isOptional" : false
- },
- {
- "name" : "col",
- "type" : "Number",
- "desc" : "The column index",
- "isOptional" : false
- },
+ "params" : [],
+ "returns" : [
{
- "name" : "hscroll",
- "type" : "Boolean",
- "desc" : "false to disable horizontal scrolling",
- "isOptional" : false
+ "name" : "",
+ "type" : "Record",
+ "desc" : ""
}
- ],
- "returns" : []
+ ]
},
{
- "name" : "focusRow",
+ "name" : "getSelections",
"type" : "function",
- "desc" : "Focuses the specified row.",
- "sig" : "(row)",
+ "desc" : "Returns the selected records",
+ "sig" : "()\n{\n\n}",
"static" : false,
"memberOf" : "",
"isStatic" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
+ "params" : [],
+ "returns" : [
{
- "name" : "row",
- "type" : "Number",
- "desc" : "The row index",
- "isOptional" : false
+ "name" : "",
+ "type" : "Array",
+ "desc" : "Array of selected records"
}
- ],
- "returns" : []
+ ]
},
{
- "name" : "getCell",
+ "name" : "hasListener",
"type" : "function",
- "desc" : "Gets the 'td' of the cell",
- "sig" : "(rowIndex, colIndex)",
+ "desc" : "Checks to see if this object has any listeners for a specified event",
+ "sig" : "(eventName)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.util.Observable",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "rowIndex",
- "type" : "Integer",
- "desc" : "row to select",
- "isOptional" : false
- },
- {
- "name" : "colIndex",
- "type" : "Integer",
- "desc" : "column to select",
+ "name" : "eventName",
+ "type" : "String",
+ "desc" : "The name of the event to check for",
"isOptional" : false
}
],
"returns" : [
{
"name" : "",
- "type" : "Object",
- "desc" : ""
+ "type" : "Boolean",
+ "desc" : "True if the event is being listened for, else false"
}
]
},
{
- "name" : "getFooterPanel",
+ "name" : "hasSelection",
"type" : "function",
- "desc" : "Gets a panel in the footer of the grid that can be used for toolbars etc.\nAfter modifying the contents of this panel a call to grid.autoSize() may be\nrequired to register any changes in size.",
- "sig" : "(doShow)",
+ "desc" : "Returns True if there is a selection.",
+ "sig" : "()\n{\n\n}",
"static" : false,
"memberOf" : "",
"isStatic" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "doShow",
- "type" : "Boolean",
- "desc" : "By default the footer is hidden. Pass true to show the panel",
- "isOptional" : false
- }
- ],
+ "params" : [],
"returns" : [
{
"name" : "",
- "type" : "",
- "desc" : "Roo.Element"
+ "type" : "Boolean",
+ "desc" : ""
}
]
},
{
- "name" : "getHeaderPanel",
+ "name" : "isIdSelected",
"type" : "function",
- "desc" : "Gets a panel in the header of the grid that can be used for toolbars etc.\nAfter modifying the contents of this panel a call to grid.autoSize() may be\nrequired to register any changes in size.",
- "sig" : "(doShow)",
+ "desc" : "Returns True if the specified record id is selected.",
+ "sig" : "(id)",
"static" : false,
"memberOf" : "",
"isStatic" : false,
"requires" : "",
"params" : [
{
- "name" : "doShow",
- "type" : "Boolean",
- "desc" : "By default the header is hidden. Pass true to show the panel",
+ "name" : "id",
+ "type" : "String",
+ "desc" : "The id of record to check",
"isOptional" : false
}
],
"returns" : [
{
"name" : "",
- "type" : "",
- "desc" : "Roo.Element"
+ "type" : "Boolean",
+ "desc" : ""
}
]
},
{
- "name" : "hasListener",
+ "name" : "isLocked",
"type" : "function",
- "desc" : "Checks to see if this object has any listeners for a specified event",
- "sig" : "(eventName)",
+ "desc" : "Returns true if the selections are locked.",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.util.Observable",
+ "memberOf" : "Roo.grid.AbstractSelectionModel",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Boolean",
+ "desc" : ""
+ }
+ ]
+ },
+ {
+ "name" : "isSelected",
+ "type" : "function",
+ "desc" : "Returns True if the specified row is selected.",
+ "sig" : "(record)",
+ "static" : false,
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "eventName",
- "type" : "String",
- "desc" : "The name of the event to check for",
+ "name" : "record",
+ "type" : "Number/Record",
+ "desc" : "The record or index of the record to check",
"isOptional" : false
}
],
{
"name" : "",
"type" : "Boolean",
- "desc" : "True if the event is being listened for, else false"
+ "desc" : ""
}
]
},
+ {
+ "name" : "lock",
+ "type" : "function",
+ "desc" : "Locks the selections.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.grid.AbstractSelectionModel",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
{
"name" : "on",
"type" : "function",
"params" : [],
"returns" : []
},
- {
- "name" : "refresh",
- "type" : "function",
- "desc" : "Refreshes the grid",
- "sig" : "(headersToo)",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "headersToo",
- "type" : "Boolean",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
{
"name" : "releaseCapture",
"type" : "function",
"returns" : []
},
{
- "name" : "scrollToTop",
+ "name" : "selectAll",
"type" : "function",
- "desc" : "Scrolls the grid to the top",
+ "desc" : "Selects all rows.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
+ {
+ "name" : "selectFirstRow",
+ "type" : "function",
+ "desc" : "Selects the first row in the grid.",
"sig" : "()\n{\n\n}",
"static" : false,
"memberOf" : "",
"params" : [],
"returns" : []
},
+ {
+ "name" : "selectLastRow",
+ "type" : "function",
+ "desc" : "Select the last row.",
+ "sig" : "(keepExisting)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "keepExisting",
+ "type" : "Boolean",
+ "desc" : "(optional) True to keep existing selections",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "selectNext",
+ "type" : "function",
+ "desc" : "Selects the row immediately following the last selected row.",
+ "sig" : "(keepExisting)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "keepExisting",
+ "type" : "Boolean",
+ "desc" : "(optional) True to keep existing selections",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "selectPrevious",
+ "type" : "function",
+ "desc" : "Selects the row that precedes the last selected row.",
+ "sig" : "(keepExisting)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "keepExisting",
+ "type" : "Boolean",
+ "desc" : "(optional) True to keep existing selections",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "selectRange",
+ "type" : "function",
+ "desc" : "Selects a range of rows. All rows in between startRow and endRow are also selected.",
+ "sig" : "(startRow, endRow, keepExisting)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "startRow",
+ "type" : "Number",
+ "desc" : "The index of the first row in the range",
+ "isOptional" : false
+ },
+ {
+ "name" : "endRow",
+ "type" : "Number",
+ "desc" : "The index of the last row in the range",
+ "isOptional" : false
+ },
+ {
+ "name" : "keepExisting",
+ "type" : "Boolean",
+ "desc" : "(optional) True to retain existing selections",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "selectRecords",
+ "type" : "function",
+ "desc" : "Select records.",
+ "sig" : "(records, keepExisting)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "records",
+ "type" : "Array",
+ "desc" : "The records to select",
+ "isOptional" : false
+ },
+ {
+ "name" : "keepExisting",
+ "type" : "Boolean",
+ "desc" : "(optional) True to keep existing selections",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "selectRow",
+ "type" : "function",
+ "desc" : "Selects a row.",
+ "sig" : "(row, keepExisting)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "row",
+ "type" : "Number",
+ "desc" : "The index of the row to select",
+ "isOptional" : false
+ },
+ {
+ "name" : "keepExisting",
+ "type" : "Boolean",
+ "desc" : "(optional) True to keep existing selections",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "selectRows",
+ "type" : "function",
+ "desc" : "Selects multiple rows.",
+ "sig" : "(rows, keepExisting)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "rows",
+ "type" : "Array",
+ "desc" : "Array of the indexes of the row to select",
+ "isOptional" : false
+ },
+ {
+ "name" : "keepExisting",
+ "type" : "Boolean",
+ "desc" : "(optional) True to keep existing selections",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
{
"name" : "un",
"type" : "function",
}
],
"returns" : []
+ },
+ {
+ "name" : "unlock",
+ "type" : "function",
+ "desc" : "Unlocks the selections.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.grid.AbstractSelectionModel",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
}
],
"isAbstract" : false,
"isBuilderTop" : false,
- "childClasses" : { },
+ "implementations" : [],
"tree_children" : [],
"tree_parent" : []
},
- "Roo.grid.PropertyGrid" : {
+ "Roo.grid.SplitDragZone" : {
"props" : [
- {
- "name" : "autoExpandColumn",
- "type" : "String",
- "desc" : "The id (or dataIndex) of a column in this grid that should expand to fill unused space. This id can not be 0. Default is false.",
- "memberOf" : "Roo.grid.Grid"
- },
- {
- "name" : "autoExpandMax",
- "type" : "Number",
- "desc" : "The maximum width the autoExpandColumn can have (if enabled). Default is 1000.",
- "memberOf" : "Roo.grid.Grid"
- },
- {
- "name" : "autoExpandMin",
- "type" : "Number",
- "desc" : "The minimum width the autoExpandColumn can have (if enabled).\nDefault is 50.",
- "memberOf" : "Roo.grid.Grid"
- },
- {
- "name" : "autoHeight",
- "type" : "Boolean",
- "desc" : "True to fit the height of the grid container to the height of the data. Default is false.",
- "memberOf" : "Roo.grid.Grid"
- },
- {
- "name" : "autoSizeColumns",
- "type" : "Boolean",
- "desc" : "True to automatically resize the columns to fit their content\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" : "autoWidth",
- "type" : "Boolean",
- "desc" : "True to set the grid's width to the default total width of the grid's columns instead\nof a fixed width. Default is false.",
- "memberOf" : "Roo.grid.Grid"
- },
- {
- "name" : "clicksToEdit",
- "type" : "Number",
- "desc" : "The number of clicks on a cell required to display the cell's editor (defaults to 2)",
- "memberOf" : "Roo.grid.EditorGrid"
- },
- {
- "name" : "cm[]",
- "type" : "Roo.grid.ColumnModel",
- "desc" : "The columns of the grid",
- "memberOf" : "Roo.grid.Grid"
- },
- {
- "name" : "customEditors",
- "type" : "Object",
- "desc" : "map of colnames=> custom editors.\nthe custom editor can be one of the standard ones (date|string|number|int|boolean), or a\ngrid editor eg. Roo.grid.GridEditor(new Roo.form.TextArea({selectOnFocus:true})),\nfalse disables editing of the field.",
- "memberOf" : ""
- },
- {
- "name" : "ddGroup",
- "type" : "String",
- "desc" : "- drag drop group.",
- "memberOf" : "Roo.grid.Grid"
- },
- {
- "name" : "ddText",
- "type" : "String",
- "desc" : "Configures the text is the drag proxy (defaults to \"%0 selected row(s)\").\n%0 is replaced with the number of selected rows.",
- "memberOf" : "Roo.grid.Grid"
- },
- {
- "name" : "dragGroup",
- "type" : "String",
- "desc" : "- drag group (?? not sure if needed.)",
- "memberOf" : "Roo.grid.Grid"
- },
- {
- "name" : "dropTarget",
- "type" : "Roo.dd.DropTarget",
- "desc" : "An {@link Roo.dd.DropTarget} config",
- "memberOf" : "Roo.grid.Grid"
- },
- {
- "name" : "ds",
- "type" : "Roo.grid.Store",
- "desc" : "The data store for the grid",
- "memberOf" : "Roo.grid.Grid"
- },
- {
- "name" : "enableColumnHide",
- "type" : "Boolean",
- "desc" : "True to enable hiding of columns with the header context menu. Default is true.",
- "memberOf" : "Roo.grid.Grid"
- },
- {
- "name" : "enableColumnMove",
- "type" : "Boolean",
- "desc" : "True to enable drag and drop reorder of columns. Default is true.",
- "memberOf" : "Roo.grid.Grid"
- },
- {
- "name" : "enableDrag",
- "type" : "Boolean",
- "desc" : "True to enable drag of rows. Default is false. (double check if this is needed?)",
- "memberOf" : "Roo.grid.Grid"
- },
- {
- "name" : "enableDragDrop",
- "type" : "Boolean",
- "desc" : "True to enable drag and drop of rows. Default is false.",
- "memberOf" : "Roo.grid.Grid"
- },
- {
- "name" : "enableDrop",
- "type" : "Boolean",
- "desc" : "True to enable drop of elements. Default is false. (double check if this is needed?)",
- "memberOf" : "Roo.grid.Grid"
- },
- {
- "name" : "enableRowHeightSync",
- "type" : "Boolean",
- "desc" : "True to manually sync row heights across locked and not locked rows. Default is false.",
- "memberOf" : "Roo.grid.Grid"
- },
{
"name" : "listeners",
"type" : "Object",
"desc" : "list of events and functions to call for this object, \nFor example :\n<pre><code>\n listeners : { \n 'click' : function(e) {\n ..... \n } ,\n .... \n } \n </code></pre>",
- "memberOf" : "Roo.util.Observable"
- },
- {
- "name" : "loadMask",
- "type" : "Object",
- "desc" : "An {@link Roo.LoadMask} config or true to mask the grid while loading. Default is false.",
- "memberOf" : "Roo.grid.Grid"
- },
- {
- "name" : "maxHeight",
- "type" : "Number",
- "desc" : "Sets the maximum height of the grid - ignored if autoHeight is not on.",
- "memberOf" : "Roo.grid.Grid"
- },
- {
- "name" : "maxRowsToMeasure",
- "type" : "Boolean",
- "desc" : "If autoSizeColumns is on, maxRowsToMeasure can be used to limit the number of\nrows measured to get a columns size. Default is 0 (all rows).",
- "memberOf" : "Roo.grid.Grid"
- },
- {
- "name" : "minColumnWidth",
- "type" : "Number",
- "desc" : "The minimum width a column can be resized to. Default is 25.",
- "memberOf" : "Roo.grid.Grid"
- },
- {
- "name" : "monitorWindowResize",
- "type" : "Boolean",
- "desc" : "True to autoSize the grid when the window resizes. Default is true.",
- "memberOf" : "Roo.grid.Grid"
- },
- {
- "name" : "propertyNames",
- "type" : "Object",
- "desc" : "map of property Names to their displayed value",
- "memberOf" : ""
- },
- {
- "name" : "sm",
- "type" : "Roo.grid.AbstractSelectionModel",
- "desc" : "The selection Model (default = Roo.grid.RowSelectionModel)",
- "memberOf" : "Roo.grid.Grid"
- },
- {
- "name" : "stripeRows",
- "type" : "Boolean",
- "desc" : "True to stripe the rows. Default is true.",
- "memberOf" : "Roo.grid.Grid"
- },
- {
- "name" : "toolbar",
- "type" : "Roo.Toolbar",
- "desc" : "a toolbar for buttons etc.",
- "memberOf" : "Roo.grid.Grid"
- },
- {
- "name" : "trackMouseOver",
- "type" : "Boolean",
- "desc" : "True to highlight rows when the mouse is over. Default is true.",
- "memberOf" : "Roo.grid.Grid"
- },
- {
- "name" : "view",
- "type" : "Roo.grid.GridView",
- "desc" : "The view that renders the grid (default = Roo.grid.GridView)",
- "memberOf" : "Roo.grid.Grid"
+ "memberOf" : "Roo.util.Observable",
+ "isOptional" : false,
+ "optvals" : []
}
],
- "events" : [
+ "events" : [],
+ "methods" : [
{
- "name" : "afteredit",
+ "name" : "addEvents",
"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>",
- "sig" : "function (e)\n{\n\n}",
- "memberOf" : "Roo.grid.EditorGrid",
+ "desc" : "Used to define events on this Observable",
+ "sig" : "(object)",
+ "static" : false,
+ "memberOf" : "Roo.util.Observable",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
- "name" : "e",
+ "name" : "object",
"type" : "Object",
- "desc" : "An edit event (see above for description)",
+ "desc" : "The object with the events defined",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "beforeedit",
+ "name" : "addInvalidHandleClass",
"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>",
- "sig" : "function (e)\n{\n\n}",
- "memberOf" : "Roo.grid.EditorGrid",
+ "desc" : "Lets you specify a css class of elements that will not initiate a drag",
+ "sig" : "(cssClass)",
+ "static" : false,
+ "memberOf" : "Roo.dd.DragDrop",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
- "name" : "e",
- "type" : "Object",
- "desc" : "An edit event (see above for description)",
+ "name" : "cssClass",
+ "type" : "string",
+ "desc" : "the class of the elements you wish to ignore",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "beforepropertychange",
+ "name" : "addInvalidHandleId",
"type" : "function",
- "desc" : "Fires before a property changes (return false to stop?)",
- "sig" : "function (grid, id, newval, oldval)\n{\n\n}",
- "memberOf" : "",
+ "desc" : "Lets you to specify an element id for a child of a drag handle\nthat should not initiate a drag",
+ "sig" : "(id)",
+ "static" : false,
+ "memberOf" : "Roo.dd.DragDrop",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
- {
- "name" : "grid",
- "type" : "Roo.grid.PropertyGrid",
- "desc" : "property grid? (check could be store)",
- "isOptional" : false
- },
{
"name" : "id",
- "type" : "String",
- "desc" : "Record Id",
- "isOptional" : false
- },
- {
- "name" : "newval",
- "type" : "String",
- "desc" : "New Value",
- "isOptional" : false
- },
- {
- "name" : "oldval",
- "type" : "String",
- "desc" : "Old Value",
+ "type" : "string",
+ "desc" : "the element id of the element you wish to ignore",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "bodyscroll",
+ "name" : "addInvalidHandleType",
"type" : "function",
- "desc" : "Fires when the body element is scrolled",
- "sig" : "function (scrollLeft, scrollTop)\n{\n\n}",
- "memberOf" : "Roo.grid.Grid",
+ "desc" : "Allows you to specify a tag name that should not start a drag operation\nwhen clicked. This is designed to facilitate embedding links within a\ndrag handle that do something other than start the drag.",
+ "sig" : "(tagName)",
+ "static" : false,
+ "memberOf" : "Roo.dd.DragDrop",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
- "name" : "scrollLeft",
- "type" : "Number",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "scrollTop",
- "type" : "Number",
- "desc" : "",
+ "name" : "tagName",
+ "type" : "string",
+ "desc" : "the type of element to exclude",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "cellclick",
+ "name" : "addListener",
"type" : "function",
- "desc" : "Fires when a cell is clicked",
- "sig" : "function (_self, rowIndex, columnIndex, e)\n{\n\n}",
- "memberOf" : "Roo.grid.Grid",
+ "desc" : "Appends an event handler to this component",
+ "sig" : "(eventName, handler, scope, options)",
+ "static" : false,
+ "memberOf" : "Roo.util.Observable",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
- "name" : "this",
- "type" : "Grid",
- "desc" : "",
+ "name" : "eventName",
+ "type" : "String",
+ "desc" : "The type of event to listen for",
"isOptional" : false
},
{
- "name" : "rowIndex",
- "type" : "Number",
- "desc" : "",
+ "name" : "handler",
+ "type" : "Function",
+ "desc" : "The method the event invokes",
"isOptional" : false
},
{
- "name" : "columnIndex",
- "type" : "Number",
- "desc" : "",
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
"isOptional" : false
},
{
- "name" : "e",
- "type" : "Roo.EventObject",
- "desc" : "",
+ "name" : "options",
+ "type" : "Object",
+ "desc" : "(optional) An object containing handler configuration\nproperties. This may contain any of the following properties:<ul>\n<li>scope {Object} The scope in which to execute the handler function. The handler function's \"this\" context.</li>\n<li>delay {Number} The number of milliseconds to delay the invocation of the handler after te event fires.</li>\n<li>single {Boolean} True to add a handler to handle just the next firing of the event, and then remove itself.</li>\n<li>buffer {Number} Causes the handler to be scheduled to run in an {@link Roo.util.DelayedTask} delayed\nby the specified number of milliseconds. If the event fires again within that time, the original\nhandler is <em>not</em> invoked, but the new handler is scheduled in its place.</li>\n</ul><br>\n<p>\n<b>Combining Options</b><br>\nUsing the options argument, it is possible to combine different types of listeners:<br>\n<br>\nA normalized, delayed, one-time listener that auto stops the event and passes a custom argument (forumId)\n\t\t<pre><code>\n\t\tel.on('click', this.onClick, this, {\n \t\t\tsingle: true,\n \t\tdelay: 100,\n \t\tforumId: 4\n\t\t});\n\t\t</code></pre>\n<p>\n<b>Attaching multiple handlers in 1 call</b><br>\nThe method also allows for a single argument to be passed which is a config object containing properties\nwhich specify multiple handlers.\n<pre><code>\n\t\tel.on({\n\t\t\t'click': {\n \t\tfn: this.onClick,\n \t\tscope: this,\n \t\tdelay: 100\n \t\t}, \n \t\t'mouseover': {\n \t\tfn: this.onMouseOver,\n \t\tscope: this\n \t\t},\n \t\t'mouseout': {\n \t\tfn: this.onMouseOut,\n \t\tscope: this\n \t\t}\n\t\t});\n\t\t</code></pre>\n<p>\nOr a shorthand syntax which passes the same scope object to all handlers:\n \t<pre><code>\n\t\tel.on({\n\t\t\t'click': this.onClick,\n \t\t'mouseover': this.onMouseOver,\n \t\t'mouseout': this.onMouseOut,\n \t\tscope: this\n\t\t});\n\t\t</code></pre>",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "cellcontextmenu",
+ "name" : "addToGroup",
"type" : "function",
- "desc" : "Fires when a cell is right clicked",
- "sig" : "function (_self, rowIndex, cellIndex, e)\n{\n\n}",
- "memberOf" : "Roo.grid.Grid",
+ "desc" : "Add this instance to a group of related drag/drop objects. All\ninstances belong to at least one group, and can belong to as many\ngroups as needed.",
+ "sig" : "(sGroup)",
+ "static" : false,
+ "memberOf" : "Roo.dd.DragDrop",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
- "name" : "this",
- "type" : "Grid",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "rowIndex",
- "type" : "Number",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "cellIndex",
- "type" : "Number",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "e",
- "type" : "Roo.EventObject",
- "desc" : "",
+ "name" : "sGroup",
+ "type" : "",
+ "desc" : "{string} the name of the group",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "celldblclick",
+ "name" : "alignElWithMouse",
"type" : "function",
- "desc" : "Fires when a cell is double clicked",
- "sig" : "function (_self, rowIndex, columnIndex, e)\n{\n\n}",
- "memberOf" : "Roo.grid.Grid",
+ "desc" : "Sets the element to the location of the mousedown or click event,\nmaintaining the cursor location relative to the location on the element\nthat was clicked. Override this if you want to place the element in a\nlocation other than where the cursor is.",
+ "sig" : "(el, iPageX, iPageY)",
+ "static" : false,
+ "memberOf" : "Roo.dd.DD",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
- "name" : "this",
- "type" : "Grid",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "rowIndex",
- "type" : "Number",
- "desc" : "",
+ "name" : "el",
+ "type" : "HTMLElement",
+ "desc" : "the element to move",
"isOptional" : false
},
{
- "name" : "columnIndex",
- "type" : "Number",
- "desc" : "",
+ "name" : "iPageX",
+ "type" : "int",
+ "desc" : "the X coordinate of the mousedown or drag event",
"isOptional" : false
},
{
- "name" : "e",
- "type" : "Roo.EventObject",
- "desc" : "",
+ "name" : "iPageY",
+ "type" : "int",
+ "desc" : "the Y coordinate of the mousedown or drag event",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "click",
+ "name" : "applyConfig",
"type" : "function",
- "desc" : "The raw click event for the entire grid.",
- "sig" : "function (e)\n{\n\n}",
- "memberOf" : "Roo.grid.Grid",
+ "desc" : "Applies the configuration parameters that were passed into the constructor.\nThis is supposed to happen at each level through the inheritance chain. So\na DDProxy implentation will execute apply config on DDProxy, DD, and\nDragDrop in order to get all of the parameters that are available in\neach object.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.dd.DragDrop",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "params" : [
- {
- "name" : "e",
- "type" : "Roo.EventObject",
- "desc" : "",
- "isOptional" : false
- }
- ],
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
"returns" : []
},
{
- "name" : "columnmove",
+ "name" : "autoOffset",
"type" : "function",
- "desc" : "Fires when the user moves a column",
- "sig" : "function (oldIndex, newIndex)\n{\n\n}",
- "memberOf" : "Roo.grid.Grid",
+ "desc" : "Sets the pointer offset to the distance between the linked element's top\nleft corner and the location the element was clicked",
+ "sig" : "(iPageX, iPageY)",
+ "static" : false,
+ "memberOf" : "Roo.dd.DD",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
- "name" : "oldIndex",
- "type" : "Number",
- "desc" : "",
+ "name" : "iPageX",
+ "type" : "int",
+ "desc" : "the X coordinate of the click",
"isOptional" : false
},
{
- "name" : "newIndex",
- "type" : "Number",
- "desc" : "",
+ "name" : "iPageY",
+ "type" : "int",
+ "desc" : "the Y coordinate of the click",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "columnresize",
+ "name" : "cachePosition",
"type" : "function",
- "desc" : "Fires when the user resizes a column",
- "sig" : "function (columnIndex, newSize)\n{\n\n}",
- "memberOf" : "Roo.grid.Grid",
+ "desc" : "Saves the most recent position so that we can reset the constraints and\ntick marks on-demand. We need to know this so that we can calculate the\nnumber of pixels the element is offset from its original position.",
+ "sig" : "(iPageX, iPageY)",
+ "static" : false,
+ "memberOf" : "Roo.dd.DD",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
- "name" : "columnIndex",
- "type" : "Number",
- "desc" : "",
+ "name" : "iPageX",
+ "type" : "",
+ "desc" : "the current x position (optional, this just makes it so we\ndon't have to look it up again)",
"isOptional" : false
},
{
- "name" : "newSize",
- "type" : "Number",
- "desc" : "",
+ "name" : "iPageY",
+ "type" : "",
+ "desc" : "the current y position (optional, this just makes it so we\ndon't have to look it up again)",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "contextmenu",
+ "name" : "capture",
"type" : "function",
- "desc" : "The raw contextmenu event for the entire grid.",
- "sig" : "function (e)\n{\n\n}",
- "memberOf" : "Roo.grid.Grid",
+ "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\n<b>before</b> the event is fired. If the supplied function returns false,\nthe event will not fire.",
+ "sig" : "(o, fn, scope)",
+ "static" : true,
+ "memberOf" : "Roo.util.Observable",
+ "isStatic" : true,
+ "isConstructor" : false,
+ "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
- "name" : "e",
- "type" : "Roo.EventObject",
- "desc" : "",
+ "name" : "o",
+ "type" : "Observable",
+ "desc" : "The Observable to capture",
+ "isOptional" : false
+ },
+ {
+ "name" : "fn",
+ "type" : "Function",
+ "desc" : "The function to call",
+ "isOptional" : false
+ },
+ {
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "(optional) The scope (this object) for the fn",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "dblclick",
+ "name" : "clearConstraints",
"type" : "function",
- "desc" : "The raw dblclick event for the entire grid.",
- "sig" : "function (e)\n{\n\n}",
- "memberOf" : "Roo.grid.Grid",
+ "desc" : "Clears any constraints applied to this instance. Also clears ticks\nsince they can't exist independent of a constraint at this time.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.dd.DragDrop",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "params" : [
- {
- "name" : "e",
- "type" : "Roo.EventObject",
- "desc" : "",
- "isOptional" : false
- }
- ],
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
"returns" : []
},
{
- "name" : "dragdrop",
+ "name" : "clearTicks",
"type" : "function",
- "desc" : "Fires when dragged row(s) are dropped on a valid DD target",
- "sig" : "function (_self, dd, targetId, e)\n{\n\n}",
- "memberOf" : "Roo.grid.Grid",
+ "desc" : "Clears any tick interval defined for this instance",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.dd.DragDrop",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Grid",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "dd",
- "type" : "Roo.GridDD",
- "desc" : "The drag drop object",
- "isOptional" : false
- },
- {
- "name" : "targetId",
- "type" : "String",
- "desc" : "The target drag drop object",
- "isOptional" : false
- },
- {
- "name" : "e",
- "type" : "event",
- "desc" : "The raw browser event",
- "isOptional" : false
- }
- ],
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
"returns" : []
},
{
- "name" : "dragenter",
+ "name" : "createFrame",
"type" : "function",
- "desc" : "Fires when the dragged row(s) first cross another DD target while being dragged",
- "sig" : "function (_self, dd, targetId, e)\n{\n\n}",
- "memberOf" : "Roo.grid.Grid",
+ "desc" : "Creates the proxy element if it does not yet exist",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.dd.DDProxy",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Grid",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "dd",
- "type" : "Roo.GridDD",
- "desc" : "The drag drop object",
- "isOptional" : false
- },
- {
- "name" : "targetId",
- "type" : "String",
- "desc" : "The target drag drop object",
- "isOptional" : false
- },
- {
- "name" : "e",
- "type" : "event",
- "desc" : "The raw browser event",
- "isOptional" : false
- }
- ],
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
"returns" : []
},
{
- "name" : "dragout",
+ "name" : "endDrag",
"type" : "function",
- "desc" : "Fires when the dragged row(s) leave another DD target while being dragged",
- "sig" : "function (_self, dd, targetId, e)\n{\n\n}",
- "memberOf" : "Roo.grid.Grid",
+ "desc" : "Fired when we are done dragging the object",
+ "sig" : "(e)",
+ "static" : false,
+ "memberOf" : "Roo.dd.DragDrop",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
- {
- "name" : "this",
- "type" : "Grid",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "dd",
- "type" : "Roo.GridDD",
- "desc" : "The drag drop object",
- "isOptional" : false
- },
- {
- "name" : "targetId",
- "type" : "String",
- "desc" : "The target drag drop object",
- "isOptional" : false
- },
{
"name" : "e",
- "type" : "event",
- "desc" : "The raw browser event",
+ "type" : "Event",
+ "desc" : "the mouseup event",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "dragover",
+ "name" : "fireEvent",
"type" : "function",
- "desc" : "Fires while row(s) are being dragged. \"targetId\" is the id of the Yahoo.util.DD object the selected rows are being dragged over.",
- "sig" : "function (_self, dd, targetId, e)\n{\n\n}",
- "memberOf" : "Roo.grid.Grid",
+ "desc" : "Fires the specified event with the passed parameters (minus the event name).",
+ "sig" : "(eventName, args)",
+ "static" : false,
+ "memberOf" : "Roo.util.Observable",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
- "name" : "this",
- "type" : "Grid",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "dd",
- "type" : "Roo.GridDD",
- "desc" : "The drag drop object",
- "isOptional" : false
- },
- {
- "name" : "targetId",
+ "name" : "eventName",
"type" : "String",
- "desc" : "The target drag drop object",
+ "desc" : "",
"isOptional" : false
},
{
- "name" : "e",
- "type" : "event",
- "desc" : "The raw browser event",
+ "name" : "args",
+ "type" : "Object...",
+ "desc" : "Variable number of parameters are passed to handlers",
"isOptional" : false
}
],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Boolean",
+ "desc" : "returns false if any of the handlers return false otherwise it returns true"
+ }
+ ]
},
{
- "name" : "enddrag",
+ "name" : "getDragEl",
"type" : "function",
- "desc" : "Fires when a drag operation is complete",
- "sig" : "function (_self, dd, e)\n{\n\n}",
- "memberOf" : "Roo.grid.Grid",
+ "desc" : "Returns a reference to the actual element to drag. By default this is\nthe same as the html element, but it can be assigned to another\nelement. An example of this can be found in Roo.dd.DDProxy",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.dd.DragDrop",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Grid",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "dd",
- "type" : "Roo.GridDD",
- "desc" : "The drag drop object",
- "isOptional" : false
- },
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : [
{
- "name" : "e",
- "type" : "event",
- "desc" : "The raw browser event",
- "isOptional" : false
+ "name" : "",
+ "type" : "HTMLElement",
+ "desc" : "the html element"
}
- ],
- "returns" : []
+ ]
},
{
- "name" : "headerclick",
+ "name" : "getEl",
"type" : "function",
- "desc" : "Fires when a header is clicked",
- "sig" : "function (_self, columnIndex, e)\n{\n\n}",
- "memberOf" : "Roo.grid.Grid",
+ "desc" : "Returns a reference to the linked element",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.dd.DragDrop",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Grid",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "columnIndex",
- "type" : "Number",
- "desc" : "",
- "isOptional" : false
- },
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : [
{
- "name" : "e",
- "type" : "Roo.EventObject",
- "desc" : "",
- "isOptional" : false
+ "name" : "",
+ "type" : "HTMLElement",
+ "desc" : "the html element"
}
- ],
- "returns" : []
+ ]
},
{
- "name" : "headercontextmenu",
+ "name" : "hasListener",
"type" : "function",
- "desc" : "Fires when a header is right clicked",
- "sig" : "function (_self, columnIndex, e)\n{\n\n}",
- "memberOf" : "Roo.grid.Grid",
+ "desc" : "Checks to see if this object has any listeners for a specified event",
+ "sig" : "(eventName)",
+ "static" : false,
+ "memberOf" : "Roo.util.Observable",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
- "name" : "this",
- "type" : "Grid",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "columnIndex",
- "type" : "Number",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "e",
- "type" : "Roo.EventObject",
- "desc" : "",
+ "name" : "eventName",
+ "type" : "String",
+ "desc" : "The name of the event to check for",
"isOptional" : false
}
],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Boolean",
+ "desc" : "True if the event is being listened for, else false"
+ }
+ ]
},
{
- "name" : "headerdblclick",
+ "name" : "init",
"type" : "function",
- "desc" : "Fires when a header cell is double clicked",
- "sig" : "function (_self, columnIndex, e)\n{\n\n}",
- "memberOf" : "Roo.grid.Grid",
+ "desc" : "Sets up the DragDrop object. Must be called in the constructor of any\nRoo.dd.DragDrop subclass",
+ "sig" : "(id, sGroup, config)",
+ "static" : false,
+ "memberOf" : "Roo.dd.DragDrop",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
- "name" : "this",
- "type" : "Grid",
- "desc" : "",
+ "name" : "id",
+ "type" : "",
+ "desc" : "the id of the linked element",
"isOptional" : false
},
{
- "name" : "columnIndex",
- "type" : "Number",
- "desc" : "",
+ "name" : "sGroup",
+ "type" : "String",
+ "desc" : "the group of related items",
"isOptional" : false
},
{
- "name" : "e",
- "type" : "Roo.EventObject",
- "desc" : "",
+ "name" : "config",
+ "type" : "object",
+ "desc" : "configuration attributes",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "keydown",
+ "name" : "initFrame",
"type" : "function",
- "desc" : "The raw keydown event for the entire grid.",
- "sig" : "function (e)\n{\n\n}",
- "memberOf" : "Roo.grid.Grid",
+ "desc" : "Initialization for the drag frame element. Must be called in the\nconstructor of all subclasses",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.dd.DDProxy",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "params" : [
- {
- "name" : "e",
- "type" : "Roo.EventObject",
- "desc" : "",
- "isOptional" : false
- }
- ],
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
"returns" : []
},
{
- "name" : "keypress",
+ "name" : "initTarget",
"type" : "function",
- "desc" : "The raw keypress event for the entire grid.",
- "sig" : "function (e)\n{\n\n}",
- "memberOf" : "Roo.grid.Grid",
+ "desc" : "Initializes Targeting functionality only... the object does not\nget a mousedown handler.",
+ "sig" : "(id, sGroup, config)",
+ "static" : false,
+ "memberOf" : "Roo.dd.DragDrop",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
- "name" : "e",
- "type" : "Roo.EventObject",
- "desc" : "",
+ "name" : "id",
+ "type" : "",
+ "desc" : "the id of the linked element",
+ "isOptional" : false
+ },
+ {
+ "name" : "sGroup",
+ "type" : "String",
+ "desc" : "the group of related items",
+ "isOptional" : false
+ },
+ {
+ "name" : "config",
+ "type" : "object",
+ "desc" : "configuration attributes",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "mousedown",
+ "name" : "isLocked",
"type" : "function",
- "desc" : "The raw mousedown event for the entire grid.",
- "sig" : "function (e)\n{\n\n}",
- "memberOf" : "Roo.grid.Grid",
+ "desc" : "Returns true if this instance is locked, or the drag drop mgr is locked\n(meaning that all drag/drop is disabled on the page.)",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.dd.DragDrop",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "params" : [
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : [
{
- "name" : "e",
- "type" : "Roo.EventObject",
- "desc" : "",
- "isOptional" : false
+ "name" : "",
+ "type" : "boolean",
+ "desc" : "true if this obj or all drag/drop is locked, else\nfalse"
}
- ],
- "returns" : []
+ ]
},
{
- "name" : "mouseout",
+ "name" : "isTarget",
"type" : "function",
- "desc" : "The raw mouseout event for the entire grid.",
- "sig" : "function (e)\n{\n\n}",
- "memberOf" : "Roo.grid.Grid",
+ "desc" : "By default, all insances can be a drop target. This can be disabled by\nsetting isTarget to false.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.dd.DragDrop",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "params" : [
- {
- "name" : "e",
- "type" : "Roo.EventObject",
- "desc" : "",
- "isOptional" : false
- }
- ],
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
"returns" : []
},
{
- "name" : "mouseover",
+ "name" : "isValidHandleChild",
"type" : "function",
- "desc" : "The raw mouseover event for the entire grid.",
- "sig" : "function (e)\n{\n\n}",
- "memberOf" : "Roo.grid.Grid",
+ "desc" : "Checks the tag exclusion list to see if this click should be ignored",
+ "sig" : "(node)",
+ "static" : false,
+ "memberOf" : "Roo.dd.DragDrop",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
- "name" : "e",
- "type" : "Roo.EventObject",
- "desc" : "",
+ "name" : "node",
+ "type" : "HTMLElement",
+ "desc" : "the HTMLElement to evaluate",
"isOptional" : false
}
],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "boolean",
+ "desc" : "true if this is a valid tag type, false if not"
+ }
+ ]
},
{
- "name" : "mouseup",
+ "name" : "lock",
"type" : "function",
- "desc" : "The raw mouseup event for the entire grid.",
- "sig" : "function (e)\n{\n\n}",
- "memberOf" : "Roo.grid.Grid",
+ "desc" : "Lock this instance",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.dd.DragDrop",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "params" : [
- {
- "name" : "e",
- "type" : "Roo.EventObject",
- "desc" : "",
- "isOptional" : false
- }
- ],
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
"returns" : []
},
{
- "name" : "propertychange",
+ "name" : "on",
"type" : "function",
- "desc" : "Fires after a property changes",
- "sig" : "function (grid, id, newval, oldval)\n{\n\n}",
- "memberOf" : "",
+ "desc" : "Appends an event handler to this element (shorthand for addListener)",
+ "sig" : "(eventName, handler, scope, options)",
+ "static" : false,
+ "memberOf" : "Roo.util.Observable",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
- "name" : "grid",
- "type" : "Roo.grid.PropertyGrid",
- "desc" : "property grid? (check could be store)",
+ "name" : "eventName",
+ "type" : "String",
+ "desc" : "The type of event to listen for",
"isOptional" : false
},
{
- "name" : "id",
- "type" : "String",
- "desc" : "Record Id",
+ "name" : "handler",
+ "type" : "Function",
+ "desc" : "The method the event invokes",
"isOptional" : false
},
{
- "name" : "newval",
- "type" : "String",
- "desc" : "New Value",
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
"isOptional" : false
},
{
- "name" : "oldval",
- "type" : "String",
- "desc" : "Old Value",
+ "name" : "options",
+ "type" : "Object",
+ "desc" : "(optional)",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "render",
+ "name" : "onAvailable",
"type" : "function",
- "desc" : "Fires when the grid is rendered",
- "sig" : "function (grid)\n{\n\n}",
- "memberOf" : "Roo.grid.Grid",
+ "desc" : "Override the onAvailable method to do what is needed after the initial\nposition was determined.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.dd.DragDrop",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "params" : [
- {
- "name" : "grid",
- "type" : "Grid",
- "desc" : "",
- "isOptional" : false
- }
- ],
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
"returns" : []
},
{
- "name" : "rowclass",
+ "name" : "onDrag",
"type" : "function",
- "desc" : "Fires when a row is rendered, so you can change add a style to it.",
- "sig" : "function (gridview, rowcfg)\n{\n\n}",
- "memberOf" : "Roo.grid.Grid",
+ "desc" : "Abstract method called during the onMouseMove event while dragging an\nobject.",
+ "sig" : "(e)",
+ "static" : false,
+ "memberOf" : "Roo.dd.DragDrop",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
- "name" : "gridview",
- "type" : "GridView",
- "desc" : "The grid view",
- "isOptional" : false
- },
- {
- "name" : "rowcfg",
- "type" : "Object",
- "desc" : "contains record rowIndex and rowClass - set rowClass to add a style.",
+ "name" : "e",
+ "type" : "Event",
+ "desc" : "the mousemove event",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "rowclick",
+ "name" : "onDragDrop",
"type" : "function",
- "desc" : "Fires when a row is clicked",
- "sig" : "function (_self, rowIndex, e)\n{\n\n}",
- "memberOf" : "Roo.grid.Grid",
+ "desc" : "Abstract method called when this item is dropped on another DragDrop\nobj",
+ "sig" : "(e, id)",
+ "static" : false,
+ "memberOf" : "Roo.dd.DragDrop",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
- "name" : "this",
- "type" : "Grid",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "rowIndex",
- "type" : "Number",
- "desc" : "",
+ "name" : "e",
+ "type" : "Event",
+ "desc" : "the mouseup event",
"isOptional" : false
},
{
- "name" : "e",
- "type" : "Roo.EventObject",
- "desc" : "",
+ "name" : "id",
+ "type" : "String|DragDrop[]",
+ "desc" : "In POINT mode, the element\nid this was dropped on. In INTERSECT mode, an array of dd items this\nwas dropped on.",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "rowcontextmenu",
+ "name" : "onDragEnter",
"type" : "function",
- "desc" : "Fires when a row is right clicked",
- "sig" : "function (_self, rowIndex, e)\n{\n\n}",
- "memberOf" : "Roo.grid.Grid",
+ "desc" : "Abstract method called when this element fist begins hovering over\nanother DragDrop obj",
+ "sig" : "(e, id)",
+ "static" : false,
+ "memberOf" : "Roo.dd.DragDrop",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
- "name" : "this",
- "type" : "Grid",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "rowIndex",
- "type" : "Number",
- "desc" : "",
+ "name" : "e",
+ "type" : "Event",
+ "desc" : "the mousemove event",
"isOptional" : false
},
{
- "name" : "e",
- "type" : "Roo.EventObject",
- "desc" : "",
+ "name" : "id",
+ "type" : "String|DragDrop[]",
+ "desc" : "In POINT mode, the element\nid this is hovering over. In INTERSECT mode, an array of one or more\ndragdrop items being hovered over.",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "rowdblclick",
+ "name" : "onDragOut",
"type" : "function",
- "desc" : "Fires when a row is double clicked",
- "sig" : "function (_self, rowIndex, e)\n{\n\n}",
- "memberOf" : "Roo.grid.Grid",
+ "desc" : "Abstract method called when we are no longer hovering over an element",
+ "sig" : "(e, id)",
+ "static" : false,
+ "memberOf" : "Roo.dd.DragDrop",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
- "name" : "this",
- "type" : "Grid",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "rowIndex",
- "type" : "Number",
- "desc" : "",
+ "name" : "e",
+ "type" : "Event",
+ "desc" : "the mousemove event",
"isOptional" : false
},
{
- "name" : "e",
- "type" : "Roo.EventObject",
- "desc" : "",
+ "name" : "id",
+ "type" : "String|DragDrop[]",
+ "desc" : "In POINT mode, the element\nid this was hovering over. In INTERSECT mode, an array of dd items\nthat the mouse is no longer over.",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "startdrag",
+ "name" : "onDragOver",
"type" : "function",
- "desc" : "Fires when row(s) start being dragged",
- "sig" : "function (_self, dd, e)\n{\n\n}",
- "memberOf" : "Roo.grid.Grid",
+ "desc" : "Abstract method called when this element is hovering over another\nDragDrop obj",
+ "sig" : "(e, id)",
+ "static" : false,
+ "memberOf" : "Roo.dd.DragDrop",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
- {
- "name" : "this",
- "type" : "Grid",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "dd",
- "type" : "Roo.GridDD",
- "desc" : "The drag drop object",
- "isOptional" : false
- },
{
"name" : "e",
- "type" : "event",
- "desc" : "The raw browser event",
+ "type" : "Event",
+ "desc" : "the mousemove event",
+ "isOptional" : false
+ },
+ {
+ "name" : "id",
+ "type" : "String|DragDrop[]",
+ "desc" : "In POINT mode, the element\nid this is hovering over. In INTERSECT mode, an array of dd items\nbeing hovered over.",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "validateedit",
+ "name" : "onInvalidDrop",
"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>",
- "sig" : "function (e)\n{\n\n}",
- "memberOf" : "Roo.grid.EditorGrid",
+ "desc" : "Abstract method called when this item is dropped on an area with no\ndrop target",
+ "sig" : "(e)",
+ "static" : false,
+ "memberOf" : "Roo.dd.DragDrop",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
"name" : "e",
- "type" : "Object",
- "desc" : "An edit event (see above for description)",
+ "type" : "Event",
+ "desc" : "the mouseup event",
"isOptional" : false
}
],
"returns" : []
- }
- ],
- "methods" : [
+ },
{
- "name" : "addColumns",
+ "name" : "onMouseDown",
"type" : "function",
- "desc" : "addColumns\nAdd's a column, default at the end..",
- "sig" : "(position, of)",
+ "desc" : "Event handler that fires when a drag/drop obj gets a mousedown",
+ "sig" : "(e)",
"static" : false,
- "memberOf" : "Roo.grid.Grid",
+ "memberOf" : "Roo.dd.DragDrop",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "position",
- "type" : "int",
- "desc" : "to add (default end)",
- "isOptional" : false
- },
- {
- "name" : "of",
- "type" : "Array",
- "desc" : "objects of column configuration see {@link Roo.grid.ColumnModel}",
+ "name" : "e",
+ "type" : "Event",
+ "desc" : "the mousedown event",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "addEvents",
+ "name" : "onMouseUp",
"type" : "function",
- "desc" : "Used to define events on this Observable",
- "sig" : "(object)",
+ "desc" : "Event handler that fires when a drag/drop obj gets a mouseup",
+ "sig" : "(e)",
"static" : false,
- "memberOf" : "Roo.util.Observable",
+ "memberOf" : "Roo.dd.DragDrop",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "object",
- "type" : "Object",
- "desc" : "The object with the events defined",
+ "name" : "e",
+ "type" : "Event",
+ "desc" : "the mouseup event",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "addListener",
+ "name" : "padding",
"type" : "function",
- "desc" : "Appends an event handler to this component",
- "sig" : "(eventName, handler, scope, options)",
+ "desc" : "The padding configured for this drag and drop object for calculating\nthe drop zone intersection with this object.",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.util.Observable",
+ "memberOf" : "Roo.dd.DragDrop",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "eventName",
- "type" : "String",
- "desc" : "The type of event to listen for",
- "isOptional" : false
- },
- {
- "name" : "handler",
- "type" : "Function",
- "desc" : "The method the event invokes",
- "isOptional" : false
- },
- {
- "name" : "scope",
- "type" : "Object",
- "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
- "isOptional" : false
- },
- {
- "name" : "options",
- "type" : "Object",
- "desc" : "(optional) An object containing handler configuration\nproperties. This may contain any of the following properties:<ul>\n<li>scope {Object} The scope in which to execute the handler function. The handler function's \"this\" context.</li>\n<li>delay {Number} The number of milliseconds to delay the invocation of the handler after te event fires.</li>\n<li>single {Boolean} True to add a handler to handle just the next firing of the event, and then remove itself.</li>\n<li>buffer {Number} Causes the handler to be scheduled to run in an {@link Roo.util.DelayedTask} delayed\nby the specified number of milliseconds. If the event fires again within that time, the original\nhandler is <em>not</em> invoked, but the new handler is scheduled in its place.</li>\n</ul><br>\n<p>\n<b>Combining Options</b><br>\nUsing the options argument, it is possible to combine different types of listeners:<br>\n<br>\nA normalized, delayed, one-time listener that auto stops the event and passes a custom argument (forumId)\n\t\t<pre><code>\n\t\tel.on('click', this.onClick, this, {\n \t\t\tsingle: true,\n \t\tdelay: 100,\n \t\tforumId: 4\n\t\t});\n\t\t</code></pre>\n<p>\n<b>Attaching multiple handlers in 1 call</b><br>\nThe method also allows for a single argument to be passed which is a config object containing properties\nwhich specify multiple handlers.\n<pre><code>\n\t\tel.on({\n\t\t\t'click': {\n \t\tfn: this.onClick,\n \t\tscope: this,\n \t\tdelay: 100\n \t\t}, \n \t\t'mouseover': {\n \t\tfn: this.onMouseOver,\n \t\tscope: this\n \t\t},\n \t\t'mouseout': {\n \t\tfn: this.onMouseOut,\n \t\tscope: this\n \t\t}\n\t\t});\n\t\t</code></pre>\n<p>\nOr a shorthand syntax which passes the same scope object to all handlers:\n \t<pre><code>\n\t\tel.on({\n\t\t\t'click': this.onClick,\n \t\t'mouseover': this.onMouseOver,\n \t\t'mouseout': this.onMouseOut,\n \t\tscope: this\n\t\t});\n\t\t</code></pre>",
- "isOptional" : false
- }
- ],
+ "params" : [],
"returns" : []
},
{
- "name" : "autoSize",
+ "name" : "purgeListeners",
"type" : "function",
- "desc" : "Causes the grid to manually recalculate its dimensions. Generally this is done automatically,\nbut if manual update is required this method will initiate it.",
+ "desc" : "Removes all listeners for this object",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.grid.Grid",
+ "memberOf" : "Roo.util.Observable",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"returns" : []
},
{
- "name" : "capture",
+ "name" : "releaseCapture",
"type" : "function",
- "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\n<b>before</b> the event is fired. If the supplied function returns false,\nthe event will not fire.",
- "sig" : "(o, fn, scope)",
+ "desc" : "Removes <b>all</b> added captures from the Observable.",
+ "sig" : "(o)",
"static" : true,
"memberOf" : "Roo.util.Observable",
"isStatic" : true,
{
"name" : "o",
"type" : "Observable",
- "desc" : "The Observable to capture",
- "isOptional" : false
- },
- {
- "name" : "fn",
- "type" : "Function",
- "desc" : "The function to call",
- "isOptional" : false
- },
- {
- "name" : "scope",
- "type" : "Object",
- "desc" : "(optional) The scope (this object) for the fn",
+ "desc" : "The Observable to release",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "destroy",
+ "name" : "removeFromGroup",
"type" : "function",
- "desc" : "Destroy this grid.",
- "sig" : "(removeEl)",
+ "desc" : "Remove's this instance from the supplied interaction group",
+ "sig" : "(sGroup)",
"static" : false,
- "memberOf" : "Roo.grid.Grid",
+ "memberOf" : "Roo.dd.DragDrop",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "removeEl",
- "type" : "Boolean",
- "desc" : "True to remove the element",
+ "name" : "sGroup",
+ "type" : "string",
+ "desc" : "The group to drop",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "fireEvent",
+ "name" : "removeInvalidHandleClass",
"type" : "function",
- "desc" : "Fires the specified event with the passed parameters (minus the event name).",
- "sig" : "(eventName, args)",
+ "desc" : "Unsets an invalid css class",
+ "sig" : "(cssClass)",
"static" : false,
- "memberOf" : "Roo.util.Observable",
+ "memberOf" : "Roo.dd.DragDrop",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "eventName",
- "type" : "String",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "args",
- "type" : "Object...",
- "desc" : "Variable number of parameters are passed to handlers",
+ "name" : "cssClass",
+ "type" : "string",
+ "desc" : "the class of the element(s) you wish to\nre-enable",
"isOptional" : false
}
],
- "returns" : [
- {
- "name" : "",
- "type" : "Boolean",
- "desc" : "returns false if any of the handlers return false otherwise it returns true"
- }
- ]
+ "returns" : []
},
{
- "name" : "getColumnModel",
+ "name" : "removeInvalidHandleId",
"type" : "function",
- "desc" : "Returns the grid's ColumnModel.",
- "sig" : "()\n{\n\n}",
+ "desc" : "Unsets an invalid handle id",
+ "sig" : "(id)",
"static" : false,
- "memberOf" : "Roo.grid.Grid",
+ "memberOf" : "Roo.dd.DragDrop",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
- "returns" : [
+ "params" : [
{
- "name" : "",
- "type" : "ColumnModel",
- "desc" : ""
+ "name" : "id",
+ "type" : "string",
+ "desc" : "the id of the element to re-enable",
+ "isOptional" : false
}
- ]
+ ],
+ "returns" : []
},
{
- "name" : "getDataSource",
+ "name" : "removeInvalidHandleType",
"type" : "function",
- "desc" : "Returns the grid's DataSource.",
- "sig" : "()\n{\n\n}",
+ "desc" : "Unsets an excluded tag name set by addInvalidHandleType",
+ "sig" : "(tagName)",
"static" : false,
- "memberOf" : "Roo.grid.Grid",
+ "memberOf" : "Roo.dd.DragDrop",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
- "returns" : [
+ "params" : [
{
- "name" : "",
- "type" : "DataSource",
- "desc" : ""
+ "name" : "tagName",
+ "type" : "string",
+ "desc" : "the type of element to unexclude",
+ "isOptional" : false
}
- ]
+ ],
+ "returns" : []
},
{
- "name" : "getDragDropText",
+ "name" : "removeListener",
"type" : "function",
- "desc" : "Called to get grid's drag proxy text, by default returns this.ddText.",
- "sig" : "()\n{\n\n}",
+ "desc" : "Removes a listener",
+ "sig" : "(eventName, handler, scope)",
"static" : false,
- "memberOf" : "Roo.grid.EditorGrid",
+ "memberOf" : "Roo.util.Observable",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
- "returns" : [
+ "params" : [
{
- "name" : "",
+ "name" : "eventName",
"type" : "String",
- "desc" : ""
+ "desc" : "The type of event to listen for",
+ "isOptional" : false
+ },
+ {
+ "name" : "handler",
+ "type" : "Function",
+ "desc" : "The handler to remove",
+ "isOptional" : false
+ },
+ {
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "(optional) The scope (this object) for the handler",
+ "isOptional" : false
}
- ]
+ ],
+ "returns" : []
},
{
- "name" : "getGridEl",
+ "name" : "resetConstraints",
"type" : "function",
- "desc" : "Returns the grid's underlying element.",
- "sig" : "()\n{\n\n}",
+ "desc" : "resetConstraints must be called if you manually reposition a dd element.",
+ "sig" : "(maintainOffset)",
"static" : false,
- "memberOf" : "Roo.grid.Grid",
+ "memberOf" : "Roo.dd.DragDrop",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
- "returns" : [
+ "params" : [
{
- "name" : "",
- "type" : "Element",
- "desc" : "The element"
+ "name" : "maintainOffset",
+ "type" : "boolean",
+ "desc" : "",
+ "isOptional" : false
}
- ]
+ ],
+ "returns" : []
},
{
- "name" : "getSelectionModel",
+ "name" : "setDelta",
"type" : "function",
- "desc" : "Returns the grid's SelectionModel.",
- "sig" : "()\n{\n\n}",
+ "desc" : "Sets the pointer offset. You can call this directly to force the\noffset to be in a particular location (e.g., pass in 0,0 to set it\nto the center of the object)",
+ "sig" : "(iDeltaX, iDeltaY)",
"static" : false,
- "memberOf" : "Roo.grid.Grid",
+ "memberOf" : "Roo.dd.DD",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
- "returns" : [
+ "params" : [
{
- "name" : "",
- "type" : "SelectionModel",
- "desc" : ""
+ "name" : "iDeltaX",
+ "type" : "int",
+ "desc" : "the distance from the left",
+ "isOptional" : false
+ },
+ {
+ "name" : "iDeltaY",
+ "type" : "int",
+ "desc" : "the distance from the top",
+ "isOptional" : false
}
- ]
+ ],
+ "returns" : []
},
{
- "name" : "getSource",
+ "name" : "setDragElId",
"type" : "function",
- "desc" : "Gets all the data from the grid.",
- "sig" : "()\n{\n\n}",
+ "desc" : "Allows you to specify that an element other than the linked element\nwill be moved with the cursor during a drag",
+ "sig" : "(id)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.dd.DragDrop",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
- "returns" : [
+ "params" : [
{
- "name" : "",
- "type" : "Object",
- "desc" : "data data stored in grid"
+ "name" : "id",
+ "type" : "",
+ "desc" : "{string} the id of the element that will be used to initiate the drag",
+ "isOptional" : false
}
- ]
+ ],
+ "returns" : []
},
{
- "name" : "getView",
+ "name" : "setDragElPos",
"type" : "function",
- "desc" : "Returns the grid's GridView object.",
- "sig" : "()\n{\n\n}",
+ "desc" : "Sets the drag element to the location of the mousedown or click event,\nmaintaining the cursor location relative to the location on the element\nthat was clicked. Override this if you want to place the element in a\nlocation other than where the cursor is.",
+ "sig" : "(iPageX, iPageY)",
"static" : false,
- "memberOf" : "Roo.grid.Grid",
+ "memberOf" : "Roo.dd.DD",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
- "returns" : [
+ "params" : [
{
- "name" : "",
- "type" : "GridView",
- "desc" : ""
+ "name" : "iPageX",
+ "type" : "int",
+ "desc" : "the X coordinate of the mousedown or drag event",
+ "isOptional" : false
+ },
+ {
+ "name" : "iPageY",
+ "type" : "int",
+ "desc" : "the Y coordinate of the mousedown or drag event",
+ "isOptional" : false
}
- ]
+ ],
+ "returns" : []
},
{
- "name" : "hasListener",
+ "name" : "setHandleElId",
"type" : "function",
- "desc" : "Checks to see if this object has any listeners for a specified event",
- "sig" : "(eventName)",
+ "desc" : "Allows you to specify a child of the linked element that should be\nused to initiate the drag operation. An example of this would be if\nyou have a content div with text and links. Clicking anywhere in the\ncontent area would normally start the drag operation. Use this method\nto specify that an element inside of the content div is the element\nthat starts the drag operation.",
+ "sig" : "(id)",
"static" : false,
- "memberOf" : "Roo.util.Observable",
+ "memberOf" : "Roo.dd.DragDrop",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "eventName",
- "type" : "String",
- "desc" : "The name of the event to check for",
+ "name" : "id",
+ "type" : "",
+ "desc" : "{string} the id of the element that will be used to\ninitiate the drag.",
"isOptional" : false
}
],
- "returns" : [
- {
- "name" : "",
- "type" : "Boolean",
- "desc" : "True if the event is being listened for, else false"
- }
- ]
+ "returns" : []
},
{
- "name" : "on",
+ "name" : "setInitPosition",
"type" : "function",
- "desc" : "Appends an event handler to this element (shorthand for addListener)",
- "sig" : "(eventName, handler, scope, options)",
+ "desc" : "Stores the initial placement of the linked element.",
+ "sig" : "(diffX, diffY)",
"static" : false,
- "memberOf" : "Roo.util.Observable",
+ "memberOf" : "Roo.dd.DragDrop",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "eventName",
- "type" : "String",
- "desc" : "The type of event to listen for",
- "isOptional" : false
- },
- {
- "name" : "handler",
- "type" : "Function",
- "desc" : "The method the event invokes",
- "isOptional" : false
- },
- {
- "name" : "scope",
- "type" : "Object",
- "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
+ "name" : "diffX",
+ "type" : "int",
+ "desc" : "the X offset, default 0",
"isOptional" : false
},
{
- "name" : "options",
- "type" : "Object",
- "desc" : "(optional)",
+ "name" : "diffY",
+ "type" : "int",
+ "desc" : "the Y offset, default 0",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "purgeListeners",
+ "name" : "setOuterHandleElId",
"type" : "function",
- "desc" : "Removes all listeners for this object",
- "sig" : "()\n{\n\n}",
+ "desc" : "Allows you to set an element outside of the linked element as a drag\nhandle",
+ "sig" : "(id)",
"static" : false,
- "memberOf" : "Roo.util.Observable",
+ "memberOf" : "Roo.dd.DragDrop",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
+ "params" : [
+ {
+ "name" : "id",
+ "type" : "",
+ "desc" : "the id of the element that will be used to initiate the drag",
+ "isOptional" : false
+ }
+ ],
"returns" : []
},
{
- "name" : "reconfigure",
+ "name" : "setPadding",
"type" : "function",
- "desc" : "Reconfigures the grid to use a different Store and Column Model.\nThe View will be bound to the new objects and refreshed.",
- "sig" : "(dataSource, The)",
+ "desc" : "Configures the padding for the target zone in px. Effectively expands\n(or reduces) the virtual object size for targeting calculations.\nSupports css-style shorthand; if only one parameter is passed, all sides\nwill have that padding, and if only two are passed, the top and bottom\nwill have the first param, the left and right the second.",
+ "sig" : "(iTop, iRight, iBot, iLeft)",
"static" : false,
- "memberOf" : "Roo.grid.Grid",
+ "memberOf" : "Roo.dd.DragDrop",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "dataSource",
- "type" : "Roo.data.Store",
- "desc" : "The new {@link Roo.data.Store} object",
+ "name" : "iTop",
+ "type" : "int",
+ "desc" : "Top pad",
"isOptional" : false
},
{
- "name" : "The",
- "type" : "Roo.grid.ColumnModel",
- "desc" : "new {@link Roo.grid.ColumnModel} object",
+ "name" : "iRight",
+ "type" : "int",
+ "desc" : "Right pad",
+ "isOptional" : false
+ },
+ {
+ "name" : "iBot",
+ "type" : "int",
+ "desc" : "Bot pad",
+ "isOptional" : false
+ },
+ {
+ "name" : "iLeft",
+ "type" : "int",
+ "desc" : "Left pad",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "releaseCapture",
+ "name" : "setXConstraint",
"type" : "function",
- "desc" : "Removes <b>all</b> added captures from the Observable.",
- "sig" : "(o)",
- "static" : true,
- "memberOf" : "Roo.util.Observable",
- "isStatic" : true,
+ "desc" : "By default, the element can be dragged any place on the screen. Use\nthis method to limit the horizontal travel of the element. Pass in\n0,0 for the parameters if you want to lock the drag to the y axis.",
+ "sig" : "(iLeft, iRight, iTickSize)",
+ "static" : false,
+ "memberOf" : "Roo.dd.DragDrop",
+ "isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"example" : "",
"requires" : "",
"params" : [
{
- "name" : "o",
- "type" : "Observable",
- "desc" : "The Observable to release",
+ "name" : "iLeft",
+ "type" : "int",
+ "desc" : "the number of pixels the element can move to the left",
+ "isOptional" : false
+ },
+ {
+ "name" : "iRight",
+ "type" : "int",
+ "desc" : "the number of pixels the element can move to the\nright",
+ "isOptional" : false
+ },
+ {
+ "name" : "iTickSize",
+ "type" : "int",
+ "desc" : "optional parameter for specifying that the\nelement\nshould move iTickSize pixels at a time.",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "removeListener",
+ "name" : "setYConstraint",
"type" : "function",
- "desc" : "Removes a listener",
- "sig" : "(eventName, handler, scope)",
+ "desc" : "By default, the element can be dragged any place on the screen. Set\nthis to limit the vertical travel of the element. Pass in 0,0 for the\nparameters if you want to lock the drag to the x axis.",
+ "sig" : "(iUp, iDown, iTickSize)",
"static" : false,
- "memberOf" : "Roo.util.Observable",
+ "memberOf" : "Roo.dd.DragDrop",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "eventName",
- "type" : "String",
- "desc" : "The type of event to listen for",
+ "name" : "iUp",
+ "type" : "int",
+ "desc" : "the number of pixels the element can move up",
"isOptional" : false
},
{
- "name" : "handler",
- "type" : "Function",
- "desc" : "The handler to remove",
+ "name" : "iDown",
+ "type" : "int",
+ "desc" : "the number of pixels the element can move down",
"isOptional" : false
},
{
- "name" : "scope",
- "type" : "Object",
- "desc" : "(optional) The scope (this object) for the handler",
+ "name" : "iTickSize",
+ "type" : "int",
+ "desc" : "optional parameter for specifying that the\nelement should move iTickSize pixels at a time.",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "render",
+ "name" : "startDrag",
"type" : "function",
- "desc" : "Called once after all setup has been completed and the grid is ready to be rendered.",
- "sig" : "()\n{\n\n}",
+ "desc" : "Abstract method called after a drag/drop object is clicked\nand the drag or mousedown time thresholds have beeen met.",
+ "sig" : "(X, Y)",
"static" : false,
- "memberOf" : "Roo.grid.Grid",
+ "memberOf" : "Roo.dd.DragDrop",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
- "returns" : [
+ "params" : [
{
- "name" : "",
- "type" : "Roo.grid.Grid",
- "desc" : "this"
+ "name" : "X",
+ "type" : "int",
+ "desc" : "click location",
+ "isOptional" : false
+ },
+ {
+ "name" : "Y",
+ "type" : "int",
+ "desc" : "click location",
+ "isOptional" : false
}
- ]
+ ],
+ "returns" : []
},
{
- "name" : "setSource",
+ "name" : "toString",
"type" : "function",
- "desc" : "Sets the data for the Grid\naccepts a Key => Value object of all the elements avaiable.",
- "sig" : "(data)",
+ "desc" : "toString method",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.dd.DragDrop",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
+ "params" : [],
+ "returns" : [
{
- "name" : "data",
- "type" : "Object",
- "desc" : "to appear in grid.",
- "isOptional" : false
+ "name" : "",
+ "type" : "string",
+ "desc" : "string representation of the dd obj"
}
- ],
- "returns" : []
+ ]
},
{
- "name" : "startEditing",
+ "name" : "un",
"type" : "function",
- "desc" : "Starts editing the specified for the specified row/column",
- "sig" : "(rowIndex, colIndex)",
+ "desc" : "Removes a listener (shorthand for removeListener)",
+ "sig" : "(eventName, handler, scope)",
"static" : false,
- "memberOf" : "Roo.grid.EditorGrid",
+ "memberOf" : "Roo.util.Observable",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "rowIndex",
- "type" : "Number",
- "desc" : "",
+ "name" : "eventName",
+ "type" : "String",
+ "desc" : "The type of event to listen for",
"isOptional" : false
},
{
- "name" : "colIndex",
- "type" : "Number",
- "desc" : "",
+ "name" : "handler",
+ "type" : "Function",
+ "desc" : "The handler to remove",
+ "isOptional" : false
+ },
+ {
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "(optional) The scope (this object) for the handler",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "stopEditing",
+ "name" : "unlock",
"type" : "function",
- "desc" : "Stops any active editing",
+ "desc" : "Unlock this instace",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.grid.EditorGrid",
+ "memberOf" : "Roo.dd.DragDrop",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"returns" : []
},
{
- "name" : "un",
+ "name" : "unreg",
"type" : "function",
- "desc" : "Removes a listener (shorthand for removeListener)",
- "sig" : "(eventName, handler, scope)",
+ "desc" : "Remove all drag and drop hooks for this element",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.util.Observable",
+ "memberOf" : "Roo.dd.DragDrop",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "eventName",
- "type" : "String",
- "desc" : "The type of event to listen for",
- "isOptional" : false
- },
- {
- "name" : "handler",
- "type" : "Function",
- "desc" : "The handler to remove",
- "isOptional" : false
- },
- {
- "name" : "scope",
- "type" : "Object",
- "desc" : "(optional) The scope (this object) for the handler",
- "isOptional" : false
- }
- ],
+ "params" : [],
"returns" : []
}
],
"isAbstract" : false,
"isBuilderTop" : false,
- "childClasses" : { },
+ "implementations" : [],
"tree_children" : [],
"tree_parent" : []
},
- "Roo.grid.RowSelectionModel" : {
+ "Roo.htmleditor" : {
+ "props" : [],
+ "events" : [],
+ "methods" : [],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "implementations" : [],
+ "tree_children" : [],
+ "tree_parent" : []
+ },
+ "Roo.htmleditor.Block" : {
"props" : [
{
- "name" : "listeners",
+ "name" : "Context",
"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"
+ "desc" : "menu - see Roo.form.HtmlEditor.ToolbarContext",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
- "name" : "singleSelect",
- "type" : "Boolean",
- "desc" : "True to allow selection of only one row at a time (defaults to false)",
- "memberOf" : ""
+ "name" : "friendly_name",
+ "type" : "String",
+ "desc" : "the name that appears in the context bar about this block",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "node",
+ "type" : "DomElement",
+ "desc" : "The node to apply stuff to.",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
}
],
- "events" : [
+ "events" : [],
+ "methods" : [
{
- "name" : "afterselectionchange",
+ "name" : "factory",
"type" : "function",
- "desc" : "Fires after the selection changes (eg. by key press or clicking)",
- "sig" : "function (_self)\n{\n\n}",
+ "desc" : "factory method to get the block from an element (using cache if necessary)",
+ "sig" : "(the)",
+ "static" : true,
"memberOf" : "",
+ "isStatic" : true,
+ "isConstructor" : false,
+ "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
- "name" : "this",
- "type" : "SelectionModel",
- "desc" : "",
+ "name" : "the",
+ "type" : "HtmlElement",
+ "desc" : "dom element",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "beforerowselect",
+ "name" : "getVal",
"type" : "function",
- "desc" : "Fires when a row is selected being selected, return false to cancel.",
- "sig" : "function (_self, rowIndex, keepExisting)\n{\n\n}",
+ "desc" : "used by readEleemnt to extract data from a node\nmay need improving as it's pretty basic",
+ "sig" : "(node, tag, attribute, style)",
+ "static" : false,
"memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
- "name" : "this",
- "type" : "SelectionModel",
+ "name" : "node",
+ "type" : "DomElement",
"desc" : "",
"isOptional" : false
},
{
- "name" : "rowIndex",
- "type" : "Number",
- "desc" : "The selected index",
+ "name" : "tag",
+ "type" : "String",
+ "desc" : "- tag to find, eg. IMG ?? might be better to use DomQuery ?",
"isOptional" : false
},
{
- "name" : "keepExisting",
- "type" : "Boolean",
- "desc" : "False if other selections will be cleared",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "rowdeselect",
- "type" : "function",
- "desc" : "Fires when a row is deselected.",
- "sig" : "function (_self, rowIndex)\n{\n\n}",
- "memberOf" : "",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "SelectionModel",
- "desc" : "",
+ "name" : "attribute",
+ "type" : "String",
+ "desc" : "(use html - for contents, style for using next param as style, or false to return the node)",
"isOptional" : false
},
{
- "name" : "rowIndex",
- "type" : "Number",
- "desc" : "The selected index",
+ "name" : "style",
+ "type" : "String",
+ "desc" : "the style property - eg. text-align",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "rowselect",
+ "name" : "initAll",
"type" : "function",
- "desc" : "Fires when a row is selected.",
- "sig" : "function (_self, rowIndex, r)\n{\n\n}",
+ "desc" : "initalize all Elements from content that are 'blockable'",
+ "sig" : "(the)",
+ "static" : true,
"memberOf" : "",
+ "isStatic" : true,
+ "isConstructor" : false,
+ "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
- "name" : "this",
- "type" : "SelectionModel",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "rowIndex",
- "type" : "Number",
- "desc" : "The selected index",
- "isOptional" : false
- },
- {
- "name" : "r",
- "type" : "Roo.data.Record",
- "desc" : "The record",
+ "name" : "the",
+ "type" : "",
+ "desc" : "body element",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "selectionchange",
+ "name" : "readElement",
"type" : "function",
- "desc" : "Fires when the selection changes",
- "sig" : "function (_self)\n{\n\n}",
+ "desc" : "Read a node that has a 'data-block' property - and extract the values from it.",
+ "sig" : "(node)",
+ "static" : false,
"memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
- "name" : "this",
- "type" : "SelectionModel",
- "desc" : "",
+ "name" : "node",
+ "type" : "DomElement",
+ "desc" : "- the node",
"isOptional" : false
}
],
"returns" : []
- }
- ],
- "methods" : [
+ },
{
- "name" : "addEvents",
+ "name" : "toHTML",
"type" : "function",
- "desc" : "Used to define events on this Observable",
- "sig" : "(object)",
+ "desc" : "convert to plain HTML for calling insertAtCursor..",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.util.Observable",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "object",
- "type" : "Object",
- "desc" : "The object with the events defined",
- "isOptional" : false
- }
- ],
+ "params" : [],
"returns" : []
},
{
- "name" : "addListener",
+ "name" : "toObject",
"type" : "function",
- "desc" : "Appends an event handler to this component",
- "sig" : "(eventName, handler, scope, options)",
+ "desc" : "create a DomHelper friendly object - for use with \nRoo.DomHelper.markup / overwrite / etc..\n(override this)",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.util.Observable",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "eventName",
- "type" : "String",
- "desc" : "The type of event to listen for",
- "isOptional" : false
- },
- {
- "name" : "handler",
- "type" : "Function",
- "desc" : "The method the event invokes",
- "isOptional" : false
- },
- {
- "name" : "scope",
- "type" : "Object",
- "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
- "isOptional" : false
- },
- {
- "name" : "options",
- "type" : "Object",
- "desc" : "(optional) An object containing handler configuration\nproperties. This may contain any of the following properties:<ul>\n<li>scope {Object} The scope in which to execute the handler function. The handler function's \"this\" context.</li>\n<li>delay {Number} The number of milliseconds to delay the invocation of the handler after te event fires.</li>\n<li>single {Boolean} True to add a handler to handle just the next firing of the event, and then remove itself.</li>\n<li>buffer {Number} Causes the handler to be scheduled to run in an {@link Roo.util.DelayedTask} delayed\nby the specified number of milliseconds. If the event fires again within that time, the original\nhandler is <em>not</em> invoked, but the new handler is scheduled in its place.</li>\n</ul><br>\n<p>\n<b>Combining Options</b><br>\nUsing the options argument, it is possible to combine different types of listeners:<br>\n<br>\nA normalized, delayed, one-time listener that auto stops the event and passes a custom argument (forumId)\n\t\t<pre><code>\n\t\tel.on('click', this.onClick, this, {\n \t\t\tsingle: true,\n \t\tdelay: 100,\n \t\tforumId: 4\n\t\t});\n\t\t</code></pre>\n<p>\n<b>Attaching multiple handlers in 1 call</b><br>\nThe method also allows for a single argument to be passed which is a config object containing properties\nwhich specify multiple handlers.\n<pre><code>\n\t\tel.on({\n\t\t\t'click': {\n \t\tfn: this.onClick,\n \t\tscope: this,\n \t\tdelay: 100\n \t\t}, \n \t\t'mouseover': {\n \t\tfn: this.onMouseOver,\n \t\tscope: this\n \t\t},\n \t\t'mouseout': {\n \t\tfn: this.onMouseOut,\n \t\tscope: this\n \t\t}\n\t\t});\n\t\t</code></pre>\n<p>\nOr a shorthand syntax which passes the same scope object to all handlers:\n \t<pre><code>\n\t\tel.on({\n\t\t\t'click': this.onClick,\n \t\t'mouseover': this.onMouseOver,\n \t\t'mouseout': this.onMouseOut,\n \t\tscope: this\n\t\t});\n\t\t</code></pre>",
- "isOptional" : false
- }
- ],
+ "params" : [],
"returns" : []
},
{
- "name" : "capture",
+ "name" : "updateElement",
"type" : "function",
- "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\n<b>before</b> the event is fired. If the supplied function returns false,\nthe event will not fire.",
- "sig" : "(o, fn, scope)",
- "static" : true,
- "memberOf" : "Roo.util.Observable",
- "isStatic" : true,
+ "desc" : "Update a node with values from this object",
+ "sig" : "(node)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"example" : "",
"requires" : "",
"params" : [
{
- "name" : "o",
- "type" : "Observable",
- "desc" : "The Observable to capture",
- "isOptional" : false
- },
- {
- "name" : "fn",
- "type" : "Function",
- "desc" : "The function to call",
- "isOptional" : false
- },
- {
- "name" : "scope",
- "type" : "Object",
- "desc" : "(optional) The scope (this object) for the fn",
+ "name" : "node",
+ "type" : "DomElement",
+ "desc" : "",
"isOptional" : false
}
],
"returns" : []
+ }
+ ],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "implementations" : [],
+ "tree_children" : [],
+ "tree_parent" : []
+ },
+ "Roo.htmleditor.BlockFigure" : {
+ "props" : [
+ {
+ "name" : "align",
+ "type" : "String",
+ "desc" : "t) alignment for the block default le",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : [
+ "left",
+ "right"
+ ]
},
{
- "name" : "clearSelections",
+ "name" : "caption",
+ "type" : "String",
+ "desc" : "the text to appear below (and in the alt tag)",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "caption_display",
+ "type" : "String",
+ "desc" : "e) display or not the capti",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : [
+ "block",
+ "none"
+ ]
+ },
+ {
+ "name" : "image_height",
+ "type" : "String|number",
+ "desc" : "the height of the image number or %?",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "image_src",
+ "type" : "String",
+ "desc" : "the url for the image",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "image_width",
+ "type" : "String|number",
+ "desc" : "the width of the image number or %?",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ }
+ ],
+ "events" : [],
+ "methods" : [
+ {
+ "name" : "toObject",
"type" : "function",
- "desc" : "Clears all selections.",
+ "desc" : "create a DomHelper friendly object - for use with\nRoo.DomHelper.markup / overwrite / etc..",
"sig" : "()\n{\n\n}",
"static" : false,
"memberOf" : "",
"requires" : "",
"params" : [],
"returns" : []
- },
+ }
+ ],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "implementations" : [],
+ "tree_children" : [],
+ "tree_parent" : []
+ },
+ "Roo.htmleditor.BlockTable" : {
+ "props" : [],
+ "events" : [],
+ "methods" : [
{
- "name" : "deselectRange",
+ "name" : "toObject",
"type" : "function",
- "desc" : "Deselects a range of rows. All rows in between startRow and endRow are also deselected.",
- "sig" : "(startRow, endRow)",
+ "desc" : "create a DomHelper friendly object - for use with\nRoo.DomHelper.markup / overwrite / etc..\n?? should it be called with option to hide all editing features?",
+ "sig" : "()\n{\n\n}",
"static" : false,
"memberOf" : "",
"isStatic" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "startRow",
- "type" : "Number",
- "desc" : "The index of the first row in the range",
- "isOptional" : false
- },
- {
- "name" : "endRow",
- "type" : "Number",
- "desc" : "The index of the last row in the range",
- "isOptional" : false
- }
- ],
+ "params" : [],
"returns" : []
- },
+ }
+ ],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "implementations" : [],
+ "tree_children" : [],
+ "tree_parent" : []
+ },
+ "Roo.htmleditor.BlockTd" : {
+ "props" : [],
+ "events" : [],
+ "methods" : [
{
- "name" : "deselectRow",
+ "name" : "toObject",
"type" : "function",
- "desc" : "Deselects a row.",
- "sig" : "(row)",
+ "desc" : "create a DomHelper friendly object - for use with\nRoo.DomHelper.markup / overwrite / etc..\n?? should it be called with option to hide all editing features?",
+ "sig" : "()\n{\n\n}",
"static" : false,
"memberOf" : "",
"isStatic" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "row",
- "type" : "Number",
- "desc" : "The index of the row to deselect",
- "isOptional" : false
- }
- ],
+ "params" : [],
"returns" : []
- },
+ }
+ ],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "implementations" : [],
+ "tree_children" : [],
+ "tree_parent" : []
+ },
+ "Roo.htmleditor.Filter" : {
+ "props" : [
{
- "name" : "fireEvent",
- "type" : "function",
- "desc" : "Fires the specified event with the passed parameters (minus the event name).",
- "sig" : "(eventName, args)",
- "static" : false,
- "memberOf" : "Roo.util.Observable",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "eventName",
- "type" : "String",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "args",
- "type" : "Object...",
- "desc" : "Variable number of parameters are passed to handlers",
- "isOptional" : false
- }
- ],
- "returns" : [
- {
- "name" : "",
- "type" : "Boolean",
- "desc" : "returns false if any of the handlers return false otherwise it returns true"
- }
- ]
+ "name" : "node",
+ "type" : "DomElement",
+ "desc" : "The node to iterate and filter",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
- "name" : "getCount",
+ "name" : "tag",
+ "type" : "boolean|String|Array",
+ "desc" : "Tags to replace",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ }
+ ],
+ "events" : [],
+ "methods" : [],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "implementations" : [],
+ "tree_children" : [],
+ "tree_parent" : []
+ },
+ "Roo.htmleditor.FilterAttributes" : {
+ "props" : [],
+ "events" : [],
+ "methods" : [],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "implementations" : [],
+ "tree_children" : [],
+ "tree_parent" : []
+ },
+ "Roo.htmleditor.FilterBlack" : {
+ "props" : [],
+ "events" : [],
+ "methods" : [],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "implementations" : [],
+ "tree_children" : [],
+ "tree_parent" : []
+ },
+ "Roo.htmleditor.FilterBlock" : {
+ "props" : [],
+ "events" : [],
+ "methods" : [],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "implementations" : [],
+ "tree_children" : [],
+ "tree_parent" : []
+ },
+ "Roo.htmleditor.FilterComment" : {
+ "props" : [],
+ "events" : [],
+ "methods" : [],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "implementations" : [],
+ "tree_children" : [],
+ "tree_parent" : []
+ },
+ "Roo.htmleditor.FilterKeepChildren" : {
+ "props" : [],
+ "events" : [],
+ "methods" : [],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "implementations" : [],
+ "tree_children" : [],
+ "tree_parent" : []
+ },
+ "Roo.htmleditor.FilterLongBr" : {
+ "props" : [],
+ "events" : [],
+ "methods" : [],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "implementations" : [],
+ "tree_children" : [],
+ "tree_parent" : []
+ },
+ "Roo.htmleditor.FilterParagraph" : {
+ "props" : [],
+ "events" : [],
+ "methods" : [],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "implementations" : [],
+ "tree_children" : [],
+ "tree_parent" : []
+ },
+ "Roo.htmleditor.FilterSpan" : {
+ "props" : [],
+ "events" : [],
+ "methods" : [],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "implementations" : [],
+ "tree_children" : [],
+ "tree_parent" : []
+ },
+ "Roo.htmleditor.FilterStyleToTag" : {
+ "props" : [],
+ "events" : [],
+ "methods" : [],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "implementations" : [],
+ "tree_children" : [],
+ "tree_parent" : []
+ },
+ "Roo.htmleditor.FilterTableWidth" : {
+ "props" : [],
+ "events" : [],
+ "methods" : [],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "implementations" : [],
+ "tree_children" : [],
+ "tree_parent" : []
+ },
+ "Roo.htmleditor.FilterWord" : {
+ "props" : [],
+ "events" : [],
+ "methods" : [
+ {
+ "name" : "replaceTag",
"type" : "function",
- "desc" : "Gets the number of selected rows.",
+ "desc" : "Clean up MS wordisms...",
"sig" : "()\n{\n\n}",
"static" : false,
"memberOf" : "",
"exceptions" : "",
"requires" : "",
"params" : [],
- "returns" : [
- {
- "name" : "",
- "type" : "Number",
- "desc" : ""
- }
- ]
- },
+ "returns" : []
+ }
+ ],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "implementations" : [],
+ "tree_children" : [],
+ "tree_parent" : []
+ },
+ "Roo.htmleditor.KeyEnter" : {
+ "props" : [
{
- "name" : "getSelected",
- "type" : "function",
- "desc" : "Returns the first selected record.",
- "sig" : "()\n{\n\n}",
- "static" : false,
+ "name" : "core",
+ "type" : "Roo.HtmlEditorCore",
+ "desc" : "the editor.",
"memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : [
- {
- "name" : "",
- "type" : "Record",
- "desc" : ""
- }
- ]
- },
+ "isOptional" : false,
+ "optvals" : []
+ }
+ ],
+ "events" : [],
+ "methods" : [],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "implementations" : [],
+ "tree_children" : [],
+ "tree_parent" : []
+ },
+ "Roo.htmleditor.TidyEntities" : {
+ "props" : [],
+ "events" : [],
+ "methods" : [
{
- "name" : "getSelections",
+ "name" : "decode",
"type" : "function",
- "desc" : "Returns the selected records",
- "sig" : "()\n{\n\n}",
- "static" : false,
+ "desc" : "Decodes the specified string, this will replace entities with raw UTF characters.",
+ "sig" : "(text)",
+ "static" : true,
"memberOf" : "",
- "isStatic" : false,
+ "isStatic" : true,
"isConstructor" : false,
"isPrivate" : false,
"example" : "",
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
+ "params" : [
+ {
+ "name" : "text",
+ "type" : "String",
+ "desc" : "Text to entity decode.",
+ "isOptional" : false
+ }
+ ],
"returns" : [
{
"name" : "",
- "type" : "Array",
- "desc" : "Array of selected records"
+ "type" : "String",
+ "desc" : "Entity decoded string."
}
]
},
{
- "name" : "hasListener",
+ "name" : "encodeAllRaw",
"type" : "function",
- "desc" : "Checks to see if this object has any listeners for a specified event",
- "sig" : "(eventName)",
- "static" : false,
- "memberOf" : "Roo.util.Observable",
- "isStatic" : false,
+ "desc" : "Encoded the specified text with both the attributes and text entities. This function will produce larger text contents\nsince it doesn't know if the context is within a attribute or text node. This was added for compatibility\nand is exposed as the DOMUtils.encode function.",
+ "sig" : "(text)",
+ "static" : true,
+ "memberOf" : "",
+ "isStatic" : true,
"isConstructor" : false,
"isPrivate" : false,
"example" : "",
"requires" : "",
"params" : [
{
- "name" : "eventName",
+ "name" : "text",
"type" : "String",
- "desc" : "The name of the event to check for",
+ "desc" : "Text to encode.",
"isOptional" : false
}
],
"returns" : [
{
"name" : "",
- "type" : "Boolean",
- "desc" : "True if the event is being listened for, else false"
+ "type" : "String",
+ "desc" : "Entity encoded text."
}
]
},
{
- "name" : "hasSelection",
+ "name" : "encodeNamed",
"type" : "function",
- "desc" : "Returns True if there is a selection.",
- "sig" : "()\n{\n\n}",
- "static" : false,
+ "desc" : "Encodes the specified string using named entities. The core entities will be encoded\nas named ones but all non lower ascii characters will be encoded into named entities.",
+ "sig" : "(text, attr, entities)",
+ "static" : true,
"memberOf" : "",
- "isStatic" : false,
+ "isStatic" : true,
"isConstructor" : false,
"isPrivate" : false,
"example" : "",
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
+ "params" : [
+ {
+ "name" : "text",
+ "type" : "String",
+ "desc" : "Text to encode.",
+ "isOptional" : false
+ },
+ {
+ "name" : "attr",
+ "type" : "Boolean",
+ "desc" : "Optional flag to specify if the text is attribute contents.",
+ "isOptional" : false
+ },
+ {
+ "name" : "entities",
+ "type" : "Object",
+ "desc" : "Optional parameter with entities to use.",
+ "isOptional" : false
+ }
+ ],
"returns" : [
{
"name" : "",
- "type" : "Boolean",
- "desc" : ""
+ "type" : "String",
+ "desc" : "Entity encoded text."
}
]
},
{
- "name" : "isIdSelected",
+ "name" : "encodeNumeric",
"type" : "function",
- "desc" : "Returns True if the specified record id is selected.",
- "sig" : "(id)",
- "static" : false,
+ "desc" : "Encodes the specified string using numeric entities. The core entities will be\nencoded as named ones but all non lower ascii characters will be encoded into numeric entities.",
+ "sig" : "(text, attr)",
+ "static" : true,
"memberOf" : "",
- "isStatic" : false,
+ "isStatic" : true,
"isConstructor" : false,
"isPrivate" : false,
"example" : "",
"requires" : "",
"params" : [
{
- "name" : "id",
+ "name" : "text",
"type" : "String",
- "desc" : "The id of record to check",
+ "desc" : "Text to encode.",
+ "isOptional" : false
+ },
+ {
+ "name" : "attr",
+ "type" : "Boolean",
+ "desc" : "Optional flag to specify if the text is attribute contents.",
"isOptional" : false
}
],
"returns" : [
{
"name" : "",
- "type" : "Boolean",
- "desc" : ""
+ "type" : "String",
+ "desc" : "Entity encoded text."
}
]
},
{
- "name" : "isLocked",
+ "name" : "encodeRaw",
"type" : "function",
- "desc" : "Returns true if the selections are locked.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.grid.AbstractSelectionModel",
- "isStatic" : false,
+ "desc" : "Encodes the specified string using raw entities. This means only the required XML base entities will be encoded.",
+ "sig" : "(text, attr)",
+ "static" : true,
+ "memberOf" : "",
+ "isStatic" : true,
"isConstructor" : false,
"isPrivate" : false,
"example" : "",
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
+ "params" : [
+ {
+ "name" : "text",
+ "type" : "String",
+ "desc" : "Text to encode.",
+ "isOptional" : false
+ },
+ {
+ "name" : "attr",
+ "type" : "Boolean",
+ "desc" : "Optional flag to specify if the text is attribute contents.",
+ "isOptional" : false
+ }
+ ],
"returns" : [
{
"name" : "",
- "type" : "Boolean",
- "desc" : ""
+ "type" : "String",
+ "desc" : "Entity encoded text."
}
]
},
{
- "name" : "isSelected",
+ "name" : "getEncodeFunc",
"type" : "function",
- "desc" : "Returns True if the specified row is selected.",
- "sig" : "(record)",
- "static" : false,
+ "desc" : "Returns an encode function based on the name(s) and it's optional entities.",
+ "sig" : "(name, entities)",
+ "static" : true,
"memberOf" : "",
- "isStatic" : false,
+ "isStatic" : true,
"isConstructor" : false,
"isPrivate" : false,
"example" : "",
"requires" : "",
"params" : [
{
- "name" : "record",
- "type" : "Number/Record",
- "desc" : "The record or index of the record to check",
+ "name" : "name",
+ "type" : "String",
+ "desc" : "Comma separated list of encoders for example named,numeric.",
+ "isOptional" : false
+ },
+ {
+ "name" : "entities",
+ "type" : "String",
+ "desc" : "Optional parameter with entities to use instead of the built in set.",
"isOptional" : false
}
],
"returns" : [
{
"name" : "",
- "type" : "Boolean",
- "desc" : ""
+ "type" : "function",
+ "desc" : "Encode function to be used."
}
]
},
{
- "name" : "lock",
+ "name" : "init",
"type" : "function",
- "desc" : "Locks the selections.",
+ "desc" : "initialize data..",
"sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.grid.AbstractSelectionModel",
- "isStatic" : false,
+ "static" : true,
+ "memberOf" : "",
+ "isStatic" : true,
"isConstructor" : false,
"isPrivate" : false,
"example" : "",
"requires" : "",
"params" : [],
"returns" : []
- },
+ }
+ ],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "implementations" : [],
+ "tree_children" : [],
+ "tree_parent" : []
+ },
+ "Roo.htmleditor.TidySerializer" : {
+ "props" : [],
+ "events" : [],
+ "methods" : [
{
- "name" : "on",
+ "name" : "inner",
"type" : "function",
- "desc" : "Appends an event handler to this element (shorthand for addListener)",
- "sig" : "(eventName, handler, scope, options)",
+ "desc" : "",
+ "sig" : "(inner)",
"static" : false,
- "memberOf" : "Roo.util.Observable",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "eventName",
- "type" : "String",
- "desc" : "The type of event to listen for",
- "isOptional" : false
- },
- {
- "name" : "handler",
- "type" : "Function",
- "desc" : "The method the event invokes",
- "isOptional" : false
- },
- {
- "name" : "scope",
- "type" : "Object",
- "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
- "isOptional" : false
- },
- {
- "name" : "options",
- "type" : "Object",
- "desc" : "(optional)",
+ "name" : "inner",
+ "type" : "boolean",
+ "desc" : "do the inner of the node.",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "purgeListeners",
+ "name" : "serialize",
"type" : "function",
- "desc" : "Removes all listeners for this object",
- "sig" : "()\n{\n\n}",
+ "desc" : "Serializes the specified node into a string.",
+ "sig" : "(node)",
"static" : false,
- "memberOf" : "Roo.util.Observable",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
- "example" : "",
+ "example" : "new tinymce.html.Serializer().serialize(new tinymce.html.DomParser().parse('<p>text</p>'));",
"deprecated" : "",
"since" : "",
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
- "returns" : []
- },
+ "params" : [
+ {
+ "name" : "node",
+ "type" : "DomElement",
+ "desc" : "Node instance to serialize.",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "String",
+ "desc" : "String with HTML based on DOM tree."
+ }
+ ]
+ }
+ ],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "implementations" : [],
+ "tree_children" : [],
+ "tree_parent" : []
+ },
+ "Roo.htmleditor.TidyWriter" : {
+ "props" : [],
+ "events" : [],
+ "methods" : [
{
- "name" : "releaseCapture",
+ "name" : "cdata",
"type" : "function",
- "desc" : "Removes <b>all</b> added captures from the Observable.",
- "sig" : "(o)",
- "static" : true,
- "memberOf" : "Roo.util.Observable",
- "isStatic" : true,
+ "desc" : "Writes a cdata node such as <![CDATA[data]]>.",
+ "sig" : "(text)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"example" : "",
"requires" : "",
"params" : [
{
- "name" : "o",
- "type" : "Observable",
- "desc" : "The Observable to release",
+ "name" : "text",
+ "type" : "String",
+ "desc" : "String to write out inside the cdata.",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "removeListener",
+ "name" : "comment",
"type" : "function",
- "desc" : "Removes a listener",
- "sig" : "(eventName, handler, scope)",
+ "desc" : "Writes a comment node such as <!-- Comment -->.",
+ "sig" : "(text)",
"static" : false,
- "memberOf" : "Roo.util.Observable",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "eventName",
+ "name" : "text",
"type" : "String",
- "desc" : "The type of event to listen for",
- "isOptional" : false
- },
- {
- "name" : "handler",
- "type" : "Function",
- "desc" : "The handler to remove",
- "isOptional" : false
- },
- {
- "name" : "scope",
- "type" : "Object",
- "desc" : "(optional) The scope (this object) for the handler",
+ "desc" : "String to write out inside the comment.",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "selectAll",
+ "name" : "doctype",
"type" : "function",
- "desc" : "Selects all rows.",
- "sig" : "()\n{\n\n}",
+ "desc" : "Writes a doctype node such as <!DOCTYPE data>.",
+ "sig" : "(text)",
"static" : false,
"memberOf" : "",
"isStatic" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
+ "params" : [
+ {
+ "name" : "text",
+ "type" : "String",
+ "desc" : "String to write out inside the doctype.",
+ "isOptional" : false
+ }
+ ],
"returns" : []
},
{
- "name" : "selectFirstRow",
+ "name" : "end",
"type" : "function",
- "desc" : "Selects the first row in the grid.",
- "sig" : "()\n{\n\n}",
+ "desc" : "Writes the a end element such as </p>.",
+ "sig" : "(name)",
"static" : false,
"memberOf" : "",
"isStatic" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
+ "params" : [
+ {
+ "name" : "name",
+ "type" : "String",
+ "desc" : "Name of the element.",
+ "isOptional" : false
+ }
+ ],
"returns" : []
},
{
- "name" : "selectLastRow",
+ "name" : "getContent",
"type" : "function",
- "desc" : "Select the last row.",
- "sig" : "(keepExisting)",
+ "desc" : "Returns the contents that got serialized.",
+ "sig" : "()\n{\n\n}",
"static" : false,
"memberOf" : "",
"isStatic" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
+ "params" : [],
+ "returns" : [
{
- "name" : "keepExisting",
- "type" : "Boolean",
- "desc" : "(optional) True to keep existing selections",
- "isOptional" : false
+ "name" : "",
+ "type" : "String",
+ "desc" : "HTML contents that got written down."
}
- ],
- "returns" : []
+ ]
},
{
- "name" : "selectNext",
+ "name" : "pi",
"type" : "function",
- "desc" : "Selects the row immediately following the last selected row.",
- "sig" : "(keepExisting)",
+ "desc" : "Writes a PI node such as <?xml attr=\"value\" ?>.",
+ "sig" : "(name, text)",
"static" : false,
"memberOf" : "",
"isStatic" : false,
"requires" : "",
"params" : [
{
- "name" : "keepExisting",
- "type" : "Boolean",
- "desc" : "(optional) True to keep existing selections",
+ "name" : "name",
+ "type" : "String",
+ "desc" : "Name of the pi.",
+ "isOptional" : false
+ },
+ {
+ "name" : "text",
+ "type" : "String",
+ "desc" : "String to write out inside the pi.",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "selectPrevious",
+ "name" : "reset",
"type" : "function",
- "desc" : "Selects the row that precedes the last selected row.",
- "sig" : "(keepExisting)",
+ "desc" : "Resets the internal buffer if one wants to reuse the writer.",
+ "sig" : "()\n{\n\n}",
"static" : false,
"memberOf" : "",
"isStatic" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "keepExisting",
- "type" : "Boolean",
- "desc" : "(optional) True to keep existing selections",
- "isOptional" : false
- }
- ],
+ "params" : [],
"returns" : []
},
{
- "name" : "selectRange",
+ "name" : "start",
"type" : "function",
- "desc" : "Selects a range of rows. All rows in between startRow and endRow are also selected.",
- "sig" : "(startRow, endRow, keepExisting)",
+ "desc" : "Writes the a start element such as <p id=\"a\">.",
+ "sig" : "(name, attrs, empty)",
"static" : false,
"memberOf" : "",
"isStatic" : false,
"requires" : "",
"params" : [
{
- "name" : "startRow",
- "type" : "Number",
- "desc" : "The index of the first row in the range",
+ "name" : "name",
+ "type" : "String",
+ "desc" : "Name of the element.",
"isOptional" : false
},
{
- "name" : "endRow",
- "type" : "Number",
- "desc" : "The index of the last row in the range",
+ "name" : "attrs",
+ "type" : "Array",
+ "desc" : "Optional attribute array or undefined if it hasn't any.",
"isOptional" : false
},
{
- "name" : "keepExisting",
+ "name" : "empty",
"type" : "Boolean",
- "desc" : "(optional) True to retain existing selections",
+ "desc" : "Optional empty state if the tag should end like <br />.",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "selectRecords",
+ "name" : "text",
"type" : "function",
- "desc" : "Select records.",
- "sig" : "(records, keepExisting)",
+ "desc" : "Writes a text node.\n\nIn pre - we should not mess with the contents.",
+ "sig" : "(text, raw)",
"static" : false,
"memberOf" : "",
"isStatic" : false,
"requires" : "",
"params" : [
{
- "name" : "records",
- "type" : "Array",
- "desc" : "The records to select",
+ "name" : "text",
+ "type" : "String",
+ "desc" : "String to write out.",
"isOptional" : false
},
{
- "name" : "keepExisting",
+ "name" : "raw",
"type" : "Boolean",
- "desc" : "(optional) True to keep existing selections",
+ "desc" : "Optional raw state if true the contents wont get encoded.",
"isOptional" : false
}
],
"returns" : []
- },
+ }
+ ],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "implementations" : [],
+ "tree_children" : [],
+ "tree_parent" : []
+ },
+ "Roo.lib" : {
+ "props" : [],
+ "events" : [],
+ "methods" : [],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "implementations" : [],
+ "tree_children" : [],
+ "tree_parent" : []
+ },
+ "Roo.lib.Ajax" : {
+ "props" : [],
+ "events" : [],
+ "methods" : [
{
- "name" : "selectRow",
+ "name" : "request",
"type" : "function",
- "desc" : "Selects a row.",
- "sig" : "(row, keepExisting)",
- "static" : false,
+ "desc" : "",
+ "sig" : "()\n{\n\n}",
+ "static" : true,
"memberOf" : "",
- "isStatic" : false,
+ "isStatic" : true,
"isConstructor" : false,
"isPrivate" : false,
"example" : "",
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "row",
- "type" : "Number",
- "desc" : "The index of the row to select",
- "isOptional" : false
- },
- {
- "name" : "keepExisting",
- "type" : "Boolean",
- "desc" : "(optional) True to keep existing selections",
- "isOptional" : false
- }
- ],
+ "params" : [],
"returns" : []
},
{
- "name" : "selectRows",
+ "name" : "serializeForm",
"type" : "function",
- "desc" : "Selects multiple rows.",
- "sig" : "(rows, keepExisting)",
- "static" : false,
+ "desc" : "serialize a form",
+ "sig" : "(form)",
+ "static" : true,
"memberOf" : "",
- "isStatic" : false,
+ "isStatic" : true,
"isConstructor" : false,
"isPrivate" : false,
"example" : "",
"requires" : "",
"params" : [
{
- "name" : "rows",
- "type" : "Array",
- "desc" : "Array of the indexes of the row to select",
- "isOptional" : false
- },
- {
- "name" : "keepExisting",
- "type" : "Boolean",
- "desc" : "(optional) True to keep existing selections",
+ "name" : "form",
+ "type" : "DomForm",
+ "desc" : "element",
"isOptional" : false
}
],
- "returns" : []
- },
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "String",
+ "desc" : "urlencode form output."
+ }
+ ]
+ }
+ ],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "implementations" : [],
+ "tree_children" : [],
+ "tree_parent" : []
+ },
+ "Roo.lib.Color" : {
+ "props" : [],
+ "events" : [],
+ "methods" : [
{
- "name" : "un",
+ "name" : "getCSSHSL",
"type" : "function",
- "desc" : "Removes a listener (shorthand for removeListener)",
- "sig" : "(eventName, handler, scope)",
+ "desc" : "getCSSHSL",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.util.Observable",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
+ "params" : [],
+ "returns" : [
{
- "name" : "eventName",
+ "name" : "",
"type" : "String",
- "desc" : "The type of event to listen for",
- "isOptional" : false
- },
- {
- "name" : "handler",
- "type" : "Function",
- "desc" : "The handler to remove",
- "isOptional" : false
- },
- {
- "name" : "scope",
- "type" : "Object",
- "desc" : "(optional) The scope (this object) for the handler",
- "isOptional" : false
+ "desc" : "a string representing this Color as a CSS HSL Color value - that\nis, a string of the form hsl(h,s%,l%) where h is in the range [0,100] and\ns and l are in the range [0,100]."
}
- ],
- "returns" : []
+ ]
},
{
- "name" : "unlock",
+ "name" : "getCSSHSLA",
"type" : "function",
- "desc" : "Unlocks the selections.",
+ "desc" : "getCSSHSLA",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.grid.AbstractSelectionModel",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"exceptions" : "",
"requires" : "",
"params" : [],
- "returns" : []
- }
- ],
- "isAbstract" : false,
- "isBuilderTop" : false,
- "childClasses" : { },
- "tree_children" : [],
- "tree_parent" : []
- },
- "Roo.grid.SplitDragZone" : {
- "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" : [],
- "methods" : [
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "String",
+ "desc" : "a string representing this Color as a CSS HSLA Color value - that\nis, a string of the form hsla(h,s%,l%,a) where h is in the range [0,100],\ns and l are in the range [0,100], and a is in the range [0,1]."
+ }
+ ]
+ },
{
- "name" : "addEvents",
+ "name" : "getCSSHexadecimalRGB",
"type" : "function",
- "desc" : "Used to define events on this Observable",
- "sig" : "(object)",
+ "desc" : "getCSSHexadecimalRGB",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.util.Observable",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
+ "params" : [],
+ "returns" : [
{
- "name" : "object",
- "type" : "Object",
- "desc" : "The object with the events defined",
- "isOptional" : false
+ "name" : "",
+ "type" : "String",
+ "desc" : "a string representing this Color as a CSS hexadecimal RGB Color\nvalue - that is, a string of the form #RRGGBB where each of RR, GG, and BB\nare two-digit hexadecimal numbers."
}
- ],
- "returns" : []
+ ]
},
{
- "name" : "addInvalidHandleClass",
+ "name" : "getCSSIntegerRGB",
"type" : "function",
- "desc" : "Lets you specify a css class of elements that will not initiate a drag",
- "sig" : "(cssClass)",
+ "desc" : "getCSSIntegerRGB",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
+ "params" : [],
+ "returns" : [
{
- "name" : "cssClass",
- "type" : "string",
- "desc" : "the class of the elements you wish to ignore",
- "isOptional" : false
+ "name" : "",
+ "type" : "String",
+ "desc" : "a string representing this Color as a CSS integer RGB Color\nvalue - that is, a string of the form rgb(r,g,b) where each of r, g, and b\nare integers in the range [0,255]."
}
- ],
- "returns" : []
+ ]
},
{
- "name" : "addInvalidHandleId",
+ "name" : "getCSSIntegerRGBA",
"type" : "function",
- "desc" : "Lets you to specify an element id for a child of a drag handle\nthat should not initiate a drag",
- "sig" : "(id)",
+ "desc" : "getCSSIntegerRGBA",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
+ "params" : [],
+ "returns" : [
{
- "name" : "id",
- "type" : "string",
- "desc" : "the element id of the element you wish to ignore",
- "isOptional" : false
+ "name" : "",
+ "type" : "String",
+ "desc" : "Returns a string representing this Color as a CSS integer RGBA Color\nvalue - that is, a string of the form rgba(r,g,b,a) where each of r, g, and\nb are integers in the range [0,255] and a is in the range [0,1]."
}
- ],
- "returns" : []
+ ]
},
{
- "name" : "addInvalidHandleType",
+ "name" : "getCSSPercentageRGB",
"type" : "function",
- "desc" : "Allows you to specify a tag name that should not start a drag operation\nwhen clicked. This is designed to facilitate embedding links within a\ndrag handle that do something other than start the drag.",
- "sig" : "(tagName)",
+ "desc" : "getCSSPercentageRGB",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
+ "params" : [],
+ "returns" : [
{
- "name" : "tagName",
- "type" : "string",
- "desc" : "the type of element to exclude",
- "isOptional" : false
+ "name" : "",
+ "type" : "String",
+ "desc" : "a string representing this Color as a CSS percentage RGB Color\nvalue - that is, a string of the form rgb(r%,g%,b%) where each of r, g, and\nb are in the range [0,100]."
}
- ],
- "returns" : []
+ ]
},
{
- "name" : "addListener",
+ "name" : "getCSSPercentageRGBA",
"type" : "function",
- "desc" : "Appends an event handler to this component",
- "sig" : "(eventName, handler, scope, options)",
+ "desc" : "getCSSPercentageRGBA",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.util.Observable",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
+ "params" : [],
+ "returns" : [
{
- "name" : "eventName",
+ "name" : "",
"type" : "String",
- "desc" : "The type of event to listen for",
- "isOptional" : false
- },
- {
- "name" : "handler",
- "type" : "Function",
- "desc" : "The method the event invokes",
- "isOptional" : false
- },
- {
- "name" : "scope",
- "type" : "Object",
- "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
- "isOptional" : false
- },
- {
- "name" : "options",
- "type" : "Object",
- "desc" : "(optional) An object containing handler configuration\nproperties. This may contain any of the following properties:<ul>\n<li>scope {Object} The scope in which to execute the handler function. The handler function's \"this\" context.</li>\n<li>delay {Number} The number of milliseconds to delay the invocation of the handler after te event fires.</li>\n<li>single {Boolean} True to add a handler to handle just the next firing of the event, and then remove itself.</li>\n<li>buffer {Number} Causes the handler to be scheduled to run in an {@link Roo.util.DelayedTask} delayed\nby the specified number of milliseconds. If the event fires again within that time, the original\nhandler is <em>not</em> invoked, but the new handler is scheduled in its place.</li>\n</ul><br>\n<p>\n<b>Combining Options</b><br>\nUsing the options argument, it is possible to combine different types of listeners:<br>\n<br>\nA normalized, delayed, one-time listener that auto stops the event and passes a custom argument (forumId)\n\t\t<pre><code>\n\t\tel.on('click', this.onClick, this, {\n \t\t\tsingle: true,\n \t\tdelay: 100,\n \t\tforumId: 4\n\t\t});\n\t\t</code></pre>\n<p>\n<b>Attaching multiple handlers in 1 call</b><br>\nThe method also allows for a single argument to be passed which is a config object containing properties\nwhich specify multiple handlers.\n<pre><code>\n\t\tel.on({\n\t\t\t'click': {\n \t\tfn: this.onClick,\n \t\tscope: this,\n \t\tdelay: 100\n \t\t}, \n \t\t'mouseover': {\n \t\tfn: this.onMouseOver,\n \t\tscope: this\n \t\t},\n \t\t'mouseout': {\n \t\tfn: this.onMouseOut,\n \t\tscope: this\n \t\t}\n\t\t});\n\t\t</code></pre>\n<p>\nOr a shorthand syntax which passes the same scope object to all handlers:\n \t<pre><code>\n\t\tel.on({\n\t\t\t'click': this.onClick,\n \t\t'mouseover': this.onMouseOver,\n \t\t'mouseout': this.onMouseOut,\n \t\tscope: this\n\t\t});\n\t\t</code></pre>",
- "isOptional" : false
+ "desc" : "a string representing this Color as a CSS percentage RGBA Color\nvalue - that is, a string of the form rgba(r%,g%,b%,a) where each of r, g,\nand b are in the range [0,100] and a is in the range [0,1]."
}
- ],
- "returns" : []
+ ]
},
{
- "name" : "addToGroup",
+ "name" : "getHSL",
"type" : "function",
- "desc" : "Add this instance to a group of related drag/drop objects. All\ninstances belong to at least one group, and can belong to as many\ngroups as needed.",
- "sig" : "(sGroup)",
+ "desc" : "getHSL",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
+ "params" : [],
+ "returns" : [
{
- "name" : "sGroup",
- "type" : "",
- "desc" : "{string} the name of the group",
- "isOptional" : false
+ "name" : "",
+ "type" : "Object",
+ "desc" : "the HSL and alpha components of this Color as an object with h,\ns, l, and a properties. h is in the range [0,360), s and l are in the range\n[0,100], and a is in the range [0,1]."
}
- ],
- "returns" : []
+ ]
},
{
- "name" : "alignElWithMouse",
+ "name" : "getHSV",
"type" : "function",
- "desc" : "Sets the element to the location of the mousedown or click event,\nmaintaining the cursor location relative to the location on the element\nthat was clicked. Override this if you want to place the element in a\nlocation other than where the cursor is.",
- "sig" : "(el, iPageX, iPageY)",
+ "desc" : "getHSV",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.dd.DD",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "el",
- "type" : "HTMLElement",
- "desc" : "the element to move",
- "isOptional" : false
- },
- {
- "name" : "iPageX",
- "type" : "int",
- "desc" : "the X coordinate of the mousedown or drag event",
- "isOptional" : false
- },
+ "params" : [],
+ "returns" : [
{
- "name" : "iPageY",
- "type" : "int",
- "desc" : "the Y coordinate of the mousedown or drag event",
- "isOptional" : false
+ "name" : "",
+ "type" : "Object",
+ "desc" : "the HSV and alpha components of this Color as an object with h,\ns, v, and a properties. h is in the range [0,360), s and v are in the range\n[0,100], and a is in the range [0,1]."
}
- ],
- "returns" : []
+ ]
},
{
- "name" : "applyConfig",
+ "name" : "getIntegerRGB",
"type" : "function",
- "desc" : "Applies the configuration parameters that were passed into the constructor.\nThis is supposed to happen at each level through the inheritance chain. So\na DDProxy implentation will execute apply config on DDProxy, DD, and\nDragDrop in order to get all of the parameters that are available in\neach object.",
+ "desc" : "getIntegerRGB",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"exceptions" : "",
"requires" : "",
"params" : [],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Object",
+ "desc" : "an object representing the RGBA components of this Color. The red,\ngreen, and blue components are converted to integers in the range [0,255].\nThe alpha is a value in the range [0,1]."
+ }
+ ]
},
{
- "name" : "autoOffset",
+ "name" : "getPercentageRGB",
"type" : "function",
- "desc" : "Sets the pointer offset to the distance between the linked element's top\nleft corner and the location the element was clicked",
- "sig" : "(iPageX, iPageY)",
+ "desc" : "getPercentageRGB",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.dd.DD",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "iPageX",
- "type" : "int",
- "desc" : "the X coordinate of the click",
- "isOptional" : false
- },
+ "params" : [],
+ "returns" : [
{
- "name" : "iPageY",
- "type" : "int",
- "desc" : "the Y coordinate of the click",
- "isOptional" : false
+ "name" : "",
+ "type" : "Object",
+ "desc" : "an object representing the RGBA components of this Color. The red,\ngreen, and blue components are converted to numbers in the range [0,100].\nThe alpha is a value in the range [0,1]."
}
- ],
- "returns" : []
+ ]
},
{
- "name" : "cachePosition",
+ "name" : "getRGB",
"type" : "function",
- "desc" : "Saves the most recent position so that we can reset the constraints and\ntick marks on-demand. We need to know this so that we can calculate the\nnumber of pixels the element is offset from its original position.",
- "sig" : "(iPageX, iPageY)",
+ "desc" : "getRGB",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.dd.DD",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "iPageX",
- "type" : "",
- "desc" : "the current x position (optional, this just makes it so we\ndon't have to look it up again)",
- "isOptional" : false
- },
+ "params" : [],
+ "returns" : [
{
- "name" : "iPageY",
- "type" : "",
- "desc" : "the current y position (optional, this just makes it so we\ndon't have to look it up again)",
- "isOptional" : false
+ "name" : "",
+ "type" : "Object",
+ "desc" : "the RGB and alpha components of this Color as an object with r,\ng, b, and a properties. r, g, and b are in the range [0,255] and a is in\nthe range [0,1]."
}
- ],
- "returns" : []
+ ]
},
{
- "name" : "capture",
+ "name" : "setNodeBackgroundColor",
"type" : "function",
- "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\n<b>before</b> the event is fired. If the supplied function returns false,\nthe event will not fire.",
- "sig" : "(o, fn, scope)",
- "static" : true,
- "memberOf" : "Roo.util.Observable",
- "isStatic" : true,
+ "desc" : "Sets the background Color of the specified node to this Color. This\nfunctions sets the CSS 'background-color' property for the node. The\nparameter is:",
+ "sig" : "(node)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"example" : "",
"requires" : "",
"params" : [
{
- "name" : "o",
- "type" : "Observable",
- "desc" : "The Observable to capture",
- "isOptional" : false
- },
- {
- "name" : "fn",
- "type" : "Function",
- "desc" : "The function to call",
- "isOptional" : false
- },
- {
- "name" : "scope",
- "type" : "Object",
- "desc" : "(optional) The scope (this object) for the fn",
+ "name" : "node",
+ "type" : "DomElement",
+ "desc" : "- the node whose background Color should be set",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "clearConstraints",
+ "name" : "setNodeColor",
"type" : "function",
- "desc" : "Clears any constraints applied to this instance. Also clears ticks\nsince they can't exist independent of a constraint at this time.",
- "sig" : "()\n{\n\n}",
+ "desc" : "Sets the Color of the specified node to this Color. This functions sets\nthe CSS 'color' property for the node. The parameter is:",
+ "sig" : "(node)",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
+ "params" : [
+ {
+ "name" : "node",
+ "type" : "DomElement",
+ "desc" : "- the node whose Color should be set",
+ "isOptional" : false
+ }
+ ],
"returns" : []
- },
+ }
+ ],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "implementations" : [
+ "Roo.lib.HSLColor",
+ "Roo.lib.HSVColor",
+ "Roo.lib.RGBColor"
+ ],
+ "tree_children" : [],
+ "tree_parent" : []
+ },
+ "Roo.lib.Dom" : {
+ "props" : [],
+ "events" : [],
+ "methods" : [
{
- "name" : "clearTicks",
+ "name" : "getDocumentHeight",
"type" : "function",
- "desc" : "Clears any tick interval defined for this instance",
+ "desc" : "Get the Full Document height",
"sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.dd.DragDrop",
- "isStatic" : false,
+ "static" : true,
+ "memberOf" : "",
+ "isStatic" : true,
"isConstructor" : false,
"isPrivate" : false,
"example" : "",
"exceptions" : "",
"requires" : "",
"params" : [],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Number",
+ "desc" : "The height"
+ }
+ ]
},
{
- "name" : "createFrame",
+ "name" : "getDocumentWidth",
"type" : "function",
- "desc" : "Creates the proxy element if it does not yet exist",
+ "desc" : "Get the Full Document width",
"sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.dd.DDProxy",
- "isStatic" : false,
+ "static" : true,
+ "memberOf" : "",
+ "isStatic" : true,
"isConstructor" : false,
"isPrivate" : false,
"example" : "",
"exceptions" : "",
"requires" : "",
"params" : [],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Number",
+ "desc" : "The width"
+ }
+ ]
},
{
- "name" : "endDrag",
+ "name" : "getViewHeight",
"type" : "function",
- "desc" : "Fired when we are done dragging the object",
- "sig" : "(e)",
- "static" : false,
- "memberOf" : "Roo.dd.DragDrop",
- "isStatic" : false,
+ "desc" : "Get the view height",
+ "sig" : "(full)",
+ "static" : true,
+ "memberOf" : "",
+ "isStatic" : true,
"isConstructor" : false,
"isPrivate" : false,
"example" : "",
"requires" : "",
"params" : [
{
- "name" : "e",
- "type" : "Event",
- "desc" : "the mouseup event",
+ "name" : "full",
+ "type" : "Boolean",
+ "desc" : "True will get the full document, otherwise it's the view height",
"isOptional" : false
}
],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Number",
+ "desc" : "The height"
+ }
+ ]
},
{
- "name" : "fireEvent",
+ "name" : "getViewWidth",
"type" : "function",
- "desc" : "Fires the specified event with the passed parameters (minus the event name).",
- "sig" : "(eventName, args)",
- "static" : false,
- "memberOf" : "Roo.util.Observable",
- "isStatic" : false,
+ "desc" : "Get the view width",
+ "sig" : "(full)",
+ "static" : true,
+ "memberOf" : "",
+ "isStatic" : true,
"isConstructor" : false,
"isPrivate" : false,
"example" : "",
"requires" : "",
"params" : [
{
- "name" : "eventName",
- "type" : "String",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "args",
- "type" : "Object...",
- "desc" : "Variable number of parameters are passed to handlers",
+ "name" : "full",
+ "type" : "Boolean",
+ "desc" : "True will get the full document, otherwise it's the view width",
"isOptional" : false
}
],
"returns" : [
{
"name" : "",
- "type" : "Boolean",
- "desc" : "returns false if any of the handlers return false otherwise it returns true"
+ "type" : "Number",
+ "desc" : "The width"
}
]
},
{
- "name" : "getDragEl",
+ "name" : "getViewportHeight",
"type" : "function",
- "desc" : "Returns a reference to the actual element to drag. By default this is\nthe same as the html element, but it can be assigned to another\nelement. An example of this can be found in Roo.dd.DDProxy",
+ "desc" : "Get the Window Viewport height",
"sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.dd.DragDrop",
- "isStatic" : false,
+ "static" : true,
+ "memberOf" : "",
+ "isStatic" : true,
"isConstructor" : false,
"isPrivate" : false,
"example" : "",
"returns" : [
{
"name" : "",
- "type" : "HTMLElement",
- "desc" : "the html element"
+ "type" : "Number",
+ "desc" : "The height"
}
]
},
{
- "name" : "getEl",
+ "name" : "getViewportWidth",
"type" : "function",
- "desc" : "Returns a reference to the linked element",
+ "desc" : "Get the Window Viewport width",
"sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.dd.DragDrop",
- "isStatic" : false,
+ "static" : true,
+ "memberOf" : "",
+ "isStatic" : true,
"isConstructor" : false,
"isPrivate" : false,
"example" : "",
"returns" : [
{
"name" : "",
- "type" : "HTMLElement",
- "desc" : "the html element"
+ "type" : "Number",
+ "desc" : "The width"
}
]
- },
+ }
+ ],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "implementations" : [],
+ "tree_children" : [],
+ "tree_parent" : []
+ },
+ "Roo.lib.HSLColor" : {
+ "props" : [],
+ "events" : [],
+ "methods" : [
{
- "name" : "hasListener",
+ "name" : "getCSSHSL",
"type" : "function",
- "desc" : "Checks to see if this object has any listeners for a specified event",
- "sig" : "(eventName)",
+ "desc" : "getCSSHSL",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.util.Observable",
+ "memberOf" : "Roo.lib.Color",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
+ "params" : [],
+ "returns" : [
{
- "name" : "eventName",
+ "name" : "",
"type" : "String",
- "desc" : "The name of the event to check for",
- "isOptional" : false
+ "desc" : "a string representing this Color as a CSS HSL Color value - that\nis, a string of the form hsl(h,s%,l%) where h is in the range [0,100] and\ns and l are in the range [0,100]."
}
- ],
+ ]
+ },
+ {
+ "name" : "getCSSHSLA",
+ "type" : "function",
+ "desc" : "getCSSHSLA",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.lib.Color",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
"returns" : [
{
"name" : "",
- "type" : "Boolean",
- "desc" : "True if the event is being listened for, else false"
+ "type" : "String",
+ "desc" : "a string representing this Color as a CSS HSLA Color value - that\nis, a string of the form hsla(h,s%,l%,a) where h is in the range [0,100],\ns and l are in the range [0,100], and a is in the range [0,1]."
}
]
},
{
- "name" : "init",
+ "name" : "getCSSHexadecimalRGB",
"type" : "function",
- "desc" : "Sets up the DragDrop object. Must be called in the constructor of any\nRoo.dd.DragDrop subclass",
- "sig" : "(id, sGroup, config)",
+ "desc" : "getCSSHexadecimalRGB",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop",
+ "memberOf" : "Roo.lib.Color",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "id",
- "type" : "",
- "desc" : "the id of the linked element",
- "isOptional" : false
- },
+ "params" : [],
+ "returns" : [
{
- "name" : "sGroup",
+ "name" : "",
"type" : "String",
- "desc" : "the group of related items",
- "isOptional" : false
- },
- {
- "name" : "config",
- "type" : "object",
- "desc" : "configuration attributes",
- "isOptional" : false
+ "desc" : "a string representing this Color as a CSS hexadecimal RGB Color\nvalue - that is, a string of the form #RRGGBB where each of RR, GG, and BB\nare two-digit hexadecimal numbers."
}
- ],
- "returns" : []
+ ]
},
{
- "name" : "initFrame",
+ "name" : "getCSSIntegerRGB",
"type" : "function",
- "desc" : "Initialization for the drag frame element. Must be called in the\nconstructor of all subclasses",
+ "desc" : "getCSSIntegerRGB",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.dd.DDProxy",
+ "memberOf" : "Roo.lib.Color",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"exceptions" : "",
"requires" : "",
"params" : [],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "String",
+ "desc" : "a string representing this Color as a CSS integer RGB Color\nvalue - that is, a string of the form rgb(r,g,b) where each of r, g, and b\nare integers in the range [0,255]."
+ }
+ ]
},
{
- "name" : "initTarget",
+ "name" : "getCSSIntegerRGBA",
"type" : "function",
- "desc" : "Initializes Targeting functionality only... the object does not\nget a mousedown handler.",
- "sig" : "(id, sGroup, config)",
+ "desc" : "getCSSIntegerRGBA",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop",
+ "memberOf" : "Roo.lib.Color",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "id",
- "type" : "",
- "desc" : "the id of the linked element",
- "isOptional" : false
- },
- {
- "name" : "sGroup",
- "type" : "String",
- "desc" : "the group of related items",
- "isOptional" : false
- },
- {
- "name" : "config",
- "type" : "object",
- "desc" : "configuration attributes",
- "isOptional" : false
+ "params" : [],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "String",
+ "desc" : "Returns a string representing this Color as a CSS integer RGBA Color\nvalue - that is, a string of the form rgba(r,g,b,a) where each of r, g, and\nb are integers in the range [0,255] and a is in the range [0,1]."
}
- ],
- "returns" : []
+ ]
},
{
- "name" : "isLocked",
+ "name" : "getCSSPercentageRGB",
"type" : "function",
- "desc" : "Returns true if this instance is locked, or the drag drop mgr is locked\n(meaning that all drag/drop is disabled on the page.)",
+ "desc" : "getCSSPercentageRGB",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop",
+ "memberOf" : "Roo.lib.Color",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"returns" : [
{
"name" : "",
- "type" : "boolean",
- "desc" : "true if this obj or all drag/drop is locked, else\nfalse"
+ "type" : "String",
+ "desc" : "a string representing this Color as a CSS percentage RGB Color\nvalue - that is, a string of the form rgb(r%,g%,b%) where each of r, g, and\nb are in the range [0,100]."
}
]
},
{
- "name" : "isTarget",
+ "name" : "getCSSPercentageRGBA",
"type" : "function",
- "desc" : "By default, all insances can be a drop target. This can be disabled by\nsetting isTarget to false.",
+ "desc" : "getCSSPercentageRGBA",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop",
+ "memberOf" : "Roo.lib.Color",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"exceptions" : "",
"requires" : "",
"params" : [],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "String",
+ "desc" : "a string representing this Color as a CSS percentage RGBA Color\nvalue - that is, a string of the form rgba(r%,g%,b%,a) where each of r, g,\nand b are in the range [0,100] and a is in the range [0,1]."
+ }
+ ]
},
{
- "name" : "isValidHandleChild",
+ "name" : "getHSL",
"type" : "function",
- "desc" : "Checks the tag exclusion list to see if this click should be ignored",
- "sig" : "(node)",
+ "desc" : "getHSL",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop",
+ "memberOf" : "Roo.lib.Color",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "node",
- "type" : "HTMLElement",
- "desc" : "the HTMLElement to evaluate",
- "isOptional" : false
- }
- ],
+ "params" : [],
"returns" : [
{
"name" : "",
- "type" : "boolean",
- "desc" : "true if this is a valid tag type, false if not"
+ "type" : "Object",
+ "desc" : "the HSL and alpha components of this Color as an object with h,\ns, l, and a properties. h is in the range [0,360), s and l are in the range\n[0,100], and a is in the range [0,1]."
}
]
},
{
- "name" : "lock",
+ "name" : "getHSV",
"type" : "function",
- "desc" : "Lock this instance",
+ "desc" : "getHSV",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop",
+ "memberOf" : "Roo.lib.Color",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"exceptions" : "",
"requires" : "",
"params" : [],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Object",
+ "desc" : "the HSV and alpha components of this Color as an object with h,\ns, v, and a properties. h is in the range [0,360), s and v are in the range\n[0,100], and a is in the range [0,1]."
+ }
+ ]
},
{
- "name" : "on",
+ "name" : "getIntegerRGB",
"type" : "function",
- "desc" : "Appends an event handler to this element (shorthand for addListener)",
- "sig" : "(eventName, handler, scope, options)",
+ "desc" : "getIntegerRGB",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.util.Observable",
+ "memberOf" : "Roo.lib.Color",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "eventName",
- "type" : "String",
- "desc" : "The type of event to listen for",
- "isOptional" : false
- },
- {
- "name" : "handler",
- "type" : "Function",
- "desc" : "The method the event invokes",
- "isOptional" : false
- },
- {
- "name" : "scope",
- "type" : "Object",
- "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
- "isOptional" : false
- },
+ "params" : [],
+ "returns" : [
{
- "name" : "options",
+ "name" : "",
"type" : "Object",
- "desc" : "(optional)",
- "isOptional" : false
+ "desc" : "an object representing the RGBA components of this Color. The red,\ngreen, and blue components are converted to integers in the range [0,255].\nThe alpha is a value in the range [0,1]."
}
- ],
- "returns" : []
+ ]
},
{
- "name" : "onAvailable",
+ "name" : "getPercentageRGB",
"type" : "function",
- "desc" : "Override the onAvailable method to do what is needed after the initial\nposition was determined.",
+ "desc" : "getPercentageRGB",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop",
+ "memberOf" : "Roo.lib.Color",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"exceptions" : "",
"requires" : "",
"params" : [],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Object",
+ "desc" : "an object representing the RGBA components of this Color. The red,\ngreen, and blue components are converted to numbers in the range [0,100].\nThe alpha is a value in the range [0,1]."
+ }
+ ]
},
{
- "name" : "onDrag",
+ "name" : "getRGB",
"type" : "function",
- "desc" : "Abstract method called during the onMouseMove event while dragging an\nobject.",
- "sig" : "(e)",
+ "desc" : "getRGB",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop",
+ "memberOf" : "Roo.lib.Color",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
+ "params" : [],
+ "returns" : [
{
- "name" : "e",
- "type" : "Event",
- "desc" : "the mousemove event",
- "isOptional" : false
+ "name" : "",
+ "type" : "Object",
+ "desc" : "the RGB and alpha components of this Color as an object with r,\ng, b, and a properties. r, g, and b are in the range [0,255] and a is in\nthe range [0,1]."
}
- ],
- "returns" : []
+ ]
},
{
- "name" : "onDragDrop",
+ "name" : "setNodeBackgroundColor",
"type" : "function",
- "desc" : "Abstract method called when this item is dropped on another DragDrop\nobj",
- "sig" : "(e, id)",
+ "desc" : "Sets the background Color of the specified node to this Color. This\nfunctions sets the CSS 'background-color' property for the node. The\nparameter is:",
+ "sig" : "(node)",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop",
+ "memberOf" : "Roo.lib.Color",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "e",
- "type" : "Event",
- "desc" : "the mouseup event",
- "isOptional" : false
- },
- {
- "name" : "id",
- "type" : "String|DragDrop[]",
- "desc" : "In POINT mode, the element\nid this was dropped on. In INTERSECT mode, an array of dd items this\nwas dropped on.",
+ "name" : "node",
+ "type" : "DomElement",
+ "desc" : "- the node whose background Color should be set",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "onDragEnter",
+ "name" : "setNodeColor",
"type" : "function",
- "desc" : "Abstract method called when this element fist begins hovering over\nanother DragDrop obj",
- "sig" : "(e, id)",
+ "desc" : "Sets the Color of the specified node to this Color. This functions sets\nthe CSS 'color' property for the node. The parameter is:",
+ "sig" : "(node)",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop",
+ "memberOf" : "Roo.lib.Color",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "e",
- "type" : "Event",
- "desc" : "the mousemove event",
- "isOptional" : false
- },
- {
- "name" : "id",
- "type" : "String|DragDrop[]",
- "desc" : "In POINT mode, the element\nid this is hovering over. In INTERSECT mode, an array of one or more\ndragdrop items being hovered over.",
+ "name" : "node",
+ "type" : "DomElement",
+ "desc" : "- the node whose Color should be set",
"isOptional" : false
}
],
"returns" : []
- },
+ }
+ ],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "implementations" : [],
+ "tree_children" : [],
+ "tree_parent" : []
+ },
+ "Roo.lib.HSVColor" : {
+ "props" : [],
+ "events" : [],
+ "methods" : [
{
- "name" : "onDragOut",
+ "name" : "getCSSHSL",
"type" : "function",
- "desc" : "Abstract method called when we are no longer hovering over an element",
- "sig" : "(e, id)",
+ "desc" : "getCSSHSL",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop",
+ "memberOf" : "Roo.lib.Color",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "e",
- "type" : "Event",
- "desc" : "the mousemove event",
- "isOptional" : false
- },
+ "params" : [],
+ "returns" : [
{
- "name" : "id",
- "type" : "String|DragDrop[]",
- "desc" : "In POINT mode, the element\nid this was hovering over. In INTERSECT mode, an array of dd items\nthat the mouse is no longer over.",
- "isOptional" : false
+ "name" : "",
+ "type" : "String",
+ "desc" : "a string representing this Color as a CSS HSL Color value - that\nis, a string of the form hsl(h,s%,l%) where h is in the range [0,100] and\ns and l are in the range [0,100]."
}
- ],
- "returns" : []
+ ]
},
{
- "name" : "onDragOver",
+ "name" : "getCSSHSLA",
"type" : "function",
- "desc" : "Abstract method called when this element is hovering over another\nDragDrop obj",
- "sig" : "(e, id)",
+ "desc" : "getCSSHSLA",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop",
+ "memberOf" : "Roo.lib.Color",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "e",
- "type" : "Event",
- "desc" : "the mousemove event",
- "isOptional" : false
- },
+ "params" : [],
+ "returns" : [
{
- "name" : "id",
- "type" : "String|DragDrop[]",
- "desc" : "In POINT mode, the element\nid this is hovering over. In INTERSECT mode, an array of dd items\nbeing hovered over.",
- "isOptional" : false
+ "name" : "",
+ "type" : "String",
+ "desc" : "a string representing this Color as a CSS HSLA Color value - that\nis, a string of the form hsla(h,s%,l%,a) where h is in the range [0,100],\ns and l are in the range [0,100], and a is in the range [0,1]."
}
- ],
- "returns" : []
+ ]
},
{
- "name" : "onInvalidDrop",
+ "name" : "getCSSHexadecimalRGB",
"type" : "function",
- "desc" : "Abstract method called when this item is dropped on an area with no\ndrop target",
- "sig" : "(e)",
+ "desc" : "getCSSHexadecimalRGB",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop",
+ "memberOf" : "Roo.lib.Color",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
+ "params" : [],
+ "returns" : [
{
- "name" : "e",
- "type" : "Event",
- "desc" : "the mouseup event",
- "isOptional" : false
+ "name" : "",
+ "type" : "String",
+ "desc" : "a string representing this Color as a CSS hexadecimal RGB Color\nvalue - that is, a string of the form #RRGGBB where each of RR, GG, and BB\nare two-digit hexadecimal numbers."
}
- ],
- "returns" : []
+ ]
},
{
- "name" : "onMouseDown",
+ "name" : "getCSSIntegerRGB",
"type" : "function",
- "desc" : "Event handler that fires when a drag/drop obj gets a mousedown",
- "sig" : "(e)",
+ "desc" : "getCSSIntegerRGB",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop",
+ "memberOf" : "Roo.lib.Color",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
+ "params" : [],
+ "returns" : [
{
- "name" : "e",
- "type" : "Event",
- "desc" : "the mousedown event",
- "isOptional" : false
+ "name" : "",
+ "type" : "String",
+ "desc" : "a string representing this Color as a CSS integer RGB Color\nvalue - that is, a string of the form rgb(r,g,b) where each of r, g, and b\nare integers in the range [0,255]."
}
- ],
- "returns" : []
+ ]
},
{
- "name" : "onMouseUp",
+ "name" : "getCSSIntegerRGBA",
"type" : "function",
- "desc" : "Event handler that fires when a drag/drop obj gets a mouseup",
- "sig" : "(e)",
+ "desc" : "getCSSIntegerRGBA",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop",
+ "memberOf" : "Roo.lib.Color",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
+ "params" : [],
+ "returns" : [
{
- "name" : "e",
- "type" : "Event",
- "desc" : "the mouseup event",
- "isOptional" : false
+ "name" : "",
+ "type" : "String",
+ "desc" : "Returns a string representing this Color as a CSS integer RGBA Color\nvalue - that is, a string of the form rgba(r,g,b,a) where each of r, g, and\nb are integers in the range [0,255] and a is in the range [0,1]."
}
- ],
- "returns" : []
+ ]
},
{
- "name" : "padding",
+ "name" : "getCSSPercentageRGB",
"type" : "function",
- "desc" : "The padding configured for this drag and drop object for calculating\nthe drop zone intersection with this object.",
+ "desc" : "getCSSPercentageRGB",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop",
+ "memberOf" : "Roo.lib.Color",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"exceptions" : "",
"requires" : "",
"params" : [],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "String",
+ "desc" : "a string representing this Color as a CSS percentage RGB Color\nvalue - that is, a string of the form rgb(r%,g%,b%) where each of r, g, and\nb are in the range [0,100]."
+ }
+ ]
},
{
- "name" : "purgeListeners",
+ "name" : "getCSSPercentageRGBA",
"type" : "function",
- "desc" : "Removes all listeners for this object",
+ "desc" : "getCSSPercentageRGBA",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.util.Observable",
+ "memberOf" : "Roo.lib.Color",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"exceptions" : "",
"requires" : "",
"params" : [],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "String",
+ "desc" : "a string representing this Color as a CSS percentage RGBA Color\nvalue - that is, a string of the form rgba(r%,g%,b%,a) where each of r, g,\nand b are in the range [0,100] and a is in the range [0,1]."
+ }
+ ]
},
{
- "name" : "releaseCapture",
+ "name" : "getHSL",
"type" : "function",
- "desc" : "Removes <b>all</b> added captures from the Observable.",
- "sig" : "(o)",
- "static" : true,
- "memberOf" : "Roo.util.Observable",
- "isStatic" : true,
+ "desc" : "getHSL",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.lib.Color",
+ "isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"example" : "",
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
+ "params" : [],
+ "returns" : [
{
- "name" : "o",
- "type" : "Observable",
- "desc" : "The Observable to release",
- "isOptional" : false
+ "name" : "",
+ "type" : "Object",
+ "desc" : "the HSL and alpha components of this Color as an object with h,\ns, l, and a properties. h is in the range [0,360), s and l are in the range\n[0,100], and a is in the range [0,1]."
}
- ],
- "returns" : []
+ ]
},
{
- "name" : "removeFromGroup",
+ "name" : "getHSV",
"type" : "function",
- "desc" : "Remove's this instance from the supplied interaction group",
- "sig" : "(sGroup)",
+ "desc" : "getHSV",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop",
+ "memberOf" : "Roo.lib.Color",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
+ "params" : [],
+ "returns" : [
{
- "name" : "sGroup",
- "type" : "string",
- "desc" : "The group to drop",
- "isOptional" : false
+ "name" : "",
+ "type" : "Object",
+ "desc" : "the HSV and alpha components of this Color as an object with h,\ns, v, and a properties. h is in the range [0,360), s and v are in the range\n[0,100], and a is in the range [0,1]."
}
- ],
- "returns" : []
+ ]
},
{
- "name" : "removeInvalidHandleClass",
+ "name" : "getIntegerRGB",
"type" : "function",
- "desc" : "Unsets an invalid css class",
- "sig" : "(cssClass)",
+ "desc" : "getIntegerRGB",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop",
+ "memberOf" : "Roo.lib.Color",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
+ "params" : [],
+ "returns" : [
{
- "name" : "cssClass",
- "type" : "string",
- "desc" : "the class of the element(s) you wish to\nre-enable",
- "isOptional" : false
+ "name" : "",
+ "type" : "Object",
+ "desc" : "an object representing the RGBA components of this Color. The red,\ngreen, and blue components are converted to integers in the range [0,255].\nThe alpha is a value in the range [0,1]."
}
- ],
- "returns" : []
+ ]
},
{
- "name" : "removeInvalidHandleId",
+ "name" : "getPercentageRGB",
"type" : "function",
- "desc" : "Unsets an invalid handle id",
- "sig" : "(id)",
+ "desc" : "getPercentageRGB",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop",
+ "memberOf" : "Roo.lib.Color",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
+ "params" : [],
+ "returns" : [
{
- "name" : "id",
- "type" : "string",
- "desc" : "the id of the element to re-enable",
- "isOptional" : false
+ "name" : "",
+ "type" : "Object",
+ "desc" : "an object representing the RGBA components of this Color. The red,\ngreen, and blue components are converted to numbers in the range [0,100].\nThe alpha is a value in the range [0,1]."
}
- ],
- "returns" : []
+ ]
},
{
- "name" : "removeInvalidHandleType",
+ "name" : "getRGB",
"type" : "function",
- "desc" : "Unsets an excluded tag name set by addInvalidHandleType",
- "sig" : "(tagName)",
+ "desc" : "getRGB",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop",
+ "memberOf" : "Roo.lib.Color",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
+ "params" : [],
+ "returns" : [
{
- "name" : "tagName",
- "type" : "string",
- "desc" : "the type of element to unexclude",
- "isOptional" : false
+ "name" : "",
+ "type" : "Object",
+ "desc" : "the RGB and alpha components of this Color as an object with r,\ng, b, and a properties. r, g, and b are in the range [0,255] and a is in\nthe range [0,1]."
}
- ],
- "returns" : []
+ ]
},
{
- "name" : "removeListener",
+ "name" : "setNodeBackgroundColor",
"type" : "function",
- "desc" : "Removes a listener",
- "sig" : "(eventName, handler, scope)",
+ "desc" : "Sets the background Color of the specified node to this Color. This\nfunctions sets the CSS 'background-color' property for the node. The\nparameter is:",
+ "sig" : "(node)",
"static" : false,
- "memberOf" : "Roo.util.Observable",
+ "memberOf" : "Roo.lib.Color",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "eventName",
- "type" : "String",
- "desc" : "The type of event to listen for",
- "isOptional" : false
- },
- {
- "name" : "handler",
- "type" : "Function",
- "desc" : "The handler to remove",
- "isOptional" : false
- },
- {
- "name" : "scope",
- "type" : "Object",
- "desc" : "(optional) The scope (this object) for the handler",
+ "name" : "node",
+ "type" : "DomElement",
+ "desc" : "- the node whose background Color should be set",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "resetConstraints",
+ "name" : "setNodeColor",
"type" : "function",
- "desc" : "resetConstraints must be called if you manually reposition a dd element.",
- "sig" : "(maintainOffset)",
+ "desc" : "Sets the Color of the specified node to this Color. This functions sets\nthe CSS 'color' property for the node. The parameter is:",
+ "sig" : "(node)",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop",
+ "memberOf" : "Roo.lib.Color",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "maintainOffset",
- "type" : "boolean",
- "desc" : "",
+ "name" : "node",
+ "type" : "DomElement",
+ "desc" : "- the node whose Color should be set",
"isOptional" : false
}
],
"returns" : []
- },
+ }
+ ],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "implementations" : [],
+ "tree_children" : [],
+ "tree_parent" : []
+ },
+ "Roo.lib.RGBColor" : {
+ "props" : [],
+ "events" : [],
+ "methods" : [
{
- "name" : "setDelta",
+ "name" : "getCSSHSL",
"type" : "function",
- "desc" : "Sets the pointer offset. You can call this directly to force the\noffset to be in a particular location (e.g., pass in 0,0 to set it\nto the center of the object)",
- "sig" : "(iDeltaX, iDeltaY)",
+ "desc" : "getCSSHSL",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.dd.DD",
+ "memberOf" : "Roo.lib.Color",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "iDeltaX",
- "type" : "int",
- "desc" : "the distance from the left",
- "isOptional" : false
- },
+ "params" : [],
+ "returns" : [
{
- "name" : "iDeltaY",
- "type" : "int",
- "desc" : "the distance from the top",
- "isOptional" : false
+ "name" : "",
+ "type" : "String",
+ "desc" : "a string representing this Color as a CSS HSL Color value - that\nis, a string of the form hsl(h,s%,l%) where h is in the range [0,100] and\ns and l are in the range [0,100]."
}
- ],
- "returns" : []
+ ]
},
{
- "name" : "setDragElId",
+ "name" : "getCSSHSLA",
"type" : "function",
- "desc" : "Allows you to specify that an element other than the linked element\nwill be moved with the cursor during a drag",
- "sig" : "(id)",
+ "desc" : "getCSSHSLA",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop",
+ "memberOf" : "Roo.lib.Color",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
+ "params" : [],
+ "returns" : [
{
- "name" : "id",
- "type" : "",
- "desc" : "{string} the id of the element that will be used to initiate the drag",
- "isOptional" : false
+ "name" : "",
+ "type" : "String",
+ "desc" : "a string representing this Color as a CSS HSLA Color value - that\nis, a string of the form hsla(h,s%,l%,a) where h is in the range [0,100],\ns and l are in the range [0,100], and a is in the range [0,1]."
}
- ],
- "returns" : []
+ ]
},
{
- "name" : "setDragElPos",
+ "name" : "getCSSHexadecimalRGB",
"type" : "function",
- "desc" : "Sets the drag element to the location of the mousedown or click event,\nmaintaining the cursor location relative to the location on the element\nthat was clicked. Override this if you want to place the element in a\nlocation other than where the cursor is.",
- "sig" : "(iPageX, iPageY)",
+ "desc" : "getCSSHexadecimalRGB",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.dd.DD",
+ "memberOf" : "Roo.lib.Color",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "iPageX",
- "type" : "int",
- "desc" : "the X coordinate of the mousedown or drag event",
- "isOptional" : false
- },
+ "params" : [],
+ "returns" : [
{
- "name" : "iPageY",
- "type" : "int",
- "desc" : "the Y coordinate of the mousedown or drag event",
- "isOptional" : false
+ "name" : "",
+ "type" : "String",
+ "desc" : "a string representing this Color as a CSS hexadecimal RGB Color\nvalue - that is, a string of the form #RRGGBB where each of RR, GG, and BB\nare two-digit hexadecimal numbers."
}
- ],
- "returns" : []
+ ]
},
{
- "name" : "setHandleElId",
+ "name" : "getCSSIntegerRGB",
"type" : "function",
- "desc" : "Allows you to specify a child of the linked element that should be\nused to initiate the drag operation. An example of this would be if\nyou have a content div with text and links. Clicking anywhere in the\ncontent area would normally start the drag operation. Use this method\nto specify that an element inside of the content div is the element\nthat starts the drag operation.",
- "sig" : "(id)",
+ "desc" : "getCSSIntegerRGB",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop",
+ "memberOf" : "Roo.lib.Color",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
+ "params" : [],
+ "returns" : [
{
- "name" : "id",
- "type" : "",
- "desc" : "{string} the id of the element that will be used to\ninitiate the drag.",
- "isOptional" : false
+ "name" : "",
+ "type" : "String",
+ "desc" : "a string representing this Color as a CSS integer RGB Color\nvalue - that is, a string of the form rgb(r,g,b) where each of r, g, and b\nare integers in the range [0,255]."
}
- ],
- "returns" : []
+ ]
},
{
- "name" : "setInitPosition",
+ "name" : "getCSSIntegerRGBA",
"type" : "function",
- "desc" : "Stores the initial placement of the linked element.",
- "sig" : "(diffX, diffY)",
+ "desc" : "getCSSIntegerRGBA",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop",
+ "memberOf" : "Roo.lib.Color",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "diffX",
- "type" : "int",
- "desc" : "the X offset, default 0",
- "isOptional" : false
- },
+ "params" : [],
+ "returns" : [
{
- "name" : "diffY",
- "type" : "int",
- "desc" : "the Y offset, default 0",
- "isOptional" : false
+ "name" : "",
+ "type" : "String",
+ "desc" : "Returns a string representing this Color as a CSS integer RGBA Color\nvalue - that is, a string of the form rgba(r,g,b,a) where each of r, g, and\nb are integers in the range [0,255] and a is in the range [0,1]."
}
- ],
- "returns" : []
+ ]
},
{
- "name" : "setOuterHandleElId",
+ "name" : "getCSSPercentageRGB",
"type" : "function",
- "desc" : "Allows you to set an element outside of the linked element as a drag\nhandle",
- "sig" : "(id)",
+ "desc" : "getCSSPercentageRGB",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop",
+ "memberOf" : "Roo.lib.Color",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
+ "params" : [],
+ "returns" : [
{
- "name" : "id",
- "type" : "",
- "desc" : "the id of the element that will be used to initiate the drag",
- "isOptional" : false
+ "name" : "",
+ "type" : "String",
+ "desc" : "a string representing this Color as a CSS percentage RGB Color\nvalue - that is, a string of the form rgb(r%,g%,b%) where each of r, g, and\nb are in the range [0,100]."
}
- ],
- "returns" : []
+ ]
},
{
- "name" : "setPadding",
+ "name" : "getCSSPercentageRGBA",
"type" : "function",
- "desc" : "Configures the padding for the target zone in px. Effectively expands\n(or reduces) the virtual object size for targeting calculations.\nSupports css-style shorthand; if only one parameter is passed, all sides\nwill have that padding, and if only two are passed, the top and bottom\nwill have the first param, the left and right the second.",
- "sig" : "(iTop, iRight, iBot, iLeft)",
+ "desc" : "getCSSPercentageRGBA",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop",
+ "memberOf" : "Roo.lib.Color",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "iTop",
- "type" : "int",
- "desc" : "Top pad",
- "isOptional" : false
- },
- {
- "name" : "iRight",
- "type" : "int",
- "desc" : "Right pad",
- "isOptional" : false
- },
- {
- "name" : "iBot",
- "type" : "int",
- "desc" : "Bot pad",
- "isOptional" : false
- },
+ "params" : [],
+ "returns" : [
{
- "name" : "iLeft",
- "type" : "int",
- "desc" : "Left pad",
- "isOptional" : false
+ "name" : "",
+ "type" : "String",
+ "desc" : "a string representing this Color as a CSS percentage RGBA Color\nvalue - that is, a string of the form rgba(r%,g%,b%,a) where each of r, g,\nand b are in the range [0,100] and a is in the range [0,1]."
}
- ],
- "returns" : []
+ ]
},
{
- "name" : "setXConstraint",
+ "name" : "getHSL",
"type" : "function",
- "desc" : "By default, the element can be dragged any place on the screen. Use\nthis method to limit the horizontal travel of the element. Pass in\n0,0 for the parameters if you want to lock the drag to the y axis.",
- "sig" : "(iLeft, iRight, iTickSize)",
+ "desc" : "getHSL",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop",
+ "memberOf" : "Roo.lib.Color",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "iLeft",
- "type" : "int",
- "desc" : "the number of pixels the element can move to the left",
- "isOptional" : false
- },
- {
- "name" : "iRight",
- "type" : "int",
- "desc" : "the number of pixels the element can move to the\nright",
- "isOptional" : false
- },
+ "params" : [],
+ "returns" : [
{
- "name" : "iTickSize",
- "type" : "int",
- "desc" : "optional parameter for specifying that the\nelement\nshould move iTickSize pixels at a time.",
- "isOptional" : false
+ "name" : "",
+ "type" : "Object",
+ "desc" : "the HSL and alpha components of this Color as an object with h,\ns, l, and a properties. h is in the range [0,360), s and l are in the range\n[0,100], and a is in the range [0,1]."
}
- ],
- "returns" : []
+ ]
},
{
- "name" : "setYConstraint",
+ "name" : "getHSV",
"type" : "function",
- "desc" : "By default, the element can be dragged any place on the screen. Set\nthis to limit the vertical travel of the element. Pass in 0,0 for the\nparameters if you want to lock the drag to the x axis.",
- "sig" : "(iUp, iDown, iTickSize)",
+ "desc" : "getHSV",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop",
+ "memberOf" : "Roo.lib.Color",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "iUp",
- "type" : "int",
- "desc" : "the number of pixels the element can move up",
- "isOptional" : false
- },
- {
- "name" : "iDown",
- "type" : "int",
- "desc" : "the number of pixels the element can move down",
- "isOptional" : false
- },
+ "params" : [],
+ "returns" : [
{
- "name" : "iTickSize",
- "type" : "int",
- "desc" : "optional parameter for specifying that the\nelement should move iTickSize pixels at a time.",
- "isOptional" : false
+ "name" : "",
+ "type" : "Object",
+ "desc" : "the HSV and alpha components of this Color as an object with h,\ns, v, and a properties. h is in the range [0,360), s and v are in the range\n[0,100], and a is in the range [0,1]."
}
- ],
- "returns" : []
+ ]
},
{
- "name" : "startDrag",
+ "name" : "getIntegerRGB",
"type" : "function",
- "desc" : "Abstract method called after a drag/drop object is clicked\nand the drag or mousedown time thresholds have beeen met.",
- "sig" : "(X, Y)",
+ "desc" : "getIntegerRGB",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop",
+ "memberOf" : "Roo.lib.Color",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "X",
- "type" : "int",
- "desc" : "click location",
- "isOptional" : false
- },
+ "params" : [],
+ "returns" : [
{
- "name" : "Y",
- "type" : "int",
- "desc" : "click location",
- "isOptional" : false
+ "name" : "",
+ "type" : "Object",
+ "desc" : "an object representing the RGBA components of this Color. The red,\ngreen, and blue components are converted to integers in the range [0,255].\nThe alpha is a value in the range [0,1]."
}
- ],
- "returns" : []
+ ]
},
{
- "name" : "toString",
+ "name" : "getPercentageRGB",
"type" : "function",
- "desc" : "toString method",
+ "desc" : "getPercentageRGB",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop",
+ "memberOf" : "Roo.lib.Color",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"returns" : [
{
"name" : "",
- "type" : "string",
- "desc" : "string representation of the dd obj"
+ "type" : "Object",
+ "desc" : "an object representing the RGBA components of this Color. The red,\ngreen, and blue components are converted to numbers in the range [0,100].\nThe alpha is a value in the range [0,1]."
}
]
},
{
- "name" : "un",
+ "name" : "getRGB",
"type" : "function",
- "desc" : "Removes a listener (shorthand for removeListener)",
- "sig" : "(eventName, handler, scope)",
+ "desc" : "getRGB",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.util.Observable",
+ "memberOf" : "Roo.lib.Color",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "eventName",
- "type" : "String",
- "desc" : "The type of event to listen for",
- "isOptional" : false
- },
- {
- "name" : "handler",
- "type" : "Function",
- "desc" : "The handler to remove",
- "isOptional" : false
- },
+ "params" : [],
+ "returns" : [
{
- "name" : "scope",
+ "name" : "",
"type" : "Object",
- "desc" : "(optional) The scope (this object) for the handler",
- "isOptional" : false
+ "desc" : "the RGB and alpha components of this Color as an object with r,\ng, b, and a properties. r, g, and b are in the range [0,255] and a is in\nthe range [0,1]."
}
- ],
- "returns" : []
+ ]
},
{
- "name" : "unlock",
+ "name" : "setNodeBackgroundColor",
"type" : "function",
- "desc" : "Unlock this instace",
- "sig" : "()\n{\n\n}",
+ "desc" : "Sets the background Color of the specified node to this Color. This\nfunctions sets the CSS 'background-color' property for the node. The\nparameter is:",
+ "sig" : "(node)",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop",
+ "memberOf" : "Roo.lib.Color",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
+ "params" : [
+ {
+ "name" : "node",
+ "type" : "DomElement",
+ "desc" : "- the node whose background Color should be set",
+ "isOptional" : false
+ }
+ ],
"returns" : []
},
{
- "name" : "unreg",
+ "name" : "setNodeColor",
"type" : "function",
- "desc" : "Remove all drag and drop hooks for this element",
- "sig" : "()\n{\n\n}",
+ "desc" : "Sets the Color of the specified node to this Color. This functions sets\nthe CSS 'color' property for the node. The parameter is:",
+ "sig" : "(node)",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop",
+ "memberOf" : "Roo.lib.Color",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
+ "params" : [
+ {
+ "name" : "node",
+ "type" : "DomElement",
+ "desc" : "- the node whose Color should be set",
+ "isOptional" : false
+ }
+ ],
"returns" : []
}
],
"isAbstract" : false,
"isBuilderTop" : false,
- "childClasses" : { },
- "tree_children" : [],
- "tree_parent" : []
- },
- "Roo.lib" : {
- "props" : [],
- "events" : [],
- "methods" : [],
- "isAbstract" : false,
- "isBuilderTop" : false,
- "childClasses" : { },
+ "implementations" : [],
"tree_children" : [],
"tree_parent" : []
},
- "Roo.lib.Ajax" : {
+ "Roo.lib.Range" : {
"props" : [],
"events" : [],
"methods" : [
{
- "name" : "request",
+ "name" : "wrap",
"type" : "function",
- "desc" : "",
- "sig" : "()\n{\n\n}",
+ "desc" : "Wrap a Dom Range object, to give it new features...",
+ "sig" : "(the)",
"static" : true,
"memberOf" : "",
"isStatic" : true,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
+ "params" : [
+ {
+ "name" : "the",
+ "type" : "Range",
+ "desc" : "range to wrap",
+ "isOptional" : false
+ }
+ ],
"returns" : []
}
],
"isAbstract" : false,
"isBuilderTop" : false,
- "childClasses" : { },
+ "implementations" : [],
"tree_children" : [],
"tree_parent" : []
},
- "Roo.lib.Dom" : {
+ "Roo.lib.Selection" : {
"props" : [],
"events" : [],
"methods" : [
{
- "name" : "getViewHeight",
+ "name" : "insertNode",
"type" : "function",
- "desc" : "Get the view height",
- "sig" : "(full)",
- "static" : true,
+ "desc" : "insert node at selection",
+ "sig" : "(node, cursor)",
+ "static" : false,
"memberOf" : "",
- "isStatic" : true,
+ "isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"example" : "",
"requires" : "",
"params" : [
{
- "name" : "full",
- "type" : "Boolean",
- "desc" : "True will get the full document, otherwise it's the view height",
+ "name" : "node",
+ "type" : "DomElement|string",
+ "desc" : "",
"isOptional" : false
- }
- ],
- "returns" : [
+ },
{
- "name" : "",
- "type" : "Number",
- "desc" : "The height"
+ "name" : "cursor",
+ "type" : "string",
+ "desc" : "(after|in|none) where to place the cursor after inserting.",
+ "isOptional" : false
}
- ]
+ ],
+ "returns" : []
},
{
- "name" : "getViewWidth",
+ "name" : "wrap",
"type" : "function",
- "desc" : "Get the view width",
- "sig" : "(full)",
+ "desc" : "Wrap a Dom Range object, to give it new features...",
+ "sig" : "(the)",
"static" : true,
"memberOf" : "",
"isStatic" : true,
"requires" : "",
"params" : [
{
- "name" : "full",
- "type" : "Boolean",
- "desc" : "True will get the full document, otherwise it's the view width",
+ "name" : "the",
+ "type" : "Range",
+ "desc" : "range to wrap",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ }
+ ],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "implementations" : [],
+ "tree_children" : [],
+ "tree_parent" : []
+ },
+ "Roo.lib.UndoManager" : {
+ "props" : [],
+ "events" : [],
+ "methods" : [
+ {
+ "name" : "addEvent",
+ "type" : "function",
+ "desc" : "Manually add an event.\nNormall called without arguements - and it will just get added to the stack.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
+ {
+ "name" : "reset",
+ "type" : "function",
+ "desc" : "Reset the undo - probaly done on load to clear all history.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
+ {
+ "name" : "transact",
+ "type" : "function",
+ "desc" : "To push and execute a transaction, the method undoManager.transact\nmust be called by passing a transaction object as the first argument, and a merge\nflag as the second argument. A transaction object has the following properties:\n\nUsage:\n<pre><code>\nundoManager.transact({\n label: 'Typing',\n execute: function() { ... },\n undo: function() { ... },\n // redo same as execute\n redo: function() { this.execute(); }\n}, false);\n\n// merge transaction\nundoManager.transact({\n label: 'Typing',\n execute: function() { ... }, // this will be run...\n undo: function() { ... }, // what to do when undo is run.\n // redo same as execute\n redo: function() { this.execute(); }\n}, true); \n</code></pre>",
+ "sig" : "(transaction)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "transaction",
+ "type" : "Object",
+ "desc" : "The transaction to add to the stack.",
"isOptional" : false
}
],
"returns" : [
{
"name" : "",
- "type" : "Number",
- "desc" : "The width"
+ "type" : "String",
+ "desc" : "The HTML fragment"
}
]
}
],
"isAbstract" : false,
"isBuilderTop" : false,
- "childClasses" : { },
+ "implementations" : [],
"tree_children" : [],
"tree_parent" : []
},
"methods" : [],
"isAbstract" : false,
"isBuilderTop" : false,
- "childClasses" : { },
+ "implementations" : [],
"tree_children" : [],
"tree_parent" : []
},
"name" : "actionMode",
"type" : "String",
"desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el' for forms you probably want to set this to fieldEl",
- "memberOf" : "Roo.Component"
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"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"
+ "memberOf" : "Roo.menu.BaseItem",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "allowDomMove",
"type" : "Boolean",
"desc" : "Whether the component can move the Dom node when rendering (defaults to true).",
- "memberOf" : "Roo.Component"
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "canActivate",
"type" : "Boolean",
"desc" : "True if this item can be visually activated (defaults to false)",
- "memberOf" : "Roo.menu.BaseItem"
+ "memberOf" : "Roo.menu.BaseItem",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "disableClass",
"type" : "String",
"desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").",
- "memberOf" : "Roo.Component"
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "handler",
"type" : "Function",
"desc" : "A function that will handle the click event of this menu item (defaults to undefined)",
- "memberOf" : "Roo.menu.BaseItem"
+ "memberOf" : "Roo.menu.BaseItem",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "hidden",
"type" : "Boolean",
"desc" : "True to prevent creation of this menu item (defaults to false)",
- "memberOf" : "Roo.menu.BaseItem"
+ "memberOf" : "Roo.menu.BaseItem",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "hideDelay",
"type" : "Number",
"desc" : "Length of time in milliseconds to wait before hiding after a click (defaults to 100)",
- "memberOf" : "Roo.menu.BaseItem"
+ "memberOf" : "Roo.menu.BaseItem",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "hideMode",
"type" : "String",
- "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".",
- "memberOf" : "Roo.Component"
+ "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display",
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : [
+ "display",
+ "visibility"
+ ]
},
{
"name" : "hideOnClick",
"type" : "Boolean",
"desc" : "True to hide the containing menu after this item is clicked (defaults to true)",
- "memberOf" : "Roo.menu.BaseItem"
+ "memberOf" : "Roo.menu.BaseItem",
+ "isOptional" : false,
+ "optvals" : []
},
{
"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"
+ "memberOf" : "Roo.util.Observable",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "style",
+ "type" : "String",
+ "desc" : "css styles to add to component\neg. text-align:right;",
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
}
],
"events" : [
],
"isAbstract" : true,
"isBuilderTop" : false,
- "childClasses" : {
- "Roo.menu.Adapter" : [
- "Roo.menu.ColorItem",
- "Roo.menu.DateItem"
- ]
- },
+ "implementations" : [
+ "Roo.menu.ColorItem",
+ "Roo.menu.DateItem"
+ ],
"tree_children" : [],
"tree_parent" : []
},
"name" : "actionMode",
"type" : "String",
"desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el' for forms you probably want to set this to fieldEl",
- "memberOf" : "Roo.Component"
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "activeClass",
"type" : "String",
"desc" : "The CSS class to use when the item becomes activated (defaults to \"x-menu-item-active\")",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "allowDomMove",
"type" : "Boolean",
"desc" : "Whether the component can move the Dom node when rendering (defaults to true).",
- "memberOf" : "Roo.Component"
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "canActivate",
"type" : "Boolean",
"desc" : "True if this item can be visually activated (defaults to false)",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "disableClass",
"type" : "String",
"desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").",
- "memberOf" : "Roo.Component"
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "handler",
"type" : "Function",
"desc" : "A function that will handle the click event of this menu item (defaults to undefined)",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "hidden",
"type" : "Boolean",
"desc" : "True to prevent creation of this menu item (defaults to false)",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "hideDelay",
"type" : "Number",
"desc" : "Length of time in milliseconds to wait before hiding after a click (defaults to 100)",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "hideMode",
"type" : "String",
- "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".",
- "memberOf" : "Roo.Component"
+ "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display",
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : [
+ "display",
+ "visibility"
+ ]
},
{
"name" : "hideOnClick",
"type" : "Boolean",
"desc" : "True to hide the containing menu after this item is clicked (defaults to true)",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"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"
+ "memberOf" : "Roo.util.Observable",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "style",
+ "type" : "String",
+ "desc" : "css styles to add to component\neg. text-align:right;",
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
}
],
"events" : [
],
"isAbstract" : true,
"isBuilderTop" : false,
- "childClasses" : {
- "Roo.menu.BaseItem" : [
- "Roo.menu.Adapter",
- "Roo.menu.Item",
- "Roo.menu.Separator",
- "Roo.menu.TextItem"
- ],
- "Roo.menu.Adapter" : [
- "Roo.menu.ColorItem",
- "Roo.menu.DateItem"
- ],
- "Roo.menu.Item" : [
- "Roo.menu.CheckItem"
- ]
- },
+ "implementations" : [
+ "Roo.menu.Adapter",
+ "Roo.menu.CheckItem",
+ "Roo.menu.ColorItem",
+ "Roo.menu.DateItem",
+ "Roo.menu.Item",
+ "Roo.menu.Separator",
+ "Roo.menu.TextItem"
+ ],
"tree_children" : [],
"tree_parent" : []
},
"Roo.menu.CheckItem" : {
"props" : [
- {
- "name" : "HTML",
- "type" : "String",
- "desc" : "to render in menu\nThe text to show on the menu item (HTML version).",
- "memberOf" : "Roo.menu.Item"
- },
{
"name" : "actionMode",
"type" : "String",
"desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el' for forms you probably want to set this to fieldEl",
- "memberOf" : "Roo.Component"
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"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"
+ "memberOf" : "Roo.menu.BaseItem",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "allowDomMove",
"type" : "Boolean",
"desc" : "Whether the component can move the Dom node when rendering (defaults to true).",
- "memberOf" : "Roo.Component"
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "canActivate",
"type" : "Boolean",
"desc" : "True if this item can be visually activated (defaults to true)",
- "memberOf" : "Roo.menu.Item"
+ "memberOf" : "Roo.menu.Item",
+ "isOptional" : false,
+ "optvals" : []
},
{
"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" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "disableClass",
"type" : "String",
"desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").",
- "memberOf" : "Roo.Component"
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"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" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "groupClass",
"type" : "String",
"desc" : "The default CSS class to use for radio group check items (defaults to \"x-menu-group-item\")",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "handler",
"type" : "Function",
"desc" : "A function that will handle the click event of this menu item (defaults to undefined)",
- "memberOf" : "Roo.menu.BaseItem"
+ "memberOf" : "Roo.menu.BaseItem",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "hidden",
"type" : "Boolean",
"desc" : "True to prevent creation of this menu item (defaults to false)",
- "memberOf" : "Roo.menu.BaseItem"
+ "memberOf" : "Roo.menu.BaseItem",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "hideDelay",
"type" : "Number",
"desc" : "Length of time in milliseconds to wait before hiding after a click (defaults to 100)",
- "memberOf" : "Roo.menu.BaseItem"
+ "memberOf" : "Roo.menu.BaseItem",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "hideMode",
"type" : "String",
- "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".",
- "memberOf" : "Roo.Component"
+ "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display",
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : [
+ "display",
+ "visibility"
+ ]
},
{
"name" : "hideOnClick",
"type" : "Boolean",
"desc" : "True to hide the containing menu after this item is clicked (defaults to true)",
- "memberOf" : "Roo.menu.BaseItem"
+ "memberOf" : "Roo.menu.BaseItem",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "html",
+ "type" : "String",
+ "desc" : "to render in menu\nThe text to show on the menu item (HTML version).",
+ "memberOf" : "Roo.menu.Item",
+ "isOptional" : false,
+ "optvals" : []
},
{
"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"
+ "memberOf" : "Roo.menu.Item",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "itemCls",
"type" : "String",
"desc" : "The default CSS class to use for check items (defaults to \"x-menu-item x-menu-check-item\")",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"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"
+ "memberOf" : "Roo.util.Observable",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "menu",
"type" : "Roo.menu.Menu",
"desc" : "A Sub menu",
- "memberOf" : "Roo.menu.Item"
+ "memberOf" : "Roo.menu.Item",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "showDelay",
"type" : "Number",
"desc" : "Length of time in milliseconds to wait before showing this item (defaults to 200)",
- "memberOf" : "Roo.menu.Item"
+ "memberOf" : "Roo.menu.Item",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "style",
+ "type" : "String",
+ "desc" : "css styles to add to component\neg. text-align:right;",
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "text",
"type" : "String",
"desc" : "The text to show on the menu item.",
- "memberOf" : "Roo.menu.Item"
+ "memberOf" : "Roo.menu.Item",
+ "isOptional" : false,
+ "optvals" : []
}
],
"events" : [
],
"isAbstract" : false,
"isBuilderTop" : false,
- "childClasses" : { },
+ "implementations" : [],
"tree_children" : [],
"tree_parent" : []
},
"name" : "actionMode",
"type" : "String",
"desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el' for forms you probably want to set this to fieldEl",
- "memberOf" : "Roo.Component"
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"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"
+ "memberOf" : "Roo.menu.BaseItem",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "allowDomMove",
"type" : "Boolean",
"desc" : "Whether the component can move the Dom node when rendering (defaults to true).",
- "memberOf" : "Roo.Component"
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "canActivate",
"type" : "Boolean",
"desc" : "True if this item can be visually activated (defaults to false)",
- "memberOf" : "Roo.menu.BaseItem"
+ "memberOf" : "Roo.menu.BaseItem",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "disableClass",
"type" : "String",
"desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").",
- "memberOf" : "Roo.Component"
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "handler",
"type" : "Function",
"desc" : "A function that will handle the click event of this menu item (defaults to undefined)",
- "memberOf" : "Roo.menu.BaseItem"
+ "memberOf" : "Roo.menu.BaseItem",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "hidden",
"type" : "Boolean",
"desc" : "True to prevent creation of this menu item (defaults to false)",
- "memberOf" : "Roo.menu.BaseItem"
+ "memberOf" : "Roo.menu.BaseItem",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "hideDelay",
"type" : "Number",
"desc" : "Length of time in milliseconds to wait before hiding after a click (defaults to 100)",
- "memberOf" : "Roo.menu.BaseItem"
+ "memberOf" : "Roo.menu.BaseItem",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "hideMode",
"type" : "String",
- "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".",
- "memberOf" : "Roo.Component"
+ "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display",
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : [
+ "display",
+ "visibility"
+ ]
},
{
"name" : "hideOnClick",
"type" : "Boolean",
"desc" : "True to hide the containing menu after this item is clicked (defaults to true)",
- "memberOf" : "Roo.menu.BaseItem"
+ "memberOf" : "Roo.menu.BaseItem",
+ "isOptional" : false,
+ "optvals" : []
},
{
"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"
+ "memberOf" : "Roo.util.Observable",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "style",
+ "type" : "String",
+ "desc" : "css styles to add to component\neg. text-align:right;",
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
}
],
"events" : [
],
"isAbstract" : false,
"isBuilderTop" : false,
- "childClasses" : { },
+ "implementations" : [],
"tree_children" : [],
"tree_parent" : []
},
"name" : "allowOtherMenus",
"type" : "Boolean",
"desc" : "True to allow multiple menus to be displayed at the same time (defaults to false)",
- "memberOf" : "Roo.menu.Menu"
+ "memberOf" : "Roo.menu.Menu",
+ "isOptional" : false,
+ "optvals" : []
},
{
"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"
+ "memberOf" : "Roo.menu.Menu",
+ "isOptional" : false,
+ "optvals" : []
},
{
"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"
+ "memberOf" : "Roo.util.Observable",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "minWidth",
"type" : "Number",
"desc" : "The minimum width of the menu in pixels (defaults to 120)",
- "memberOf" : "Roo.menu.Menu"
+ "memberOf" : "Roo.menu.Menu",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "registerMenu",
"type" : "Boolean",
"desc" : "True (default) - means that clicking on screen etc. hides it.",
- "memberOf" : "Roo.menu.Menu"
+ "memberOf" : "Roo.menu.Menu",
+ "isOptional" : false,
+ "optvals" : []
},
{
"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"
+ "memberOf" : "Roo.menu.Menu",
+ "isOptional" : false,
+ "optvals" : []
},
{
"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"
+ "memberOf" : "Roo.menu.Menu",
+ "isOptional" : false,
+ "optvals" : []
}
],
"events" : [
],
"isAbstract" : false,
"isBuilderTop" : false,
- "childClasses" : { },
+ "implementations" : [],
"tree_children" : [],
"tree_parent" : []
},
"name" : "actionMode",
"type" : "String",
"desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el' for forms you probably want to set this to fieldEl",
- "memberOf" : "Roo.Component"
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"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"
+ "memberOf" : "Roo.menu.BaseItem",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "allowDomMove",
"type" : "Boolean",
"desc" : "Whether the component can move the Dom node when rendering (defaults to true).",
- "memberOf" : "Roo.Component"
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "canActivate",
"type" : "Boolean",
"desc" : "True if this item can be visually activated (defaults to false)",
- "memberOf" : "Roo.menu.BaseItem"
+ "memberOf" : "Roo.menu.BaseItem",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "disableClass",
"type" : "String",
"desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").",
- "memberOf" : "Roo.Component"
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "handler",
"type" : "Function",
"desc" : "A function that will handle the click event of this menu item (defaults to undefined)",
- "memberOf" : "Roo.menu.BaseItem"
+ "memberOf" : "Roo.menu.BaseItem",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "hidden",
"type" : "Boolean",
"desc" : "True to prevent creation of this menu item (defaults to false)",
- "memberOf" : "Roo.menu.BaseItem"
+ "memberOf" : "Roo.menu.BaseItem",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "hideDelay",
"type" : "Number",
"desc" : "Length of time in milliseconds to wait before hiding after a click (defaults to 100)",
- "memberOf" : "Roo.menu.BaseItem"
+ "memberOf" : "Roo.menu.BaseItem",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "hideMode",
"type" : "String",
- "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".",
- "memberOf" : "Roo.Component"
+ "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display",
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : [
+ "display",
+ "visibility"
+ ]
},
{
"name" : "hideOnClick",
"type" : "Boolean",
"desc" : "True to hide the containing menu after this item is clicked (defaults to true)",
- "memberOf" : "Roo.menu.BaseItem"
+ "memberOf" : "Roo.menu.BaseItem",
+ "isOptional" : false,
+ "optvals" : []
},
{
"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"
+ "memberOf" : "Roo.util.Observable",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "style",
+ "type" : "String",
+ "desc" : "css styles to add to component\neg. text-align:right;",
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
}
],
"events" : [
],
"isAbstract" : false,
"isBuilderTop" : false,
- "childClasses" : { },
+ "implementations" : [],
"tree_children" : [],
"tree_parent" : []
},
"name" : "allowOtherMenus",
"type" : "Boolean",
"desc" : "True to allow multiple menus to be displayed at the same time (defaults to false)",
- "memberOf" : "Roo.menu.Menu"
+ "memberOf" : "Roo.menu.Menu",
+ "isOptional" : false,
+ "optvals" : []
},
{
"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"
+ "memberOf" : "Roo.menu.Menu",
+ "isOptional" : false,
+ "optvals" : []
},
{
"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"
+ "memberOf" : "Roo.util.Observable",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "minWidth",
"type" : "Number",
"desc" : "The minimum width of the menu in pixels (defaults to 120)",
- "memberOf" : "Roo.menu.Menu"
+ "memberOf" : "Roo.menu.Menu",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "registerMenu",
"type" : "Boolean",
"desc" : "True (default) - means that clicking on screen etc. hides it.",
- "memberOf" : "Roo.menu.Menu"
+ "memberOf" : "Roo.menu.Menu",
+ "isOptional" : false,
+ "optvals" : []
},
{
"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"
+ "memberOf" : "Roo.menu.Menu",
+ "isOptional" : false,
+ "optvals" : []
},
{
"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"
+ "memberOf" : "Roo.menu.Menu",
+ "isOptional" : false,
+ "optvals" : []
}
],
"events" : [
],
"isAbstract" : false,
"isBuilderTop" : false,
- "childClasses" : { },
+ "implementations" : [],
"tree_children" : [],
"tree_parent" : []
},
"Roo.menu.Item" : {
"props" : [
- {
- "name" : "HTML",
- "type" : "String",
- "desc" : "to render in menu\nThe text to show on the menu item (HTML version).",
- "memberOf" : ""
- },
{
"name" : "actionMode",
"type" : "String",
"desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el' for forms you probably want to set this to fieldEl",
- "memberOf" : "Roo.Component"
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"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"
+ "memberOf" : "Roo.menu.BaseItem",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "allowDomMove",
"type" : "Boolean",
"desc" : "Whether the component can move the Dom node when rendering (defaults to true).",
- "memberOf" : "Roo.Component"
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "canActivate",
"type" : "Boolean",
"desc" : "True if this item can be visually activated (defaults to true)",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "disableClass",
"type" : "String",
"desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").",
- "memberOf" : "Roo.Component"
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "handler",
"type" : "Function",
"desc" : "A function that will handle the click event of this menu item (defaults to undefined)",
- "memberOf" : "Roo.menu.BaseItem"
+ "memberOf" : "Roo.menu.BaseItem",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "hidden",
"type" : "Boolean",
"desc" : "True to prevent creation of this menu item (defaults to false)",
- "memberOf" : "Roo.menu.BaseItem"
+ "memberOf" : "Roo.menu.BaseItem",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "hideDelay",
"type" : "Number",
"desc" : "Length of time in milliseconds to wait before hiding after a click (defaults to 100)",
- "memberOf" : "Roo.menu.BaseItem"
+ "memberOf" : "Roo.menu.BaseItem",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "hideMode",
"type" : "String",
- "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".",
- "memberOf" : "Roo.Component"
+ "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display",
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : [
+ "display",
+ "visibility"
+ ]
},
{
"name" : "hideOnClick",
"type" : "Boolean",
"desc" : "True to hide the containing menu after this item is clicked (defaults to true)",
- "memberOf" : "Roo.menu.BaseItem"
+ "memberOf" : "Roo.menu.BaseItem",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "html",
+ "type" : "String",
+ "desc" : "to render in menu\nThe text to show on the menu item (HTML version).",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "icon",
"type" : "String",
"desc" : "The path to an icon to display in this menu item (defaults to Roo.BLANK_IMAGE_URL)",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "itemCls",
"type" : "String",
"desc" : "The default CSS class to use for menu items (defaults to \"x-menu-item\")",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"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"
+ "memberOf" : "Roo.util.Observable",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "menu",
"type" : "Roo.menu.Menu",
"desc" : "A Sub menu",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "showDelay",
"type" : "Number",
"desc" : "Length of time in milliseconds to wait before showing this item (defaults to 200)",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "style",
+ "type" : "String",
+ "desc" : "css styles to add to component\neg. text-align:right;",
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "text",
"type" : "String",
"desc" : "The text to show on the menu item.",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
}
],
"events" : [
],
"isAbstract" : false,
"isBuilderTop" : false,
- "childClasses" : {
- "Roo.menu.Item" : [
- "Roo.menu.CheckItem"
- ]
- },
+ "implementations" : [
+ "Roo.menu.CheckItem"
+ ],
"tree_children" : [],
"tree_parent" : []
},
"name" : "allowOtherMenus",
"type" : "Boolean",
"desc" : "True to allow multiple menus to be displayed at the same time (defaults to false)",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"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" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"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"
+ "memberOf" : "Roo.util.Observable",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "minWidth",
"type" : "Number",
"desc" : "The minimum width of the menu in pixels (defaults to 120)",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "registerMenu",
"type" : "Boolean",
"desc" : "True (default) - means that clicking on screen etc. hides it.",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"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" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"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" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
}
],
"events" : [
],
"isAbstract" : false,
"isBuilderTop" : false,
- "childClasses" : {
- "Roo.menu.Menu" : [
- "Roo.menu.ColorMenu",
- "Roo.menu.DateMenu"
- ]
- },
+ "implementations" : [
+ "Roo.menu.ColorMenu",
+ "Roo.menu.DateMenu"
+ ],
"tree_children" : [
- "Roo.menu.CheckItem",
- "Roo.menu.ColorItem",
- "Roo.menu.DateItem",
"Roo.menu.Item",
+ "Roo.menu.CheckItem",
"Roo.menu.Separator",
"Roo.menu.TextItem"
],
],
"isAbstract" : false,
"isBuilderTop" : false,
- "childClasses" : { },
+ "implementations" : [],
"tree_children" : [],
"tree_parent" : []
},
"name" : "actionMode",
"type" : "String",
"desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el' for forms you probably want to set this to fieldEl",
- "memberOf" : "Roo.Component"
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"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"
+ "memberOf" : "Roo.menu.BaseItem",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "allowDomMove",
"type" : "Boolean",
"desc" : "Whether the component can move the Dom node when rendering (defaults to true).",
- "memberOf" : "Roo.Component"
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "canActivate",
"type" : "Boolean",
"desc" : "True if this item can be visually activated (defaults to false)",
- "memberOf" : "Roo.menu.BaseItem"
+ "memberOf" : "Roo.menu.BaseItem",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "disableClass",
"type" : "String",
"desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").",
- "memberOf" : "Roo.Component"
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "handler",
"type" : "Function",
"desc" : "A function that will handle the click event of this menu item (defaults to undefined)",
- "memberOf" : "Roo.menu.BaseItem"
+ "memberOf" : "Roo.menu.BaseItem",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "hidden",
"type" : "Boolean",
"desc" : "True to prevent creation of this menu item (defaults to false)",
- "memberOf" : "Roo.menu.BaseItem"
+ "memberOf" : "Roo.menu.BaseItem",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "hideDelay",
"type" : "Number",
"desc" : "Length of time in milliseconds to wait before hiding after a click (defaults to 100)",
- "memberOf" : "Roo.menu.BaseItem"
+ "memberOf" : "Roo.menu.BaseItem",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "hideMode",
"type" : "String",
- "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".",
- "memberOf" : "Roo.Component"
+ "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display",
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : [
+ "display",
+ "visibility"
+ ]
},
{
"name" : "hideOnClick",
"type" : "Boolean",
"desc" : "True to hide the containing menu after this item is clicked (defaults to false)",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "itemCls",
"type" : "String",
"desc" : "The default CSS class to use for separators (defaults to \"x-menu-sep\")",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"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"
+ "memberOf" : "Roo.util.Observable",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "style",
+ "type" : "String",
+ "desc" : "css styles to add to component\neg. text-align:right;",
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
}
],
"events" : [
],
"isAbstract" : false,
"isBuilderTop" : false,
- "childClasses" : { },
+ "implementations" : [],
"tree_children" : [],
"tree_parent" : []
},
"name" : "actionMode",
"type" : "String",
"desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el' for forms you probably want to set this to fieldEl",
- "memberOf" : "Roo.Component"
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"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"
+ "memberOf" : "Roo.menu.BaseItem",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "allowDomMove",
"type" : "Boolean",
"desc" : "Whether the component can move the Dom node when rendering (defaults to true).",
- "memberOf" : "Roo.Component"
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "canActivate",
"type" : "Boolean",
"desc" : "True if this item can be visually activated (defaults to false)",
- "memberOf" : "Roo.menu.BaseItem"
+ "memberOf" : "Roo.menu.BaseItem",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "disableClass",
"type" : "String",
"desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").",
- "memberOf" : "Roo.Component"
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "handler",
"type" : "Function",
"desc" : "A function that will handle the click event of this menu item (defaults to undefined)",
- "memberOf" : "Roo.menu.BaseItem"
+ "memberOf" : "Roo.menu.BaseItem",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "hidden",
"type" : "Boolean",
"desc" : "True to prevent creation of this menu item (defaults to false)",
- "memberOf" : "Roo.menu.BaseItem"
+ "memberOf" : "Roo.menu.BaseItem",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "hideDelay",
"type" : "Number",
"desc" : "Length of time in milliseconds to wait before hiding after a click (defaults to 100)",
- "memberOf" : "Roo.menu.BaseItem"
+ "memberOf" : "Roo.menu.BaseItem",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "hideMode",
"type" : "String",
- "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".",
- "memberOf" : "Roo.Component"
+ "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display",
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : [
+ "display",
+ "visibility"
+ ]
},
{
"name" : "hideOnClick",
"type" : "Boolean",
"desc" : "True to hide the containing menu after this item is clicked (defaults to false)",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "itemCls",
"type" : "String",
"desc" : "The default CSS class to use for text items (defaults to \"x-menu-text\")",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"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"
+ "memberOf" : "Roo.util.Observable",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "style",
+ "type" : "String",
+ "desc" : "css styles to add to component\neg. text-align:right;",
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "text",
"type" : "String",
"desc" : "Text to show on item.",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
}
],
"events" : [
],
"isAbstract" : false,
"isBuilderTop" : false,
- "childClasses" : { },
+ "implementations" : [],
+ "tree_children" : [],
+ "tree_parent" : []
+ },
+ "Roo.rtf" : {
+ "props" : [],
+ "events" : [],
+ "methods" : [],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "implementations" : [],
"tree_children" : [],
"tree_parent" : []
},
"methods" : [],
"isAbstract" : false,
"isBuilderTop" : false,
- "childClasses" : { },
+ "implementations" : [],
"tree_children" : [],
"tree_parent" : []
},
"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" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "expires",
"type" : "Date",
"desc" : "The cookie expiration date (defaults to 7 days from now)",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"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" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "secure",
"type" : "Boolean",
"desc" : "True if the site is using SSL (defaults to false)",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
}
],
"events" : [
],
"isAbstract" : false,
"isBuilderTop" : false,
- "childClasses" : { },
+ "implementations" : [],
"tree_children" : [],
"tree_parent" : []
},
],
"isAbstract" : false,
"isBuilderTop" : false,
- "childClasses" : { },
+ "implementations" : [],
"tree_children" : [],
"tree_parent" : []
},
],
"isAbstract" : false,
"isBuilderTop" : false,
- "childClasses" : {
- "Roo.state.Provider" : [
- "Roo.state.CookieProvider"
- ]
- },
+ "implementations" : [
+ "Roo.state.CookieProvider"
+ ],
"tree_children" : [],
"tree_parent" : []
},
"methods" : [],
"isAbstract" : false,
"isBuilderTop" : false,
- "childClasses" : { },
+ "implementations" : [],
"tree_children" : [],
"tree_parent" : []
},
"name" : "allowDrag",
"type" : "Boolean",
"desc" : "false to make this node undraggable if DD is on (defaults to true)",
- "memberOf" : "Roo.tree.TreeNode"
+ "memberOf" : "Roo.tree.TreeNode",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "allowDrop",
"type" : "Boolean",
"desc" : "false if this node cannot be drop on",
- "memberOf" : "Roo.tree.TreeNode"
+ "memberOf" : "Roo.tree.TreeNode",
+ "isOptional" : false,
+ "optvals" : []
},
{
"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"
+ "memberOf" : "Roo.tree.TreeNode",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "cls",
"type" : "String",
"desc" : "A css class to be added to the node",
- "memberOf" : "Roo.tree.TreeNode"
+ "memberOf" : "Roo.tree.TreeNode",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "disabled",
"type" : "Boolean",
"desc" : "true to start the node disabled",
- "memberOf" : "Roo.tree.TreeNode"
+ "memberOf" : "Roo.tree.TreeNode",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "expanded",
"type" : "Boolean",
"desc" : "true to start the node expanded",
- "memberOf" : "Roo.tree.TreeNode"
+ "memberOf" : "Roo.tree.TreeNode",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "href",
"type" : "String",
"desc" : "URL of the link used for the node (defaults to #)",
- "memberOf" : "Roo.tree.TreeNode"
+ "memberOf" : "Roo.tree.TreeNode",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "hrefTarget",
"type" : "String",
"desc" : "target frame for the link",
- "memberOf" : "Roo.tree.TreeNode"
+ "memberOf" : "Roo.tree.TreeNode",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "icon",
"type" : "String",
"desc" : "The path to an icon for the node. The preferred way to do this",
- "memberOf" : "Roo.tree.TreeNode"
+ "memberOf" : "Roo.tree.TreeNode",
+ "isOptional" : false,
+ "optvals" : []
},
{
"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"
+ "memberOf" : "Roo.tree.TreeNode",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "id",
"type" : "String",
"desc" : "The id for this node. If one is not specified, one is generated.",
- "memberOf" : "Roo.data.Node"
+ "memberOf" : "Roo.data.Node",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "leaf",
"type" : "Boolean",
"desc" : "true if this node is a leaf and does not have children",
- "memberOf" : "Roo.data.Node"
+ "memberOf" : "Roo.data.Node",
+ "isOptional" : false,
+ "optvals" : []
},
{
"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"
+ "memberOf" : "Roo.util.Observable",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "loader",
"type" : "TreeLoader",
"desc" : "A TreeLoader to be used by this node (defaults to the loader defined on the tree)",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "qtip",
"type" : "String",
"desc" : "An Ext QuickTip for the node",
- "memberOf" : "Roo.tree.TreeNode"
+ "memberOf" : "Roo.tree.TreeNode",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "qtipCfg",
"type" : "String",
"desc" : "An Ext QuickTip config for the node (used instead of qtip)",
- "memberOf" : "Roo.tree.TreeNode"
+ "memberOf" : "Roo.tree.TreeNode",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "singleClickExpand",
"type" : "Boolean",
"desc" : "True for single click expand on this node",
- "memberOf" : "Roo.tree.TreeNode"
+ "memberOf" : "Roo.tree.TreeNode",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "text",
"type" : "String",
"desc" : "The text for this node",
- "memberOf" : "Roo.tree.TreeNode"
+ "memberOf" : "Roo.tree.TreeNode",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "uiProvider",
"type" : "Function",
"desc" : "A UI <b>class</b> to use for this node (defaults to Roo.tree.TreeNodeUI)",
- "memberOf" : "Roo.tree.TreeNode"
+ "memberOf" : "Roo.tree.TreeNode",
+ "isOptional" : false,
+ "optvals" : []
}
],
"events" : [
],
"isAbstract" : false,
"isBuilderTop" : false,
- "childClasses" : { },
+ "implementations" : [],
"tree_children" : [],
"tree_parent" : []
},
"name" : "animate",
"type" : "Boolean",
"desc" : "true to enable animated expand/collapse (defaults to the value of Roo.enableFx)",
- "memberOf" : "Roo.tree.TreePanel"
+ "memberOf" : "Roo.tree.TreePanel",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "borderWidth",
"type" : "int",
"desc" : "compined right/left border allowance",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "columns",
"type" : "Object",
"desc" : "Including width, header, renderer, cls, dataIndex",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "containerScroll",
"type" : "Boolean",
"desc" : "true to register this container with ScrollManager",
- "memberOf" : "Roo.tree.TreePanel"
+ "memberOf" : "Roo.tree.TreePanel",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "ddAppendOnly",
"type" : "String",
"desc" : "True if the tree should only allow append drops (use for trees which are sorted)",
- "memberOf" : "Roo.tree.TreePanel"
+ "memberOf" : "Roo.tree.TreePanel",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "ddGroup",
"type" : "String",
"desc" : "The DD group this TreePanel belongs to",
- "memberOf" : "Roo.tree.TreePanel"
+ "memberOf" : "Roo.tree.TreePanel",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "ddScroll",
"type" : "Boolean",
"desc" : "true to enable YUI body scrolling",
- "memberOf" : "Roo.tree.TreePanel"
+ "memberOf" : "Roo.tree.TreePanel",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "dragConfig",
"type" : "Object",
"desc" : "Custom config to pass to the {@link Roo.tree.TreeDragZone} instance",
- "memberOf" : "Roo.tree.TreePanel"
+ "memberOf" : "Roo.tree.TreePanel",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "dropConfig",
"type" : "Object",
"desc" : "Custom config to pass to the {@link Roo.tree.TreeDropZone} instance",
- "memberOf" : "Roo.tree.TreePanel"
+ "memberOf" : "Roo.tree.TreePanel",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "editor",
"type" : "Roo.tree.TreeEditor",
"desc" : "The TreeEditor to display when clicked.",
- "memberOf" : "Roo.tree.TreePanel"
+ "memberOf" : "Roo.tree.TreePanel",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "enableDD",
"type" : "Boolean",
"desc" : "true to enable drag and drop",
- "memberOf" : "Roo.tree.TreePanel"
+ "memberOf" : "Roo.tree.TreePanel",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "enableDrag",
"type" : "Boolean",
"desc" : "true to enable just drag",
- "memberOf" : "Roo.tree.TreePanel"
+ "memberOf" : "Roo.tree.TreePanel",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "enableDrop",
"type" : "Boolean",
"desc" : "true to enable just drop",
- "memberOf" : "Roo.tree.TreePanel"
+ "memberOf" : "Roo.tree.TreePanel",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "hlColor",
"type" : "String",
"desc" : "The color of the node highlight (defaults to C3DAF9)",
- "memberOf" : "Roo.tree.TreePanel"
+ "memberOf" : "Roo.tree.TreePanel",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "hlDrop",
"type" : "Boolean",
"desc" : "false to disable node highlight on drop (defaults to the value of Roo.enableFx)",
- "memberOf" : "Roo.tree.TreePanel"
+ "memberOf" : "Roo.tree.TreePanel",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "lines",
"type" : "Boolean",
"desc" : "false to disable tree lines (defaults to true)",
- "memberOf" : "Roo.tree.TreePanel"
+ "memberOf" : "Roo.tree.TreePanel",
+ "isOptional" : false,
+ "optvals" : []
},
{
"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"
+ "memberOf" : "Roo.util.Observable",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "loader",
"type" : "Roo.tree.TreeLoader",
"desc" : "A TreeLoader for use with this TreePanel",
- "memberOf" : "Roo.tree.TreePanel"
+ "memberOf" : "Roo.tree.TreePanel",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "pathSeparator",
"type" : "String",
"desc" : "The token used to separate sub-paths in path strings (defaults to '/')",
- "memberOf" : "Roo.tree.TreePanel"
+ "memberOf" : "Roo.tree.TreePanel",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "renderer",
"type" : "Function",
"desc" : "DEPRECATED - use TreeLoader:create event / Sets the rendering (formatting) function for the nodes. to return HTML markup for the tree view. The render function is called with the following parameters:<ul><li>The {Object} The data for the node.</li></ul>",
- "memberOf" : "Roo.tree.TreePanel"
+ "memberOf" : "Roo.tree.TreePanel",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "rendererTip",
"type" : "Function",
"desc" : "DEPRECATED - use TreeLoader:create event / Sets the rendering (formatting) function for the nodes hovertip to return HTML markup for the tree view. The render function is called with the following parameters:<ul><li>The {Object} The data for the node.</li></ul>",
- "memberOf" : "Roo.tree.TreePanel"
+ "memberOf" : "Roo.tree.TreePanel",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "root",
"type" : "Roo.tree.TreeNode",
"desc" : "The root node",
- "memberOf" : "Roo.tree.TreePanel"
+ "memberOf" : "Roo.tree.TreePanel",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "rootVisible",
"type" : "Boolean",
"desc" : "false to hide the root node (defaults to true)",
- "memberOf" : "Roo.tree.TreePanel"
+ "memberOf" : "Roo.tree.TreePanel",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "selModel",
"type" : "Boolean",
"desc" : "A tree selection model to use with this TreePanel (defaults to a {@link Roo.tree.DefaultSelectionModel})",
- "memberOf" : "Roo.tree.TreePanel"
+ "memberOf" : "Roo.tree.TreePanel",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "singleExpand",
"type" : "Boolean",
"desc" : "true if only 1 node per branch may be expanded",
- "memberOf" : "Roo.tree.TreePanel"
+ "memberOf" : "Roo.tree.TreePanel",
+ "isOptional" : false,
+ "optvals" : []
}
],
"events" : [
],
"isAbstract" : false,
"isBuilderTop" : false,
- "childClasses" : { },
+ "implementations" : [],
"tree_children" : [],
"tree_parent" : []
},
"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"
+ "memberOf" : "Roo.util.Observable",
+ "isOptional" : false,
+ "optvals" : []
}
],
"events" : [
],
"isAbstract" : false,
"isBuilderTop" : false,
- "childClasses" : { },
+ "implementations" : [],
"tree_children" : [],
"tree_parent" : []
},
"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"
+ "memberOf" : "Roo.util.Observable",
+ "isOptional" : false,
+ "optvals" : []
}
],
"events" : [
],
"isAbstract" : false,
"isBuilderTop" : false,
- "childClasses" : { },
+ "implementations" : [],
"tree_children" : [],
"tree_parent" : []
},
"name" : "actionMode",
"type" : "String",
"desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el' for forms you probably want to set this to fieldEl",
- "memberOf" : "Roo.Component"
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "alignment",
"type" : "String",
"desc" : "The position to align to (see {@link Roo.Element#alignTo} for more details, defaults to \"l-l\").",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "allowDomMove",
"type" : "Boolean",
"desc" : "Whether the component can move the Dom node when rendering (defaults to true).",
- "memberOf" : "Roo.Component"
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"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"
+ "memberOf" : "Roo.Editor",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "cancelOnEsc",
"type" : "Boolean",
"desc" : "True to cancel the edit when the escape key is pressed (defaults to false)",
- "memberOf" : "Roo.Editor"
+ "memberOf" : "Roo.Editor",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "cls",
"type" : "String",
"desc" : "CSS class to apply to the editor (defaults to \"x-small-editor x-tree-editor\")",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "completeOnEnter",
"type" : "Boolean",
"desc" : "True to complete the edit when the enter key is pressed (defaults to false)",
- "memberOf" : "Roo.Editor"
+ "memberOf" : "Roo.Editor",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "constrain",
"type" : "Boolean",
"desc" : "True to constrain the editor to the viewport",
- "memberOf" : "Roo.Editor"
+ "memberOf" : "Roo.Editor",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "disableClass",
"type" : "String",
"desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").",
- "memberOf" : "Roo.Component"
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "field",
"type" : "Roo.form.TextField",
- "desc" : "[required] The field configuration",
- "memberOf" : ""
+ "desc" : "The field configuration",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "hideEl",
"type" : "Boolean",
"desc" : "True to hide the bound element while the editor is displayed (defaults to false)",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "hideMode",
"type" : "String",
- "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".",
- "memberOf" : "Roo.Component"
+ "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display",
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : [
+ "display",
+ "visibility"
+ ]
},
{
"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"
+ "memberOf" : "Roo.Editor",
+ "isOptional" : false,
+ "optvals" : []
},
{
"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"
+ "memberOf" : "Roo.util.Observable",
+ "isOptional" : false,
+ "optvals" : []
},
{
"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" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"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"
+ "memberOf" : "Roo.Editor",
+ "isOptional" : false,
+ "optvals" : []
},
{
"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"
+ "memberOf" : "Roo.Editor",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "shim",
"type" : "Boolean",
"desc" : "True to shim the editor if selects/iframes could be displayed beneath it (defaults to false)",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "style",
+ "type" : "String",
+ "desc" : "css styles to add to component\neg. text-align:right;",
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "tree",
"type" : "Roo.tree.TreePanel",
"desc" : "The tree to bind to.",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "updateEl",
"type" : "Boolean",
"desc" : "True to update the innerHTML of the bound element when the update completes (defaults to false)",
- "memberOf" : "Roo.Editor"
+ "memberOf" : "Roo.Editor",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "value",
"type" : "Mixed",
"desc" : "The data value of the underlying field (defaults to \"\")",
- "memberOf" : "Roo.Editor"
+ "memberOf" : "Roo.Editor",
+ "isOptional" : false,
+ "optvals" : []
}
],
"events" : [
],
"isAbstract" : false,
"isBuilderTop" : false,
- "childClasses" : { },
+ "implementations" : [],
"tree_children" : [],
"tree_parent" : []
},
],
"isAbstract" : false,
"isBuilderTop" : false,
- "childClasses" : { },
+ "implementations" : [],
"tree_children" : [],
"tree_parent" : []
},
"name" : "baseAttrs",
"type" : "Object",
"desc" : "(optional) An object containing attributes to be added to all nodes\ncreated by this loader. If the attributes sent by the server have an attribute in this object,\nthey take priority.",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "baseParams",
"type" : "Object",
"desc" : "(optional) An object containing properties which\nspecify HTTP parameters to be passed to each request for child nodes.",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "clearOnLoad",
"type" : "Boolean",
"desc" : "(optional) Default to true. Remove previously existing\nchild nodes before loading.",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "dataUrl",
"type" : "String",
"desc" : "The URL from which to request a Json string which\nspecifies an array of node definition object representing the child nodes\nto be loaded.",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"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"
+ "memberOf" : "Roo.util.Observable",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "queryParam",
"type" : "String",
"desc" : "(optional) \nName of the query as it will be passed on the querystring (defaults to 'node')\neg. the request will be ?node=[id]",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "requestMethod",
"type" : "String",
"desc" : "either GET or POST\ndefaults to POST (due to BC)\nto be loaded.",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "root",
"type" : "String",
"desc" : "(optional) Default to false. Use this to read data from an object \nproperty on loading, rather than expecting an array. (eg. more compatible to a standard\nGrid query { data : [ .....] }",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "uiProviders",
"type" : "Object",
"desc" : "(optional) An object containing properties which\n\nDEPRECATED - use 'create' event handler to modify attributes - which affect creation.\nspecify custom {@link Roo.tree.TreeNodeUI} implementations. If the optional\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" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
}
],
"events" : [
],
"isAbstract" : false,
"isBuilderTop" : false,
- "childClasses" : { },
+ "implementations" : [],
"tree_children" : [],
"tree_parent" : []
},
"name" : "allowDrag",
"type" : "Boolean",
"desc" : "false to make this node undraggable if DD is on (defaults to true)",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "allowDrop",
"type" : "Boolean",
"desc" : "false if this node cannot be drop on",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"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" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "cls",
"type" : "String",
"desc" : "A css class to be added to the node",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "disabled",
"type" : "Boolean",
"desc" : "true to start the node disabled",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "expanded",
"type" : "Boolean",
"desc" : "true to start the node expanded",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "href",
"type" : "String",
"desc" : "URL of the link used for the node (defaults to #)",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "hrefTarget",
"type" : "String",
"desc" : "target frame for the link",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "icon",
"type" : "String",
"desc" : "The path to an icon for the node. The preferred way to do this",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "iconCls",
"type" : "String",
"desc" : "A css class to be added to the nodes icon element for applying css background images",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "id",
"type" : "String",
"desc" : "The id for this node. If one is not specified, one is generated.",
- "memberOf" : "Roo.data.Node"
+ "memberOf" : "Roo.data.Node",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "leaf",
"type" : "Boolean",
"desc" : "true if this node is a leaf and does not have children",
- "memberOf" : "Roo.data.Node"
+ "memberOf" : "Roo.data.Node",
+ "isOptional" : false,
+ "optvals" : []
},
{
"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"
+ "memberOf" : "Roo.util.Observable",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "qtip",
"type" : "String",
"desc" : "An Ext QuickTip for the node",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "qtipCfg",
"type" : "String",
"desc" : "An Ext QuickTip config for the node (used instead of qtip)",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "singleClickExpand",
"type" : "Boolean",
"desc" : "True for single click expand on this node",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "text",
"type" : "String",
"desc" : "The text for this node",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "uiProvider",
"type" : "Function",
"desc" : "A UI <b>class</b> to use for this node (defaults to Roo.tree.TreeNodeUI)",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
}
],
"events" : [
],
"isAbstract" : false,
"isBuilderTop" : false,
- "childClasses" : {
- "Roo.tree.TreeNode" : [
- "Roo.tree.AsyncTreeNode"
- ]
- },
+ "implementations" : [
+ "Roo.tree.AsyncTreeNode"
+ ],
"tree_children" : [],
"tree_parent" : []
},
"methods" : [],
"isAbstract" : false,
"isBuilderTop" : false,
- "childClasses" : { },
+ "implementations" : [],
"tree_children" : [],
"tree_parent" : []
},
"name" : "animate",
"type" : "Boolean",
"desc" : "true to enable animated expand/collapse (defaults to the value of Roo.enableFx)",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "containerScroll",
"type" : "Boolean",
"desc" : "true to register this container with ScrollManager",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "ddAppendOnly",
"type" : "String",
"desc" : "True if the tree should only allow append drops (use for trees which are sorted)",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "ddGroup",
"type" : "String",
"desc" : "The DD group this TreePanel belongs to",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "ddScroll",
"type" : "Boolean",
"desc" : "true to enable YUI body scrolling",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "dragConfig",
"type" : "Object",
"desc" : "Custom config to pass to the {@link Roo.tree.TreeDragZone} instance",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "dropConfig",
"type" : "Object",
"desc" : "Custom config to pass to the {@link Roo.tree.TreeDropZone} instance",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "editor",
"type" : "Roo.tree.TreeEditor",
"desc" : "The TreeEditor to display when clicked.",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "enableDD",
"type" : "Boolean",
"desc" : "true to enable drag and drop",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "enableDrag",
"type" : "Boolean",
"desc" : "true to enable just drag",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "enableDrop",
"type" : "Boolean",
"desc" : "true to enable just drop",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "hlColor",
"type" : "String",
"desc" : "The color of the node highlight (defaults to C3DAF9)",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "hlDrop",
"type" : "Boolean",
"desc" : "false to disable node highlight on drop (defaults to the value of Roo.enableFx)",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "lines",
"type" : "Boolean",
"desc" : "false to disable tree lines (defaults to true)",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"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"
+ "memberOf" : "Roo.util.Observable",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "loader",
"type" : "Roo.tree.TreeLoader",
"desc" : "A TreeLoader for use with this TreePanel",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "pathSeparator",
"type" : "String",
"desc" : "The token used to separate sub-paths in path strings (defaults to '/')",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "renderer",
"type" : "Function",
"desc" : "DEPRECATED - use TreeLoader:create event / Sets the rendering (formatting) function for the nodes. to return HTML markup for the tree view. The render function is called with the following parameters:<ul><li>The {Object} The data for the node.</li></ul>",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "rendererTip",
"type" : "Function",
"desc" : "DEPRECATED - use TreeLoader:create event / Sets the rendering (formatting) function for the nodes hovertip to return HTML markup for the tree view. The render function is called with the following parameters:<ul><li>The {Object} The data for the node.</li></ul>",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "root",
"type" : "Roo.tree.TreeNode",
"desc" : "The root node",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "rootVisible",
"type" : "Boolean",
"desc" : "false to hide the root node (defaults to true)",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "selModel",
"type" : "Boolean",
"desc" : "A tree selection model to use with this TreePanel (defaults to a {@link Roo.tree.DefaultSelectionModel})",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "singleExpand",
"type" : "Boolean",
"desc" : "true if only 1 node per branch may be expanded",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
}
],
"events" : [
],
"isAbstract" : false,
"isBuilderTop" : false,
- "childClasses" : {
- "Roo.tree.TreePanel" : [
- "Roo.tree.ColumnTree"
- ]
- },
+ "implementations" : [
+ "Roo.tree.ColumnTree"
+ ],
"tree_children" : [],
"tree_parent" : []
},
"name" : "caseSensitive",
"type" : "Boolean",
"desc" : "true for case sensitive sort (defaults to false)",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "dir",
"type" : "String",
"desc" : "The direction to sort (asc or desc) (defaults to asc)",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "folderSort",
"type" : "Boolean",
"desc" : "True to sort leaf nodes under non leaf nodes",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "leafAttr",
"type" : "String",
"desc" : "The attribute used to determine leaf nodes in folder sort (defaults to \"leaf\")",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "property",
"type" : "String",
"desc" : "The named attribute on the node to sort by (defaults to text)",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "sortType",
"type" : "Function",
"desc" : "A custom \"casting\" function used to convert node values before sorting",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
}
],
"events" : [],
"methods" : [],
"isAbstract" : false,
"isBuilderTop" : false,
- "childClasses" : { },
+ "implementations" : [],
"tree_children" : [],
"tree_parent" : []
},
"methods" : [],
"isAbstract" : false,
"isBuilderTop" : false,
- "childClasses" : { },
+ "implementations" : [],
"tree_children" : [],
"tree_parent" : []
},
],
"isAbstract" : false,
"isBuilderTop" : false,
- "childClasses" : { },
+ "implementations" : [],
"tree_children" : [],
"tree_parent" : []
},
"name" : "accelerate",
"type" : "Boolean",
"desc" : "True if autorepeating should start slowly and accelerate.\n \"interval\" and \"delay\" are ignored. \"immediate\" is honored.",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "delay",
"type" : "Number",
"desc" : "The initial delay before the repeating event begins firing.\nSimilar to an autorepeat key delay.",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "el",
"type" : "String/HTMLElement/Element",
"desc" : "The element to act as a button.",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "interval",
"type" : "Number",
"desc" : "The interval between firings of the \"click\" event. Default 10 ms.",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"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"
+ "memberOf" : "Roo.util.Observable",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "pressClass",
"type" : "String",
"desc" : "A CSS class name to be applied to the element while pressed.",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "preventDefault",
"type" : "Boolean",
"desc" : "True to prevent the default click event",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "stopDefault",
"type" : "Boolean",
"desc" : "True to stop the default click event",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
}
],
"events" : [
],
"isAbstract" : false,
"isBuilderTop" : false,
- "childClasses" : { },
+ "implementations" : [],
"tree_children" : [],
"tree_parent" : []
},
],
"isAbstract" : false,
"isBuilderTop" : false,
- "childClasses" : { },
+ "implementations" : [],
"tree_children" : [],
"tree_parent" : []
},
"Roo.util.DelayedTask" : {
"props" : [],
"events" : [],
- "methods" : [],
+ "methods" : [
+ {
+ "name" : "cancel",
+ "type" : "function",
+ "desc" : "Cancel the last queued timeout",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
+ {
+ "name" : "delay",
+ "type" : "function",
+ "desc" : "Cancels any pending timeout and queues a new one",
+ "sig" : "(delay, newFn, newScope, newArgs)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "delay",
+ "type" : "Number",
+ "desc" : "The milliseconds to delay",
+ "isOptional" : false
+ },
+ {
+ "name" : "newFn",
+ "type" : "Function",
+ "desc" : "(optional) Overrides function passed to constructor",
+ "isOptional" : false
+ },
+ {
+ "name" : "newScope",
+ "type" : "Object",
+ "desc" : "(optional) Overrides scope passed to constructor",
+ "isOptional" : false
+ },
+ {
+ "name" : "newArgs",
+ "type" : "Array",
+ "desc" : "(optional) Overrides args passed to constructor",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ }
+ ],
"isAbstract" : false,
"isBuilderTop" : false,
- "childClasses" : { },
+ "implementations" : [],
"tree_children" : [],
"tree_parent" : []
},
],
"isAbstract" : false,
"isBuilderTop" : false,
- "childClasses" : { },
+ "implementations" : [],
"tree_children" : [],
"tree_parent" : []
},
"Roo.util.JSON" : {
"props" : [],
"events" : [],
- "methods" : [],
+ "methods" : [
+ {
+ "name" : "decode",
+ "type" : "function",
+ "desc" : "Decodes (parses) a JSON string to an object. If the JSON is invalid, this function throws a SyntaxError.",
+ "sig" : "(json)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "json",
+ "type" : "String",
+ "desc" : "The JSON string",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Object",
+ "desc" : "The resulting object"
+ }
+ ]
+ },
+ {
+ "name" : "encode",
+ "type" : "function",
+ "desc" : "Encodes an Object, Array or other value",
+ "sig" : "(o)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "o",
+ "type" : "Mixed",
+ "desc" : "The variable to encode",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "String",
+ "desc" : "The JSON string"
+ }
+ ]
+ }
+ ],
"isAbstract" : false,
"isBuilderTop" : false,
- "childClasses" : { },
+ "implementations" : [],
"tree_children" : [],
"tree_parent" : []
},
"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"
+ "memberOf" : "Roo.util.Observable",
+ "isOptional" : false,
+ "optvals" : []
}
],
"events" : [
],
"isAbstract" : false,
"isBuilderTop" : false,
- "childClasses" : { },
+ "implementations" : [],
"tree_children" : [],
"tree_parent" : []
},
"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" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
}
],
"events" : [],
],
"isAbstract" : false,
"isBuilderTop" : false,
- "childClasses" : {
- "Roo.bootstrap.nav.Item" : [
- "Roo.bootstrap.nav.SidebarItem"
- ],
- "Roo.ContentPanel" : [
- "Roo.GridPanel",
- "Roo.NestedLayoutPanel",
- "Roo.TreePanel"
- ],
- "Roo.LayoutRegion" : [
- "Roo.SplitLayoutRegion",
- "Roo.bootstrap.layout.Split"
- ],
- "Roo.form.Layout" : [
- "Roo.form.Column",
- "Roo.form.FieldSet",
- "Roo.form.Row"
- ],
- "Roo.bootstrap.Column" : [
- "Roo.bootstrap.TabGroup"
- ],
- "Roo.grid.EditorGrid" : [
- "Roo.grid.PropertyGrid"
- ],
- "Roo.LayoutManager" : [
- "Roo.BorderLayout"
- ],
- "Roo.dd.DropTarget" : [
- "Roo.dd.DropZone"
- ],
- "Roo.bootstrap.Element" : [
- "Roo.bootstrap.CardFooter",
- "Roo.bootstrap.CardHeader",
- "Roo.bootstrap.CardImageTop",
- "Roo.bootstrap.DropTarget"
- ],
- "Roo.form.TriggerField" : [
- "Roo.form.ComboBox",
- "Roo.form.DateField",
- "Roo.form.MonthField",
- "Roo.form.Select"
- ],
- "Roo.form.ComboBox" : [
- "Roo.form.ComboCheck",
- "Roo.form.ComboNested"
- ],
- "Roo.View" : [
- "Roo.JsonView"
- ],
- "Roo.data.DataProxy" : [
- "Roo.data.HttpProxy"
- ],
- "Roo.menu.Menu" : [
- "Roo.menu.ColorMenu",
- "Roo.menu.DateMenu"
- ],
- "Roo.bootstrap.form.TriggerField" : [
- "Roo.bootstrap.form.ComboBox",
- "Roo.bootstrap.form.PhoneInput"
- ],
- "Roo.dd.DragDrop" : [
- "Roo.dd.DD",
- "Roo.dd.DDTarget"
- ],
- "Roo.tree.TreeNode" : [
- "Roo.tree.AsyncTreeNode"
- ],
- "Roo.Button" : [
- "Roo.SplitButton",
- "Roo.Toolbar.Button"
- ],
- "Roo.util.Observable" : [
- "Roo.BasicDialog",
- "Roo.BasicLayoutRegion",
- "Roo.Button",
- "Roo.Component",
- "Roo.ContentPanel",
- "Roo.Document",
- "Roo.LayoutManager",
- "Roo.Resizable",
- "Roo.SplitBar",
- "Roo.TabPanel",
- "Roo.TabPanelItem",
- "Roo.UpdateManager",
- "Roo.View",
- "Roo.XComponent",
- "Roo.bootstrap.SplitBar",
- "Roo.bootstrap.layout.Basic",
- "Roo.bootstrap.panel.Content",
- "Roo.bootstrap.panel.TabItem",
- "Roo.bootstrap.panel.Tabs",
- "Roo.data.Connection",
- "Roo.data.DataProxy",
- "Roo.data.Node",
- "Roo.data.Store",
- "Roo.data.Tree",
- "Roo.dd.DragDrop",
- "Roo.form.BasicForm",
- "Roo.grid.AbstractGridView",
- "Roo.grid.AbstractSelectionModel",
- "Roo.grid.ColumnModel",
- "Roo.grid.Grid",
- "Roo.grid.GridView",
- "Roo.menu.Menu",
- "Roo.tree.DefaultSelectionModel",
- "Roo.tree.MultiSelectionModel",
- "Roo.tree.TreeLoader",
- "Roo.util.ClickRepeater",
- "Roo.util.MixedCollection"
- ],
- "Roo.bootstrap.layout.Manager" : [
- "Roo.bootstrap.layout.Border"
- ],
- "Roo.Component" : [
- "Roo.BoxComponent",
- "Roo.CalendarPanel",
- "Roo.ColorPalette",
- "Roo.DatePicker",
- "Roo.Editor",
- "Roo.HtmlEditorCore",
- "Roo.bootstrap.Component",
- "Roo.form.Layout",
- "Roo.menu.BaseItem"
- ],
- "Roo.BorderLayout" : [
- "Roo.ReaderLayout"
- ],
- "Roo.menu.Item" : [
- "Roo.menu.CheckItem"
- ],
- "Roo.bootstrap.form.TextArea" : [
- "Roo.bootstrap.form.HtmlEditor",
- "Roo.bootstrap.form.Markdown"
- ],
- "Roo.form.Field" : [
- "Roo.form.Checkbox",
- "Roo.form.DayPicker",
- "Roo.form.DisplayField",
- "Roo.form.GridField",
- "Roo.form.HtmlEditor",
- "Roo.form.Signature",
- "Roo.form.TextField"
- ],
- "Roo.form.BasicForm" : [
- "Roo.form.Form"
- ],
- "Roo.SplitButton" : [
- "Roo.Toolbar.SplitButton"
- ],
- "Roo.bootstrap.panel.Content" : [
- "Roo.bootstrap.panel.Grid",
- "Roo.bootstrap.panel.Nest"
- ],
- "Roo.BasicDialog" : [
- "Roo.LayoutDialog"
- ],
- "Roo.menu.BaseItem" : [
- "Roo.menu.Adapter",
- "Roo.menu.Item",
- "Roo.menu.Separator",
- "Roo.menu.TextItem"
- ],
- "Roo.BoxComponent" : [
- "Roo.form.ComboBoxArray.Item",
- "Roo.form.Field",
- "Roo.form.TextItem"
- ],
- "Roo.data.Store" : [
- "Roo.data.JsonStore",
- "Roo.data.SimpleStore"
- ],
- "Roo.dd.DDProxy" : [
- "Roo.dd.DragSource",
- "Roo.grid.SplitDragZone"
- ],
- "Roo.menu.Adapter" : [
- "Roo.menu.ColorItem",
- "Roo.menu.DateItem"
- ],
- "Roo.tree.TreePanel" : [
- "Roo.tree.ColumnTree"
- ],
- "Roo.bootstrap.layout.Basic" : [
- "Roo.bootstrap.layout.Region"
- ],
- "Roo.form.TextField" : [
- "Roo.form.ComboBoxArray",
- "Roo.form.Hidden",
- "Roo.form.NumberField",
- "Roo.form.TextArea",
- "Roo.form.TriggerField"
- ],
- "Roo.form.Checkbox" : [
- "Roo.form.Radio"
- ],
- "Roo.bootstrap.form.Input" : [
- "Roo.bootstrap.form.CheckBox",
- "Roo.bootstrap.form.DateField",
- "Roo.bootstrap.form.MonthField",
- "Roo.bootstrap.form.NumberField",
- "Roo.bootstrap.form.RadioSet",
- "Roo.bootstrap.form.SecurePass",
- "Roo.bootstrap.form.TextArea",
- "Roo.bootstrap.form.TimeField",
- "Roo.bootstrap.form.TriggerField"
- ],
- "Roo.grid.AbstractSelectionModel" : [
- "Roo.grid.CellSelectionModel",
- "Roo.grid.RowSelectionModel"
- ],
- "Roo.bootstrap.form.ComboBox" : [
- "Roo.bootstrap.form.MoneyField"
- ],
- "Roo.dd.DDTarget" : [
- "Roo.dd.DropTarget"
- ],
- "Roo.bootstrap.Button" : [
- "Roo.bootstrap.ButtonUploader",
- "Roo.bootstrap.form.CardUploader"
- ],
- "Roo.bootstrap.Component" : [
- "Roo.bootstrap.Alert",
- "Roo.bootstrap.BezierSignature",
- "Roo.bootstrap.Body",
- "Roo.bootstrap.Brick",
- "Roo.bootstrap.Button",
- "Roo.bootstrap.ButtonGroup",
- "Roo.bootstrap.Calendar",
- "Roo.bootstrap.Card",
- "Roo.bootstrap.Column",
- "Roo.bootstrap.Container",
- "Roo.bootstrap.DocumentManager",
- "Roo.bootstrap.DocumentSlider",
- "Roo.bootstrap.DocumentViewer",
- "Roo.bootstrap.Element",
- "Roo.bootstrap.Graph",
- "Roo.bootstrap.Header",
- "Roo.bootstrap.Img",
- "Roo.bootstrap.LayoutMasonry",
- "Roo.bootstrap.LayoutMasonryAuto",
- "Roo.bootstrap.Link",
- "Roo.bootstrap.LocationPicker",
- "Roo.bootstrap.MasonryBrick",
- "Roo.bootstrap.MessageBar",
- "Roo.bootstrap.Modal",
- "Roo.bootstrap.Pagination",
- "Roo.bootstrap.PaginationItem",
- "Roo.bootstrap.Popover",
- "Roo.bootstrap.Progress",
- "Roo.bootstrap.ProgressBar",
- "Roo.bootstrap.Row",
- "Roo.bootstrap.Slider",
- "Roo.bootstrap.TabPanel",
- "Roo.bootstrap.Table",
- "Roo.bootstrap.TableBody",
- "Roo.bootstrap.TableCell",
- "Roo.bootstrap.TableRow",
- "Roo.bootstrap.UploadCropbox",
- "Roo.bootstrap.breadcrumb.Item",
- "Roo.bootstrap.breadcrumb.Nav",
- "Roo.bootstrap.dash.NumberBox",
- "Roo.bootstrap.dash.TabBox",
- "Roo.bootstrap.dash.TabPane",
- "Roo.bootstrap.form.DateSplitField",
- "Roo.bootstrap.form.FieldLabel",
- "Roo.bootstrap.form.Form",
- "Roo.bootstrap.form.Input",
- "Roo.bootstrap.form.Radio",
- "Roo.bootstrap.layout.Manager",
- "Roo.bootstrap.menu.Item",
- "Roo.bootstrap.menu.Menu",
- "Roo.bootstrap.menu.Separator",
- "Roo.bootstrap.nav.Bar",
- "Roo.bootstrap.nav.Group",
- "Roo.bootstrap.nav.Item",
- "Roo.bootstrap.nav.ProgressBar",
- "Roo.bootstrap.nav.ProgressBarItem"
- ],
- "Roo.data.Tree" : [
- "Roo.tree.TreePanel"
- ],
- "Roo.dd.DD" : [
- "Roo.dd.DDProxy"
- ],
- "Roo.form.TextArea" : [
- "Roo.form.FCKeditor"
- ],
- "Roo.grid.Grid" : [
- "Roo.grid.Calendar",
- "Roo.grid.EditorGrid"
- ],
- "Roo.Editor" : [
- "Roo.grid.GridEditor",
- "Roo.tree.TreeEditor"
- ],
- "Roo.bootstrap.nav.Simplebar" : [
- "Roo.bootstrap.PagingToolbar",
- "Roo.bootstrap.PopoverNav",
- "Roo.bootstrap.form.HtmlEditorToolbarStandard",
- "Roo.bootstrap.nav.Headerbar"
- ],
- "Roo.data.Connection" : [
- "Roo.Ajax"
- ],
- "Roo.dd.DragSource" : [
- "Roo.dd.DragZone"
- ],
- "Roo.bootstrap.nav.Bar" : [
- "Roo.bootstrap.nav.Sidebar",
- "Roo.bootstrap.nav.Simplebar"
- ],
- "Roo.BasicLayoutRegion" : [
- "Roo.LayoutRegion"
- ],
- "Roo.data.Node" : [
- "Roo.tree.TreeNode"
- ]
- },
+ "implementations" : [
+ "Roo.Ajax",
+ "Roo.BasicDialog",
+ "Roo.BasicLayoutRegion",
+ "Roo.BorderLayout",
+ "Roo.BoxComponent",
+ "Roo.Button",
+ "Roo.CalendarPanel",
+ "Roo.ColorPalette",
+ "Roo.Component",
+ "Roo.ContentPanel",
+ "Roo.DatePicker",
+ "Roo.Document",
+ "Roo.Editor",
+ "Roo.GridPanel",
+ "Roo.HtmlEditorCore",
+ "Roo.JsonView",
+ "Roo.LayoutDialog",
+ "Roo.LayoutManager",
+ "Roo.LayoutRegion",
+ "Roo.NestedLayoutPanel",
+ "Roo.ReaderLayout",
+ "Roo.Resizable",
+ "Roo.SplitBar",
+ "Roo.SplitButton",
+ "Roo.SplitLayoutRegion",
+ "Roo.TabPanel",
+ "Roo.TabPanelItem",
+ "Roo.Toolbar.Button",
+ "Roo.Toolbar.SplitButton",
+ "Roo.TreePanel",
+ "Roo.UpdateManager",
+ "Roo.View",
+ "Roo.XComponent",
+ "Roo.bootstrap.Alert",
+ "Roo.bootstrap.BezierSignature",
+ "Roo.bootstrap.Body",
+ "Roo.bootstrap.Brick",
+ "Roo.bootstrap.Button",
+ "Roo.bootstrap.ButtonGroup",
+ "Roo.bootstrap.ButtonUploader",
+ "Roo.bootstrap.Calendar",
+ "Roo.bootstrap.Card",
+ "Roo.bootstrap.CardFooter",
+ "Roo.bootstrap.CardHeader",
+ "Roo.bootstrap.CardImageTop",
+ "Roo.bootstrap.Column",
+ "Roo.bootstrap.Component",
+ "Roo.bootstrap.Container",
+ "Roo.bootstrap.DocumentManager",
+ "Roo.bootstrap.DocumentSlider",
+ "Roo.bootstrap.DocumentViewer",
+ "Roo.bootstrap.DropTarget",
+ "Roo.bootstrap.Element",
+ "Roo.bootstrap.Graph",
+ "Roo.bootstrap.Header",
+ "Roo.bootstrap.Img",
+ "Roo.bootstrap.LayoutMasonry",
+ "Roo.bootstrap.LayoutMasonryAuto",
+ "Roo.bootstrap.Link",
+ "Roo.bootstrap.LocationPicker",
+ "Roo.bootstrap.MasonryBrick",
+ "Roo.bootstrap.MessageBar",
+ "Roo.bootstrap.Modal",
+ "Roo.bootstrap.Pagination",
+ "Roo.bootstrap.PaginationItem",
+ "Roo.bootstrap.PagingToolbar",
+ "Roo.bootstrap.Popover",
+ "Roo.bootstrap.PopoverNav",
+ "Roo.bootstrap.Progress",
+ "Roo.bootstrap.ProgressBar",
+ "Roo.bootstrap.Row",
+ "Roo.bootstrap.Slider",
+ "Roo.bootstrap.SplitBar",
+ "Roo.bootstrap.TabGroup",
+ "Roo.bootstrap.TabPanel",
+ "Roo.bootstrap.Table",
+ "Roo.bootstrap.TableBody",
+ "Roo.bootstrap.TableCell",
+ "Roo.bootstrap.TableRow",
+ "Roo.bootstrap.UploadCropbox",
+ "Roo.bootstrap.breadcrumb.Item",
+ "Roo.bootstrap.breadcrumb.Nav",
+ "Roo.bootstrap.dash.NumberBox",
+ "Roo.bootstrap.dash.TabBox",
+ "Roo.bootstrap.dash.TabPane",
+ "Roo.bootstrap.form.CardUploader",
+ "Roo.bootstrap.form.CheckBox",
+ "Roo.bootstrap.form.ComboBox",
+ "Roo.bootstrap.form.DateField",
+ "Roo.bootstrap.form.DateSplitField",
+ "Roo.bootstrap.form.FieldLabel",
+ "Roo.bootstrap.form.Form",
+ "Roo.bootstrap.form.HtmlEditor",
+ "Roo.bootstrap.form.HtmlEditorToolbarStandard",
+ "Roo.bootstrap.form.Input",
+ "Roo.bootstrap.form.Markdown",
+ "Roo.bootstrap.form.MoneyField",
+ "Roo.bootstrap.form.MonthField",
+ "Roo.bootstrap.form.NumberField",
+ "Roo.bootstrap.form.PhoneInput",
+ "Roo.bootstrap.form.Radio",
+ "Roo.bootstrap.form.RadioSet",
+ "Roo.bootstrap.form.SecurePass",
+ "Roo.bootstrap.form.TextArea",
+ "Roo.bootstrap.form.TimeField",
+ "Roo.bootstrap.form.TriggerField",
+ "Roo.bootstrap.layout.Basic",
+ "Roo.bootstrap.layout.Border",
+ "Roo.bootstrap.layout.Manager",
+ "Roo.bootstrap.layout.Region",
+ "Roo.bootstrap.layout.Split",
+ "Roo.bootstrap.menu.Item",
+ "Roo.bootstrap.menu.Menu",
+ "Roo.bootstrap.menu.Separator",
+ "Roo.bootstrap.nav.Bar",
+ "Roo.bootstrap.nav.Group",
+ "Roo.bootstrap.nav.Headerbar",
+ "Roo.bootstrap.nav.Item",
+ "Roo.bootstrap.nav.ProgressBar",
+ "Roo.bootstrap.nav.ProgressBarItem",
+ "Roo.bootstrap.nav.Sidebar",
+ "Roo.bootstrap.nav.SidebarItem",
+ "Roo.bootstrap.nav.Simplebar",
+ "Roo.bootstrap.panel.Content",
+ "Roo.bootstrap.panel.Grid",
+ "Roo.bootstrap.panel.Nest",
+ "Roo.bootstrap.panel.TabItem",
+ "Roo.bootstrap.panel.Tabs",
+ "Roo.data.Connection",
+ "Roo.data.DataProxy",
+ "Roo.data.HttpProxy",
+ "Roo.data.JsonStore",
+ "Roo.data.MemoryProxy",
+ "Roo.data.Node",
+ "Roo.data.SimpleStore",
+ "Roo.data.Store",
+ "Roo.data.Tree",
+ "Roo.dd.DD",
+ "Roo.dd.DDProxy",
+ "Roo.dd.DDTarget",
+ "Roo.dd.DragDrop",
+ "Roo.dd.DragSource",
+ "Roo.dd.DragZone",
+ "Roo.dd.DropTarget",
+ "Roo.dd.DropZone",
+ "Roo.dialog.UploadCropbox",
+ "Roo.form.BasicForm",
+ "Roo.form.Checkbox",
+ "Roo.form.Column",
+ "Roo.form.ComboBox",
+ "Roo.form.ComboBoxArray",
+ "Roo.form.ComboBoxArray.Item",
+ "Roo.form.ComboCheck",
+ "Roo.form.ComboNested",
+ "Roo.form.DateField",
+ "Roo.form.DayPicker",
+ "Roo.form.DisplayField",
+ "Roo.form.FCKeditor",
+ "Roo.form.Field",
+ "Roo.form.FieldSet",
+ "Roo.form.Form",
+ "Roo.form.GridField",
+ "Roo.form.Hidden",
+ "Roo.form.HtmlEditor",
+ "Roo.form.Layout",
+ "Roo.form.MonthField",
+ "Roo.form.NumberField",
+ "Roo.form.Radio",
+ "Roo.form.Row",
+ "Roo.form.Select",
+ "Roo.form.Signature",
+ "Roo.form.TextArea",
+ "Roo.form.TextField",
+ "Roo.form.TextItem",
+ "Roo.form.TriggerField",
+ "Roo.grid.AbstractGridView",
+ "Roo.grid.AbstractSelectionModel",
+ "Roo.grid.Calendar",
+ "Roo.grid.CellSelectionModel",
+ "Roo.grid.ColumnModel",
+ "Roo.grid.EditorGrid",
+ "Roo.grid.Grid",
+ "Roo.grid.GridEditor",
+ "Roo.grid.GridView",
+ "Roo.grid.PropertyGrid",
+ "Roo.grid.RowSelectionModel",
+ "Roo.grid.SplitDragZone",
+ "Roo.menu.Adapter",
+ "Roo.menu.BaseItem",
+ "Roo.menu.CheckItem",
+ "Roo.menu.ColorItem",
+ "Roo.menu.ColorMenu",
+ "Roo.menu.DateItem",
+ "Roo.menu.DateMenu",
+ "Roo.menu.Item",
+ "Roo.menu.Menu",
+ "Roo.menu.Separator",
+ "Roo.menu.TextItem",
+ "Roo.tree.AsyncTreeNode",
+ "Roo.tree.ColumnTree",
+ "Roo.tree.DefaultSelectionModel",
+ "Roo.tree.MultiSelectionModel",
+ "Roo.tree.TreeEditor",
+ "Roo.tree.TreeLoader",
+ "Roo.tree.TreeNode",
+ "Roo.tree.TreePanel",
+ "Roo.util.ClickRepeater",
+ "Roo.util.MixedCollection"
+ ],
+ "tree_children" : [],
+ "tree_parent" : []
+ },
+ "Roo.util.TaskRunner" : {
+ "props" : [],
+ "events" : [],
+ "methods" : [
+ {
+ "name" : "start",
+ "type" : "function",
+ "desc" : "Queues a new task.",
+ "sig" : "(task)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "task",
+ "type" : "Object",
+ "desc" : "Task property : interval = how frequent to run.\nTask object should implement\nfunction run()\nTask object may implement\nfunction onStop()",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "stop",
+ "type" : "function",
+ "desc" : "Stop new task.",
+ "sig" : "(task)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "task",
+ "type" : "Object",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "stopAll",
+ "type" : "function",
+ "desc" : "Stop all Tasks",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ }
+ ],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "implementations" : [],
"tree_children" : [],
"tree_parent" : []
},
],
"isAbstract" : false,
"isBuilderTop" : false,
- "childClasses" : { },
+ "implementations" : [],
"tree_children" : [],
"tree_parent" : []
},
"Roo.util.TextMetrics.Instance" : {
"props" : [],
"events" : [],
- "methods" : [],
+ "methods" : [
+ {
+ "name" : "bind",
+ "type" : "function",
+ "desc" : "Binds this TextMetrics instance to an element from which to copy existing CSS styles\nthat can affect the size of the rendered text",
+ "sig" : "(el)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "el",
+ "type" : "String/HTMLElement",
+ "desc" : "The element, dom node or id",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "getHeight",
+ "type" : "function",
+ "desc" : "Returns the measured height of the specified text. For multiline text, be sure to call\n{@link #setFixedWidth} if necessary.",
+ "sig" : "(text)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "text",
+ "type" : "String",
+ "desc" : "The text to measure",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Number",
+ "desc" : "height The height in pixels"
+ }
+ ]
+ },
+ {
+ "name" : "getSize",
+ "type" : "function",
+ "desc" : "Returns the size of the specified text based on the internal element's style and width properties",
+ "sig" : "(text)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "text",
+ "type" : "String",
+ "desc" : "The text to measure",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Object",
+ "desc" : "An object containing the text's size {width: (width), height: (height)}"
+ }
+ ]
+ },
+ {
+ "name" : "getWidth",
+ "type" : "function",
+ "desc" : "Returns the measured width of the specified text",
+ "sig" : "(text)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "text",
+ "type" : "String",
+ "desc" : "The text to measure",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Number",
+ "desc" : "width The width in pixels"
+ }
+ ]
+ },
+ {
+ "name" : "setFixedWidth",
+ "type" : "function",
+ "desc" : "Sets a fixed width on the internal measurement element. If the text will be multiline, you have\nto set a fixed width in order to accurately measure the text height.",
+ "sig" : "(width)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "width",
+ "type" : "Number",
+ "desc" : "The width to set on the element",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ }
+ ],
"isAbstract" : false,
"isBuilderTop" : false,
- "childClasses" : { },
+ "implementations" : [],
"tree_children" : [],
"tree_parent" : []
},
}
]
},
+ {
+ "name" : "toUpperCaseFirst",
+ "type" : "function",
+ "desc" : "Make the first letter of a string uppercase",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "String",
+ "desc" : "The new string."
+ }
+ ]
+ },
{
"name" : "toggle",
"type" : "function",
],
"isAbstract" : false,
"isBuilderTop" : false,
- "childClasses" : { },
+ "implementations" : [],
"tree_children" : [],
"tree_parent" : []
},
],
"isAbstract" : false,
"isBuilderTop" : false,
- "childClasses" : { },
- "tree_children" : [],
- "tree_parent" : []
- },
- "this" : {
- "props" : [],
- "events" : [],
- "methods" : [],
- "isAbstract" : false,
- "isBuilderTop" : false,
- "childClasses" : { },
+ "implementations" : [],
"tree_children" : [],
"tree_parent" : []
}
projects / roojs1 / blobdiff