],
"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",
"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"
}
]
},
"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",
{
"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
}
],
"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" : [
"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" : [
"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" : [
"name" : "actionMode",
"type" : "String",
"desc" : "which property holds the 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,
"implementations" : [
+ "Roo.dialog.UploadCropbox",
"Roo.form.Checkbox",
"Roo.form.ComboBox",
"Roo.form.ComboBoxArray",
"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",
"name" : "actionMode",
"type" : "String",
"desc" : "which property holds the 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" : [
"name" : "actionMode",
"type" : "String",
"desc" : "which property holds the 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" : [
"name" : "actionMode",
"type" : "String",
"desc" : "which property 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" : [
"Roo.bootstrap.form.FieldLabel",
"Roo.bootstrap.form.Form",
"Roo.bootstrap.form.HtmlEditor",
- "Roo.bootstrap.form.HtmlEditorToolbarStandard",
+ "Roo.bootstrap.form.HtmlEditorToolbar.Standard",
"Roo.bootstrap.form.Input",
"Roo.bootstrap.form.Markdown",
"Roo.bootstrap.form.MoneyField",
"Roo.bootstrap.form.MonthField",
"Roo.bootstrap.form.NumberField",
+ "Roo.bootstrap.form.Password",
"Roo.bootstrap.form.PhoneInput",
"Roo.bootstrap.form.Radio",
"Roo.bootstrap.form.RadioSet",
"Roo.bootstrap.nav.Sidebar",
"Roo.bootstrap.nav.SidebarItem",
"Roo.bootstrap.nav.Simplebar",
+ "Roo.dialog.UploadCropbox",
"Roo.form.Checkbox",
"Roo.form.Column",
"Roo.form.ComboBox",
{
"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
}
],
{
"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
}
],
"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" : [
"tree_parent" : [
"Roo.BorderLayout",
"Roo.LayoutDialog",
- "builder-top"
+ "builder"
]
},
"Roo.DDView" : {
"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" : [],
"name" : "actionMode",
"type" : "String",
"desc" : "which property holds the 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" : [
"name" : "listeners",
"type" : "Object",
"desc" : "list of events and functions to call for 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" : [],
"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,
"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" : [],
"name" : "actionMode",
"type" : "String",
"desc" : "which property holds the 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" : [
"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" : [],
"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" : [
"isBuilderTop" : false,
"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" : "css",
+ "type" : "String",
+ "desc" : "styling for resizing. (used on bootstrap only)",
+ "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",
+ "name" : "style",
"type" : "String",
- "desc" : "'s' or 'se' or 'e' - wrapps the element in a\n Roo.resizable.",
- "memberOf" : ""
+ "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",
"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" : [
"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" : [],
"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" : "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" : [
"name" : "listeners",
"type" : "Object",
"desc" : "list of events and functions to call for 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" : [
"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" : [
"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" : [],
"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" : [],
"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" : []
+ },
"Roo.NestedLayoutPanel" : {
"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.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" : [
"isBuilderTop" : false,
"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",
"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" : "Delay",
"type" : "Number",
"desc" : "in milliseconds before the quick tip hides when autoDismiss = true (defaults to 5000)",
- "memberOf" : ""
+ "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" : ""
+ "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" : ""
+ "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" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "cls",
"type" : "String",
"desc" : "A CSS class to apply to the base quick tip element (defaults to '').",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "hideDelay",
"type" : "Number",
"desc" : "Delay in milliseconds before the quick tip hides when autoHide = true (defaults to 200)",
- "memberOf" : ""
+ "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" : ""
+ "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" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "maxWidth",
"type" : "Number",
"desc" : "The maximum width of the quick tip (defaults to 300)",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "minWidth",
"type" : "Number",
"desc" : "The minimum width of the quick tip (defaults to 40)",
- "memberOf" : ""
+ "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" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "text",
"type" : "String",
"desc" : "Body text to display (defaults to ''). This can be any valid HTML markup.",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "title",
"type" : "String",
"desc" : "Title text to display (defaults to ''). This can be any valid HTML markup.",
- "memberOf" : ""
+ "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" : ""
+ "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" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
}
],
"events" : [],
"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" : [
"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" : [
"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" : [],
"name" : "listeners",
"type" : "Object",
"desc" : "list of events and functions to call for 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" : [
"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",
"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" : [
"name" : "listeners",
"type" : "Object",
"desc" : "list of events and functions to call for 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" : [
"name" : "listeners",
"type" : "Object",
"desc" : "list of events and functions to call for 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" : [
"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" : [],
"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" : [],
"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",
"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",
"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,
"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" : [
"isBuilderTop" : false,
"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" : [
"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" : [
"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" : [
"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" : [],
"name" : "actionMode",
"type" : "String",
"desc" : "which property holds the 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" : [
"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" : [
"name" : "actionMode",
"type" : "String",
"desc" : "which property holds the 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" : [
"Roo.bootstrap.form.MoneyField",
"Roo.bootstrap.form.MonthField",
"Roo.bootstrap.form.NumberField",
+ "Roo.bootstrap.form.Password",
"Roo.bootstrap.form.PhoneInput",
"Roo.bootstrap.form.Radio",
"Roo.bootstrap.form.RadioSet",
"name" : "actionMode",
"type" : "String",
"desc" : "which property holds the 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" : [
"name" : "actionMode",
"type" : "String",
"desc" : "which property holds the 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" : [
"name" : "actionMode",
"type" : "String",
"desc" : "which property holds the 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" : [
"name" : "actionMode",
"type" : "String",
"desc" : "which property holds the 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" : [
"name" : "actionMode",
"type" : "String",
"desc" : "which property holds the 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" : [
"name" : "actionMode",
"type" : "String",
"desc" : "which property holds the 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" : [
"Roo.bootstrap.form.MoneyField",
"Roo.bootstrap.form.MonthField",
"Roo.bootstrap.form.NumberField",
+ "Roo.bootstrap.form.Password",
"Roo.bootstrap.form.PhoneInput",
"Roo.bootstrap.form.Radio",
"Roo.bootstrap.form.RadioSet",
"name" : "actionMode",
"type" : "String",
"desc" : "which property holds the 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" : [
"Roo.bootstrap.form.MoneyField",
"Roo.bootstrap.form.MonthField",
"Roo.bootstrap.form.NumberField",
+ "Roo.bootstrap.form.Password",
"Roo.bootstrap.form.PhoneInput",
"Roo.bootstrap.form.Radio",
"Roo.bootstrap.form.RadioSet",
"name" : "actionMode",
"type" : "String",
"desc" : "which property holds the 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" : [
"Roo.bootstrap.form.MoneyField",
"Roo.bootstrap.form.MonthField",
"Roo.bootstrap.form.NumberField",
+ "Roo.bootstrap.form.Password",
"Roo.bootstrap.form.PhoneInput",
"Roo.bootstrap.form.Radio",
"Roo.bootstrap.form.RadioSet",
"name" : "actionMode",
"type" : "String",
"desc" : "which property holds the 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" : [
"Roo.bootstrap.form.MoneyField",
"Roo.bootstrap.form.MonthField",
"Roo.bootstrap.form.NumberField",
+ "Roo.bootstrap.form.Password",
"Roo.bootstrap.form.PhoneInput",
"Roo.bootstrap.form.Radio",
"Roo.bootstrap.form.RadioSet",
"name" : "actionMode",
"type" : "String",
"desc" : "which property holds the 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" : [
"Roo.bootstrap.form.MoneyField",
"Roo.bootstrap.form.MonthField",
"Roo.bootstrap.form.NumberField",
+ "Roo.bootstrap.form.Password",
"Roo.bootstrap.form.PhoneInput",
"Roo.bootstrap.form.Radio",
"Roo.bootstrap.form.RadioSet",
"name" : "actionMode",
"type" : "String",
"desc" : "which property holds the 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" : [
"Roo.bootstrap.form.FieldLabel",
"Roo.bootstrap.form.Form",
"Roo.bootstrap.form.HtmlEditor",
- "Roo.bootstrap.form.HtmlEditorToolbarStandard",
+ "Roo.bootstrap.form.HtmlEditorToolbar.Standard",
"Roo.bootstrap.form.Input",
"Roo.bootstrap.form.Markdown",
"Roo.bootstrap.form.MoneyField",
"Roo.bootstrap.form.MonthField",
"Roo.bootstrap.form.NumberField",
+ "Roo.bootstrap.form.Password",
"Roo.bootstrap.form.PhoneInput",
"Roo.bootstrap.form.Radio",
"Roo.bootstrap.form.RadioSet",
"Roo.bootstrap.form.MoneyField",
"Roo.bootstrap.form.MonthField",
"Roo.bootstrap.form.NumberField",
+ "Roo.bootstrap.form.Password",
"Roo.bootstrap.form.PhoneInput",
"Roo.bootstrap.form.Radio",
"Roo.bootstrap.form.RadioSet",
"name" : "actionMode",
"type" : "String",
"desc" : "which property holds the 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" : [
"Roo.bootstrap.form.MoneyField",
"Roo.bootstrap.form.MonthField",
"Roo.bootstrap.form.NumberField",
+ "Roo.bootstrap.form.Password",
"Roo.bootstrap.form.PhoneInput",
"Roo.bootstrap.form.Radio",
"Roo.bootstrap.form.RadioSet",
"name" : "actionMode",
"type" : "String",
"desc" : "which property holds the 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" : [
"name" : "actionMode",
"type" : "String",
"desc" : "which property holds the 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" : [
"name" : "actionMode",
"type" : "String",
"desc" : "which property holds the 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" : [
"name" : "actionMode",
"type" : "String",
"desc" : "which property holds the 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" : [
"name" : "actionMode",
"type" : "String",
"desc" : "which property holds the 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" : [
"Roo.bootstrap.form.MoneyField",
"Roo.bootstrap.form.MonthField",
"Roo.bootstrap.form.NumberField",
+ "Roo.bootstrap.form.Password",
"Roo.bootstrap.form.PhoneInput",
"Roo.bootstrap.form.Radio",
"Roo.bootstrap.form.RadioSet",
"name" : "actionMode",
"type" : "String",
"desc" : "which property holds the 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" : [
"name" : "actionMode",
"type" : "String",
"desc" : "which property holds the 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" : [
"Roo.bootstrap.form.MoneyField",
"Roo.bootstrap.form.MonthField",
"Roo.bootstrap.form.NumberField",
+ "Roo.bootstrap.form.Password",
"Roo.bootstrap.form.PhoneInput",
"Roo.bootstrap.form.Radio",
"Roo.bootstrap.form.RadioSet",
"name" : "actionMode",
"type" : "String",
"desc" : "which property holds the 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" : [
"name" : "actionMode",
"type" : "String",
"desc" : "which property holds the 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" : [
"name" : "actionMode",
"type" : "String",
"desc" : "which property holds the 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" : [
"name" : "actionMode",
"type" : "String",
"desc" : "which property holds the 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" : [
"Roo.bootstrap.form.MoneyField",
"Roo.bootstrap.form.MonthField",
"Roo.bootstrap.form.NumberField",
+ "Roo.bootstrap.form.Password",
"Roo.bootstrap.form.PhoneInput",
"Roo.bootstrap.form.Radio",
"Roo.bootstrap.form.RadioSet",
"name" : "actionMode",
"type" : "String",
"desc" : "which property holds the 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" : [
"name" : "actionMode",
"type" : "String",
"desc" : "which property holds the 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" : [
"name" : "actionMode",
"type" : "String",
"desc" : "which property holds the 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" : [
"name" : "actionMode",
"type" : "String",
"desc" : "which property holds the 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" : [
"Roo.bootstrap.form.MoneyField",
"Roo.bootstrap.form.MonthField",
"Roo.bootstrap.form.NumberField",
+ "Roo.bootstrap.form.Password",
"Roo.bootstrap.form.PhoneInput",
"Roo.bootstrap.form.Radio",
"Roo.bootstrap.form.RadioSet",
"name" : "actionMode",
"type" : "String",
"desc" : "which property holds the 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" : [
"name" : "actionMode",
"type" : "String",
"desc" : "which property holds the 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" : [
"name" : "actionMode",
"type" : "String",
"desc" : "which property holds the 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" : [
"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" : [
"Roo.bootstrap.form.MoneyField",
"Roo.bootstrap.form.MonthField",
"Roo.bootstrap.form.NumberField",
+ "Roo.bootstrap.form.Password",
"Roo.bootstrap.form.PhoneInput",
"Roo.bootstrap.form.Radio",
"Roo.bootstrap.form.RadioSet",
"name" : "actionMode",
"type" : "String",
"desc" : "which property holds the 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" : [
"name" : "actionMode",
"type" : "String",
"desc" : "which property holds the 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" : [
"name" : "actionMode",
"type" : "String",
"desc" : "which property holds the 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" : [
"name" : "actionMode",
"type" : "String",
"desc" : "which property holds the 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" : [
"Roo.bootstrap.form.MoneyField",
"Roo.bootstrap.form.MonthField",
"Roo.bootstrap.form.NumberField",
+ "Roo.bootstrap.form.Password",
"Roo.bootstrap.form.PhoneInput",
"Roo.bootstrap.form.Radio",
"Roo.bootstrap.form.RadioSet",
"name" : "actionMode",
"type" : "String",
"desc" : "which property holds the 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" : [
"name" : "listeners",
"type" : "Object",
"desc" : "list of events and functions to call for 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" : [
"name" : "actionMode",
"type" : "String",
"desc" : "which property holds the 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" : [
"name" : "actionMode",
"type" : "String",
"desc" : "which property holds the 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" : [
"Roo.bootstrap.form.MoneyField",
"Roo.bootstrap.form.MonthField",
"Roo.bootstrap.form.NumberField",
+ "Roo.bootstrap.form.Password",
"Roo.bootstrap.form.PhoneInput",
"Roo.bootstrap.form.Radio",
"Roo.bootstrap.form.RadioSet",
"name" : "actionMode",
"type" : "String",
"desc" : "which property holds the 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" : "disableAutoSize",
+ "type" : "Boolean",
+ "desc" : "disable autoSize() and initCSS()",
+ "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" : "empty_results",
"type" : "string",
"desc" : "Text to display for no results",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "enableColumnResize",
"type" : "Boolean",
"desc" : "default true if columns can be resized = needs scrollBody to be set to work (drag/drop)",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "footer",
"type" : "Roo.bootstrap.PagingToolbar",
"desc" : "a paging toolbar",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "footerRow",
+ "type" : "Boolean",
+ "desc" : "e) generate tfoot with columns of values, default fal",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : [
+ "true",
+ "false"
+ ]
},
{
"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 (with resizable columns)",
- "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" : [
"name" : "actionMode",
"type" : "String",
"desc" : "which property holds the 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" : [
"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" : [
"Roo.bootstrap.form.MoneyField",
"Roo.bootstrap.form.MonthField",
"Roo.bootstrap.form.NumberField",
+ "Roo.bootstrap.form.Password",
"Roo.bootstrap.form.PhoneInput",
"Roo.bootstrap.form.Radio",
"Roo.bootstrap.form.RadioSet",
"name" : "actionMode",
"type" : "String",
"desc" : "which property holds the 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" : [
"name" : "actionMode",
"type" : "String",
"desc" : "which property holds the 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" : [
"name" : "actionMode",
"type" : "String",
"desc" : "which property holds the 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" : [
"Roo.bootstrap.form.MoneyField",
"Roo.bootstrap.form.MonthField",
"Roo.bootstrap.form.NumberField",
+ "Roo.bootstrap.form.Password",
"Roo.bootstrap.form.PhoneInput",
"Roo.bootstrap.form.Radio",
"Roo.bootstrap.form.RadioSet",
"name" : "actionMode",
"type" : "String",
"desc" : "which property holds the 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" : [
"name" : "actionMode",
"type" : "String",
"desc" : "which property holds the 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" : [
"name" : "actionMode",
"type" : "String",
"desc" : "which property holds the 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" : [
"name" : "actionMode",
"type" : "String",
"desc" : "which property holds the 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" : [
"name" : "actionMode",
"type" : "String",
"desc" : "which property holds the 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" : [
{
"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" : [
],
"returns" : []
},
+ {
+ "name" : "getAutoCreateLabel",
+ "type" : "function",
+ "desc" : "autocreate the label - also used by textara... ?? and others?",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
{
"name" : "getChildContainer",
"type" : "function",
{
"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" : [
}
]
},
+ {
+ "name" : "getAutoCreateLabel",
+ "type" : "function",
+ "desc" : "autocreate the label - also used by textara... ?? and others?",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
{
"name" : "getChildContainer",
"type" : "function",
{
"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"
- },
- {
- "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" : "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" : [
}
]
},
+ {
+ "name" : "getAutoCreateLabel",
+ "type" : "function",
+ "desc" : "autocreate the label - also used by textara... ?? and others?",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
{
"name" : "getChildContainer",
"type" : "function",
"name" : "actionMode",
"type" : "String",
"desc" : "which property holds the 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" : [
"name" : "actionMode",
"type" : "String",
"desc" : "which property holds the 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" : [
"name" : "actionMode",
"type" : "String",
"desc" : "which property holds the 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" : [
"Roo.bootstrap.form.MoneyField",
"Roo.bootstrap.form.MonthField",
"Roo.bootstrap.form.NumberField",
+ "Roo.bootstrap.form.Password",
"Roo.bootstrap.form.PhoneInput",
"Roo.bootstrap.form.Radio",
"Roo.bootstrap.form.RadioSet",
{
"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"
- },
- {
- "name" : "resizable",
- "type" : "String",
- "desc" : "'s' or 'se' or 'e' - wrapps the element in a\n Roo.resizable.",
- "memberOf" : ""
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "resize",
- "type" : "string",
- "desc" : "l)",
- "memberOf" : "Roo.bootstrap.form.TextArea"
+ "type" : "String",
+ "desc" : "l) - css resize of eleme",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : [
+ "none",
+ "both",
+ "horizontal",
+ "vertical"
+ ]
},
{
"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" : ""
+ "type" : "Array|boolean",
+ "desc" : "Array of toolbars, or names of toolbars. - true for standard, and false for none.",
+ "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" : [
"params" : [
{
"name" : "this",
- "type" : "HtmlEditor",
+ "type" : "Roo.bootstrap.form.HtmlEditor",
"desc" : "",
"isOptional" : false
}
"params" : [
{
"name" : "this",
- "type" : "HtmlEditor",
+ "type" : "Roo.bootstrap.form.HtmlEditor",
"desc" : "",
"isOptional" : false
}
"params" : [
{
"name" : "this",
- "type" : "HtmlEditor",
+ "type" : "Roo.bootstrap.form.HtmlEditor",
"desc" : "",
"isOptional" : false
},
"params" : [
{
"name" : "this",
- "type" : "HtmlEditor",
+ "type" : "Roo.bootstrap.form.HtmlEditor",
"desc" : "",
"isOptional" : false
},
"params" : [
{
"name" : "this",
- "type" : "HtmlEditor",
+ "type" : "Roo.bootstrap.form.HtmlEditor",
"desc" : "",
"isOptional" : false
},
"params" : [
{
"name" : "this",
- "type" : "HtmlEditor",
+ "type" : "Roo.bootstrap.form.HtmlEditor",
"desc" : "",
"isOptional" : false
}
"params" : [
{
"name" : "this",
- "type" : "HtmlEditor",
+ "type" : "Roo.bootstrap.form.HtmlEditor",
"desc" : "",
"isOptional" : false
}
],
"returns" : []
},
+ {
+ "name" : "imageadd",
+ "type" : "function",
+ "desc" : "Fires when on any editor when an image is added (excluding paste)",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.bootstrap.form.HtmlEditor",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "imagedelete",
+ "type" : "function",
+ "desc" : "Fires when on any editor when an image is deleted",
+ "sig" : "function (_self, img, oldSrc)\n{\n\n}",
+ "memberOf" : "",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.bootstrap.form.HtmlEditor",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "img",
+ "type" : "HTMLElement",
+ "desc" : "could also be a figure if blocks are enabled",
+ "isOptional" : false
+ },
+ {
+ "name" : "oldSrc",
+ "type" : "HTMLElement",
+ "desc" : "source of image being replaced",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "imageupdated",
+ "type" : "function",
+ "desc" : "Fires when on any editor when an image is changed (excluding paste)",
+ "sig" : "function (_self, img)\n{\n\n}",
+ "memberOf" : "",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.bootstrap.form.HtmlEditor",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "img",
+ "type" : "HTMLElement",
+ "desc" : "could also be a figure if blocks are enabled",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
{
"name" : "initialize",
"type" : "function",
"params" : [
{
"name" : "this",
- "type" : "HtmlEditor",
+ "type" : "Roo.bootstrap.form.HtmlEditor",
"desc" : "",
"isOptional" : false
}
{
"name" : "paste",
"type" : "function",
- "desc" : "Fires after the user pastes into input",
- "sig" : "function (_self, e)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.form.Input",
+ "desc" : "Fires when press user pastes into the editor",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.form.Field",
+ "type" : "Roo.HtmlEditorCore",
"desc" : "",
"isOptional" : false
- },
- {
- "name" : "e",
- "type" : "Roo.EventObject",
- "desc" : "The event Object",
- "isOptional" : false
}
],
"returns" : []
"params" : [
{
"name" : "this",
- "type" : "HtmlEditor",
+ "type" : "Roo.bootstrap.form.HtmlEditor",
"desc" : "",
"isOptional" : false
},
"params" : [
{
"name" : "this",
- "type" : "HtmlEditor",
+ "type" : "Roo.bootstrap.form.HtmlEditor",
"desc" : "",
"isOptional" : false
}
"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",
"params" : [
{
"name" : "this",
- "type" : "HtmlEditor",
+ "type" : "Roo.bootstrap.form.HtmlEditor",
"desc" : "",
"isOptional" : false
},
}
]
},
+ {
+ "name" : "getAutoCreateLabel",
+ "type" : "function",
+ "desc" : "autocreate the label - also used by textara... ?? and others?",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
{
"name" : "getChildContainer",
"type" : "function",
"tree_children" : [],
"tree_parent" : []
},
- "Roo.bootstrap.form.HtmlEditorToolbarStandard" : {
+ "Roo.bootstrap.form.HtmlEditorToolbar" : {
+ "props" : [],
+ "events" : [],
+ "methods" : [],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "implementations" : [],
+ "tree_children" : [],
+ "tree_parent" : []
+ },
+ "Roo.bootstrap.form.HtmlEditorToolbar.Standard" : {
"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" : "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" : [
{
"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" : [
}
]
},
+ {
+ "name" : "getAutoCreateLabel",
+ "type" : "function",
+ "desc" : "autocreate the label - also used by textara... ?? and others?",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
{
"name" : "getChildContainer",
"type" : "function",
"Roo.bootstrap.form.MoneyField",
"Roo.bootstrap.form.MonthField",
"Roo.bootstrap.form.NumberField",
+ "Roo.bootstrap.form.Password",
"Roo.bootstrap.form.PhoneInput",
"Roo.bootstrap.form.RadioSet",
"Roo.bootstrap.form.SecurePass",
{
"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" : [
}
]
},
+ {
+ "name" : "getAutoCreateLabel",
+ "type" : "function",
+ "desc" : "autocreate the label - also used by textara... ?? and others?",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
{
"name" : "getChildContainer",
"type" : "function",
{
"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" : [
}
]
},
+ {
+ "name" : "getAutoCreateLabel",
+ "type" : "function",
+ "desc" : "autocreate the label - also used by textara... ?? and others?",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
{
"name" : "getChildContainer",
"type" : "function",
{
"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" : [
}
]
},
+ {
+ "name" : "getAutoCreateLabel",
+ "type" : "function",
+ "desc" : "autocreate the label - also used by textara... ?? and others?",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
{
"name" : "getChildContainer",
"type" : "function",
"tree_children" : [],
"tree_parent" : []
},
+ "Roo.bootstrap.form.MultiLineTag" : {
+ "props" : [],
+ "events" : [
+ {
+ "name" : "beforeload",
+ "type" : "function",
+ "desc" : "Fires before a request is made for a new data object. If the beforeload handler returns false\nthe load action will be canceled.",
+ "sig" : "function (_self, store, options)\n{\n\n}",
+ "memberOf" : "",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.boostrap.form.MultiLineTag",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "store",
+ "type" : "Store",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "options",
+ "type" : "Object",
+ "desc" : "The loading options that were specified (see {@link #load} for details)",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ }
+ ],
+ "methods" : [],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "implementations" : [],
+ "tree_children" : [],
+ "tree_parent" : []
+ },
"Roo.bootstrap.form.NumberField" : {
"props" : [
{
"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" : [
}
]
},
+ {
+ "name" : "getAutoCreateLabel",
+ "type" : "function",
+ "desc" : "autocreate the label - also used by textara... ?? and others?",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
{
"name" : "getChildContainer",
"type" : "function",
"tree_children" : [],
"tree_parent" : []
},
- "Roo.bootstrap.form.PhoneInput" : {
+ "Roo.bootstrap.form.Password" : {
"props" : [
{
"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"
- },
- {
- "name" : "caret",
- "type" : "String",
- "desc" : "r) BS3 only - carat fa name",
- "memberOf" : "Roo.bootstrap.form.TriggerField"
+ "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"
- },
- {
- "name" : "defaultDialCode",
- "type" : "String",
- "desc" : "default '+852'",
- "memberOf" : ""
+ "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"
- },
- {
- "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"
+ "desc" : "y)\nHow this component 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"
- },
- {
- "name" : "preferedCountries",
- "type" : "Array",
- "desc" : "default []",
- "memberOf" : ""
+ "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"
- },
- {
- "name" : "removable",
- "type" : "Boolean",
- "desc" : "e) special filter default false",
- "memberOf" : "Roo.bootstrap.form.TriggerField"
+ "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"
- },
- {
- "name" : "store",
- "type" : "Roo.data.Store",
- "desc" : "[required] The data store to which this combo is bound (defaults to undefined)",
- "memberOf" : ""
+ "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"
- },
- {
- "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.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" : [
],
"returns" : []
},
- {
- "name" : "autoSize",
- "type" : "function",
- "desc" : "",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.form.TriggerField",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
{
"name" : "capture",
"type" : "function",
}
]
},
+ {
+ "name" : "getAutoCreateLabel",
+ "type" : "function",
+ "desc" : "autocreate the label - also used by textara... ?? and others?",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
{
"name" : "getChildContainer",
"type" : "function",
"returns" : []
},
{
- "name" : "onTriggerClick",
+ "name" : "purgeListeners",
"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" : "Removes all listeners for this object",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.bootstrap.form.TriggerField",
+ "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" : "e",
- "type" : "EventObject",
+ "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.bootstrap.form.Input",
+ "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" : "purgeListeners",
+ "name" : "setRawValue",
"type" : "function",
- "desc" : "Removes all listeners for this object",
+ "desc" : "Sets the underlying DOM field's value directly, bypassing validation. To set the value with validation see {@link #setValue}.",
+ "sig" : "(value)",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "value",
+ "type" : "Mixed",
+ "desc" : "The value to set",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "setValue",
+ "type" : "function",
+ "desc" : "Sets a data value into the field and validates it. To set the value directly without validation see {@link #setRawValue}.",
+ "sig" : "(value)",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "value",
+ "type" : "Mixed",
+ "desc" : "The value to set",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "setVisibilityEl",
+ "type" : "function",
+ "desc" : "Set the element that will be used to show or hide",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.util.Observable",
+ "memberOf" : "Roo.bootstrap.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"returns" : []
},
{
- "name" : "releaseCapture",
+ "name" : "setVisible",
"type" : "function",
- "desc" : "Removes <b>all</b> added captures from the Observable.",
- "sig" : "(o)",
- "static" : true,
- "memberOf" : "Roo.util.Observable",
- "isStatic" : true,
+ "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" : "",
"requires" : "",
"params" : [
{
- "name" : "o",
- "type" : "Observable",
- "desc" : "The Observable to release",
+ "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 a component - removes 'hidden' class",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.Component",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
"returns" : []
},
{
- "name" : "removeListener",
+ "name" : "tooltipEl",
"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.bootstrap.form.Input",
- "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" : "setRawValue",
- "type" : "function",
- "desc" : "Sets the underlying DOM field's value directly, bypassing validation. To set the value with validation see {@link #setValue}.",
- "sig" : "(value)",
- "static" : false,
- "memberOf" : "Roo.bootstrap.form.Input",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "value",
- "type" : "Mixed",
- "desc" : "The value to set",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "setValue",
- "type" : "function",
- "desc" : "Sets a data value into the field and validates it. To set the value directly without validation see {@link #setRawValue}.",
- "sig" : "(value)",
- "static" : false,
- "memberOf" : "Roo.bootstrap.form.Input",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "value",
- "type" : "Mixed",
- "desc" : "The value to set",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "setVisibilityEl",
- "type" : "function",
- "desc" : "Set the element that will be used to show or hide",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.Component",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
- {
- "name" : "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 a component - removes 'hidden' class",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.Component",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
- {
- "name" : "tooltipEl",
- "type" : "function",
- "desc" : "Fetch the element to display the tooltip on.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.Component",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : [
- {
- "name" : "",
- "type" : "Roo.Element",
- "desc" : "defaults to this.el"
- }
- ]
- },
- {
- "name" : "un",
- "type" : "function",
- "desc" : "Removes a listener (shorthand for removeListener)",
+ "desc" : "Fetch the element to display the tooltip on.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.Component",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.Element",
+ "desc" : "defaults to this.el"
+ }
+ ]
+ },
+ {
+ "name" : "un",
+ "type" : "function",
+ "desc" : "Removes a listener (shorthand for removeListener)",
"sig" : "(eventName, handler, scope)",
"static" : false,
"memberOf" : "Roo.util.Observable",
"tree_children" : [],
"tree_parent" : []
},
- "Roo.bootstrap.form.Radio" : {
+ "Roo.bootstrap.form.PhoneInput" : {
"props" : [
+ {
+ "name" : "accept",
+ "type" : "String",
+ "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",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "afterButton",
+ "type" : "Roo.bootstrap.Button",
+ "desc" : "to show before",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "align",
+ "type" : "String",
+ "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",
+ "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",
+ "name" : "autocomplete",
"type" : "String",
- "desc" : "- the label associated",
- "memberOf" : ""
+ "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",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "before",
+ "type" : "string",
+ "desc" : "- input group add on before",
+ "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",
+ "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 empt",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : [
+ "user",
+ "camera"
+ ]
+ },
+ {
+ "name" : "caret",
+ "type" : "String",
+ "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" : "",
+ "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",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "disabled",
+ "type" : "Boolean",
+ "desc" : "is it disabled",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "fieldLabel",
+ "type" : "string",
+ "desc" : "- the label associated",
+ "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",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "forceFeedback",
+ "type" : "Boolean",
+ "desc" : "e) Default fal",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : [
+ "true",
+ "false"
+ ]
+ },
+ {
+ "name" : "hasFeedback",
+ "type" : "Boolean",
+ "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",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "indicatorpos",
+ "type" : "String",
+ "desc" : "t) default le",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : [
+ "left",
+ "right"
+ ]
+ },
+ {
+ "name" : "inputType",
+ "type" : "String",
+ "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",
+ "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",
+ "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",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "labelAlign",
+ "type" : "String",
+ "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",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "labellg",
+ "type" : "Number",
+ "desc" : "set the width of label (1-12)",
+ "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",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "labelsm",
+ "type" : "Number",
+ "desc" : "set the width of label (1-12)",
+ "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",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "lg",
+ "type" : "Number",
+ "desc" : "colspan out of 12 for large computer-sized screens",
+ "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",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "maxLength",
+ "type" : "Number",
+ "desc" : "Maximum input field length allowed (defaults to Number.MAX_VALUE)",
+ "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",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "md",
+ "type" : "Number",
+ "desc" : "colspan out of 12 for computer-sized screens",
+ "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",
+ "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",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "name",
+ "type" : "String",
+ "desc" : "name of the input",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "placeholder",
"type" : "string",
- "desc" : "Specifies name attribute",
- "memberOf" : "Roo.bootstrap.Component"
+ "desc" : "- placeholder to put in text.",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "preferedCountries",
+ "type" : "Array",
+ "desc" : "default []",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "preventMark",
+ "type" : "Boolean",
+ "desc" : "Do not show tick or cross if error/success",
+ "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",
+ "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",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "regexText",
+ "type" : "String",
+ "desc" : "-- Depricated - use Invalid Text",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "removable",
+ "type" : "Boolean",
+ "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",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "size",
+ "type" : "string",
+ "desc" : "- (lg|sm) or leave empty..",
+ "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",
+ "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" : "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",
+ "name" : "triggerClass",
"type" : "String",
- "desc" : "- the value of radio",
- "memberOf" : ""
+ "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",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "validClass",
+ "type" : "String",
+ "desc" : "DEPRICATED - code uses BS4 - is-valid / is-invalid",
+ "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",
+ "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",
+ "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",
+ "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",
+ "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",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "value",
+ "type" : "string",
+ "desc" : "default value of the 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",
+ "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",
+ "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.bootstrap.form.Input",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.form.Field",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "change",
+ "type" : "function",
+ "desc" : "Fires just before the field blurs if the field value has changed.",
+ "sig" : "function (_self, newValue, oldValue)\n{\n\n}",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.form.Field",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "newValue",
+ "type" : "Mixed",
+ "desc" : "The new value",
+ "isOptional" : false
+ },
+ {
+ "name" : "oldValue",
+ "type" : "Mixed",
+ "desc" : "The original value",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
{
"name" : "childrenrendered",
"type" : "function",
],
"returns" : []
},
+ {
+ "name" : "focus",
+ "type" : "function",
+ "desc" : "Fires when this field receives input focus.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "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.bootstrap.form.Input",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.form.Field",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "msg",
+ "type" : "String",
+ "desc" : "The validation message",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "keyup",
+ "type" : "function",
+ "desc" : "Fires after the key up",
+ "sig" : "function (_self, e)\n{\n\n}",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.form.Field",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "e",
+ "type" : "Roo.EventObject",
+ "desc" : "The event Object",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "paste",
+ "type" : "function",
+ "desc" : "Fires after the user pastes into input",
+ "sig" : "function (_self, e)\n{\n\n}",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.form.Field",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "e",
+ "type" : "Roo.EventObject",
+ "desc" : "The event Object",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
{
"name" : "render",
"type" : "function",
}
],
"returns" : []
+ },
+ {
+ "name" : "specialkey",
+ "type" : "function",
+ "desc" : "Fires when any key related to navigation (arrows, tab, enter, esc, etc.) is pressed. You can check\n{@link Roo.EventObject#getKey} to determine which key was pressed.",
+ "sig" : "function (_self, e)\n{\n\n}",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.form.Field",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "e",
+ "type" : "Roo.EventObject",
+ "desc" : "The event object",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "valid",
+ "type" : "function",
+ "desc" : "Fires after the field has been validated with no errors.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.form.Field",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
}
],
"methods" : [
],
"returns" : []
},
+ {
+ "name" : "autoSize",
+ "type" : "function",
+ "desc" : "",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.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.bootstrap.form.Input",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
{
"name" : "destroy",
"type" : "function",
}
]
},
+ {
+ "name" : "getAutoCreateLabel",
+ "type" : "function",
+ "desc" : "autocreate the label - also used by textara... ?? and others?",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
{
"name" : "getChildContainer",
"type" : "function",
}
]
},
+ {
+ "name" : "getName",
+ "type" : "function",
+ "desc" : "Returns the name of the field",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Mixed",
+ "desc" : "name The name field"
+ }
+ ]
+ },
+ {
+ "name" : "getRawValue",
+ "type" : "function",
+ "desc" : "Returns the raw data value which may or may not be a valid, defined value. To return a normalized value see {@link #getValue}.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Mixed",
+ "desc" : "value The field value"
+ }
+ ]
+ },
+ {
+ "name" : "getValue",
+ "type" : "function",
+ "desc" : "Returns the normalized data value (undefined or emptyText will be returned as ''). To return the raw value see {@link #getRawValue}.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Mixed",
+ "desc" : "value The field value"
+ }
+ ]
+ },
{
"name" : "getVisibilityEl",
"type" : "function",
"params" : [],
"returns" : []
},
+ {
+ "name" : "inputEl",
+ "type" : "function",
+ "desc" : "return the real input element.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
{
"name" : "isVisible",
"type" : "function",
"params" : [],
"returns" : []
},
+ {
+ "name" : "markInvalid",
+ "type" : "function",
+ "desc" : "Mark this field as invalid",
+ "sig" : "(msg)",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "msg",
+ "type" : "String",
+ "desc" : "The validation message",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "markValid",
+ "type" : "function",
+ "desc" : "Mark this field as valid",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
{
"name" : "on",
"type" : "function",
"returns" : []
},
{
- "name" : "purgeListeners",
+ "name" : "onTriggerClick",
"type" : "function",
- "desc" : "Removes all listeners for this object",
- "sig" : "()\n{\n\n}",
+ "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.util.Observable",
+ "memberOf" : "Roo.bootstrap.form.TriggerField",
"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)",
+ "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,
],
"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.bootstrap.form.Input",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "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.bootstrap.form.Input",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "value",
+ "type" : "Mixed",
+ "desc" : "The value to set",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "setValue",
+ "type" : "function",
+ "desc" : "Sets a data value into the field and validates it. To set the value directly without validation see {@link #setRawValue}.",
+ "sig" : "(value)",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "value",
+ "type" : "Mixed",
+ "desc" : "The value to set",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
{
"name" : "setVisibilityEl",
"type" : "function",
}
],
"returns" : []
+ },
+ {
+ "name" : "validate",
+ "type" : "function",
+ "desc" : "Validates the field value",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Boolean",
+ "desc" : "True if the value is valid, else false"
+ }
+ ]
+ },
+ {
+ "name" : "validateValue",
+ "type" : "function",
+ "desc" : "Validates a value according to the field's validation rules and marks the field as invalid\nif the validation fails",
+ "sig" : "(value)",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "value",
+ "type" : "Mixed",
+ "desc" : "The value to validate",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Boolean",
+ "desc" : "True if the value is valid, else false"
+ }
+ ]
}
],
"isAbstract" : false,
"tree_children" : [],
"tree_parent" : []
},
- "Roo.bootstrap.form.RadioSet" : {
+ "Roo.bootstrap.form.Radio" : {
"props" : [
- {
- "name" : "accept",
- "type" : "String",
- "desc" : "o) use for file input only. (default empty)",
- "memberOf" : "Roo.bootstrap.form.Input"
- },
{
"name" : "actionMode",
"type" : "String",
"desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el' for forms you probably want to set this to fieldEl",
- "memberOf" : "Roo.Component"
- },
- {
- "name" : "after",
- "type" : "string",
- "desc" : "- input group add on after",
- "memberOf" : "Roo.bootstrap.form.Input"
- },
- {
- "name" : "afterButton",
- "type" : "Roo.bootstrap.Button",
- "desc" : "to show before",
- "memberOf" : "Roo.bootstrap.form.Input"
- },
- {
- "name" : "align",
- "type" : "String",
- "desc" : "t) Default left",
- "memberOf" : "Roo.bootstrap.form.Input"
- },
- {
- "name" : "allowBlank",
- "type" : "Boolean",
- "desc" : "False to validate that the value length > 0 (defaults to true)",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "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" : "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"
- },
- {
- "name" : "before",
- "type" : "string",
- "desc" : "- input group add on before",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.Component",
+ "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.bootstrap.form.Input"
+ "desc" : "- the label associated",
+ "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"
- },
- {
- "name" : "capture",
- "type" : "String",
- "desc" : "a) use for file input only. (default empty)",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "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"
- },
- {
- "name" : "disableKeyFilter",
- "type" : "Boolean",
- "desc" : "True to disable input keystroke filtering (defaults to false)",
- "memberOf" : "Roo.bootstrap.form.Input"
- },
- {
- "name" : "disabled",
- "type" : "Boolean",
- "desc" : "is it disabled",
- "memberOf" : "Roo.bootstrap.form.Input"
- },
- {
- "name" : "fieldLabel",
- "type" : "string",
- "desc" : "- the label associated",
- "memberOf" : "Roo.bootstrap.form.Input"
- },
- {
- "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"
- },
- {
- "name" : "forceFeedback",
- "type" : "Boolean",
- "desc" : "e) Default false",
- "memberOf" : "Roo.bootstrap.form.Input"
- },
- {
- "name" : "hasFeedback",
- "type" : "Boolean",
- "desc" : "e) default true",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "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"
- },
- {
- "name" : "indicatorpos",
- "type" : "String",
- "desc" : "t) default left",
- "memberOf" : ""
- },
- {
- "name" : "inline",
- "type" : "Boolean",
- "desc" : "e) inline the element (default true)",
- "memberOf" : ""
- },
- {
- "name" : "inputType",
- "type" : "String",
- "desc" : "t)",
- "memberOf" : "Roo.bootstrap.form.Input"
- },
- {
- "name" : "invalidClass",
- "type" : "String",
- "desc" : "DEPRICATED - code uses BS4 - is-valid / is-invalid",
- "memberOf" : "Roo.bootstrap.form.Input"
- },
- {
- "name" : "invalidFeedbackIcon",
- "type" : "String",
- "desc" : "The CSS class to use when create feedback icon (defaults to \"x-form-invalid\")",
- "memberOf" : "Roo.bootstrap.form.Input"
- },
- {
- "name" : "invalidText",
- "type" : "String",
- "desc" : "The error text to display if {@link #validator} test fails during validation (defaults to \"\")",
- "memberOf" : "Roo.bootstrap.form.Input"
- },
- {
- "name" : "labelAlign",
- "type" : "String",
- "desc" : "t)",
- "memberOf" : "Roo.bootstrap.form.Input"
- },
- {
- "name" : "labelWidth",
- "type" : "Number",
- "desc" : "set the width of label",
- "memberOf" : "Roo.bootstrap.form.Input"
- },
- {
- "name" : "labellg",
- "type" : "Number",
- "desc" : "set the width of label (1-12)",
- "memberOf" : "Roo.bootstrap.form.Input"
- },
- {
- "name" : "labelmd",
- "type" : "Number",
- "desc" : "set the width of label (1-12)",
- "memberOf" : "Roo.bootstrap.form.Input"
- },
- {
- "name" : "labelsm",
- "type" : "Number",
- "desc" : "set the width of label (1-12)",
- "memberOf" : "Roo.bootstrap.form.Input"
- },
- {
- "name" : "labelxs",
- "type" : "Number",
- "desc" : "set the width of label (1-12)",
- "memberOf" : "Roo.bootstrap.form.Input"
- },
- {
- "name" : "lg",
- "type" : "Number",
- "desc" : "colspan out of 12 for large computer-sized screens",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "desc" : "y)\nHow this component 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"
- },
- {
- "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"
- },
- {
- "name" : "maxLength",
- "type" : "Number",
- "desc" : "Maximum input field length allowed (defaults to Number.MAX_VALUE)",
- "memberOf" : "Roo.bootstrap.form.Input"
- },
- {
- "name" : "maxLengthText",
- "type" : "String",
- "desc" : "Error text to display if the maximum length validation fails (defaults to \"The maximum length for this field is {maxLength}\")",
- "memberOf" : "Roo.bootstrap.form.Input"
- },
- {
- "name" : "md",
- "type" : "Number",
- "desc" : "colspan out of 12 for computer-sized screens",
- "memberOf" : "Roo.bootstrap.form.Input"
- },
- {
- "name" : "minLength",
- "type" : "Number",
- "desc" : "Minimum input field length required (defaults to 0)",
- "memberOf" : "Roo.bootstrap.form.Input"
- },
- {
- "name" : "minLengthText",
- "type" : "String",
- "desc" : "Error text to display if the minimum length validation fails (defaults to \"The minimum length for this field is {minLength}\")",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.util.Observable",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "name",
- "type" : "String",
- "desc" : "name of the input",
- "memberOf" : "Roo.bootstrap.form.Input"
- },
- {
- "name" : "placeholder",
- "type" : "string",
- "desc" : "- placeholder to put in text.",
- "memberOf" : "Roo.bootstrap.form.Input"
- },
- {
- "name" : "preventMark",
- "type" : "Boolean",
- "desc" : "Do not show tick or cross if error/success",
- "memberOf" : "Roo.bootstrap.form.Input"
- },
- {
- "name" : "readOnly",
- "type" : "Boolean",
- "desc" : "Specifies that the field should be read-only",
- "memberOf" : "Roo.bootstrap.form.Input"
- },
- {
- "name" : "regex",
- "type" : "RegExp",
- "desc" : "A JavaScript RegExp object to be tested against the field value during validation (defaults to null).\nIf available, this regex will be evaluated only after the basic validators all return true, and will be passed the\ncurrent field value. If the test fails, the field will be marked invalid using {@link #regexText}.",
- "memberOf" : "Roo.bootstrap.form.Input"
- },
- {
- "name" : "regexText",
- "type" : "String",
- "desc" : "-- Depricated - use Invalid Text",
- "memberOf" : "Roo.bootstrap.form.Input"
- },
- {
- "name" : "selectOnFocus",
- "type" : "Boolean",
- "desc" : "True to automatically select any existing field text when the field receives input focus (defaults to false)",
- "memberOf" : "Roo.bootstrap.form.Input"
- },
- {
- "name" : "size",
"type" : "string",
- "desc" : "- (lg|sm) or leave empty..",
- "memberOf" : "Roo.bootstrap.form.Input"
- },
- {
- "name" : "sm",
- "type" : "Number",
- "desc" : "colspan out of 12 for tablet-sized screens",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "desc" : "Specifies name attribute",
+ "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"
- },
- {
- "name" : "validClass",
- "type" : "String",
- "desc" : "DEPRICATED - code uses BS4 - is-valid / is-invalid",
- "memberOf" : "Roo.bootstrap.form.Input"
- },
- {
- "name" : "validFeedbackIcon",
- "type" : "String",
- "desc" : "The CSS class to use when create feedback icon (defaults to \"x-form-invalid\")",
- "memberOf" : "Roo.bootstrap.form.Input"
- },
- {
- "name" : "validateOnBlur",
- "type" : "Boolean",
- "desc" : "Whether the field should validate when it loses focus (defaults to true).",
- "memberOf" : "Roo.bootstrap.form.Input"
- },
- {
- "name" : "validationDelay",
- "type" : "Number",
- "desc" : "The length of time in milliseconds after user input begins until validation is initiated (defaults to 250)",
- "memberOf" : "Roo.bootstrap.form.Input"
- },
- {
- "name" : "validationEvent",
- "type" : "String/Boolean",
- "desc" : "The event that should initiate field validation. Set to false to disable\n automatic validation (defaults to \"keyup\").",
- "memberOf" : "Roo.bootstrap.form.Input"
- },
- {
- "name" : "validator",
- "type" : "Function",
- "desc" : "A custom validation function to be called during field validation (defaults to null).\nIf available, this function will be called only after the basic validators all return true, and will be passed the\ncurrent field value and expected to return boolean true if the value is valid or a string error message if invalid.",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "value",
- "type" : "string",
- "desc" : "default value of the input",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "type" : "String",
+ "desc" : "- the value of radio",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "visibilityEl",
"type" : "string|object",
- "desc" : "t) What element to use for visibility (@see getVisibilityEl())",
- "memberOf" : "Roo.bootstrap.Component"
- },
- {
- "name" : "vtype",
- "type" : "String",
- "desc" : "A validation type name as defined in {@link Roo.form.VTypes} (defaults to null)",
- "memberOf" : "Roo.bootstrap.form.Input"
- },
- {
- "name" : "weight",
- "type" : "String",
- "desc" : "s) The text that appears beside the radio",
- "memberOf" : ""
+ "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"
- },
- {
- "name" : "xs",
- "type" : "Number",
- "desc" : "colspan out of 12 for mobile-sized screens",
- "memberOf" : "Roo.bootstrap.form.Input"
+ "memberOf" : "Roo.bootstrap.Component",
+ "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.bootstrap.form.Input",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.form.Field",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "change",
- "type" : "function",
- "desc" : "Fires just before the field blurs if the field value has changed.",
- "sig" : "function (_self, newValue, oldValue)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.form.Input",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.form.Field",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "newValue",
- "type" : "Mixed",
- "desc" : "The new value",
- "isOptional" : false
- },
- {
- "name" : "oldValue",
- "type" : "Mixed",
- "desc" : "The original value",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "check",
- "type" : "function",
- "desc" : "Fires when the element is checked or unchecked.",
- "sig" : "function (_self, item)\n{\n\n}",
- "memberOf" : "",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.bootstrap.form.RadioSet",
- "desc" : "This radio",
- "isOptional" : false
- },
- {
- "name" : "item",
- "type" : "Roo.bootstrap.form.Radio",
- "desc" : "The checked item",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
{
"name" : "childrenrendered",
"type" : "function",
],
"returns" : []
},
- {
- "name" : "click",
- "type" : "function",
- "desc" : "Fires when the element is click.",
- "sig" : "function (_self, item, e)\n{\n\n}",
- "memberOf" : "",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.bootstrap.form.RadioSet",
- "desc" : "This radio set",
- "isOptional" : false
- },
- {
- "name" : "item",
- "type" : "Roo.bootstrap.form.Radio",
- "desc" : "The checked item",
- "isOptional" : false
- },
- {
- "name" : "e",
- "type" : "Roo.EventObject",
- "desc" : "The event object",
- "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.bootstrap.form.Input",
- "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.bootstrap.form.Input",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.form.Field",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "msg",
- "type" : "String",
- "desc" : "The validation message",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "keyup",
- "type" : "function",
- "desc" : "Fires after the key up",
- "sig" : "function (_self, e)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.form.Input",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.form.Field",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "e",
- "type" : "Roo.EventObject",
- "desc" : "The event Object",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "paste",
- "type" : "function",
- "desc" : "Fires after the user pastes into input",
- "sig" : "function (_self, e)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.form.Input",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.form.Field",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "e",
- "type" : "Roo.EventObject",
- "desc" : "The event Object",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
{
"name" : "render",
"type" : "function",
}
],
"returns" : []
- },
- {
- "name" : "specialkey",
- "type" : "function",
- "desc" : "Fires when any key related to navigation (arrows, tab, enter, esc, etc.) is pressed. You can check\n{@link Roo.EventObject#getKey} to determine which key was pressed.",
- "sig" : "function (_self, e)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.form.Input",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.form.Field",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "e",
- "type" : "Roo.EventObject",
- "desc" : "The event object",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "valid",
- "type" : "function",
- "desc" : "Fires after the field has been validated with no errors.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.form.Input",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.form.Field",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
}
],
"methods" : [
],
"returns" : []
},
- {
- "name" : "clearInvalid",
- "type" : "function",
- "desc" : "Clear any invalid styles/messages for this field",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.form.Input",
- "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 of the field",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.form.Input",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : [
- {
- "name" : "",
- "type" : "Mixed",
- "desc" : "name The name field"
- }
- ]
- },
- {
- "name" : "getRawValue",
- "type" : "function",
- "desc" : "Returns the raw data value which may or may not be a valid, defined value. To return a normalized value see {@link #getValue}.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.form.Input",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : [
- {
- "name" : "",
- "type" : "Mixed",
- "desc" : "value The field value"
- }
- ]
- },
- {
- "name" : "getValue",
- "type" : "function",
- "desc" : "Returns the normalized data value (undefined or emptyText will be returned as ''). To return the raw value see {@link #getRawValue}.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.form.Input",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : [
- {
- "name" : "",
- "type" : "Mixed",
- "desc" : "value The field value"
- }
- ]
- },
{
"name" : "getVisibilityEl",
"type" : "function",
"params" : [],
"returns" : []
},
- {
- "name" : "inputEl",
- "type" : "function",
- "desc" : "return the real input element.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.form.Input",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
{
"name" : "isVisible",
"type" : "function",
"params" : [],
"returns" : []
},
- {
- "name" : "markInvalid",
- "type" : "function",
- "desc" : "Mark this field as invalid",
- "sig" : "(msg)",
- "static" : false,
- "memberOf" : "Roo.bootstrap.form.Input",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "msg",
- "type" : "String",
- "desc" : "The validation message",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "markValid",
- "type" : "function",
- "desc" : "Mark this field as valid",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.form.Input",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "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" : "Roo.bootstrap.form.Input",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "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.bootstrap.form.Input",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "value",
- "type" : "Mixed",
- "desc" : "The value to set",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "setValue",
- "type" : "function",
- "desc" : "Sets a data value into the field and validates it. To set the value directly without validation see {@link #setRawValue}.",
- "sig" : "(value)",
- "static" : false,
- "memberOf" : "Roo.bootstrap.form.Input",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "value",
- "type" : "Mixed",
- "desc" : "The value to set",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
{
"name" : "setVisibilityEl",
"type" : "function",
}
],
"returns" : []
- },
- {
- "name" : "validate",
- "type" : "function",
- "desc" : "Validates the field value",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.form.Input",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : [
- {
- "name" : "",
- "type" : "Boolean",
- "desc" : "True if the value is valid, else false"
- }
- ]
- },
- {
- "name" : "validateValue",
- "type" : "function",
- "desc" : "Validates a value according to the field's validation rules and marks the field as invalid\nif the validation fails",
- "sig" : "(value)",
- "static" : false,
- "memberOf" : "Roo.bootstrap.form.Input",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "value",
- "type" : "Mixed",
- "desc" : "The value to validate",
- "isOptional" : false
- }
- ],
- "returns" : [
- {
- "name" : "",
- "type" : "Boolean",
- "desc" : "True if the value is valid, else false"
- }
- ]
}
],
"isAbstract" : false,
"isBuilderTop" : false,
"implementations" : [],
- "tree_children" : [
- "Roo.bootstrap.form.Radio"
- ],
+ "tree_children" : [],
"tree_parent" : []
},
- "Roo.bootstrap.form.SecurePass" : {
+ "Roo.bootstrap.form.RadioSet" : {
"props" : [
- {
- "name" : "Label",
- "type" : "String/Object",
- "desc" : "for the strength meter (defaults to\n'Password strength:')",
- "memberOf" : ""
- },
{
"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"
- },
- {
- "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" : "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" : "",
+ "isOptional" : false,
+ "optvals" : [
+ "left",
+ "right"
+ ]
+ },
+ {
+ "name" : "inline",
+ "type" : "Boolean",
+ "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"
- },
- {
- "name" : "pwdStrengths",
- "type" : "String/Object",
- "desc" : "A pwdStrengths spec, or true for a default spec (defaults to\n['Weak', 'Medium', 'Strong'])",
- "memberOf" : ""
+ "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 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" : [
],
"returns" : []
},
+ {
+ "name" : "check",
+ "type" : "function",
+ "desc" : "Fires when the element is checked or unchecked.",
+ "sig" : "function (_self, item)\n{\n\n}",
+ "memberOf" : "",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.bootstrap.form.RadioSet",
+ "desc" : "This radio",
+ "isOptional" : false
+ },
+ {
+ "name" : "item",
+ "type" : "Roo.bootstrap.form.Radio",
+ "desc" : "The checked item",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
{
"name" : "childrenrendered",
"type" : "function",
],
"returns" : []
},
+ {
+ "name" : "click",
+ "type" : "function",
+ "desc" : "Fires when the element is click.",
+ "sig" : "function (_self, item, e)\n{\n\n}",
+ "memberOf" : "",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.bootstrap.form.RadioSet",
+ "desc" : "This radio set",
+ "isOptional" : false
+ },
+ {
+ "name" : "item",
+ "type" : "Roo.bootstrap.form.Radio",
+ "desc" : "The checked item",
+ "isOptional" : false
+ },
+ {
+ "name" : "e",
+ "type" : "Roo.EventObject",
+ "desc" : "The event object",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
{
"name" : "destroy",
"type" : "function",
}
]
},
+ {
+ "name" : "getAutoCreateLabel",
+ "type" : "function",
+ "desc" : "autocreate the label - also used by textara... ?? and others?",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
{
"name" : "getChildContainer",
"type" : "function",
"isAbstract" : false,
"isBuilderTop" : false,
"implementations" : [],
- "tree_children" : [],
+ "tree_children" : [
+ "Roo.bootstrap.form.Radio"
+ ],
"tree_parent" : []
},
- "Roo.bootstrap.form.TextArea" : {
+ "Roo.bootstrap.form.SecurePass" : {
"props" : [
{
"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"
- },
- {
- "name" : "cols",
- "type" : "Number",
- "desc" : "Specifies the visible width of a text area",
- "memberOf" : ""
+ "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"
- },
- {
- "name" : "html",
- "type" : "string",
- "desc" : "text",
- "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" : "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" : "minimumStrength",
+ "type" : "Number",
+ "desc" : "invalid if the strength of the password input is less than the minimum strength (from 0 to 3) (default 2)",
+ "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"
- },
- {
- "name" : "resize",
- "type" : "string",
- "desc" : "l)",
- "memberOf" : ""
- },
- {
- "name" : "rows",
- "type" : "Number",
- "desc" : "Specifies the visible number of lines in a text area",
- "memberOf" : ""
+ "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"
- },
- {
- "name" : "wrap",
- "type" : "string",
- "desc" : "d)Specifies how the text in a text area is to be wrapped when submitted in a form",
- "memberOf" : ""
+ "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" : [
"desc" : "Clear any invalid styles/messages for this field",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.bootstrap.form.Input",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
}
]
},
+ {
+ "name" : "getAutoCreateLabel",
+ "type" : "function",
+ "desc" : "autocreate the label - also used by textara... ?? and others?",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
{
"name" : "getChildContainer",
"type" : "function",
{
"name" : "inputEl",
"type" : "function",
- "desc" : "return the real textarea element.",
+ "desc" : "return the real input element.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.bootstrap.form.Input",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"desc" : "Mark this field as invalid",
"sig" : "(msg)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.bootstrap.form.Input",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"desc" : "Mark this field as valid",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.bootstrap.form.Input",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
],
"isAbstract" : false,
"isBuilderTop" : false,
- "implementations" : [
- "Roo.bootstrap.form.HtmlEditor",
- "Roo.bootstrap.form.Markdown"
- ],
+ "implementations" : [],
"tree_children" : [],
"tree_parent" : []
},
- "Roo.bootstrap.form.TimeField" : {
+ "Roo.bootstrap.form.TextArea" : {
"props" : [
{
"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" : "",
+ "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"
- },
- {
- "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" : ""
+ "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" : "",
+ "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" : "",
+ "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" : "",
+ "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 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" : [
],
"returns" : []
},
- {
- "name" : "select",
- "type" : "function",
- "desc" : "Fires when select a date.",
- "sig" : "function (_self, date)\n{\n\n}",
- "memberOf" : "",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.bootstrap.form.DateField",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "date",
- "type" : "Mixed",
- "desc" : "The date value",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
{
"name" : "show",
"type" : "function",
- "desc" : "Fires when this field show.",
- "sig" : "function (thisthis, date)\n{\n\n}",
- "memberOf" : "",
+ "desc" : "Fires after the component is shown.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
"params" : [
{
- "name" : "thisthis",
- "type" : "Roo.bootstrap.form.DateField",
+ "name" : "this",
+ "type" : "Roo.Component",
"desc" : "",
"isOptional" : false
- },
- {
- "name" : "date",
- "type" : "Mixed",
- "desc" : "The date value",
- "isOptional" : false
}
],
"returns" : []
"desc" : "Clear any invalid styles/messages for this field",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.bootstrap.form.Input",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
}
]
},
+ {
+ "name" : "getAutoCreateLabel",
+ "type" : "function",
+ "desc" : "autocreate the label - also used by textara... ?? and others?",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
{
"name" : "getChildContainer",
"type" : "function",
{
"name" : "inputEl",
"type" : "function",
- "desc" : "return the real input element.",
+ "desc" : "return the real textarea element.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.bootstrap.form.Input",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"desc" : "Mark this field as invalid",
"sig" : "(msg)",
"static" : false,
- "memberOf" : "Roo.bootstrap.form.Input",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"desc" : "Mark this field as valid",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.bootstrap.form.Input",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
],
"isAbstract" : false,
"isBuilderTop" : false,
- "implementations" : [],
+ "implementations" : [
+ "Roo.bootstrap.form.HtmlEditor",
+ "Roo.bootstrap.form.Markdown"
+ ],
"tree_children" : [],
"tree_parent" : []
},
- "Roo.bootstrap.form.TriggerField" : {
+ "Roo.bootstrap.form.TimeField" : {
"props" : [
{
"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"
- },
- {
- "name" : "caret",
- "type" : "String",
- "desc" : "r) BS3 only - carat fa name",
- "memberOf" : ""
+ "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" : "",
+ "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"
- },
- {
- "name" : "hideTrigger",
- "type" : "Boolean",
- "desc" : "True to hide the trigger element and display only the base text field (defaults to false)",
- "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" : "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" : "minuteStep",
+ "type" : "Number",
+ "desc" : "the minutes is always the multiple of a fixed number, default 1",
+ "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"
- },
- {
- "name" : "removable",
- "type" : "Boolean",
- "desc" : "e) special filter default false",
- "memberOf" : ""
+ "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"
- },
- {
- "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" : "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" : [
"returns" : []
},
{
- "name" : "show",
+ "name" : "select",
"type" : "function",
- "desc" : "Fires after the component is shown.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
+ "desc" : "Fires when select a date.",
+ "sig" : "function (_self, date)\n{\n\n}",
+ "memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.Component",
+ "type" : "Roo.bootstrap.form.DateField",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "date",
+ "type" : "Mixed",
+ "desc" : "The date value",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "show",
+ "type" : "function",
+ "desc" : "Fires when this field show.",
+ "sig" : "function (thisthis, date)\n{\n\n}",
+ "memberOf" : "",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "thisthis",
+ "type" : "Roo.bootstrap.form.DateField",
"desc" : "",
"isOptional" : false
+ },
+ {
+ "name" : "date",
+ "type" : "Mixed",
+ "desc" : "The date value",
+ "isOptional" : false
}
],
"returns" : []
],
"returns" : []
},
- {
- "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",
}
]
},
+ {
+ "name" : "getAutoCreateLabel",
+ "type" : "function",
+ "desc" : "autocreate the label - also used by textara... ?? and others?",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
{
"name" : "getChildContainer",
"type" : "function",
"returns" : []
},
{
- "name" : "onTriggerClick",
+ "name" : "purgeListeners",
"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" : "Removes all listeners for this object",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "",
+ "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,
"requires" : "",
"params" : [
{
- "name" : "e",
- "type" : "EventObject",
+ "name" : "eventName",
+ "type" : "String",
+ "desc" : "The type of event to listen for",
+ "isOptional" : false
+ },
+ {
+ "name" : "handler",
+ "type" : "Function",
+ "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.bootstrap.form.Input",
+ "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" : "purgeListeners",
+ "name" : "setRawValue",
"type" : "function",
- "desc" : "Removes all listeners for this object",
+ "desc" : "Sets the underlying DOM field's value directly, bypassing validation. To set the value with validation see {@link #setValue}.",
+ "sig" : "(value)",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "value",
+ "type" : "Mixed",
+ "desc" : "The value to set",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "setValue",
+ "type" : "function",
+ "desc" : "Sets a data value into the field and validates it. To set the value directly without validation see {@link #setRawValue}.",
+ "sig" : "(value)",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "value",
+ "type" : "Mixed",
+ "desc" : "The value to set",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "setVisibilityEl",
+ "type" : "function",
+ "desc" : "Set the element that will be used to show or hide",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.util.Observable",
+ "memberOf" : "Roo.bootstrap.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"returns" : []
},
{
- "name" : "releaseCapture",
+ "name" : "setVisible",
"type" : "function",
- "desc" : "Removes <b>all</b> added captures from the Observable.",
- "sig" : "(o)",
- "static" : true,
- "memberOf" : "Roo.util.Observable",
- "isStatic" : true,
+ "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" : "",
"requires" : "",
"params" : [
{
- "name" : "o",
- "type" : "Observable",
- "desc" : "The Observable to release",
+ "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 a component - removes 'hidden' class",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.Component",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
"returns" : []
},
{
- "name" : "removeListener",
+ "name" : "tooltipEl",
"type" : "function",
- "desc" : "Removes a listener",
+ "desc" : "Fetch the element to display the tooltip on.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.Component",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.Element",
+ "desc" : "defaults to this.el"
+ }
+ ]
+ },
+ {
+ "name" : "un",
+ "type" : "function",
+ "desc" : "Removes a listener (shorthand for removeListener)",
"sig" : "(eventName, handler, scope)",
"static" : false,
"memberOf" : "Roo.util.Observable",
],
"returns" : []
},
+ {
+ "name" : "validate",
+ "type" : "function",
+ "desc" : "Validates the field value",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Boolean",
+ "desc" : "True if the value is valid, else false"
+ }
+ ]
+ },
+ {
+ "name" : "validateValue",
+ "type" : "function",
+ "desc" : "Validates a value according to the field's validation rules and marks the field as invalid\nif the validation fails",
+ "sig" : "(value)",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "value",
+ "type" : "Mixed",
+ "desc" : "The value to validate",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Boolean",
+ "desc" : "True if the value is valid, else false"
+ }
+ ]
+ }
+ ],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "implementations" : [],
+ "tree_children" : [],
+ "tree_parent" : []
+ },
+ "Roo.bootstrap.form.TriggerField" : {
+ "props" : [
+ {
+ "name" : "accept",
+ "type" : "String",
+ "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",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "after",
+ "type" : "string",
+ "desc" : "- input group add on after",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "afterButton",
+ "type" : "Roo.bootstrap.Button",
+ "desc" : "to show before",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "align",
+ "type" : "String",
+ "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",
+ "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" : "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",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "before",
+ "type" : "string",
+ "desc" : "- input group add on before",
+ "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",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "can_build_overlaid",
+ "type" : "Boolean",
+ "desc" : "True if element can be rebuild from a HTML page",
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "capture",
+ "type" : "String",
+ "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 na",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : [
+ "search",
+ "calendar"
+ ]
+ },
+ {
+ "name" : "cls",
+ "type" : "String",
+ "desc" : "css class",
+ "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",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "dataId",
+ "type" : "string",
+ "desc" : "cutomer id",
+ "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",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "disableKeyFilter",
+ "type" : "Boolean",
+ "desc" : "True to disable input keystroke filtering (defaults to false)",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "disabled",
+ "type" : "Boolean",
+ "desc" : "is it disabled",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "fieldLabel",
+ "type" : "string",
+ "desc" : "- the label associated",
+ "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",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "forceFeedback",
+ "type" : "Boolean",
+ "desc" : "e) Default fal",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : [
+ "true",
+ "false"
+ ]
+ },
+ {
+ "name" : "hasFeedback",
+ "type" : "Boolean",
+ "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",
+ "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" : "indicatorpos",
+ "type" : "String",
+ "desc" : "t) default le",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : [
+ "left",
+ "right"
+ ]
+ },
+ {
+ "name" : "inputType",
+ "type" : "String",
+ "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",
+ "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",
+ "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",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "labelAlign",
+ "type" : "String",
+ "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",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "labellg",
+ "type" : "Number",
+ "desc" : "set the width of label (1-12)",
+ "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",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "labelsm",
+ "type" : "Number",
+ "desc" : "set the width of label (1-12)",
+ "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",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "lg",
+ "type" : "Number",
+ "desc" : "colspan out of 12 for large computer-sized screens",
+ "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",
+ "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",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "maxLength",
+ "type" : "Number",
+ "desc" : "Maximum input field length allowed (defaults to Number.MAX_VALUE)",
+ "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",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "md",
+ "type" : "Number",
+ "desc" : "colspan out of 12 for computer-sized screens",
+ "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",
+ "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",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "name",
+ "type" : "String",
+ "desc" : "name of the input",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "placeholder",
+ "type" : "string",
+ "desc" : "- placeholder to put in text.",
+ "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",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "readOnly",
+ "type" : "Boolean",
+ "desc" : "Specifies that the field should be read-only",
+ "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",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "regexText",
+ "type" : "String",
+ "desc" : "-- Depricated - use Invalid Text",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "removable",
+ "type" : "Boolean",
+ "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",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "size",
+ "type" : "string",
+ "desc" : "- (lg|sm) or leave empty..",
+ "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",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "style",
+ "type" : "String",
+ "desc" : "any extra css",
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "tooltip",
+ "type" : "string",
+ "desc" : "Text for the tooltip",
+ "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" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "validClass",
+ "type" : "String",
+ "desc" : "DEPRICATED - code uses BS4 - is-valid / is-invalid",
+ "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",
+ "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",
+ "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",
+ "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",
+ "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",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "value",
+ "type" : "string",
+ "desc" : "default value of the 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",
+ "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",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "xattr",
+ "type" : "Object",
+ "desc" : "extra attributes to add to 'element' (used by builder to store stuff.)",
+ "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",
+ "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" : "Roo.bootstrap.form.Input",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.form.Field",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "change",
+ "type" : "function",
+ "desc" : "Fires just before the field blurs if the field value has changed.",
+ "sig" : "function (_self, newValue, oldValue)\n{\n\n}",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.form.Field",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "newValue",
+ "type" : "Mixed",
+ "desc" : "The new value",
+ "isOptional" : false
+ },
+ {
+ "name" : "oldValue",
+ "type" : "Mixed",
+ "desc" : "The original value",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "childrenrendered",
+ "type" : "function",
+ "desc" : "Fires when the children have been rendered..",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.bootstrap.Component",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.bootstrap.Component",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "destroy",
+ "type" : "function",
+ "desc" : "Fires after the component is destroyed.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
+ "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.bootstrap.form.Input",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.form.Field",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "hide",
+ "type" : "function",
+ "desc" : "Fires after the component is hidden.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.Component",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "invalid",
+ "type" : "function",
+ "desc" : "Fires after the field has been marked as invalid.",
+ "sig" : "function (_self, msg)\n{\n\n}",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.form.Field",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "msg",
+ "type" : "String",
+ "desc" : "The validation message",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "keyup",
+ "type" : "function",
+ "desc" : "Fires after the key up",
+ "sig" : "function (_self, e)\n{\n\n}",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.form.Field",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "e",
+ "type" : "Roo.EventObject",
+ "desc" : "The event Object",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "paste",
+ "type" : "function",
+ "desc" : "Fires after the user pastes into input",
+ "sig" : "function (_self, e)\n{\n\n}",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.form.Field",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "e",
+ "type" : "Roo.EventObject",
+ "desc" : "The event Object",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
{
"name" : "render",
"type" : "function",
- "desc" : "If this is a lazy rendering component, render it to its container element.",
- "sig" : "(container)",
- "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" : "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.bootstrap.form.Input",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.form.Field",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "e",
+ "type" : "Roo.EventObject",
+ "desc" : "The event object",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "valid",
+ "type" : "function",
+ "desc" : "Fires after the field has been validated with no errors.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "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" : "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",
+ "desc" : "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.bootstrap.form.Input",
+ "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" : "getAutoCreateLabel",
+ "type" : "function",
+ "desc" : "autocreate the label - also used by textara... ?? and others?",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
+ {
+ "name" : "getChildContainer",
+ "type" : "function",
+ "desc" : "Fetch the element to add children to",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.Component",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.Element",
+ "desc" : "defaults to this.el"
+ }
+ ]
+ },
+ {
+ "name" : "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 of the field",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Mixed",
+ "desc" : "name The name field"
+ }
+ ]
+ },
+ {
+ "name" : "getRawValue",
+ "type" : "function",
+ "desc" : "Returns the raw data value which may or may not be a valid, defined value. To return a normalized value see {@link #getValue}.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Mixed",
+ "desc" : "value The field value"
+ }
+ ]
+ },
+ {
+ "name" : "getValue",
+ "type" : "function",
+ "desc" : "Returns the normalized data value (undefined or emptyText will be returned as ''). To return the raw value see {@link #getRawValue}.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Mixed",
+ "desc" : "value The field value"
+ }
+ ]
+ },
+ {
+ "name" : "getVisibilityEl",
+ "type" : "function",
+ "desc" : "Get the element that will be used to show or hide",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.Component",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
+ {
+ "name" : "hasListener",
+ "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 a component - adds 'hidden' class",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.Component",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
+ {
+ "name" : "initEvents",
+ "type" : "function",
+ "desc" : "Initialize Events for the element",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.Component",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
+ {
+ "name" : "inputEl",
+ "type" : "function",
+ "desc" : "return the real input element.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
+ {
+ "name" : "isVisible",
+ "type" : "function",
+ "desc" : "Returns true if this component is visible.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.Component",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
+ {
+ "name" : "markInvalid",
+ "type" : "function",
+ "desc" : "Mark this field as invalid",
+ "sig" : "(msg)",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "msg",
+ "type" : "String",
+ "desc" : "The validation message",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "markValid",
+ "type" : "function",
+ "desc" : "Mark this field as valid",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
+ {
+ "name" : "on",
+ "type" : "function",
+ "desc" : "Appends an event handler to this element (shorthand for addListener)",
+ "sig" : "(eventName, handler, scope, options)",
+ "static" : false,
+ "memberOf" : "Roo.util.Observable",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "eventName",
+ "type" : "String",
+ "desc" : "The type of event to listen for",
+ "isOptional" : false
+ },
+ {
+ "name" : "handler",
+ "type" : "Function",
+ "desc" : "The method the event invokes",
+ "isOptional" : false
+ },
+ {
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
+ "isOptional" : false
+ },
+ {
+ "name" : "options",
+ "type" : "Object",
+ "desc" : "(optional)",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "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",
+ "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.bootstrap.form.Input",
+ "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" : "setRawValue",
+ "type" : "function",
+ "desc" : "Sets the underlying DOM field's value directly, bypassing validation. To set the value with validation see {@link #setValue}.",
+ "sig" : "(value)",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "value",
+ "type" : "Mixed",
+ "desc" : "The value to set",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "setValue",
+ "type" : "function",
+ "desc" : "Sets a data value into the field and validates it. To set the value directly without validation see {@link #setRawValue}.",
+ "sig" : "(value)",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "value",
+ "type" : "Mixed",
+ "desc" : "The value to set",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "setVisibilityEl",
+ "type" : "function",
+ "desc" : "Set the element that will be used to show or hide",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.Component",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
+ {
+ "name" : "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 a component - removes 'hidden' class",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.Component",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
+ {
+ "name" : "tooltipEl",
+ "type" : "function",
+ "desc" : "Fetch the element to display the tooltip on.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.Component",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.Element",
+ "desc" : "defaults to this.el"
+ }
+ ]
+ },
+ {
+ "name" : "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" : "validate",
+ "type" : "function",
+ "desc" : "Validates the field value",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Boolean",
+ "desc" : "True if the value is valid, else false"
+ }
+ ]
+ },
+ {
+ "name" : "validateValue",
+ "type" : "function",
+ "desc" : "Validates a value according to the field's validation rules and marks the field as invalid\nif the validation fails",
+ "sig" : "(value)",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.form.Input",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "value",
+ "type" : "Mixed",
+ "desc" : "The value to validate",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Boolean",
+ "desc" : "True if the value is valid, else false"
+ }
+ ]
+ }
+ ],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "implementations" : [
+ "Roo.bootstrap.form.ComboBox",
+ "Roo.bootstrap.form.MoneyField",
+ "Roo.bootstrap.form.PhoneInput"
+ ],
+ "tree_children" : [],
+ "tree_parent" : []
+ },
+ "Roo.bootstrap.layout" : {
+ "props" : [],
+ "events" : [],
+ "methods" : [],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "implementations" : [],
+ "tree_children" : [],
+ "tree_parent" : []
+ },
+ "Roo.bootstrap.layout.Basic" : {
+ "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" : "mgr",
+ "type" : "Roo.bootstrap.layout.Manager",
+ "desc" : "The manager",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "region",
+ "type" : "string",
+ "desc" : "the region that it inhabits..",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "skipConfig",
+ "type" : "bool",
+ "desc" : "skip config?",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ }
+ ],
+ "events" : [],
+ "methods" : [
+ {
+ "name" : "add",
+ "type" : "function",
+ "desc" : "Add the passed ContentPanel(s)",
+ "sig" : "(panel)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "panel",
+ "type" : "ContentPanel...",
+ "desc" : "The ContentPanel(s) to add (you can pass more than one)",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.ContentPanel",
+ "desc" : "The panel added (if only one was added)"
+ }
+ ]
+ },
+ {
+ "name" : "addEvents",
+ "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" : "getActivePanel",
+ "type" : "function",
+ "desc" : "Get the active panel for this region.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.ContentPanel",
+ "desc" : "The active panel or null"
+ }
+ ]
+ },
+ {
+ "name" : "getEl",
+ "type" : "function",
+ "desc" : "Returns the container element for this region.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.Element",
+ "desc" : ""
+ }
+ ]
+ },
+ {
+ "name" : "getPanel",
+ "type" : "function",
+ "desc" : "Returns the panel specified or null if it's not in this region.",
+ "sig" : "(panel)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "panel",
+ "type" : "Number/String/ContentPanel",
+ "desc" : "The panels index, id or the panel itself",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.ContentPanel",
+ "desc" : ""
+ }
+ ]
+ },
+ {
+ "name" : "getPosition",
+ "type" : "function",
+ "desc" : "Returns this regions position (north/south/east/west/center).",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "String",
+ "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" : "hasPanel",
+ "type" : "function",
+ "desc" : "Returns true if the panel is in this region.",
+ "sig" : "(panel)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "panel",
+ "type" : "Number/String/ContentPanel",
+ "desc" : "The panels index, id or the panel itself",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Boolean",
+ "desc" : ""
+ }
+ ]
+ },
+ {
+ "name" : "isVisible",
+ "type" : "function",
+ "desc" : "Returns true if this region is currently visible.",
+ "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" : ""
+ }
+ ]
+ },
+ {
+ "name" : "on",
+ "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" : "remove",
+ "type" : "function",
+ "desc" : "Removes the specified panel. If preservePanel is not true (either here or in the config), the panel is destroyed.",
+ "sig" : "(panel, preservePanel)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "panel",
+ "type" : "Number/String/ContentPanel",
+ "desc" : "The panels index, id or the panel itself",
+ "isOptional" : false
+ },
+ {
+ "name" : "preservePanel",
+ "type" : "Boolean",
+ "desc" : "Overrides the config preservePanel option",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.ContentPanel",
+ "desc" : "The panel that was removed"
+ }
+ ]
+ },
+ {
+ "name" : "removeListener",
+ "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" : "resizeTo",
+ "type" : "function",
+ "desc" : "Resizes the region to the specified size. For vertical regions (west, east) this adjusts \nthe width, for horizontal (north, south) the height.",
+ "sig" : "(newSize)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "newSize",
+ "type" : "Number",
+ "desc" : "The new width or height",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "showPanel",
+ "type" : "function",
+ "desc" : "Show the specified panel.",
+ "sig" : "(panelId)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "panelId",
+ "type" : "Number/String/ContentPanel",
+ "desc" : "The panels index, id or the panel itself",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.ContentPanel",
+ "desc" : "The shown panel or null"
+ }
+ ]
+ },
+ {
+ "name" : "un",
+ "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" : [
+ "Roo.bootstrap.layout.Region"
+ ],
+ "tree_children" : [],
+ "tree_parent" : []
+ },
+ "Roo.bootstrap.layout.Border" : {
+ "props" : [
+ {
+ "name" : "actionMode",
+ "type" : "String",
+ "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el' 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" : "can_build_overlaid",
+ "type" : "Boolean",
+ "desc" : "True if element can be rebuild from a HTML page",
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "center",
+ "type" : "Roo.bootstrap.layout.Region",
+ "desc" : "region to go in center",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "cls",
+ "type" : "String",
+ "desc" : "css class",
+ "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",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "dataId",
+ "type" : "string",
+ "desc" : "cutomer id",
+ "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",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "east",
+ "type" : "Roo.bootstrap.layout.Region",
+ "desc" : "region to go in east",
+ "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" : "listeners",
+ "type" : "Object",
+ "desc" : "list of events and functions to call for 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" : "name",
+ "type" : "string",
+ "desc" : "Specifies name attribute",
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "north",
+ "type" : "Roo.bootstrap.layout.Region",
+ "desc" : "region to go in north",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "south",
+ "type" : "Roo.bootstrap.layout.Region",
+ "desc" : "region to go in south",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "style",
+ "type" : "String",
+ "desc" : "any extra css",
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "tooltip",
+ "type" : "string",
+ "desc" : "Text for the tooltip",
+ "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",
+ "isOptional" : false,
+ "optvals" : [
+ "el",
+ "parent"
+ ]
+ },
+ {
+ "name" : "west",
+ "type" : "Roo.bootstrap.layout.Region",
+ "desc" : "region to go in west",
+ "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",
+ "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",
- "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" : "this",
+ "type" : "Roo.Component",
+ "desc" : "",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "reset",
+ "name" : "beforehide",
"type" : "function",
- "desc" : "Resets the current field value to the originally loaded value and clears any validation messages",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.form.Input",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
+ "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" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.Component",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
"returns" : []
},
{
- "name" : "setDisabled",
+ "name" : "beforerender",
"type" : "function",
- "desc" : "Convenience function for setting disabled/enabled by boolean.",
- "sig" : "(disabled)",
- "static" : false,
+ "desc" : "Fires before the component is rendered. Return false to stop the render.",
+ "sig" : "function (_self)\n{\n\n}",
"memberOf" : "Roo.Component",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
"params" : [
{
- "name" : "disabled",
- "type" : "Boolean",
+ "name" : "this",
+ "type" : "Roo.Component",
"desc" : "",
"isOptional" : false
}
"returns" : []
},
{
- "name" : "setRawValue",
+ "name" : "beforeshow",
"type" : "function",
- "desc" : "Sets the underlying DOM field's value directly, bypassing validation. To set the value with validation see {@link #setValue}.",
- "sig" : "(value)",
- "static" : false,
- "memberOf" : "Roo.bootstrap.form.Input",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
+ "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" : "",
- "exceptions" : "",
- "requires" : "",
"params" : [
{
- "name" : "value",
- "type" : "Mixed",
- "desc" : "The value to set",
+ "name" : "this",
+ "type" : "Roo.Component",
+ "desc" : "",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "setValue",
+ "name" : "childrenrendered",
"type" : "function",
- "desc" : "Sets a data value into the field and validates it. To set the value directly without validation see {@link #setRawValue}.",
- "sig" : "(value)",
- "static" : false,
- "memberOf" : "Roo.bootstrap.form.Input",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
+ "desc" : "Fires when the children have been rendered..",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.bootstrap.Component",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
"params" : [
{
- "name" : "value",
- "type" : "Mixed",
- "desc" : "The value to set",
+ "name" : "this",
+ "type" : "Roo.bootstrap.Component",
+ "desc" : "",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "setVisibilityEl",
+ "name" : "destroy",
"type" : "function",
- "desc" : "Set the element that will be used to show or hide",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.Component",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
+ "desc" : "Fires after the component is destroyed.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.Component",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
"returns" : []
},
{
- "name" : "setVisible",
+ "name" : "disable",
"type" : "function",
- "desc" : "Convenience function to hide or show this component by boolean.",
- "sig" : "(visible)",
- "static" : false,
+ "desc" : "Fires after the component is disabled.",
+ "sig" : "function (_self)\n{\n\n}",
"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" : "this",
+ "type" : "Roo.Component",
+ "desc" : "",
"isOptional" : false
}
],
- "returns" : [
+ "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" : "",
+ "name" : "this",
"type" : "Roo.Component",
- "desc" : "this"
+ "desc" : "",
+ "isOptional" : false
}
- ]
+ ],
+ "returns" : []
},
{
- "name" : "show",
+ "name" : "hide",
"type" : "function",
- "desc" : "Show a component - removes 'hidden' class",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.Component",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
+ "desc" : "Fires after the component is hidden.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.Component",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
"returns" : []
},
{
- "name" : "tooltipEl",
+ "name" : "layout",
"type" : "function",
- "desc" : "Fetch the element to display the tooltip on.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.Component",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
+ "desc" : "Fires when a layout is performed.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.bootstrap.layout.Manager",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : [
+ "params" : [
{
- "name" : "",
- "type" : "Roo.Element",
- "desc" : "defaults to this.el"
+ "name" : "this",
+ "type" : "Roo.LayoutManager",
+ "desc" : "",
+ "isOptional" : false
}
- ]
+ ],
+ "returns" : []
},
{
- "name" : "un",
+ "name" : "regioncollapsed",
"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 region is collapsed.",
+ "sig" : "function (region)\n{\n\n}",
+ "memberOf" : "Roo.bootstrap.layout.Manager",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
"params" : [
{
- "name" : "eventName",
- "type" : "String",
- "desc" : "The type of event to listen for",
+ "name" : "region",
+ "type" : "Roo.LayoutRegion",
+ "desc" : "The collapsed region",
"isOptional" : false
- },
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "regionexpanded",
+ "type" : "function",
+ "desc" : "Fires when a region is expanded.",
+ "sig" : "function (region)\n{\n\n}",
+ "memberOf" : "Roo.bootstrap.layout.Manager",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
{
- "name" : "handler",
- "type" : "Function",
- "desc" : "The handler to remove",
+ "name" : "region",
+ "type" : "Roo.LayoutRegion",
+ "desc" : "The expanded region",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "regionresized",
+ "type" : "function",
+ "desc" : "Fires when the user resizes a region.",
+ "sig" : "function (region, newSize)\n{\n\n}",
+ "memberOf" : "Roo.bootstrap.layout.Manager",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "region",
+ "type" : "Roo.LayoutRegion",
+ "desc" : "The resized region",
"isOptional" : false
},
{
- "name" : "scope",
- "type" : "Object",
- "desc" : "(optional) The scope (this object) for the handler",
+ "name" : "newSize",
+ "type" : "Number",
+ "desc" : "The new size (width for east/west, height for north/south)",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "validate",
+ "name" : "render",
"type" : "function",
- "desc" : "Validates the field value",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.form.Input",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
+ "desc" : "Fires after the component is rendered.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : [
+ "params" : [
{
- "name" : "",
- "type" : "Boolean",
- "desc" : "True if the value is valid, else false"
+ "name" : "this",
+ "type" : "Roo.Component",
+ "desc" : "",
+ "isOptional" : false
}
- ]
+ ],
+ "returns" : []
},
{
- "name" : "validateValue",
+ "name" : "show",
"type" : "function",
- "desc" : "Validates a value according to the field's validation rules and marks the field as invalid\nif the validation fails",
- "sig" : "(value)",
- "static" : false,
- "memberOf" : "Roo.bootstrap.form.Input",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
+ "desc" : "Fires after the component is shown.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
"params" : [
{
- "name" : "value",
- "type" : "Mixed",
- "desc" : "The value to validate",
+ "name" : "this",
+ "type" : "Roo.Component",
+ "desc" : "",
"isOptional" : false
}
],
- "returns" : [
- {
- "name" : "",
- "type" : "Boolean",
- "desc" : "True if the value is valid, else false"
- }
- ]
- }
- ],
- "isAbstract" : false,
- "isBuilderTop" : false,
- "implementations" : [
- "Roo.bootstrap.form.ComboBox",
- "Roo.bootstrap.form.MoneyField",
- "Roo.bootstrap.form.PhoneInput"
- ],
- "tree_children" : [],
- "tree_parent" : []
- },
- "Roo.bootstrap.layout" : {
- "props" : [],
- "events" : [],
- "methods" : [],
- "isAbstract" : false,
- "isBuilderTop" : false,
- "implementations" : [],
- "tree_children" : [],
- "tree_parent" : []
- },
- "Roo.bootstrap.layout.Basic" : {
- "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" : "mgr",
- "type" : "Roo.bootstrap.layout.Manager",
- "desc" : "The manager",
- "memberOf" : ""
- },
- {
- "name" : "region",
- "type" : "string",
- "desc" : "the region that it inhabits..",
- "memberOf" : ""
- },
- {
- "name" : "skipConfig",
- "type" : "bool",
- "desc" : "skip config?",
- "memberOf" : ""
+ "returns" : []
}
],
- "events" : [],
"methods" : [
{
"name" : "add",
"type" : "function",
- "desc" : "Add the passed ContentPanel(s)",
- "sig" : "(panel)",
+ "desc" : "Adds a ContentPanel (or subclass) to this layout.",
+ "sig" : "(target, panel)",
"static" : false,
"memberOf" : "",
"isStatic" : false,
"exceptions" : "",
"requires" : "",
"params" : [
+ {
+ "name" : "target",
+ "type" : "String",
+ "desc" : "The target region key (north, south, east, west or center).",
+ "isOptional" : false
+ },
{
"name" : "panel",
- "type" : "ContentPanel...",
- "desc" : "The ContentPanel(s) to add (you can pass more than one)",
+ "type" : "Roo.ContentPanel",
+ "desc" : "The panel to add",
"isOptional" : false
}
],
{
"name" : "",
"type" : "Roo.ContentPanel",
- "desc" : "The panel added (if only one was added)"
+ "desc" : "The added panel"
}
]
},
],
"returns" : []
},
+ {
+ "name" : "addRegion",
+ "type" : "function",
+ "desc" : "Creates and adds a new region if it doesn't already exist.",
+ "sig" : "(target, config)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "target",
+ "type" : "String",
+ "desc" : "The target region key (north, south, east, west or center).",
+ "isOptional" : false
+ },
+ {
+ "name" : "config",
+ "type" : "Object",
+ "desc" : "The regions config object",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "BorderLayoutRegion",
+ "desc" : "The new region"
+ }
+ ]
+ },
+ {
+ "name" : "addxtype",
+ "type" : "function",
+ "desc" : "Adds a xtype elements to the layout.\n<pre><code>\n\nlayout.addxtype({\n xtype : 'ContentPanel',\n region: 'west',\n items: [ .... ]\n }\n);\n\nlayout.addxtype({\n xtype : 'NestedLayoutPanel',\n region: 'west',\n layout: {\n center: { },\n west: { } \n },\n items : [ ... list of content panels or nested layout panels.. ]\n }\n);\n</code></pre>",
+ "sig" : "(cfg)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "cfg",
+ "type" : "Object",
+ "desc" : "Xtype definition of item to add.",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "beginUpdate",
+ "type" : "function",
+ "desc" : "Suspend the LayoutManager from doing auto-layouts while\nmaking multiple add or remove calls",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.layout.Manager",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
{
"name" : "capture",
"type" : "function",
],
"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" : "endUpdate",
+ "type" : "function",
+ "desc" : "Restore auto-layouts and optionally disable the manager from performing a layout",
+ "sig" : "(noLayout)",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.layout.Manager",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "noLayout",
+ "type" : "Boolean",
+ "desc" : "true to disable a layout update",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "findPanel",
+ "type" : "function",
+ "desc" : "Searches all regions for a panel with the specified id",
+ "sig" : "(panelId)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "panelId",
+ "type" : "String",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.ContentPanel",
+ "desc" : "The panel or null if it wasn't found"
+ }
+ ]
+ },
{
"name" : "fireEvent",
"type" : "function",
]
},
{
- "name" : "getActivePanel",
+ "name" : "focus",
"type" : "function",
- "desc" : "Get the active panel for this region.",
+ "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" : "getChildContainer",
+ "type" : "function",
+ "desc" : "Fetch the element to add children to",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.bootstrap.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"returns" : [
{
"name" : "",
- "type" : "Roo.ContentPanel",
- "desc" : "The active panel or null"
+ "type" : "Roo.Element",
+ "desc" : "defaults to this.el"
}
]
},
{
"name" : "getEl",
"type" : "function",
- "desc" : "Returns the container element for this region.",
+ "desc" : "Returns the Element this layout is bound to.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.bootstrap.layout.Manager",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
]
},
{
- "name" : "getPanel",
+ "name" : "getId",
"type" : "function",
- "desc" : "Returns the panel specified or null if it's not in this region.",
- "sig" : "(panel)",
+ "desc" : "Returns the id of this component.",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.Component",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "String",
+ "desc" : ""
+ }
+ ]
+ },
+ {
+ "name" : "getRegion",
+ "type" : "function",
+ "desc" : "Returns the specified region.",
+ "sig" : "(target)",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.layout.Manager",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "panel",
- "type" : "Number/String/ContentPanel",
- "desc" : "The panels index, id or the panel itself",
+ "name" : "target",
+ "type" : "String",
+ "desc" : "The region key ('center', 'north', 'south', 'east' or 'west')",
"isOptional" : false
}
],
"returns" : [
{
"name" : "",
- "type" : "Roo.ContentPanel",
+ "type" : "Roo.LayoutRegion",
"desc" : ""
}
]
},
{
- "name" : "getPosition",
+ "name" : "getViewSize",
"type" : "function",
- "desc" : "Returns this regions position (north/south/east/west/center).",
+ "desc" : "Returns the size of the current view. This method normalizes document.body and element embedded layouts and\nperforms box-model adjustments.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.bootstrap.layout.Manager",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"returns" : [
{
"name" : "",
- "type" : "String",
- "desc" : ""
+ "type" : "Object",
+ "desc" : "The size as an object {width: (the width), height: (the height)}"
}
]
},
+ {
+ "name" : "getVisibilityEl",
+ "type" : "function",
+ "desc" : "Get the element that will be used to show or hide",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.Component",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
{
"name" : "hasListener",
"type" : "function",
]
},
{
- "name" : "hasPanel",
+ "name" : "hide",
"type" : "function",
- "desc" : "Returns true if the panel is in this region.",
- "sig" : "(panel)",
+ "desc" : "Hide a component - adds 'hidden' class",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.bootstrap.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "panel",
- "type" : "Number/String/ContentPanel",
- "desc" : "The panels index, id or the panel itself",
- "isOptional" : false
- }
- ],
+ "params" : [],
+ "returns" : []
+ },
+ {
+ "name" : "initEvents",
+ "type" : "function",
+ "desc" : "Initialize Events for the element",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.Component",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
+ {
+ "name" : "isUpdating",
+ "type" : "function",
+ "desc" : "Returns true if this layout is currently being updated",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.layout.Manager",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
"returns" : [
{
"name" : "",
{
"name" : "isVisible",
"type" : "function",
- "desc" : "Returns true if this region is currently visible.",
+ "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" : "layout",
+ "type" : "function",
+ "desc" : "Performs a layout update.",
"sig" : "()\n{\n\n}",
"static" : false,
"memberOf" : "",
"exceptions" : "",
"requires" : "",
"params" : [],
- "returns" : [
- {
- "name" : "",
- "type" : "Boolean",
- "desc" : ""
- }
- ]
+ "returns" : []
},
{
"name" : "on",
{
"name" : "remove",
"type" : "function",
- "desc" : "Removes the specified panel. If preservePanel is not true (either here or in the config), the panel is destroyed.",
- "sig" : "(panel, preservePanel)",
+ "desc" : "Remove a ContentPanel (or subclass) to this layout.",
+ "sig" : "(target, panel)",
"static" : false,
"memberOf" : "",
"isStatic" : false,
"requires" : "",
"params" : [
{
- "name" : "panel",
- "type" : "Number/String/ContentPanel",
- "desc" : "The panels index, id or the panel itself",
+ "name" : "target",
+ "type" : "String",
+ "desc" : "The target region key (north, south, east, west or center).",
"isOptional" : false
},
{
- "name" : "preservePanel",
- "type" : "Boolean",
- "desc" : "Overrides the config preservePanel option",
+ "name" : "panel",
+ "type" : "Number/String/Roo.ContentPanel",
+ "desc" : "The index, id or panel to remove",
"isOptional" : false
}
],
{
"name" : "",
"type" : "Roo.ContentPanel",
- "desc" : "The panel that was removed"
+ "desc" : "The removed panel"
}
]
},
"returns" : []
},
{
- "name" : "resizeTo",
+ "name" : "render",
"type" : "function",
- "desc" : "Resizes the region to the specified size. For vertical regions (west, east) this adjusts \nthe width, for horizontal (north, south) the height.",
- "sig" : "(newSize)",
+ "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" : "newSize",
- "type" : "Number",
- "desc" : "The new width or height",
+ "name" : "container",
+ "type" : "String/HTMLElement/Element",
+ "desc" : "(optional) The 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" : "setVisibilityEl",
+ "type" : "function",
+ "desc" : "Set the element that will be used to show or hide",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.Component",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
+ {
+ "name" : "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 a component - removes 'hidden' class",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.Component",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
{
"name" : "showPanel",
"type" : "function",
- "desc" : "Show the specified panel.",
+ "desc" : "Searches all regions for a panel with the specified id and activates (shows) it.",
"sig" : "(panelId)",
"static" : false,
"memberOf" : "",
"params" : [
{
"name" : "panelId",
- "type" : "Number/String/ContentPanel",
- "desc" : "The panels index, id or the panel itself",
+ "type" : "String/ContentPanel",
+ "desc" : "The panels id or the panel itself",
"isOptional" : false
}
],
}
]
},
+ {
+ "name" : "tooltipEl",
+ "type" : "function",
+ "desc" : "Fetch the element to display the tooltip on.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.Component",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.Element",
+ "desc" : "defaults to this.el"
+ }
+ ]
+ },
{
"name" : "un",
"type" : "function",
],
"isAbstract" : false,
"isBuilderTop" : false,
- "implementations" : [
- "Roo.bootstrap.layout.Region"
+ "implementations" : [],
+ "tree_children" : [
+ "Roo.bootstrap.panel.Content",
+ "Roo.bootstrap.panel.Grid",
+ "Roo.bootstrap.panel.Nest",
+ "Roo.bootstrap.panel.Nest",
+ "Roo.bootstrap.panel.Grid"
],
- "tree_children" : [],
- "tree_parent" : []
+ "tree_parent" : [
+ "builder",
+ "Roo.bootstrap.panel.Nest",
+ "Roo.bootstrap.panel.Nest",
+ "Roo.bootstrap.Modal"
+ ]
},
- "Roo.bootstrap.layout.Border" : {
+ "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"
- },
- {
- "name" : "center",
- "type" : "Roo.bootstrap.layout.Region",
- "desc" : "region to go in center",
- "memberOf" : ""
+ "desc" : "True if element can be rebuild from a HTML page",
+ "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"
- },
- {
- "name" : "east",
- "type" : "Roo.bootstrap.layout.Region",
- "desc" : "region to go in east",
- "memberOf" : ""
+ "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"
- },
- {
- "name" : "north",
- "type" : "Roo.bootstrap.layout.Region",
- "desc" : "region to go in north",
- "memberOf" : ""
- },
- {
- "name" : "south",
- "type" : "Roo.bootstrap.layout.Region",
- "desc" : "region to go in south",
- "memberOf" : ""
+ "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"
- },
- {
- "name" : "west",
- "type" : "Roo.bootstrap.layout.Region",
- "desc" : "region to go in west",
- "memberOf" : ""
+ "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" : [
"type" : "function",
"desc" : "Fires when a layout is performed.",
"sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.layout.Manager",
+ "memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
"type" : "function",
"desc" : "Fires when a region is collapsed.",
"sig" : "function (region)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.layout.Manager",
+ "memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
"type" : "function",
"desc" : "Fires when a region is expanded.",
"sig" : "function (region)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.layout.Manager",
+ "memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
"type" : "function",
"desc" : "Fires when the user resizes a region.",
"sig" : "function (region, newSize)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.layout.Manager",
+ "memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
],
"methods" : [
{
- "name" : "add",
+ "name" : "addEvents",
"type" : "function",
- "desc" : "Adds a ContentPanel (or subclass) to this layout.",
- "sig" : "(target, panel)",
+ "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" : "target",
+ "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 target region key (north, south, east, west or center).",
+ "desc" : "The type of event to listen for",
"isOptional" : false
},
{
- "name" : "panel",
- "type" : "Roo.ContentPanel",
- "desc" : "The panel to add",
+ "name" : "handler",
+ "type" : "Function",
+ "desc" : "The method the event invokes",
+ "isOptional" : false
+ },
+ {
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"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" : "beginUpdate",
+ "type" : "function",
+ "desc" : "Suspend the LayoutManager from doing auto-layouts while\nmaking multiple add or remove calls",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "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" : "destroy",
+ "type" : "function",
+ "desc" : "Destroys this component by purging any event listeners, removing the component's element from the DOM,\nremoving the 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.ContentPanel",
- "desc" : "The added panel"
+ "type" : "Roo.Component",
+ "desc" : "this"
}
]
},
{
- "name" : "addEvents",
+ "name" : "enable",
"type" : "function",
- "desc" : "Used to define events on this Observable",
- "sig" : "(object)",
+ "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" : "endUpdate",
+ "type" : "function",
+ "desc" : "Restore auto-layouts and optionally disable the manager from performing a layout",
+ "sig" : "(noLayout)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "noLayout",
+ "type" : "Boolean",
+ "desc" : "true to disable a layout update",
+ "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,
"requires" : "",
"params" : [
{
- "name" : "object",
+ "name" : "eventName",
+ "type" : "String",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "args",
+ "type" : "Object...",
+ "desc" : "Variable number of parameters are 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" : "getChildContainer",
+ "type" : "function",
+ "desc" : "Fetch the element to add children to",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.Component",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.Element",
+ "desc" : "defaults to this.el"
+ }
+ ]
+ },
+ {
+ "name" : "getEl",
+ "type" : "function",
+ "desc" : "Returns the Element this layout is bound to.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.Element",
+ "desc" : ""
+ }
+ ]
+ },
+ {
+ "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" : "getRegion",
+ "type" : "function",
+ "desc" : "Returns the specified region.",
+ "sig" : "(target)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "target",
+ "type" : "String",
+ "desc" : "The region key ('center', 'north', 'south', 'east' or 'west')",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.LayoutRegion",
+ "desc" : ""
+ }
+ ]
+ },
+ {
+ "name" : "getViewSize",
+ "type" : "function",
+ "desc" : "Returns the size of the current view. This method normalizes document.body and element embedded layouts and\nperforms box-model adjustments.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : [
+ {
+ "name" : "",
"type" : "Object",
- "desc" : "The object with the events defined",
+ "desc" : "The size as an object {width: (the width), height: (the height)}"
+ }
+ ]
+ },
+ {
+ "name" : "getVisibilityEl",
+ "type" : "function",
+ "desc" : "Get the element that will be used to show or hide",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.Component",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
+ {
+ "name" : "hasListener",
+ "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 a component - adds 'hidden' class",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.Component",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
"returns" : []
},
{
- "name" : "addListener",
+ "name" : "initEvents",
"type" : "function",
- "desc" : "Appends an event handler to this component",
+ "desc" : "Initialize Events for the element",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.Component",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
+ {
+ "name" : "isUpdating",
+ "type" : "function",
+ "desc" : "Returns true if this layout is currently being updated",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Boolean",
+ "desc" : ""
+ }
+ ]
+ },
+ {
+ "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" : "on",
+ "type" : "function",
+ "desc" : "Appends an event handler to this element (shorthand for addListener)",
"sig" : "(eventName, handler, scope, options)",
"static" : false,
"memberOf" : "Roo.util.Observable",
{
"name" : "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" : "addRegion",
+ "name" : "purgeListeners",
"type" : "function",
- "desc" : "Creates and adds a new region if it doesn't already exist.",
- "sig" : "(target, config)",
+ "desc" : "Removes all listeners for this object",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "",
+ "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" : "target",
+ "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 target region key (north, south, east, west or center).",
+ "desc" : "The type of event to listen for",
"isOptional" : false
},
{
- "name" : "config",
+ "name" : "handler",
+ "type" : "Function",
+ "desc" : "The handler to remove",
+ "isOptional" : false
+ },
+ {
+ "name" : "scope",
"type" : "Object",
- "desc" : "The regions config object",
+ "desc" : "(optional) The scope (this object) for the handler",
"isOptional" : false
}
],
- "returns" : [
+ "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" : "",
- "type" : "BorderLayoutRegion",
- "desc" : "The new region"
+ "name" : "container",
+ "type" : "String/HTMLElement/Element",
+ "desc" : "(optional) The element this component should be rendered into. If it is being applied to existing markup, this should be left off.",
+ "isOptional" : false
}
- ]
+ ],
+ "returns" : []
},
{
- "name" : "addxtype",
+ "name" : "setDisabled",
"type" : "function",
- "desc" : "Adds a xtype elements to the layout.\n<pre><code>\n\nlayout.addxtype({\n xtype : 'ContentPanel',\n region: 'west',\n items: [ .... ]\n }\n);\n\nlayout.addxtype({\n xtype : 'NestedLayoutPanel',\n region: 'west',\n layout: {\n center: { },\n west: { } \n },\n items : [ ... list of content panels or nested layout panels.. ]\n }\n);\n</code></pre>",
- "sig" : "(cfg)",
+ "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" : "cfg",
- "type" : "Object",
- "desc" : "Xtype definition of item to add.",
+ "name" : "disabled",
+ "type" : "Boolean",
+ "desc" : "",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "beginUpdate",
+ "name" : "setVisibilityEl",
"type" : "function",
- "desc" : "Suspend the LayoutManager from doing auto-layouts while\nmaking multiple add or remove calls",
+ "desc" : "Set the element that will be used to show or hide",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.bootstrap.layout.Manager",
+ "memberOf" : "Roo.bootstrap.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"returns" : []
},
{
- "name" : "capture",
+ "name" : "setVisible",
"type" : "function",
- "desc" : "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" : "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 a component - removes 'hidden' class",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.Component",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
+ {
+ "name" : "tooltipEl",
+ "type" : "function",
+ "desc" : "Fetch the element to display the tooltip on.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.Component",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.Element",
+ "desc" : "defaults to this.el"
+ }
+ ]
+ },
+ {
+ "name" : "un",
+ "type" : "function",
+ "desc" : "Removes a listener (shorthand for removeListener)",
+ "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" : []
+ }
+ ],
+ "isAbstract" : true,
+ "isBuilderTop" : false,
+ "implementations" : [
+ "Roo.bootstrap.layout.Border"
+ ],
+ "tree_children" : [],
+ "tree_parent" : []
+ },
+ "Roo.bootstrap.layout.Region" : {
+ "props" : [
+ {
+ "name" : "alwaysShowTabs",
+ "type" : "Boolean",
+ "desc" : "True to always display tabs even when there is only 1 panel (defaults to false)",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
- "name" : "destroy",
+ "name" : "animate",
+ "type" : "Boolean",
+ "desc" : "True to animate expand/collapse (defaults to false)",
+ "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" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "autoScroll",
+ "type" : "Boolean",
+ "desc" : "True to enable overflow scrolling (defaults to false)",
+ "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" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "cls",
+ "type" : "string",
+ "desc" : "Extra CSS classes to add to region",
+ "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" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "disableTabTips",
+ "type" : "Boolean",
+ "desc" : "True to disable tab tooltips",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "height",
+ "type" : "Number",
+ "desc" : "For North/South panels",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "hidden",
+ "type" : "Boolean",
+ "desc" : "True to start the region hidden (defaults to false)",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "hideTabs",
+ "type" : "Boolean",
+ "desc" : "True to hide the tab strip (defaults to false)",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "hideWhenEmpty",
+ "type" : "Boolean",
+ "desc" : "True to hide the region when it has no panels",
+ "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" : "margins",
+ "type" : "Object",
+ "desc" : "Margins for the element (defaults to {top: 0, left: 0, right:0, bottom: 0})",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "mgr",
+ "type" : "Roo.bootstrap.layout.Manager",
+ "desc" : "The manager",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "minTabWidth",
+ "type" : "Number",
+ "desc" : "The minimum tab width (defaults to 40)",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "overflow",
+ "type" : "String",
+ "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" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "preservePanels",
+ "type" : "Boolean",
+ "desc" : "True to preserve removed panels so they can be readded later (defaults to false)",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "region",
+ "type" : "string",
+ "desc" : "the region that it inhabits..",
+ "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" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "skipConfig",
+ "type" : "bool",
+ "desc" : "skip config?",
+ "memberOf" : "Roo.bootstrap.layout.Basic",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "split",
+ "type" : "Boolean",
+ "desc" : "To show the splitter",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "tabPosition",
+ "type" : "String",
+ "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" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "titlebar",
+ "type" : "Boolean",
+ "desc" : "True to display a title bar (defaults to true)",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "toolbar",
+ "type" : "Boolean",
+ "desc" : "xtype configuration for a toolbar - shows on right of tabbar",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "width",
+ "type" : "Number",
+ "desc" : "For East/West panels",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ }
+ ],
+ "events" : [],
+ "methods" : [
+ {
+ "name" : "add",
"type" : "function",
- "desc" : "Destroys this component by purging any event listeners, removing the component's element 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" : "Adds the passed ContentPanel(s) to this region.",
+ "sig" : "(panel)",
"static" : false,
- "memberOf" : "Roo.Component",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
+ "params" : [
+ {
+ "name" : "panel",
+ "type" : "ContentPanel...",
+ "desc" : "The ContentPanel(s) to add (you can pass more than one)",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.ContentPanel",
+ "desc" : "The panel added (if only one was added; null otherwise)"
+ }
+ ]
+ },
+ {
+ "name" : "addEvents",
+ "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" : "disable",
+ "name" : "addListener",
"type" : "function",
- "desc" : "Disable this component.",
- "sig" : "()\n{\n\n}",
+ "desc" : "Appends an event handler to this component",
+ "sig" : "(eventName, handler, scope, options)",
"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" : "eventName",
+ "type" : "String",
+ "desc" : "The type of event to listen for",
+ "isOptional" : false
+ },
+ {
+ "name" : "handler",
+ "type" : "Function",
+ "desc" : "The method the event invokes",
+ "isOptional" : false
+ },
+ {
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"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" : "enable",
+ "name" : "animateCollapse",
"type" : "function",
- "desc" : "Enable this component.",
- "sig" : "()\n{\n\n}",
+ "desc" : "Collapses this region.",
+ "sig" : "(skipAnim)",
"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" : "skipAnim",
+ "type" : "Boolean",
+ "desc" : "(optional) true to collapse the element without animation (if animate is true)",
+ "isOptional" : false
}
- ]
+ ],
+ "returns" : []
},
{
- "name" : "endUpdate",
+ "name" : "animateExpand",
"type" : "function",
- "desc" : "Restore auto-layouts and optionally disable the manager from performing a layout",
- "sig" : "(noLayout)",
+ "desc" : "Expands this region if it was previously collapsed.",
+ "sig" : "(e, skipAnim)",
"static" : false,
- "memberOf" : "Roo.bootstrap.layout.Manager",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "noLayout",
+ "name" : "e",
+ "type" : "Roo.EventObject",
+ "desc" : "The event that triggered the expand (or null if calling manually)",
+ "isOptional" : false
+ },
+ {
+ "name" : "skipAnim",
"type" : "Boolean",
- "desc" : "true to disable a layout update",
+ "desc" : "(optional) true to expand the element without animation (if animate is true)",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "findPanel",
+ "name" : "capture",
"type" : "function",
- "desc" : "Searches all regions for a panel with the specified id",
- "sig" : "(panelId)",
- "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" : "panelId",
- "type" : "String",
- "desc" : "",
+ "name" : "o",
+ "type" : "Observable",
+ "desc" : "The Observable to capture",
"isOptional" : false
- }
- ],
- "returns" : [
+ },
{
- "name" : "",
- "type" : "Roo.ContentPanel",
- "desc" : "The panel or null if it wasn't found"
+ "name" : "fn",
+ "type" : "Function",
+ "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",
]
},
{
- "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" : "getChildContainer",
+ "name" : "getActivePanel",
"type" : "function",
- "desc" : "Fetch the element to add children to",
+ "desc" : "Get the active panel for this region.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.bootstrap.Component",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"returns" : [
{
"name" : "",
- "type" : "Roo.Element",
- "desc" : "defaults to this.el"
+ "type" : "Roo.ContentPanel",
+ "desc" : "The active panel or null"
}
]
},
{
- "name" : "getEl",
+ "name" : "getBox",
"type" : "function",
- "desc" : "Returns the Element this layout is bound to.",
- "sig" : "()\n{\n\n}",
+ "desc" : "Updates the title for collapsed north/south regions (used with {@link #collapsedTitle} config option)",
+ "sig" : "(title)",
"static" : false,
- "memberOf" : "Roo.bootstrap.layout.Manager",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
- "returns" : [
+ "params" : [
{
- "name" : "",
- "type" : "Roo.Element",
- "desc" : ""
+ "name" : "title",
+ "type" : "String",
+ "desc" : "(optional) The title text (accepts HTML markup, defaults to the numeric character reference for a non-breaking space, \"&#160;\")",
+ "isOptional" : false
}
- ]
+ ],
+ "returns" : []
},
{
- "name" : "getId",
+ "name" : "getEl",
"type" : "function",
- "desc" : "Returns the id of this component.",
+ "desc" : "Returns the container element for this region.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.Component",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"returns" : [
{
"name" : "",
- "type" : "String",
+ "type" : "Roo.Element",
"desc" : ""
}
]
},
{
- "name" : "getRegion",
+ "name" : "getPanel",
"type" : "function",
- "desc" : "Returns the specified region.",
- "sig" : "(target)",
+ "desc" : "Returns the panel specified or null if it's not in this region.",
+ "sig" : "(panel)",
"static" : false,
- "memberOf" : "Roo.bootstrap.layout.Manager",
+ "memberOf" : "Roo.bootstrap.layout.Basic",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "target",
- "type" : "String",
- "desc" : "The region key ('center', 'north', 'south', 'east' or 'west')",
+ "name" : "panel",
+ "type" : "Number/String/ContentPanel",
+ "desc" : "The panels index, id or the panel itself",
"isOptional" : false
}
],
"returns" : [
{
"name" : "",
- "type" : "Roo.LayoutRegion",
+ "type" : "Roo.ContentPanel",
"desc" : ""
}
]
},
{
- "name" : "getViewSize",
+ "name" : "getPosition",
"type" : "function",
- "desc" : "Returns the size of the current view. This method normalizes document.body and element embedded layouts and\nperforms box-model adjustments.",
+ "desc" : "Returns this regions position (north/south/east/west/center).",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.bootstrap.layout.Manager",
+ "memberOf" : "Roo.bootstrap.layout.Basic",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"returns" : [
{
"name" : "",
- "type" : "Object",
- "desc" : "The size as an object {width: (the width), height: (the height)}"
+ "type" : "String",
+ "desc" : ""
}
]
},
{
- "name" : "getVisibilityEl",
+ "name" : "getTabs",
"type" : "function",
- "desc" : "Get the element that will be used to show or hide",
+ "desc" : "Returns the TabPanel component used by this region",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.bootstrap.Component",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"exceptions" : "",
"requires" : "",
"params" : [],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.TabPanel",
+ "desc" : ""
+ }
+ ]
},
{
"name" : "hasListener",
]
},
{
- "name" : "hide",
+ "name" : "hasPanel",
"type" : "function",
- "desc" : "Hide a component - adds 'hidden' class",
- "sig" : "()\n{\n\n}",
+ "desc" : "Returns true if the panel is in this region.",
+ "sig" : "(panel)",
"static" : false,
- "memberOf" : "Roo.bootstrap.Component",
+ "memberOf" : "Roo.bootstrap.layout.Basic",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
- "returns" : []
+ "params" : [
+ {
+ "name" : "panel",
+ "type" : "Number/String/ContentPanel",
+ "desc" : "The panels index, id or the panel itself",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Boolean",
+ "desc" : ""
+ }
+ ]
},
{
- "name" : "initEvents",
+ "name" : "hide",
"type" : "function",
- "desc" : "Initialize Events for the element",
+ "desc" : "Hides this region.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.bootstrap.Component",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"returns" : []
},
{
- "name" : "isUpdating",
+ "name" : "hidePanel",
"type" : "function",
- "desc" : "Returns true if this layout is currently being updated",
- "sig" : "()\n{\n\n}",
+ "desc" : "Hides the tab for the specified panel.",
+ "sig" : "(panel)",
"static" : false,
- "memberOf" : "Roo.bootstrap.layout.Manager",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
- "returns" : [
+ "params" : [
{
- "name" : "",
- "type" : "Boolean",
- "desc" : ""
+ "name" : "panel",
+ "type" : "Number/String/ContentPanel",
+ "desc" : "The panel's index, id or the panel itself",
+ "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" : "layout",
+ "name" : "isVisible",
"type" : "function",
- "desc" : "Performs a layout update.",
+ "desc" : "Returns true if this region is currently visible.",
"sig" : "()\n{\n\n}",
"static" : false,
"memberOf" : "",
"exceptions" : "",
"requires" : "",
"params" : [],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Boolean",
+ "desc" : ""
+ }
+ ]
},
{
"name" : "on",
{
"name" : "remove",
"type" : "function",
- "desc" : "Remove a ContentPanel (or subclass) to this layout.",
- "sig" : "(target, panel)",
+ "desc" : "Removes the specified panel. If preservePanel is not true (either here or in the config), the panel is destroyed.",
+ "sig" : "(panel, preservePanel)",
"static" : false,
"memberOf" : "",
"isStatic" : false,
"requires" : "",
"params" : [
{
- "name" : "target",
- "type" : "String",
- "desc" : "The target region key (north, south, east, west or center).",
+ "name" : "panel",
+ "type" : "Number/String/ContentPanel",
+ "desc" : "The panel's index, id or the panel itself",
"isOptional" : false
},
{
- "name" : "panel",
- "type" : "Number/String/Roo.ContentPanel",
- "desc" : "The index, id or panel to remove",
+ "name" : "preservePanel",
+ "type" : "Boolean",
+ "desc" : "Overrides the config preservePanel option",
"isOptional" : false
}
],
{
"name" : "",
"type" : "Roo.ContentPanel",
- "desc" : "The removed panel"
+ "desc" : "The panel that was removed"
}
]
},
"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",
+ "name" : "resizeTo",
"type" : "function",
- "desc" : "Convenience function for setting disabled/enabled by boolean.",
- "sig" : "(disabled)",
+ "desc" : "Resizes the region to the specified size. For vertical regions (west, east) this adjusts \nthe width, for horizontal (north, south) the height.",
+ "sig" : "(newSize)",
"static" : false,
- "memberOf" : "Roo.Component",
+ "memberOf" : "Roo.bootstrap.layout.Basic",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "disabled",
- "type" : "Boolean",
- "desc" : "",
+ "name" : "newSize",
+ "type" : "Number",
+ "desc" : "The new width or height",
"isOptional" : false
}
],
"returns" : []
},
- {
- "name" : "setVisibilityEl",
- "type" : "function",
- "desc" : "Set the element that will be used to show or hide",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.Component",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
- {
- "name" : "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 a component - removes 'hidden' class",
+ "desc" : "Shows this region if it was previously hidden.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.bootstrap.Component",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
{
"name" : "showPanel",
"type" : "function",
- "desc" : "Searches all regions for a panel with the specified id and activates (shows) it.",
+ "desc" : "Shows the specified panel.",
"sig" : "(panelId)",
"static" : false,
"memberOf" : "",
"params" : [
{
"name" : "panelId",
- "type" : "String/ContentPanel",
- "desc" : "The panels id or the panel itself",
+ "type" : "Number/String/ContentPanel",
+ "desc" : "The panel's index, id or the panel itself",
"isOptional" : false
}
],
{
"name" : "",
"type" : "Roo.ContentPanel",
- "desc" : "The shown panel or null"
- }
- ]
- },
- {
- "name" : "tooltipEl",
- "type" : "function",
- "desc" : "Fetch the element to display the tooltip on.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.Component",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : [
- {
- "name" : "",
- "type" : "Roo.Element",
- "desc" : "defaults to this.el"
+ "desc" : "The shown panel, or null if a panel could not be found from panelId"
}
]
},
}
],
"returns" : []
+ },
+ {
+ "name" : "unhidePanel",
+ "type" : "function",
+ "desc" : "Unhides the tab for a previously hidden panel.",
+ "sig" : "(panel)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "panel",
+ "type" : "Number/String/ContentPanel",
+ "desc" : "The panel's index, id or the panel itself",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
}
],
"isAbstract" : false,
"isBuilderTop" : false,
"implementations" : [],
- "tree_children" : [
- "Roo.bootstrap.panel.Content",
- "Roo.bootstrap.panel.Grid",
- "Roo.bootstrap.panel.Nest",
- "Roo.bootstrap.panel.Nest",
- "Roo.bootstrap.panel.Grid"
- ],
- "tree_parent" : [
- "builder",
- "Roo.bootstrap.panel.Nest",
- "Roo.bootstrap.panel.Nest",
- "Roo.bootstrap.Modal"
- ]
+ "tree_children" : [],
+ "tree_parent" : []
},
- "Roo.bootstrap.layout.Manager" : {
+ "Roo.bootstrap.layout.Split" : {
"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" : "alwaysShowTabs",
+ "type" : "Boolean",
+ "desc" : "True to always display tabs even when there is only 1 panel (defaults to false)",
+ "memberOf" : "Roo.LayoutRegion",
+ "isOptional" : false,
+ "optvals" : []
},
{
- "name" : "allowDomMove",
+ "name" : "animate",
"type" : "Boolean",
- "desc" : "Whether the component can move the Dom node when rendering (defaults to true).",
- "memberOf" : "Roo.Component"
+ "desc" : "True to animate expand/collapse (defaults to false)",
+ "memberOf" : "Roo.LayoutRegion",
+ "isOptional" : false,
+ "optvals" : []
},
{
- "name" : "can_build_overlaid",
+ "name" : "autoHide",
"type" : "Boolean",
- "desc" : "True if element can be rebuild from a HTML page",
- "memberOf" : "Roo.bootstrap.Component"
+ "desc" : "False to disable auto hiding when the mouse leaves the \"floated\" region (defaults to true)",
+ "memberOf" : "Roo.LayoutRegion",
+ "isOptional" : false,
+ "optvals" : []
},
{
- "name" : "cls",
- "type" : "String",
- "desc" : "css class",
- "memberOf" : "Roo.bootstrap.Component"
+ "name" : "autoScroll",
+ "type" : "Boolean",
+ "desc" : "True to enable overflow scrolling (defaults to false)",
+ "memberOf" : "Roo.LayoutRegion",
+ "isOptional" : false,
+ "optvals" : []
},
{
- "name" : "container_method",
- "type" : "string",
- "desc" : "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)",
- "memberOf" : "Roo.bootstrap.Component"
+ "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",
+ "isOptional" : false,
+ "optvals" : []
},
{
- "name" : "dataId",
- "type" : "string",
- "desc" : "cutomer id",
- "memberOf" : "Roo.bootstrap.Component"
+ "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",
+ "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" : "collapsed",
+ "type" : "Boolean",
+ "desc" : "True to set the initial display to collapsed (defaults to false)",
+ "memberOf" : "Roo.LayoutRegion",
+ "isOptional" : false,
+ "optvals" : []
},
{
- "name" : "hideMode",
+ "name" : "collapsedTitle",
"type" : "String",
- "desc" : "y)\nHow this component 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" : "Optional string message to display in the collapsed block of a north or south region",
+ "memberOf" : "Roo.LayoutRegion",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "collapsible",
+ "type" : "Boolean",
+ "desc" : "False to disable collapsing (defaults to true)",
+ "memberOf" : "Roo.LayoutRegion",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "disableTabTips",
+ "type" : "Boolean",
+ "desc" : "True to disable tab tooltips",
+ "memberOf" : "Roo.LayoutRegion",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "floatable",
+ "type" : "Boolean",
+ "desc" : "False to disable floating (defaults to true)",
+ "memberOf" : "Roo.LayoutRegion",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "height",
+ "type" : "Number",
+ "desc" : "For North/South panels",
+ "memberOf" : "Roo.LayoutRegion",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "hidden",
+ "type" : "Boolean",
+ "desc" : "True to start the region hidden (defaults to false)",
+ "memberOf" : "Roo.LayoutRegion",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "hideTabs",
+ "type" : "Boolean",
+ "desc" : "True to hide the tab strip (defaults to false)",
+ "memberOf" : "Roo.LayoutRegion",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "hideWhenEmpty",
+ "type" : "Boolean",
+ "desc" : "True to hide the region when it has no panels",
+ "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" : "name",
- "type" : "string",
- "desc" : "Specifies name attribute",
- "memberOf" : "Roo.bootstrap.Component"
+ "name" : "margins",
+ "type" : "Object",
+ "desc" : "Margins for the element (defaults to {top: 0, left: 0, right:0, bottom: 0})",
+ "memberOf" : "Roo.LayoutRegion",
+ "isOptional" : false,
+ "optvals" : []
},
{
- "name" : "style",
+ "name" : "minTabWidth",
+ "type" : "Number",
+ "desc" : "The minimum tab width (defaults to 40)",
+ "memberOf" : "Roo.LayoutRegion",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "preferredTabWidth",
+ "type" : "Number",
+ "desc" : "The preferred tab width (defaults to 150)",
+ "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",
+ "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",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "showPin",
+ "type" : "Boolean",
+ "desc" : "True to show a pin button",
+ "memberOf" : "Roo.LayoutRegion",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "split",
+ "type" : "Boolean",
+ "desc" : "To show the splitter",
+ "memberOf" : "Roo.LayoutRegion",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "tabPosition",
"type" : "String",
- "desc" : "any extra css",
- "memberOf" : "Roo.bootstrap.Component"
+ "desc" : "m) \"top\" or \"bottom\" (defaults to \"bottom",
+ "memberOf" : "Roo.LayoutRegion",
+ "isOptional" : false,
+ "optvals" : [
+ "top",
+ "bottom"
+ ]
},
{
- "name" : "tooltip",
- "type" : "string",
- "desc" : "Text for the tooltip",
- "memberOf" : "Roo.bootstrap.Component"
+ "name" : "title",
+ "type" : "String",
+ "desc" : "The title for the region (overrides panel titles)",
+ "memberOf" : "Roo.LayoutRegion",
+ "isOptional" : false,
+ "optvals" : []
},
{
- "name" : "visibilityEl",
- "type" : "string|object",
- "desc" : "t) What element to use for visibility (@see getVisibilityEl())",
- "memberOf" : "Roo.bootstrap.Component"
+ "name" : "titlebar",
+ "type" : "Boolean",
+ "desc" : "True to display a title bar (defaults to true)",
+ "memberOf" : "Roo.LayoutRegion",
+ "isOptional" : false,
+ "optvals" : []
},
{
- "name" : "xattr",
- "type" : "Object",
- "desc" : "extra attributes to add to 'element' (used by builder to store stuff.)",
- "memberOf" : "Roo.bootstrap.Component"
+ "name" : "toolbar",
+ "type" : "Boolean",
+ "desc" : "xtype configuration for a toolbar - shows on right of tabbar",
+ "memberOf" : "Roo.LayoutRegion",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "width",
+ "type" : "Number",
+ "desc" : "For East/West panels",
+ "memberOf" : "Roo.LayoutRegion",
+ "isOptional" : false,
+ "optvals" : []
}
],
"events" : [
{
- "name" : "beforedestroy",
+ "name" : "beforecollapse",
"type" : "function",
- "desc" : "Fires before the component is destroyed. Return false to stop the destroy.",
+ "desc" : "Fires when this region before collapse.",
"sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
+ "memberOf" : "Roo.BasicLayoutRegion",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.Component",
+ "type" : "Roo.LayoutRegion",
"desc" : "",
"isOptional" : false
}
"returns" : []
},
{
- "name" : "beforehide",
+ "name" : "beforeremove",
"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 before a panel is removed (or closed). To cancel the removal set \"e.cancel = true\" on the event argument.",
+ "sig" : "function (_self, panel, e)\n{\n\n}",
+ "memberOf" : "Roo.BasicLayoutRegion",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.Component",
+ "type" : "Roo.LayoutRegion",
"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" : "panel",
+ "type" : "Roo.ContentPanel",
+ "desc" : "The panel",
+ "isOptional" : false
+ },
+ {
+ "name" : "e",
+ "type" : "Object",
+ "desc" : "The cancel event object",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "beforeshow",
+ "name" : "collapsed",
"type" : "function",
- "desc" : "Fires before the component is shown. Return false to stop the show.",
+ "desc" : "Fires when this region is collapsed.",
"sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
+ "memberOf" : "Roo.BasicLayoutRegion",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.Component",
+ "type" : "Roo.LayoutRegion",
"desc" : "",
"isOptional" : false
}
"returns" : []
},
{
- "name" : "childrenrendered",
+ "name" : "expanded",
"type" : "function",
- "desc" : "Fires when the children have been rendered..",
+ "desc" : "Fires when this region is expanded.",
"sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.Component",
+ "memberOf" : "Roo.BasicLayoutRegion",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.bootstrap.Component",
+ "type" : "Roo.LayoutRegion",
"desc" : "",
"isOptional" : false
}
"returns" : []
},
{
- "name" : "destroy",
+ "name" : "invalidated",
"type" : "function",
- "desc" : "Fires after the component is destroyed.",
+ "desc" : "Fires when the layout for this region is changed.",
"sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
+ "memberOf" : "Roo.BasicLayoutRegion",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.Component",
+ "type" : "Roo.LayoutRegion",
"desc" : "",
"isOptional" : false
}
"returns" : []
},
{
- "name" : "disable",
+ "name" : "panelactivated",
"type" : "function",
- "desc" : "Fires after the component is disabled.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
+ "desc" : "Fires when a panel is activated.",
+ "sig" : "function (_self, panel)\n{\n\n}",
+ "memberOf" : "Roo.BasicLayoutRegion",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.Component",
+ "type" : "Roo.LayoutRegion",
"desc" : "",
"isOptional" : false
+ },
+ {
+ "name" : "panel",
+ "type" : "Roo.ContentPanel",
+ "desc" : "The activated panel",
+ "isOptional" : false
}
],
"returns" : []
},
{
- "name" : "enable",
+ "name" : "paneladded",
"type" : "function",
- "desc" : "Fires after the component is enabled.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
+ "desc" : "Fires when a panel is added.",
+ "sig" : "function (_self, panel)\n{\n\n}",
+ "memberOf" : "Roo.BasicLayoutRegion",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.Component",
+ "type" : "Roo.LayoutRegion",
"desc" : "",
"isOptional" : false
+ },
+ {
+ "name" : "panel",
+ "type" : "Roo.ContentPanel",
+ "desc" : "The panel",
+ "isOptional" : false
}
],
"returns" : []
},
{
- "name" : "hide",
+ "name" : "panelremoved",
"type" : "function",
- "desc" : "Fires after the component is hidden.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
+ "desc" : "Fires when a panel is removed.",
+ "sig" : "function (_self, panel)\n{\n\n}",
+ "memberOf" : "Roo.BasicLayoutRegion",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.Component",
+ "type" : "Roo.LayoutRegion",
"desc" : "",
"isOptional" : false
+ },
+ {
+ "name" : "panel",
+ "type" : "Roo.ContentPanel",
+ "desc" : "The panel",
+ "isOptional" : false
}
],
"returns" : []
},
{
- "name" : "layout",
+ "name" : "resized",
"type" : "function",
- "desc" : "Fires when a layout is performed.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "",
+ "desc" : "Fires when the user resizes this region.",
+ "sig" : "function (_self, newSize)\n{\n\n}",
+ "memberOf" : "Roo.BasicLayoutRegion",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.LayoutManager",
+ "type" : "Roo.LayoutRegion",
"desc" : "",
"isOptional" : false
+ },
+ {
+ "name" : "newSize",
+ "type" : "Number",
+ "desc" : "The new size (width for east/west, height for north/south)",
+ "isOptional" : false
}
],
"returns" : []
},
{
- "name" : "regioncollapsed",
+ "name" : "slidehide",
"type" : "function",
- "desc" : "Fires when a region is collapsed.",
- "sig" : "function (region)\n{\n\n}",
- "memberOf" : "",
+ "desc" : "Fires when this region slides out of view.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.BasicLayoutRegion",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
"params" : [
{
- "name" : "region",
+ "name" : "this",
"type" : "Roo.LayoutRegion",
- "desc" : "The collapsed region",
+ "desc" : "",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "regionexpanded",
+ "name" : "slideshow",
"type" : "function",
- "desc" : "Fires when a region is expanded.",
- "sig" : "function (region)\n{\n\n}",
- "memberOf" : "",
+ "desc" : "Fires when this region is slid into view.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.BasicLayoutRegion",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
"params" : [
{
- "name" : "region",
+ "name" : "this",
"type" : "Roo.LayoutRegion",
- "desc" : "The expanded region",
+ "desc" : "",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "regionresized",
+ "name" : "visibilitychange",
"type" : "function",
- "desc" : "Fires when the user resizes a region.",
- "sig" : "function (region, newSize)\n{\n\n}",
- "memberOf" : "",
+ "desc" : "Fires when this region is shown or hidden",
+ "sig" : "function (_self, visibility)\n{\n\n}",
+ "memberOf" : "Roo.BasicLayoutRegion",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
"params" : [
{
- "name" : "region",
+ "name" : "this",
"type" : "Roo.LayoutRegion",
- "desc" : "The resized region",
+ "desc" : "",
"isOptional" : false
},
{
- "name" : "newSize",
- "type" : "Number",
- "desc" : "The new size (width for east/west, height for north/south)",
+ "name" : "visibility",
+ "type" : "Boolean",
+ "desc" : "true or false",
"isOptional" : false
}
],
"returns" : []
- },
+ }
+ ],
+ "methods" : [
{
- "name" : "render",
+ "name" : "add",
"type" : "function",
- "desc" : "Fires after the component is rendered.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
+ "desc" : "Adds the passed ContentPanel(s) to this region.",
+ "sig" : "(panel)",
+ "static" : false,
+ "memberOf" : "Roo.LayoutRegion",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
- "name" : "this",
- "type" : "Roo.Component",
- "desc" : "",
+ "name" : "panel",
+ "type" : "ContentPanel...",
+ "desc" : "The ContentPanel(s) to add (you can pass more than one)",
"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" : [
+ "returns" : [
{
- "name" : "this",
- "type" : "Roo.Component",
- "desc" : "",
- "isOptional" : false
+ "name" : "",
+ "type" : "Roo.ContentPanel",
+ "desc" : "The panel added (if only one was added; null otherwise)"
}
- ],
- "returns" : []
- }
- ],
- "methods" : [
+ ]
+ },
{
"name" : "addEvents",
"type" : "function",
],
"returns" : []
},
- {
- "name" : "beginUpdate",
- "type" : "function",
- "desc" : "Suspend the LayoutManager from doing auto-layouts while\nmaking multiple add or remove calls",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
{
"name" : "capture",
"type" : "function",
"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" : "endUpdate",
+ "name" : "collapse",
"type" : "function",
- "desc" : "Restore auto-layouts and optionally disable the manager from performing a layout",
- "sig" : "(noLayout)",
+ "desc" : "Collapses this region.",
+ "sig" : "(skipAnim)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.LayoutRegion",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "noLayout",
+ "name" : "skipAnim",
"type" : "Boolean",
- "desc" : "true to disable a layout update",
+ "desc" : "(optional) true to collapse the element without animation (if animate is true)",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "fireEvent",
+ "name" : "expand",
"type" : "function",
- "desc" : "Fires the specified event with the passed parameters (minus the event name).",
- "sig" : "(eventName, args)",
+ "desc" : "Expands this region if it was previously collapsed.",
+ "sig" : "(e, skipAnim)",
"static" : false,
- "memberOf" : "Roo.util.Observable",
+ "memberOf" : "Roo.LayoutRegion",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "eventName",
- "type" : "String",
- "desc" : "",
+ "name" : "e",
+ "type" : "Roo.EventObject",
+ "desc" : "The event that triggered the expand (or null if calling manually)",
"isOptional" : false
},
{
- "name" : "args",
- "type" : "Object...",
- "desc" : "Variable number of parameters are passed to handlers",
+ "name" : "skipAnim",
+ "type" : "Boolean",
+ "desc" : "(optional) true to expand the element without animation (if animate is true)",
"isOptional" : false
}
],
- "returns" : [
- {
- "name" : "",
- "type" : "Boolean",
- "desc" : "returns false if any of the handlers return false otherwise it returns true"
- }
- ]
+ "returns" : []
},
{
- "name" : "focus",
+ "name" : "fireEvent",
"type" : "function",
- "desc" : "Try to focus this component.",
- "sig" : "(selectText)",
+ "desc" : "Fires the specified event with the passed parameters (minus the event name).",
+ "sig" : "(eventName, args)",
"static" : false,
- "memberOf" : "Roo.Component",
+ "memberOf" : "Roo.util.Observable",
"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" : "eventName",
+ "type" : "String",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "args",
+ "type" : "Object...",
+ "desc" : "Variable number of parameters are passed to handlers",
"isOptional" : false
}
],
"returns" : [
{
"name" : "",
- "type" : "Roo.Component",
- "desc" : "this"
+ "type" : "Boolean",
+ "desc" : "returns false if any of the handlers return false otherwise it returns true"
}
]
},
{
- "name" : "getChildContainer",
+ "name" : "getActivePanel",
"type" : "function",
- "desc" : "Fetch the element to add children to",
+ "desc" : "Get the active panel for this region.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.bootstrap.Component",
+ "memberOf" : "Roo.LayoutRegion",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"returns" : [
{
"name" : "",
- "type" : "Roo.Element",
- "desc" : "defaults to this.el"
+ "type" : "Roo.ContentPanel",
+ "desc" : "The active panel or null"
}
]
},
{
"name" : "getEl",
"type" : "function",
- "desc" : "Returns the Element this layout is bound to.",
+ "desc" : "Returns the container element for this region.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.LayoutRegion",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
]
},
{
- "name" : "getId",
+ "name" : "getPanel",
"type" : "function",
- "desc" : "Returns the id of this component.",
- "sig" : "()\n{\n\n}",
+ "desc" : "Returns the panel specified or null if it's not in this region.",
+ "sig" : "(panel)",
"static" : false,
- "memberOf" : "Roo.Component",
+ "memberOf" : "Roo.BasicLayoutRegion",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
+ "params" : [
+ {
+ "name" : "panel",
+ "type" : "Number/String/ContentPanel",
+ "desc" : "The panels index, id or the panel itself",
+ "isOptional" : false
+ }
+ ],
"returns" : [
{
"name" : "",
- "type" : "String",
+ "type" : "Roo.ContentPanel",
"desc" : ""
}
]
},
{
- "name" : "getRegion",
+ "name" : "getPosition",
"type" : "function",
- "desc" : "Returns the specified region.",
- "sig" : "(target)",
+ "desc" : "Returns this regions position (north/south/east/west/center).",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.BasicLayoutRegion",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "target",
- "type" : "String",
- "desc" : "The region key ('center', 'north', 'south', 'east' or 'west')",
- "isOptional" : false
- }
- ],
+ "params" : [],
"returns" : [
{
"name" : "",
- "type" : "Roo.LayoutRegion",
+ "type" : "String",
"desc" : ""
}
]
},
{
- "name" : "getViewSize",
+ "name" : "getSplitBar",
"type" : "function",
- "desc" : "Returns the size of the current view. This method normalizes document.body and element embedded layouts and\nperforms box-model adjustments.",
+ "desc" : "Returns the {@link Roo.SplitBar} for this region.",
"sig" : "()\n{\n\n}",
"static" : false,
"memberOf" : "",
"returns" : [
{
"name" : "",
- "type" : "Object",
- "desc" : "The size as an object {width: (the width), height: (the height)}"
+ "type" : "Roo.SplitBar",
+ "desc" : ""
}
]
},
{
- "name" : "getVisibilityEl",
+ "name" : "getTabs",
"type" : "function",
- "desc" : "Get the element that will be used to show or hide",
+ "desc" : "Returns the TabPanel component used by this region",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.bootstrap.Component",
+ "memberOf" : "Roo.LayoutRegion",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"exceptions" : "",
"requires" : "",
"params" : [],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.TabPanel",
+ "desc" : ""
+ }
+ ]
},
{
"name" : "hasListener",
]
},
{
- "name" : "hide",
+ "name" : "hasPanel",
"type" : "function",
- "desc" : "Hide a component - adds 'hidden' class",
- "sig" : "()\n{\n\n}",
+ "desc" : "Returns true if the panel is in this region.",
+ "sig" : "(panel)",
"static" : false,
- "memberOf" : "Roo.bootstrap.Component",
+ "memberOf" : "Roo.BasicLayoutRegion",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
- "returns" : []
+ "params" : [
+ {
+ "name" : "panel",
+ "type" : "Number/String/ContentPanel",
+ "desc" : "The panels index, id or the panel itself",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Boolean",
+ "desc" : ""
+ }
+ ]
},
{
- "name" : "initEvents",
+ "name" : "hide",
"type" : "function",
- "desc" : "Initialize Events for the element",
+ "desc" : "Hides this region.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.bootstrap.Component",
+ "memberOf" : "Roo.LayoutRegion",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"returns" : []
},
{
- "name" : "isUpdating",
+ "name" : "hidePanel",
"type" : "function",
- "desc" : "Returns true if this layout is currently being updated",
- "sig" : "()\n{\n\n}",
+ "desc" : "Hides the tab for the specified panel.",
+ "sig" : "(panel)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.LayoutRegion",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
- "returns" : [
+ "params" : [
{
- "name" : "",
- "type" : "Boolean",
- "desc" : ""
+ "name" : "panel",
+ "type" : "Number/String/ContentPanel",
+ "desc" : "The panel's index, id or the panel itself",
+ "isOptional" : false
}
- ]
+ ],
+ "returns" : []
},
{
"name" : "isVisible",
"type" : "function",
- "desc" : "Returns true if this component is visible.",
+ "desc" : "Returns true if this region is currently visible.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.Component",
+ "memberOf" : "Roo.LayoutRegion",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"exceptions" : "",
"requires" : "",
"params" : [],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Boolean",
+ "desc" : ""
+ }
+ ]
},
{
"name" : "on",
],
"returns" : []
},
+ {
+ "name" : "remove",
+ "type" : "function",
+ "desc" : "Removes the specified panel. If preservePanel is not true (either here or in the config), the panel is destroyed.",
+ "sig" : "(panel, preservePanel)",
+ "static" : false,
+ "memberOf" : "Roo.LayoutRegion",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "panel",
+ "type" : "Number/String/ContentPanel",
+ "desc" : "The panel's index, id or the panel itself",
+ "isOptional" : false
+ },
+ {
+ "name" : "preservePanel",
+ "type" : "Boolean",
+ "desc" : "Overrides the config preservePanel option",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.ContentPanel",
+ "desc" : "The panel that was removed"
+ }
+ ]
+ },
{
"name" : "removeListener",
"type" : "function",
"returns" : []
},
{
- "name" : "render",
+ "name" : "resizeTo",
"type" : "function",
- "desc" : "If this is a lazy rendering component, render it to its container element.",
- "sig" : "(container)",
+ "desc" : "Resizes the region to the specified size. For vertical regions (west, east) this adjusts \nthe width, for horizontal (north, south) the height.",
+ "sig" : "(newSize)",
"static" : false,
- "memberOf" : "Roo.Component",
+ "memberOf" : "Roo.BasicLayoutRegion",
"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" : "newSize",
+ "type" : "Number",
+ "desc" : "The new width or height",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "setDisabled",
+ "name" : "setCollapsedTitle",
"type" : "function",
- "desc" : "Convenience function for setting disabled/enabled by boolean.",
- "sig" : "(disabled)",
+ "desc" : "Updates the title for collapsed north/south regions (used with {@link #collapsedTitle} config option)",
+ "sig" : "(title)",
"static" : false,
- "memberOf" : "Roo.Component",
+ "memberOf" : "Roo.LayoutRegion",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "disabled",
- "type" : "Boolean",
- "desc" : "",
+ "name" : "title",
+ "type" : "String",
+ "desc" : "(optional) The title text (accepts HTML markup, defaults to the numeric character reference for a non-breaking space, \"&#160;\")",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "setVisibilityEl",
+ "name" : "show",
"type" : "function",
- "desc" : "Set the element that will be used to show or hide",
+ "desc" : "Shows this region if it was previously hidden.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.bootstrap.Component",
+ "memberOf" : "Roo.LayoutRegion",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"returns" : []
},
{
- "name" : "setVisible",
+ "name" : "showPanel",
"type" : "function",
- "desc" : "Convenience function to hide or show this component by boolean.",
- "sig" : "(visible)",
+ "desc" : "Shows the specified panel.",
+ "sig" : "(panelId)",
"static" : false,
- "memberOf" : "Roo.Component",
+ "memberOf" : "Roo.LayoutRegion",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "visible",
- "type" : "Boolean",
- "desc" : "True to show, false to hide",
+ "name" : "panelId",
+ "type" : "Number/String/ContentPanel",
+ "desc" : "The panel's index, id or the panel itself",
"isOptional" : false
}
],
"returns" : [
{
"name" : "",
- "type" : "Roo.Component",
- "desc" : "this"
- }
- ]
- },
- {
- "name" : "show",
- "type" : "function",
- "desc" : "Show a component - removes 'hidden' class",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.Component",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
- {
- "name" : "tooltipEl",
- "type" : "function",
- "desc" : "Fetch the element to display the tooltip on.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.Component",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : [
- {
- "name" : "",
- "type" : "Roo.Element",
- "desc" : "defaults to this.el"
+ "type" : "Roo.ContentPanel",
+ "desc" : "The shown panel, or null if a panel could not be found from panelId"
}
]
},
}
],
"returns" : []
+ },
+ {
+ "name" : "unhidePanel",
+ "type" : "function",
+ "desc" : "Unhides the tab for a previously hidden panel.",
+ "sig" : "(panel)",
+ "static" : false,
+ "memberOf" : "Roo.LayoutRegion",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "panel",
+ "type" : "Number/String/ContentPanel",
+ "desc" : "The panel's index, id or the panel itself",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
}
],
- "isAbstract" : true,
+ "isAbstract" : false,
"isBuilderTop" : false,
- "implementations" : [
- "Roo.bootstrap.layout.Border"
- ],
+ "implementations" : [],
"tree_children" : [],
"tree_parent" : []
},
- "Roo.bootstrap.layout.Region" : {
+ "Roo.bootstrap.menu" : {
+ "props" : [],
+ "events" : [],
+ "methods" : [],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "implementations" : [],
+ "tree_children" : [],
+ "tree_parent" : []
+ },
+ "Roo.bootstrap.menu.Item" : {
"props" : [
{
- "name" : "alwaysShowTabs",
- "type" : "Boolean",
- "desc" : "True to always display tabs even when there is only 1 panel (defaults to false)",
- "memberOf" : ""
+ "name" : "actionMode",
+ "type" : "String",
+ "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el' for forms you probably want to set this to fieldEl",
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
- "name" : "animate",
+ "name" : "active",
"type" : "Boolean",
- "desc" : "True to animate expand/collapse (defaults to false)",
- "memberOf" : ""
+ "desc" : "used on sidebars to highlight active itesm",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
- "name" : "autoHide",
+ "name" : "allowDomMove",
"type" : "Boolean",
- "desc" : "False to disable auto hiding when the mouse leaves the \"floated\" region (defaults to true)",
- "memberOf" : ""
+ "desc" : "Whether the component can move the Dom node when rendering (defaults to true).",
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
- "name" : "autoScroll",
+ "name" : "can_build_overlaid",
"type" : "Boolean",
- "desc" : "True to enable overflow scrolling (defaults to false)",
- "memberOf" : ""
+ "desc" : "True if element can be rebuild from a HTML page",
+ "memberOf" : "Roo.bootstrap.Component",
+ "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" : ""
+ "name" : "cls",
+ "type" : "String",
+ "desc" : "css class",
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
- "name" : "cls",
+ "name" : "container_method",
"type" : "string",
- "desc" : "Extra CSS classes to add to region",
- "memberOf" : ""
+ "desc" : "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)",
+ "memberOf" : "Roo.bootstrap.Component",
+ "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" : ""
+ "name" : "dataId",
+ "type" : "string",
+ "desc" : "cutomer id",
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
- "name" : "disableTabTips",
- "type" : "Boolean",
- "desc" : "True to disable tab tooltips",
- "memberOf" : ""
+ "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" : "For North/South panels",
- "memberOf" : ""
+ "name" : "fa",
+ "type" : "String",
+ "desc" : "favicon to show on left of menu item.",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
- "name" : "hidden",
- "type" : "Boolean",
- "desc" : "True to start the region hidden (defaults to false)",
- "memberOf" : ""
+ "name" : "hideMode",
+ "type" : "String",
+ "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display",
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : [
+ "display",
+ "visibility"
+ ]
},
{
- "name" : "hideTabs",
- "type" : "Boolean",
- "desc" : "True to hide the tab strip (defaults to false)",
- "memberOf" : ""
+ "name" : "href",
+ "type" : "String",
+ "desc" : "the link",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
- "name" : "hideWhenEmpty",
+ "name" : "html",
+ "type" : "String",
+ "desc" : "the menu label",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "isContainer",
"type" : "Boolean",
- "desc" : "True to hide the region when it has no panels",
- "memberOf" : ""
+ "desc" : "is it a container - just returns a drop down 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"
+ "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" : ""
+ "name" : "menu",
+ "type" : "Roo.bootsrap.Menu",
+ "desc" : "the child menu.",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
- "name" : "mgr",
- "type" : "Roo.bootstrap.layout.Manager",
- "desc" : "The manager",
- "memberOf" : ""
+ "name" : "name",
+ "type" : "string",
+ "desc" : "Specifies name attribute",
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
- "name" : "minTabWidth",
- "type" : "Number",
- "desc" : "The minimum tab width (defaults to 40)",
- "memberOf" : ""
+ "name" : "preventDefault",
+ "type" : "Boolean",
+ "desc" : "do not trigger A href on clicks (default false).",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
- "name" : "overflow",
+ "name" : "style",
"type" : "String",
- "desc" : "e) if you have menus in the region, then you need to set this to visible.",
- "memberOf" : ""
+ "desc" : "any extra css",
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
- "name" : "preferredTabWidth",
- "type" : "Number",
- "desc" : "The preferred tab width (defaults to 150)",
- "memberOf" : ""
+ "name" : "tooltip",
+ "type" : "string",
+ "desc" : "Text for the tooltip",
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
- "name" : "preservePanels",
- "type" : "Boolean",
- "desc" : "True to preserve removed panels so they can be readded later (defaults to false)",
- "memberOf" : ""
+ "name" : "visibilityEl",
+ "type" : "string|object",
+ "desc" : "t) What element to use for visibility (@see getVisibilityEl(",
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : [
+ "el",
+ "parent"
+ ]
},
{
- "name" : "region",
- "type" : "string",
- "desc" : "the region that it inhabits..",
- "memberOf" : ""
+ "name" : "xattr",
+ "type" : "Object",
+ "desc" : "extra attributes to add to 'element' (used by builder to store stuff.)",
+ "memberOf" : "Roo.bootstrap.Component",
+ "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" : "resizeTabs",
- "type" : "Boolean",
- "desc" : "True to enable automatic tab resizing. This will resize the tabs so they are all the same size and fit within\n the space available, similar to FireFox 1.5 tabs (defaults to false)",
- "memberOf" : ""
+ "name" : "beforehide",
+ "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" : "skipConfig",
- "type" : "bool",
- "desc" : "skip config?",
- "memberOf" : "Roo.bootstrap.layout.Basic"
+ "name" : "beforerender",
+ "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" : "split",
- "type" : "Boolean",
- "desc" : "To show the splitter",
- "memberOf" : ""
+ "name" : "beforeshow",
+ "type" : "function",
+ "desc" : "Fires before the component is shown. Return false to stop the show.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.Component",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
},
{
- "name" : "tabPosition",
- "type" : "String",
- "desc" : "m) \"top\" or \"bottom\" (defaults to \"bottom\")",
- "memberOf" : ""
+ "name" : "childrenrendered",
+ "type" : "function",
+ "desc" : "Fires when the children have been rendered..",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.bootstrap.Component",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.bootstrap.Component",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
},
{
- "name" : "title",
- "type" : "String",
- "desc" : "The title for the region (overrides panel titles)",
- "memberOf" : ""
+ "name" : "click",
+ "type" : "function",
+ "desc" : "The raw click event for the entire grid.",
+ "sig" : "function (_self, e)\n{\n\n}",
+ "memberOf" : "",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.bootstrap.menu.Item",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "e",
+ "type" : "Roo.EventObject",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
},
{
- "name" : "titlebar",
- "type" : "Boolean",
- "desc" : "True to display a title bar (defaults to true)",
- "memberOf" : ""
+ "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" : "toolbar",
- "type" : "Boolean",
- "desc" : "xtype configuration for a toolbar - shows on right of tabbar",
- "memberOf" : ""
+ "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" : "width",
- "type" : "Number",
- "desc" : "For East/West panels",
- "memberOf" : ""
- }
- ],
- "events" : [],
- "methods" : [
+ "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" : "add",
+ "name" : "hide",
"type" : "function",
- "desc" : "Adds the passed ContentPanel(s) to this region.",
- "sig" : "(panel)",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
+ "desc" : "Fires after the component is hidden.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
"params" : [
{
- "name" : "panel",
- "type" : "ContentPanel...",
- "desc" : "The ContentPanel(s) to add (you can pass more than one)",
+ "name" : "this",
+ "type" : "Roo.Component",
+ "desc" : "",
"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" : "Roo.ContentPanel",
- "desc" : "The panel added (if only one was added; null otherwise)"
+ "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",
],
"returns" : []
},
- {
- "name" : "animateCollapse",
- "type" : "function",
- "desc" : "Collapses this region.",
- "sig" : "(skipAnim)",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "skipAnim",
- "type" : "Boolean",
- "desc" : "(optional) true to collapse the element without animation (if animate is true)",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "animateExpand",
- "type" : "function",
- "desc" : "Expands this region if it was previously collapsed.",
- "sig" : "(e, skipAnim)",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "e",
- "type" : "Roo.EventObject",
- "desc" : "The event that triggered the expand (or null if calling manually)",
- "isOptional" : false
- },
- {
- "name" : "skipAnim",
- "type" : "Boolean",
- "desc" : "(optional) true to expand the element without animation (if animate is true)",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
{
"name" : "capture",
"type" : "function",
"returns" : []
},
{
- "name" : "fireEvent",
+ "name" : "destroy",
"type" : "function",
- "desc" : "Fires the specified event with the passed parameters (minus the event name).",
- "sig" : "(eventName, args)",
+ "desc" : "Destroys this component by purging any event listeners, removing the component's element from the DOM,\nremoving the component from its {@link Roo.Container} (if applicable) and unregistering it from {@link Roo.ComponentMgr}.",
+ "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" : "",
- "isOptional" : false
- },
- {
- "name" : "args",
- "type" : "Object...",
- "desc" : "Variable number of parameters are passed to handlers",
- "isOptional" : false
- }
- ],
- "returns" : [
- {
- "name" : "",
- "type" : "Boolean",
- "desc" : "returns false if any of the handlers return false otherwise it returns true"
- }
- ]
+ "params" : [],
+ "returns" : []
},
{
- "name" : "getActivePanel",
+ "name" : "disable",
"type" : "function",
- "desc" : "Get the active panel for this region.",
+ "desc" : "Disable this component.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"returns" : [
{
"name" : "",
- "type" : "Roo.ContentPanel",
- "desc" : "The active panel or null"
+ "type" : "Roo.Component",
+ "desc" : "this"
}
]
},
{
- "name" : "getBox",
+ "name" : "enable",
"type" : "function",
- "desc" : "Updates the title for collapsed north/south regions (used with {@link #collapsedTitle} config option)",
- "sig" : "(title)",
+ "desc" : "Enable this component.",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
+ "params" : [],
+ "returns" : [
{
- "name" : "title",
- "type" : "String",
- "desc" : "(optional) The title text (accepts HTML markup, defaults to the numeric character reference for a non-breaking space, \"&#160;\")",
- "isOptional" : false
+ "name" : "",
+ "type" : "Roo.Component",
+ "desc" : "this"
}
- ],
- "returns" : []
+ ]
},
{
- "name" : "getEl",
+ "name" : "fireEvent",
"type" : "function",
- "desc" : "Returns the container element for this region.",
- "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" : "Roo.Element",
- "desc" : ""
+ "type" : "Boolean",
+ "desc" : "returns false if any of the handlers return false otherwise it returns true"
}
]
},
{
- "name" : "getPanel",
+ "name" : "focus",
"type" : "function",
- "desc" : "Returns the panel specified or null if it's not in this region.",
- "sig" : "(panel)",
+ "desc" : "Try to focus this component.",
+ "sig" : "(selectText)",
"static" : false,
- "memberOf" : "Roo.bootstrap.layout.Basic",
+ "memberOf" : "Roo.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "panel",
- "type" : "Number/String/ContentPanel",
- "desc" : "The panels index, id or the panel itself",
+ "name" : "selectText",
+ "type" : "Boolean",
+ "desc" : "True to also select the text in this component (if applicable)",
"isOptional" : false
}
],
"returns" : [
{
"name" : "",
- "type" : "Roo.ContentPanel",
- "desc" : ""
+ "type" : "Roo.Component",
+ "desc" : "this"
}
]
},
{
- "name" : "getPosition",
+ "name" : "getChildContainer",
"type" : "function",
- "desc" : "Returns this regions position (north/south/east/west/center).",
+ "desc" : "Fetch the element to add children to",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.bootstrap.layout.Basic",
+ "memberOf" : "Roo.bootstrap.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"returns" : [
{
"name" : "",
- "type" : "String",
- "desc" : ""
+ "type" : "Roo.Element",
+ "desc" : "defaults to this.el"
}
]
},
{
- "name" : "getTabs",
+ "name" : "getEl",
"type" : "function",
- "desc" : "Returns the TabPanel component used by this region",
+ "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" : "Roo.TabPanel",
- "desc" : ""
+ "type" : "Roo.Element",
+ "desc" : "The element"
}
]
},
{
- "name" : "hasListener",
+ "name" : "getId",
"type" : "function",
- "desc" : "Checks to see if this object has any listeners for a specified event",
- "sig" : "(eventName)",
+ "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,
"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" : "String",
+ "desc" : ""
}
]
},
{
- "name" : "hasPanel",
+ "name" : "getVisibilityEl",
"type" : "function",
- "desc" : "Returns true if the panel is in this region.",
- "sig" : "(panel)",
+ "desc" : "Get the element that will be used to show or hide",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.bootstrap.layout.Basic",
+ "memberOf" : "Roo.bootstrap.Component",
+ "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,
"requires" : "",
"params" : [
{
- "name" : "panel",
- "type" : "Number/String/ContentPanel",
- "desc" : "The panels index, id or the panel itself",
+ "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"
}
]
},
{
"name" : "hide",
"type" : "function",
- "desc" : "Hides this region.",
+ "desc" : "Hide a component - adds 'hidden' class",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.bootstrap.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"returns" : []
},
{
- "name" : "hidePanel",
+ "name" : "initEvents",
"type" : "function",
- "desc" : "Hides the tab for the specified panel.",
- "sig" : "(panel)",
+ "desc" : "Initialize Events for the element",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.bootstrap.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "panel",
- "type" : "Number/String/ContentPanel",
- "desc" : "The panel's index, id or the panel itself",
- "isOptional" : false
- }
- ],
+ "params" : [],
"returns" : []
},
{
"name" : "isVisible",
"type" : "function",
- "desc" : "Returns true if this region is currently visible.",
+ "desc" : "Returns true if this component is visible.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"exceptions" : "",
"requires" : "",
"params" : [],
- "returns" : [
- {
- "name" : "",
- "type" : "Boolean",
- "desc" : ""
- }
- ]
+ "returns" : []
},
{
"name" : "on",
{
"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" : "remove",
- "type" : "function",
- "desc" : "Removes the specified panel. If preservePanel is not true (either here or in the config), the panel is destroyed.",
- "sig" : "(panel, preservePanel)",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
+ "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" : "panel",
- "type" : "Number/String/ContentPanel",
- "desc" : "The panel's index, id or the panel itself",
- "isOptional" : false
- },
- {
- "name" : "preservePanel",
- "type" : "Boolean",
- "desc" : "Overrides the config preservePanel option",
+ "name" : "o",
+ "type" : "Observable",
+ "desc" : "The Observable to release",
"isOptional" : false
}
],
- "returns" : [
- {
- "name" : "",
- "type" : "Roo.ContentPanel",
- "desc" : "The panel that was removed"
- }
- ]
+ "returns" : []
},
{
"name" : "removeListener",
"returns" : []
},
{
- "name" : "resizeTo",
+ "name" : "render",
"type" : "function",
- "desc" : "Resizes the region to the specified size. For vertical regions (west, east) this adjusts \nthe width, for horizontal (north, south) the height.",
- "sig" : "(newSize)",
+ "desc" : "If this is a lazy rendering component, render it to its container element.",
+ "sig" : "(container)",
"static" : false,
- "memberOf" : "Roo.bootstrap.layout.Basic",
+ "memberOf" : "Roo.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "newSize",
- "type" : "Number",
- "desc" : "The new width or height",
+ "name" : "container",
+ "type" : "String/HTMLElement/Element",
+ "desc" : "(optional) The element this component should be rendered into. If it is being applied to existing markup, this should be left off.",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "show",
+ "name" : "setDisabled",
"type" : "function",
- "desc" : "Shows this region if it was previously hidden.",
+ "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" : "setVisibilityEl",
+ "type" : "function",
+ "desc" : "Set the element that will be used to show or hide",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.bootstrap.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"returns" : []
},
{
- "name" : "showPanel",
+ "name" : "setVisible",
"type" : "function",
- "desc" : "Shows the specified panel.",
- "sig" : "(panelId)",
+ "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" : "panelId",
- "type" : "Number/String/ContentPanel",
- "desc" : "The panel's index, id or the panel itself",
+ "name" : "visible",
+ "type" : "Boolean",
+ "desc" : "True to show, false to hide",
"isOptional" : false
}
],
"returns" : [
{
"name" : "",
- "type" : "Roo.ContentPanel",
- "desc" : "The shown panel, or null if a panel could not be found from panelId"
+ "type" : "Roo.Component",
+ "desc" : "this"
+ }
+ ]
+ },
+ {
+ "name" : "show",
+ "type" : "function",
+ "desc" : "Show a component - removes 'hidden' class",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.Component",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
+ {
+ "name" : "tooltipEl",
+ "type" : "function",
+ "desc" : "Fetch the element to display the tooltip on.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.Component",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.Element",
+ "desc" : "defaults to this.el"
}
]
},
}
],
"returns" : []
- },
+ }
+ ],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "implementations" : [],
+ "tree_children" : [
+ "Roo.bootstrap.Button",
+ "Roo.bootstrap.ButtonUploader",
+ "Roo.bootstrap.form.CardUploader",
+ "Roo.bootstrap.ButtonUploader",
+ "Roo.bootstrap.Row",
+ "Roo.bootstrap.Column",
+ "Roo.bootstrap.TabGroup"
+ ],
+ "tree_parent" : [
+ "Roo.bootstrap.menu.Menu"
+ ]
+ },
+ "Roo.bootstrap.menu.Manager" : {
+ "props" : [],
+ "events" : [],
+ "methods" : [
{
- "name" : "unhidePanel",
+ "name" : "get",
"type" : "function",
- "desc" : "Unhides the tab for a previously hidden panel.",
- "sig" : "(panel)",
+ "desc" : "Returns a {@link Roo.menu.Menu} object",
+ "sig" : "(menu)",
"static" : false,
"memberOf" : "",
"isStatic" : false,
"requires" : "",
"params" : [
{
- "name" : "panel",
- "type" : "Number/String/ContentPanel",
- "desc" : "The panel's index, id or the panel itself",
+ "name" : "menu",
+ "type" : "String/Object",
+ "desc" : "The string menu id, an existing menu object reference, or a Menu config that will\nbe used to generate and return a new Menu instance.",
"isOptional" : false
}
],
"returns" : []
+ },
+ {
+ "name" : "hideAll",
+ "type" : "function",
+ "desc" : "Hides all menus that are currently visible",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
}
],
"isAbstract" : false,
"tree_children" : [],
"tree_parent" : []
},
- "Roo.bootstrap.layout.Split" : {
+ "Roo.bootstrap.menu.Menu" : {
"props" : [
{
- "name" : "alwaysShowTabs",
- "type" : "Boolean",
- "desc" : "True to always display tabs even when there is only 1 panel (defaults to false)",
- "memberOf" : "Roo.LayoutRegion"
- },
- {
- "name" : "animate",
- "type" : "Boolean",
- "desc" : "True to animate expand/collapse (defaults to false)",
- "memberOf" : "Roo.LayoutRegion"
- },
- {
- "name" : "autoHide",
- "type" : "Boolean",
- "desc" : "False to disable auto hiding when the mouse leaves the \"floated\" region (defaults to true)",
- "memberOf" : "Roo.LayoutRegion"
+ "name" : "actionMode",
+ "type" : "String",
+ "desc" : "which property holds the 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" : "autoScroll",
- "type" : "Boolean",
- "desc" : "True to enable overflow scrolling (defaults to false)",
- "memberOf" : "Roo.LayoutRegion"
+ "name" : "align",
+ "type" : "String",
+ "desc" : "default tl-bl? == below - how the menu should be aligned.",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
- "name" : "closeOnTab",
+ "name" : "allowDomMove",
"type" : "Boolean",
- "desc" : "True to place the close icon on the tabs instead of the region titlebar (defaults to false)",
- "memberOf" : "Roo.LayoutRegion"
- },
- {
- "name" : "cmargins",
- "type" : "Object",
- "desc" : "Margins for the element when collapsed (defaults to: north/south {top: 2, left: 0, right:0, bottom: 2} or east/west {top: 0, left: 2, right:2, bottom: 0})",
- "memberOf" : "Roo.LayoutRegion"
+ "desc" : "Whether the component can move the Dom node when rendering (defaults to true).",
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
- "name" : "collapsed",
+ "name" : "can_build_overlaid",
"type" : "Boolean",
- "desc" : "True to set the initial display to collapsed (defaults to false)",
- "memberOf" : "Roo.LayoutRegion"
+ "desc" : "True if element can be rebuild from a HTML page",
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
- "name" : "collapsedTitle",
+ "name" : "cls",
"type" : "String",
- "desc" : "Optional string message to display in the collapsed block of a north or south region",
- "memberOf" : "Roo.LayoutRegion"
+ "desc" : "css class",
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
- "name" : "collapsible",
- "type" : "Boolean",
- "desc" : "False to disable collapsing (defaults to true)",
- "memberOf" : "Roo.LayoutRegion"
+ "name" : "container_method",
+ "type" : "string",
+ "desc" : "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)",
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
- "name" : "disableTabTips",
- "type" : "Boolean",
- "desc" : "True to disable tab tooltips",
- "memberOf" : "Roo.LayoutRegion"
+ "name" : "dataId",
+ "type" : "string",
+ "desc" : "cutomer id",
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
- "name" : "floatable",
- "type" : "Boolean",
- "desc" : "False to disable floating (defaults to true)",
- "memberOf" : "Roo.LayoutRegion"
+ "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" : "For North/South panels",
- "memberOf" : "Roo.LayoutRegion"
+ "name" : "hidden",
+ "type" : "bool",
+ "desc" : "if the menu should be hidden when rendered.",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
- "name" : "hidden",
- "type" : "Boolean",
- "desc" : "True to start the region hidden (defaults to false)",
- "memberOf" : "Roo.LayoutRegion"
+ "name" : "hideMode",
+ "type" : "String",
+ "desc" : "y)\nHow this component 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" : "hideTabs",
- "type" : "Boolean",
- "desc" : "True to hide the tab strip (defaults to false)",
- "memberOf" : "Roo.LayoutRegion"
+ "name" : "hideTrigger",
+ "type" : "bool",
+ "desc" : "e) default false - hide the carret for trigge",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : [
+ "true",
+ "false"
+ ]
},
{
- "name" : "hideWhenEmpty",
- "type" : "Boolean",
- "desc" : "True to hide the region when it has no panels",
- "memberOf" : "Roo.LayoutRegion"
+ "name" : "isLink",
+ "type" : "bool",
+ "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"
- },
- {
- "name" : "margins",
- "type" : "Object",
- "desc" : "Margins for the element (defaults to {top: 0, left: 0, right:0, bottom: 0})",
- "memberOf" : "Roo.LayoutRegion"
- },
- {
- "name" : "minTabWidth",
- "type" : "Number",
- "desc" : "The minimum tab width (defaults to 40)",
- "memberOf" : "Roo.LayoutRegion"
- },
- {
- "name" : "preferredTabWidth",
- "type" : "Number",
- "desc" : "The preferred tab width (defaults to 150)",
- "memberOf" : "Roo.LayoutRegion"
- },
- {
- "name" : "preservePanels",
- "type" : "Boolean",
- "desc" : "True to preserve removed panels so they can be readded later (defaults to false)",
- "memberOf" : "Roo.LayoutRegion"
+ "memberOf" : "Roo.util.Observable",
+ "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"
+ "name" : "name",
+ "type" : "string",
+ "desc" : "Specifies name attribute",
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
- "name" : "showPin",
+ "name" : "registerMenu",
"type" : "Boolean",
- "desc" : "True to show a pin button",
- "memberOf" : "Roo.LayoutRegion"
+ "desc" : "True (default) - means that clicking on screen etc. hides it.",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
- "name" : "split",
- "type" : "Boolean",
- "desc" : "To show the splitter",
- "memberOf" : "Roo.LayoutRegion"
+ "name" : "stopEvent",
+ "type" : "bool",
+ "desc" : "e) Stop event after trigger press (default tru",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : [
+ "true",
+ "false"
+ ]
},
{
- "name" : "tabPosition",
+ "name" : "style",
"type" : "String",
- "desc" : "m) \"top\" or \"bottom\" (defaults to \"bottom\")",
- "memberOf" : "Roo.LayoutRegion"
+ "desc" : "any extra css",
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
- "name" : "title",
- "type" : "String",
- "desc" : "The title for the region (overrides panel titles)",
- "memberOf" : "Roo.LayoutRegion"
+ "name" : "tooltip",
+ "type" : "string",
+ "desc" : "Text for the tooltip",
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
- "name" : "titlebar",
- "type" : "Boolean",
- "desc" : "True to display a title bar (defaults to true)",
- "memberOf" : "Roo.LayoutRegion"
+ "name" : "type",
+ "type" : "String",
+ "desc" : "u) type of me",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : [
+ "dropdown",
+ "treeview",
+ "submenu"
+ ]
},
{
- "name" : "toolbar",
- "type" : "Boolean",
- "desc" : "xtype configuration for a toolbar - shows on right of tabbar",
- "memberOf" : "Roo.LayoutRegion"
+ "name" : "visibilityEl",
+ "type" : "string|object",
+ "desc" : "t) What element to use for visibility (@see getVisibilityEl(",
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : [
+ "el",
+ "parent"
+ ]
},
{
- "name" : "width",
- "type" : "Number",
- "desc" : "For East/West panels",
- "memberOf" : "Roo.LayoutRegion"
+ "name" : "xattr",
+ "type" : "Object",
+ "desc" : "extra attributes to add to 'element' (used by builder to store stuff.)",
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
}
],
"events" : [
{
- "name" : "beforecollapse",
+ "name" : "beforedestroy",
"type" : "function",
- "desc" : "Fires when this region before collapse.",
+ "desc" : "Fires before the component is destroyed. Return false to stop the destroy.",
"sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.BasicLayoutRegion",
+ "memberOf" : "Roo.Component",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.LayoutRegion",
+ "type" : "Roo.Component",
"desc" : "",
"isOptional" : false
}
"returns" : []
},
{
- "name" : "beforeremove",
+ "name" : "beforehide",
"type" : "function",
- "desc" : "Fires before a panel is removed (or closed). To cancel the removal set \"e.cancel = true\" on the event argument.",
- "sig" : "function (_self, panel, e)\n{\n\n}",
- "memberOf" : "Roo.BasicLayoutRegion",
+ "desc" : "Fires before this menu is hidden (return false to block)",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.LayoutRegion",
+ "type" : "Roo.menu.Menu",
"desc" : "",
"isOptional" : false
- },
- {
- "name" : "panel",
- "type" : "Roo.ContentPanel",
- "desc" : "The panel",
- "isOptional" : false
- },
- {
- "name" : "e",
- "type" : "Object",
- "desc" : "The cancel event object",
- "isOptional" : false
}
],
"returns" : []
},
{
- "name" : "collapsed",
+ "name" : "beforerender",
"type" : "function",
- "desc" : "Fires when this region is collapsed.",
+ "desc" : "Fires before the component is rendered. Return false to stop the render.",
"sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.BasicLayoutRegion",
+ "memberOf" : "Roo.Component",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.LayoutRegion",
+ "type" : "Roo.Component",
"desc" : "",
"isOptional" : false
}
"returns" : []
},
{
- "name" : "expanded",
+ "name" : "beforeshow",
"type" : "function",
- "desc" : "Fires when this region is expanded.",
+ "desc" : "Fires before this menu is displayed (return false to block)",
"sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.BasicLayoutRegion",
+ "memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.LayoutRegion",
+ "type" : "Roo.menu.Menu",
"desc" : "",
"isOptional" : false
}
"returns" : []
},
{
- "name" : "invalidated",
+ "name" : "childrenrendered",
"type" : "function",
- "desc" : "Fires when the layout for this region is changed.",
+ "desc" : "Fires when the children have been rendered..",
"sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.BasicLayoutRegion",
+ "memberOf" : "Roo.bootstrap.Component",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.LayoutRegion",
+ "type" : "Roo.bootstrap.Component",
"desc" : "",
"isOptional" : false
}
"returns" : []
},
{
- "name" : "panelactivated",
+ "name" : "click",
"type" : "function",
- "desc" : "Fires when a panel is activated.",
- "sig" : "function (_self, panel)\n{\n\n}",
- "memberOf" : "Roo.BasicLayoutRegion",
+ "desc" : "Fires when this menu is clicked (or when the enter key is pressed while it is active)",
+ "sig" : "function (_self, menuItem, e)\n{\n\n}",
+ "memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.LayoutRegion",
+ "type" : "Roo.menu.Menu",
"desc" : "",
"isOptional" : false
},
{
- "name" : "panel",
- "type" : "Roo.ContentPanel",
- "desc" : "The activated panel",
+ "name" : "menuItem",
+ "type" : "Roo.menu.Item",
+ "desc" : "The menu item that was clicked",
+ "isOptional" : false
+ },
+ {
+ "name" : "e",
+ "type" : "Roo.EventObject",
+ "desc" : "",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "paneladded",
+ "name" : "destroy",
"type" : "function",
- "desc" : "Fires when a panel is added.",
- "sig" : "function (_self, panel)\n{\n\n}",
- "memberOf" : "Roo.BasicLayoutRegion",
+ "desc" : "Fires after the component is destroyed.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.LayoutRegion",
+ "type" : "Roo.Component",
"desc" : "",
"isOptional" : false
- },
- {
- "name" : "panel",
- "type" : "Roo.ContentPanel",
- "desc" : "The panel",
- "isOptional" : false
}
],
"returns" : []
},
{
- "name" : "panelremoved",
+ "name" : "disable",
"type" : "function",
- "desc" : "Fires when a panel is removed.",
- "sig" : "function (_self, panel)\n{\n\n}",
- "memberOf" : "Roo.BasicLayoutRegion",
+ "desc" : "Fires after the component is disabled.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.LayoutRegion",
+ "type" : "Roo.Component",
"desc" : "",
"isOptional" : false
- },
- {
- "name" : "panel",
- "type" : "Roo.ContentPanel",
- "desc" : "The panel",
- "isOptional" : false
}
],
"returns" : []
},
{
- "name" : "resized",
+ "name" : "enable",
"type" : "function",
- "desc" : "Fires when the user resizes this region.",
- "sig" : "function (_self, newSize)\n{\n\n}",
- "memberOf" : "Roo.BasicLayoutRegion",
+ "desc" : "Fires after the component is enabled.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.LayoutRegion",
+ "type" : "Roo.Component",
"desc" : "",
"isOptional" : false
- },
- {
- "name" : "newSize",
- "type" : "Number",
- "desc" : "The new size (width for east/west, height for north/south)",
- "isOptional" : false
}
],
"returns" : []
},
{
- "name" : "slidehide",
+ "name" : "hide",
"type" : "function",
- "desc" : "Fires when this region slides out of view.",
+ "desc" : "Fires after this menu is hidden",
"sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.BasicLayoutRegion",
+ "memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.LayoutRegion",
+ "type" : "Roo.menu.Menu",
"desc" : "",
"isOptional" : false
}
"returns" : []
},
{
- "name" : "slideshow",
+ "name" : "itemclick",
"type" : "function",
- "desc" : "Fires when this region is slid into view.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.BasicLayoutRegion",
+ "desc" : "Fires when a menu item contained in this menu is clicked",
+ "sig" : "function (baseItem, e)\n{\n\n}",
+ "memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
"params" : [
{
- "name" : "this",
- "type" : "Roo.LayoutRegion",
+ "name" : "baseItem",
+ "type" : "Roo.menu.BaseItem",
+ "desc" : "The BaseItem that was clicked",
+ "isOptional" : false
+ },
+ {
+ "name" : "e",
+ "type" : "Roo.EventObject",
"desc" : "",
"isOptional" : false
}
"returns" : []
},
{
- "name" : "visibilitychange",
+ "name" : "mouseout",
"type" : "function",
- "desc" : "Fires when this region is shown or hidden",
- "sig" : "function (_self, visibility)\n{\n\n}",
- "memberOf" : "Roo.BasicLayoutRegion",
+ "desc" : "Fires when the mouse exits this menu",
+ "sig" : "function (_self, e, menuItem)\n{\n\n}",
+ "memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.LayoutRegion",
+ "type" : "Roo.menu.Menu",
"desc" : "",
"isOptional" : false
},
{
- "name" : "visibility",
- "type" : "Boolean",
- "desc" : "true or false",
+ "name" : "e",
+ "type" : "Roo.EventObject",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "menuItem",
+ "type" : "Roo.menu.Item",
+ "desc" : "The menu item that was clicked",
"isOptional" : false
}
],
"returns" : []
- }
- ],
- "methods" : [
+ },
{
- "name" : "add",
+ "name" : "mouseover",
"type" : "function",
- "desc" : "Adds the passed ContentPanel(s) to this region.",
- "sig" : "(panel)",
- "static" : false,
- "memberOf" : "Roo.LayoutRegion",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
+ "desc" : "Fires when the mouse is hovering over this menu",
+ "sig" : "function (_self, e, menuItem)\n{\n\n}",
+ "memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
"params" : [
{
- "name" : "panel",
- "type" : "ContentPanel...",
- "desc" : "The ContentPanel(s) to add (you can pass more than one)",
+ "name" : "this",
+ "type" : "Roo.menu.Menu",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "e",
+ "type" : "Roo.EventObject",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "menuItem",
+ "type" : "Roo.menu.Item",
+ "desc" : "The menu item that was clicked",
"isOptional" : false
}
],
- "returns" : [
+ "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" : "Roo.ContentPanel",
- "desc" : "The panel added (if only one was added; null otherwise)"
+ "name" : "this",
+ "type" : "Roo.Component",
+ "desc" : "",
+ "isOptional" : false
}
- ]
+ ],
+ "returns" : []
},
+ {
+ "name" : "show",
+ "type" : "function",
+ "desc" : "Fires after this menu is displayed",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.menu.Menu",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ }
+ ],
+ "methods" : [
{
"name" : "addEvents",
"type" : "function",
"returns" : []
},
{
- "name" : "collapse",
+ "name" : "destroy",
"type" : "function",
- "desc" : "Collapses this region.",
- "sig" : "(skipAnim)",
+ "desc" : "Destroys this component by purging any event listeners, removing the component's element from the DOM,\nremoving the component from its {@link Roo.Container} (if applicable) and unregistering it from {@link Roo.ComponentMgr}.",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.LayoutRegion",
+ "memberOf" : "Roo.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "skipAnim",
- "type" : "Boolean",
- "desc" : "(optional) true to collapse the element without animation (if animate is true)",
- "isOptional" : false
- }
- ],
+ "params" : [],
"returns" : []
},
{
- "name" : "expand",
+ "name" : "disable",
"type" : "function",
- "desc" : "Expands this region if it was previously collapsed.",
- "sig" : "(e, skipAnim)",
+ "desc" : "Disable this component.",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.LayoutRegion",
+ "memberOf" : "Roo.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
+ "params" : [],
+ "returns" : [
{
- "name" : "e",
- "type" : "Roo.EventObject",
- "desc" : "The event that triggered the expand (or null if calling manually)",
- "isOptional" : false
- },
+ "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" : "skipAnim",
- "type" : "Boolean",
- "desc" : "(optional) true to expand the element without animation (if animate is true)",
- "isOptional" : false
+ "name" : "",
+ "type" : "Roo.Component",
+ "desc" : "this"
}
- ],
- "returns" : []
+ ]
},
{
"name" : "fireEvent",
]
},
{
- "name" : "getActivePanel",
+ "name" : "focus",
"type" : "function",
- "desc" : "Get the active panel for this region.",
- "sig" : "()\n{\n\n}",
+ "desc" : "Try to focus this component.",
+ "sig" : "(selectText)",
"static" : false,
- "memberOf" : "Roo.LayoutRegion",
+ "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" : "Roo.ContentPanel",
- "desc" : "The active panel or null"
+ "type" : "Roo.Component",
+ "desc" : "this"
}
]
},
{
- "name" : "getEl",
+ "name" : "getChildContainer",
"type" : "function",
- "desc" : "Returns the container element for this region.",
+ "desc" : "Fetch the element to add children to",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.LayoutRegion",
+ "memberOf" : "Roo.bootstrap.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
{
"name" : "",
"type" : "Roo.Element",
- "desc" : ""
- }
- ]
- },
- {
- "name" : "getPanel",
- "type" : "function",
- "desc" : "Returns the panel specified or null if it's not in this region.",
- "sig" : "(panel)",
- "static" : false,
- "memberOf" : "Roo.BasicLayoutRegion",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "panel",
- "type" : "Number/String/ContentPanel",
- "desc" : "The panels index, id or the panel itself",
- "isOptional" : false
- }
- ],
- "returns" : [
- {
- "name" : "",
- "type" : "Roo.ContentPanel",
- "desc" : ""
+ "desc" : "defaults to this.el"
}
]
},
{
- "name" : "getPosition",
+ "name" : "getEl",
"type" : "function",
- "desc" : "Returns this regions position (north/south/east/west/center).",
+ "desc" : "Returns the underlying {@link Roo.Element}.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.BasicLayoutRegion",
+ "memberOf" : "Roo.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"returns" : [
{
"name" : "",
- "type" : "String",
- "desc" : ""
+ "type" : "Roo.Element",
+ "desc" : "The element"
}
]
},
{
- "name" : "getSplitBar",
+ "name" : "getId",
"type" : "function",
- "desc" : "Returns the {@link Roo.SplitBar} for this region.",
+ "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" : "Roo.SplitBar",
+ "type" : "String",
"desc" : ""
}
]
},
{
- "name" : "getTabs",
+ "name" : "getVisibilityEl",
"type" : "function",
- "desc" : "Returns the TabPanel component used by this region",
+ "desc" : "Get the element that will be used to show or hide",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.LayoutRegion",
+ "memberOf" : "Roo.bootstrap.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"exceptions" : "",
"requires" : "",
"params" : [],
- "returns" : [
- {
- "name" : "",
- "type" : "Roo.TabPanel",
- "desc" : ""
- }
- ]
+ "returns" : []
},
{
"name" : "hasListener",
]
},
{
- "name" : "hasPanel",
+ "name" : "hide",
"type" : "function",
- "desc" : "Returns true if the panel is in this region.",
- "sig" : "(panel)",
+ "desc" : "Hides this menu and optionally all parent menus",
+ "sig" : "(deep)",
"static" : false,
- "memberOf" : "Roo.BasicLayoutRegion",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "panel",
- "type" : "Number/String/ContentPanel",
- "desc" : "The panels index, id or the panel itself",
+ "name" : "deep",
+ "type" : "Boolean",
+ "desc" : "(optional) True to hide all parent menus recursively, if any (defaults to false)",
"isOptional" : false
}
],
- "returns" : [
- {
- "name" : "",
- "type" : "Boolean",
- "desc" : ""
- }
- ]
+ "returns" : []
},
{
- "name" : "hide",
+ "name" : "initEvents",
"type" : "function",
- "desc" : "Hides this region.",
+ "desc" : "Initialize Events for the element",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.LayoutRegion",
+ "memberOf" : "Roo.bootstrap.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"params" : [],
"returns" : []
},
- {
- "name" : "hidePanel",
- "type" : "function",
- "desc" : "Hides the tab for the specified panel.",
- "sig" : "(panel)",
- "static" : false,
- "memberOf" : "Roo.LayoutRegion",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "panel",
- "type" : "Number/String/ContentPanel",
- "desc" : "The panel's index, id or the panel itself",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
{
"name" : "isVisible",
"type" : "function",
- "desc" : "Returns true if this region is currently visible.",
+ "desc" : "Returns true if this component is visible.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.LayoutRegion",
+ "memberOf" : "Roo.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"exceptions" : "",
"requires" : "",
"params" : [],
- "returns" : [
- {
- "name" : "",
- "type" : "Boolean",
- "desc" : ""
- }
- ]
+ "returns" : []
},
{
"name" : "on",
],
"returns" : []
},
- {
- "name" : "remove",
- "type" : "function",
- "desc" : "Removes the specified panel. If preservePanel is not true (either here or in the config), the panel is destroyed.",
- "sig" : "(panel, preservePanel)",
- "static" : false,
- "memberOf" : "Roo.LayoutRegion",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "panel",
- "type" : "Number/String/ContentPanel",
- "desc" : "The panel's index, id or the panel itself",
- "isOptional" : false
- },
- {
- "name" : "preservePanel",
- "type" : "Boolean",
- "desc" : "Overrides the config preservePanel option",
- "isOptional" : false
- }
- ],
- "returns" : [
- {
- "name" : "",
- "type" : "Roo.ContentPanel",
- "desc" : "The panel that was removed"
- }
- ]
- },
{
"name" : "removeListener",
"type" : "function",
"returns" : []
},
{
- "name" : "resizeTo",
+ "name" : "render",
"type" : "function",
- "desc" : "Resizes the region to the specified size. For vertical regions (west, east) this adjusts \nthe width, for horizontal (north, south) the height.",
- "sig" : "(newSize)",
+ "desc" : "If this is a lazy rendering component, render it to its container element.",
+ "sig" : "(container)",
"static" : false,
- "memberOf" : "Roo.BasicLayoutRegion",
+ "memberOf" : "Roo.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "newSize",
- "type" : "Number",
- "desc" : "The new width or height",
+ "name" : "container",
+ "type" : "String/HTMLElement/Element",
+ "desc" : "(optional) The element this component should be rendered into. If it is being applied to existing markup, this should be left off.",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "setCollapsedTitle",
+ "name" : "setDisabled",
"type" : "function",
- "desc" : "Updates the title for collapsed north/south regions (used with {@link #collapsedTitle} config option)",
- "sig" : "(title)",
+ "desc" : "Convenience function for setting disabled/enabled by boolean.",
+ "sig" : "(disabled)",
"static" : false,
- "memberOf" : "Roo.LayoutRegion",
+ "memberOf" : "Roo.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "title",
- "type" : "String",
- "desc" : "(optional) The title text (accepts HTML markup, defaults to the numeric character reference for a non-breaking space, \"&#160;\")",
+ "name" : "disabled",
+ "type" : "Boolean",
+ "desc" : "",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "show",
+ "name" : "setVisibilityEl",
"type" : "function",
- "desc" : "Shows this region if it was previously hidden.",
+ "desc" : "Set the element that will be used to show or hide",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.LayoutRegion",
+ "memberOf" : "Roo.bootstrap.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"returns" : []
},
{
- "name" : "showPanel",
+ "name" : "setVisible",
"type" : "function",
- "desc" : "Shows the specified panel.",
- "sig" : "(panelId)",
+ "desc" : "Convenience function to hide or show this component by boolean.",
+ "sig" : "(visible)",
"static" : false,
- "memberOf" : "Roo.LayoutRegion",
+ "memberOf" : "Roo.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "panelId",
- "type" : "Number/String/ContentPanel",
- "desc" : "The panel's index, id or the panel itself",
+ "name" : "visible",
+ "type" : "Boolean",
+ "desc" : "True to show, false to hide",
"isOptional" : false
}
],
"returns" : [
{
"name" : "",
- "type" : "Roo.ContentPanel",
- "desc" : "The shown panel, or null if a panel could not be found from panelId"
+ "type" : "Roo.Component",
+ "desc" : "this"
+ }
+ ]
+ },
+ {
+ "name" : "show",
+ "type" : "function",
+ "desc" : "Displays this menu relative to another element",
+ "sig" : "(element, position, parentMenu)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "element",
+ "type" : "String/HTMLElement/Roo.Element",
+ "desc" : "The element to align to",
+ "isOptional" : false
+ },
+ {
+ "name" : "position",
+ "type" : "String",
+ "desc" : "(optional) The {@link Roo.Element#alignTo} anchor position to use in aligning to\nthe element (defaults to this.defaultAlign)",
+ "isOptional" : false
+ },
+ {
+ "name" : "parentMenu",
+ "type" : "Roo.menu.Menu",
+ "desc" : "(optional) This menu's parent menu, if applicable (defaults to undefined)",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "showAt",
+ "type" : "function",
+ "desc" : "Displays this menu at a specific xy position",
+ "sig" : "(xyPosition, parentMenu)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "xyPosition",
+ "type" : "Array",
+ "desc" : "Contains X & Y [x, y] values for the position at which to show the menu (coordinates are page-based)",
+ "isOptional" : false
+ },
+ {
+ "name" : "parentMenu",
+ "type" : "Roo.menu.Menu",
+ "desc" : "(optional) This menu's parent menu, if applicable (defaults to undefined)",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "tooltipEl",
+ "type" : "function",
+ "desc" : "Fetch the element to display the tooltip on.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.Component",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.Element",
+ "desc" : "defaults to this.el"
}
]
},
}
],
"returns" : []
- },
- {
- "name" : "unhidePanel",
- "type" : "function",
- "desc" : "Unhides the tab for a previously hidden panel.",
- "sig" : "(panel)",
- "static" : false,
- "memberOf" : "Roo.LayoutRegion",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "panel",
- "type" : "Number/String/ContentPanel",
- "desc" : "The panel's index, id or the panel itself",
- "isOptional" : false
- }
- ],
- "returns" : []
}
],
"isAbstract" : false,
"isBuilderTop" : false,
"implementations" : [],
- "tree_children" : [],
- "tree_parent" : []
- },
- "Roo.bootstrap.menu" : {
- "props" : [],
- "events" : [],
- "methods" : [],
- "isAbstract" : false,
- "isBuilderTop" : false,
- "implementations" : [],
- "tree_children" : [],
- "tree_parent" : []
+ "tree_children" : [
+ "Roo.bootstrap.menu.Item",
+ "Roo.bootstrap.menu.Separator"
+ ],
+ "tree_parent" : [
+ "none"
+ ]
},
- "Roo.bootstrap.menu.Item" : {
+ "Roo.bootstrap.menu.Separator" : {
"props" : [
{
"name" : "actionMode",
"type" : "String",
"desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el' for forms you probably want to set this to fieldEl",
- "memberOf" : "Roo.Component"
- },
- {
- "name" : "active",
- "type" : "Boolean",
- "desc" : "used on sidebars to highlight active itesm",
- "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"
+ "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"
- },
- {
- "name" : "fa",
- "type" : "String",
- "desc" : "favicon to show on left of menu item.",
- "memberOf" : ""
+ "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"
- },
- {
- "name" : "href",
- "type" : "String",
- "desc" : "the link",
- "memberOf" : ""
- },
- {
- "name" : "html",
- "type" : "String",
- "desc" : "the menu label",
- "memberOf" : ""
- },
- {
- "name" : "isContainer",
- "type" : "Boolean",
- "desc" : "is it a container - just returns a drop down item..",
- "memberOf" : ""
+ "desc" : "y)\nHow this component 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"
- },
- {
- "name" : "menu",
- "type" : "Roo.bootsrap.Menu",
- "desc" : "the child menu.",
- "memberOf" : ""
+ "memberOf" : "Roo.util.Observable",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "name",
"type" : "string",
"desc" : "Specifies name attribute",
- "memberOf" : "Roo.bootstrap.Component"
- },
- {
- "name" : "preventDefault",
- "type" : "Boolean",
- "desc" : "do not trigger A href on clicks (default false).",
- "memberOf" : ""
+ "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" : [
],
"returns" : []
},
- {
- "name" : "click",
- "type" : "function",
- "desc" : "The raw click event for the entire grid.",
- "sig" : "function (_self, e)\n{\n\n}",
- "memberOf" : "",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.bootstrap.menu.Item",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "e",
- "type" : "Roo.EventObject",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
{
"name" : "destroy",
"type" : "function",
"isAbstract" : false,
"isBuilderTop" : false,
"implementations" : [],
- "tree_children" : [
- "Roo.bootstrap.Button",
- "Roo.bootstrap.ButtonUploader",
- "Roo.bootstrap.form.CardUploader",
- "Roo.bootstrap.ButtonUploader",
- "Roo.bootstrap.Row",
- "Roo.bootstrap.Column",
- "Roo.bootstrap.TabGroup"
- ],
+ "tree_children" : [],
"tree_parent" : [
"Roo.bootstrap.menu.Menu"
]
},
- "Roo.bootstrap.menu.Manager" : {
+ "Roo.bootstrap.nav" : {
"props" : [],
"events" : [],
- "methods" : [
- {
- "name" : "get",
- "type" : "function",
- "desc" : "Returns a {@link Roo.menu.Menu} object",
- "sig" : "(menu)",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "menu",
- "type" : "String/Object",
- "desc" : "The string menu id, an existing menu object reference, or a Menu config that will\nbe used to generate and return a new Menu instance.",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "hideAll",
- "type" : "function",
- "desc" : "Hides all menus that are currently visible",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- }
- ],
+ "methods" : [],
"isAbstract" : false,
"isBuilderTop" : false,
"implementations" : [],
"tree_children" : [],
"tree_parent" : []
},
- "Roo.bootstrap.menu.Menu" : {
+ "Roo.bootstrap.nav.Bar" : {
"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" : "align",
- "type" : "String",
- "desc" : "default tl-bl? == below - how the menu should be aligned.",
- "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"
+ "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"
- },
- {
- "name" : "hidden",
- "type" : "bool",
- "desc" : "if the menu should be hidden when rendered.",
- "memberOf" : ""
+ "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"
- },
- {
- "name" : "hideTrigger",
- "type" : "bool",
- "desc" : "e) default false - hide the carret for trigger.",
- "memberOf" : ""
- },
- {
- "name" : "isLink",
- "type" : "bool",
- "desc" : "e) the menu has link disable auto expand and collaspe (default false)",
- "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" : "listeners",
"type" : "Object",
"desc" : "list of events and functions to call for 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"
- },
- {
- "name" : "registerMenu",
- "type" : "Boolean",
- "desc" : "True (default) - means that clicking on screen etc. hides it.",
- "memberOf" : ""
- },
- {
- "name" : "stopEvent",
- "type" : "bool",
- "desc" : "e) Stop event after trigger press (default true)",
- "memberOf" : ""
+ "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"
- },
- {
- "name" : "type",
- "type" : "String",
- "desc" : "u) type of menu",
- "memberOf" : ""
+ "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" : [
{
"name" : "beforehide",
"type" : "function",
- "desc" : "Fires before this menu is hidden (return false to block)",
+ "desc" : "Fires before the component is hidden. Return false to stop the hide.",
"sig" : "function (_self)\n{\n\n}",
- "memberOf" : "",
+ "memberOf" : "Roo.Component",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.menu.Menu",
+ "type" : "Roo.Component",
"desc" : "",
"isOptional" : false
}
{
"name" : "beforeshow",
"type" : "function",
- "desc" : "Fires before this menu is displayed (return false to block)",
+ "desc" : "Fires before the component is shown. Return false to stop the show.",
"sig" : "function (_self)\n{\n\n}",
- "memberOf" : "",
+ "memberOf" : "Roo.Component",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.menu.Menu",
+ "type" : "Roo.Component",
"desc" : "",
"isOptional" : false
}
"returns" : []
},
{
- "name" : "childrenrendered",
+ "name" : "beforetoggle",
"type" : "function",
- "desc" : "Fires when the children have been rendered..",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.Component",
+ "desc" : "Fire before toggle the menu",
+ "sig" : "function (e)\n{\n\n}",
+ "memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
"params" : [
{
- "name" : "this",
- "type" : "Roo.bootstrap.Component",
+ "name" : "e",
+ "type" : "Roo.EventObject",
"desc" : "",
"isOptional" : false
}
"returns" : []
},
{
- "name" : "click",
+ "name" : "childrenrendered",
"type" : "function",
- "desc" : "Fires when this menu is clicked (or when the enter key is pressed while it is active)",
- "sig" : "function (_self, menuItem, e)\n{\n\n}",
- "memberOf" : "",
+ "desc" : "Fires when the children have been rendered..",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.bootstrap.Component",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.menu.Menu",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "menuItem",
- "type" : "Roo.menu.Item",
- "desc" : "The menu item that was clicked",
- "isOptional" : false
- },
- {
- "name" : "e",
- "type" : "Roo.EventObject",
+ "type" : "Roo.bootstrap.Component",
"desc" : "",
"isOptional" : false
}
{
"name" : "hide",
"type" : "function",
- "desc" : "Fires after this menu is hidden",
+ "desc" : "Fires after the component is hidden.",
"sig" : "function (_self)\n{\n\n}",
- "memberOf" : "",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.menu.Menu",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "itemclick",
- "type" : "function",
- "desc" : "Fires when a menu item contained in this menu is clicked",
- "sig" : "function (baseItem, e)\n{\n\n}",
- "memberOf" : "",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "baseItem",
- "type" : "Roo.menu.BaseItem",
- "desc" : "The BaseItem that was clicked",
- "isOptional" : false
- },
- {
- "name" : "e",
- "type" : "Roo.EventObject",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "mouseout",
- "type" : "function",
- "desc" : "Fires when the mouse exits this menu",
- "sig" : "function (_self, e, menuItem)\n{\n\n}",
- "memberOf" : "",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.menu.Menu",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "e",
- "type" : "Roo.EventObject",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "menuItem",
- "type" : "Roo.menu.Item",
- "desc" : "The menu item that was clicked",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "mouseover",
- "type" : "function",
- "desc" : "Fires when the mouse is hovering over this menu",
- "sig" : "function (_self, e, menuItem)\n{\n\n}",
- "memberOf" : "",
+ "memberOf" : "Roo.Component",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.menu.Menu",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "e",
- "type" : "Roo.EventObject",
+ "type" : "Roo.Component",
"desc" : "",
"isOptional" : false
- },
- {
- "name" : "menuItem",
- "type" : "Roo.menu.Item",
- "desc" : "The menu item that was clicked",
- "isOptional" : false
}
],
"returns" : []
{
"name" : "show",
"type" : "function",
- "desc" : "Fires after this menu is displayed",
+ "desc" : "Fires after the component is shown.",
"sig" : "function (_self)\n{\n\n}",
- "memberOf" : "",
+ "memberOf" : "Roo.Component",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.menu.Menu",
+ "type" : "Roo.Component",
"desc" : "",
"isOptional" : false
}
],
"returns" : []
},
+ {
+ "name" : "collapse",
+ "type" : "function",
+ "desc" : "Collapse the navbar pulldown",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
{
"name" : "destroy",
"type" : "function",
}
]
},
+ {
+ "name" : "expand",
+ "type" : "function",
+ "desc" : "Expand the navbar pulldown",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
{
"name" : "fireEvent",
"type" : "function",
{
"name" : "hide",
"type" : "function",
- "desc" : "Hides this menu and optionally all parent menus",
- "sig" : "(deep)",
+ "desc" : "Hide a component - adds 'hidden' class",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.bootstrap.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "deep",
- "type" : "Boolean",
- "desc" : "(optional) True to hide all parent menus recursively, if any (defaults to false)",
- "isOptional" : false
- }
- ],
+ "params" : [],
"returns" : []
},
{
{
"name" : "show",
"type" : "function",
- "desc" : "Displays this menu relative to another element",
- "sig" : "(element, position, parentMenu)",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "element",
- "type" : "String/HTMLElement/Roo.Element",
- "desc" : "The element to align to",
- "isOptional" : false
- },
- {
- "name" : "position",
- "type" : "String",
- "desc" : "(optional) The {@link Roo.Element#alignTo} anchor position to use in aligning to\nthe element (defaults to this.defaultAlign)",
- "isOptional" : false
- },
- {
- "name" : "parentMenu",
- "type" : "Roo.menu.Menu",
- "desc" : "(optional) This menu's parent menu, if applicable (defaults to undefined)",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "showAt",
- "type" : "function",
- "desc" : "Displays this menu at a specific xy position",
- "sig" : "(xyPosition, parentMenu)",
+ "desc" : "Show a component - removes 'hidden' class",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.bootstrap.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "xyPosition",
- "type" : "Array",
- "desc" : "Contains X & Y [x, y] values for the position at which to show the menu (coordinates are page-based)",
- "isOptional" : false
- },
- {
- "name" : "parentMenu",
- "type" : "Roo.menu.Menu",
- "desc" : "(optional) This menu's parent menu, if applicable (defaults to undefined)",
- "isOptional" : false
- }
- ],
+ "params" : [],
"returns" : []
},
{
"returns" : []
}
],
- "isAbstract" : false,
+ "isAbstract" : true,
"isBuilderTop" : false,
- "implementations" : [],
- "tree_children" : [
- "Roo.bootstrap.menu.Item"
+ "implementations" : [
+ "Roo.bootstrap.PagingToolbar",
+ "Roo.bootstrap.PopoverNav",
+ "Roo.bootstrap.form.HtmlEditorToolbar.Standard",
+ "Roo.bootstrap.nav.Headerbar",
+ "Roo.bootstrap.nav.Sidebar",
+ "Roo.bootstrap.nav.Simplebar"
],
- "tree_parent" : [
- "none"
- ]
+ "tree_children" : [],
+ "tree_parent" : []
},
- "Roo.bootstrap.menu.Separator" : {
+ "Roo.bootstrap.nav.Group" : {
"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" : "align",
+ "type" : "String",
+ "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" : "",
+ "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" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "pilltype",
+ "type" : "Boolean",
+ "desc" : "default true (turn to off to disable active toggle)",
+ "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 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" : [
],
"returns" : []
},
+ {
+ "name" : "changed",
+ "type" : "function",
+ "desc" : "Fires when the active item changes",
+ "sig" : "function (_self, selected, prev)\n{\n\n}",
+ "memberOf" : "",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.bootstrap.nav.Group",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "selected",
+ "type" : "Roo.bootstrap.Navbar.Item",
+ "desc" : "The item selected",
+ "isOptional" : false
+ },
+ {
+ "name" : "prev",
+ "type" : "Roo.bootstrap.Navbar.Item",
+ "desc" : "The previously selected item",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
{
"name" : "childrenrendered",
"type" : "function",
],
"returns" : []
},
+ {
+ "name" : "addItem",
+ "type" : "function",
+ "desc" : "adds a Navigation item",
+ "sig" : "(the)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "the",
+ "type" : "Roo.bootstrap.nav.Item",
+ "desc" : "navitem to add",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
{
"name" : "addListener",
"type" : "function",
],
"returns" : []
},
+ {
+ "name" : "clearAll",
+ "type" : "function",
+ "desc" : "clear all the Navigation item",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
{
"name" : "destroy",
"type" : "function",
}
]
},
+ {
+ "name" : "get",
+ "type" : "function",
+ "desc" : "fetch a Navigation Group based on the navigation ID",
+ "sig" : "(the)",
+ "static" : true,
+ "memberOf" : "",
+ "isStatic" : true,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "the",
+ "type" : "string",
+ "desc" : "navgroup to add",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "getActive",
+ "type" : "function",
+ "desc" : "gets the active Navigation item",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.bootstrap.nav.Item",
+ "desc" : "the current navitem"
+ }
+ ]
+ },
{
"name" : "getChildContainer",
"type" : "function",
"params" : [],
"returns" : []
},
+ {
+ "name" : "register",
+ "type" : "function",
+ "desc" : "register a Navigation item",
+ "sig" : "(the)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "the",
+ "type" : "Roo.bootstrap.nav.Item",
+ "desc" : "navitem to add",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "register",
+ "type" : "function",
+ "desc" : "register a Navigation Group",
+ "sig" : "(the)",
+ "static" : true,
+ "memberOf" : "",
+ "isStatic" : true,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "the",
+ "type" : "Roo.bootstrap.nav.Group",
+ "desc" : "navgroup to add",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
{
"name" : "releaseCapture",
"type" : "function",
],
"returns" : []
},
+ {
+ "name" : "setActiveItem",
+ "type" : "function",
+ "desc" : "sets the active Navigation item",
+ "sig" : "(the)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "the",
+ "type" : "Roo.bootstrap.nav.Item",
+ "desc" : "new current navitem",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
{
"name" : "setDisabled",
"type" : "function",
"isAbstract" : false,
"isBuilderTop" : false,
"implementations" : [],
- "tree_children" : [],
- "tree_parent" : [
- "Roo.bootstrap.menu.Menu"
- ]
- },
- "Roo.bootstrap.nav" : {
- "props" : [],
- "events" : [],
- "methods" : [],
- "isAbstract" : false,
- "isBuilderTop" : false,
- "implementations" : [],
- "tree_children" : [],
+ "tree_children" : [
+ "Roo.bootstrap.nav.Item",
+ "Roo.bootstrap.nav.SidebarItem"
+ ],
"tree_parent" : []
},
- "Roo.bootstrap.nav.Bar" : {
+ "Roo.bootstrap.nav.Headerbar" : {
"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" : "align",
+ "type" : "String",
+ "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",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "autohide",
+ "type" : "Boolean",
+ "desc" : "a top nav bar header that hides on scroll.",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "brand",
+ "type" : "String",
+ "desc" : "what is brand",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "brand_href",
+ "type" : "String",
+ "desc" : "href of the brand",
+ "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" : "",
+ "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",
+ "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 b",
+ "memberOf" : "Roo.bootstrap.nav.Simplebar",
+ "isOptional" : false,
+ "optvals" : [
+ "true",
+ "false"
+ ]
+ },
+ {
+ "name" : "main",
+ "type" : "Boolean",
+ "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" : "",
+ "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) 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" : "",
+ "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 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" : "",
+ "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 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" : [
"type" : "function",
"desc" : "Fire before toggle the menu",
"sig" : "function (e)\n{\n\n}",
- "memberOf" : "",
+ "memberOf" : "Roo.bootstrap.nav.Bar",
"example" : "",
"deprecated" : "",
"since" : "",
"desc" : "Collapse the navbar pulldown",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.bootstrap.nav.Bar",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"desc" : "Expand the navbar pulldown",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.bootstrap.nav.Bar",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"returns" : []
}
],
- "isAbstract" : true,
+ "isAbstract" : false,
"isBuilderTop" : false,
- "implementations" : [
- "Roo.bootstrap.PagingToolbar",
- "Roo.bootstrap.PopoverNav",
- "Roo.bootstrap.form.HtmlEditorToolbarStandard",
- "Roo.bootstrap.nav.Headerbar",
- "Roo.bootstrap.nav.Sidebar",
- "Roo.bootstrap.nav.Simplebar"
+ "implementations" : [],
+ "tree_children" : [
+ "Roo.bootstrap.nav.Group",
+ "Roo.bootstrap.form.Form",
+ "Roo.bootstrap.Row",
+ "Roo.bootstrap.Column",
+ "Roo.bootstrap.TabGroup",
+ "Roo.bootstrap.Link"
],
- "tree_children" : [],
"tree_parent" : []
},
- "Roo.bootstrap.nav.Group" : {
+ "Roo.bootstrap.nav.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"
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
- "name" : "align",
- "type" : "String",
- "desc" : "t)",
- "memberOf" : ""
+ "name" : "active",
+ "type" : "Boolean",
+ "desc" : "Is item active",
+ "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 fal",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : [
+ "true",
+ "false"
+ ]
+ },
+ {
+ "name" : "badge",
+ "type" : "String",
+ "desc" : "text inside badge",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "badgecls",
+ "type" : "String",
+ "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" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "button_weight",
+ "type" : "String",
+ "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" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "fa",
+ "type" : "String",
+ "desc" : "- Fontawsome icon name (can add stuff to it like fa-2x)",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "glyphicon",
+ "type" : "String",
+ "desc" : "DEPRICATED - use fa",
+ "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" : "",
- "memberOf" : ""
+ "name" : "href",
+ "type" : "String",
+ "desc" : "link to",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "html",
+ "type" : "String",
+ "desc" : "content of button",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "icon",
+ "type" : "String",
+ "desc" : "DEPRICATED - use fa",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "linkcls",
+ "type" : "String",
+ "desc" : "Link Class",
+ "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" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "name",
"type" : "string",
"desc" : "Specifies name attribute",
- "memberOf" : "Roo.bootstrap.Component"
- },
- {
- "name" : "navId",
- "type" : "String",
- "desc" : "- reference Id for navbar.",
- "memberOf" : ""
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
- "name" : "pilltype",
+ "name" : "preventDefault",
"type" : "Boolean",
- "desc" : "default true (turn to off to disable active toggle)",
- "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" : "tooltip",
- "type" : "string",
- "desc" : "Text for the tooltip",
- "memberOf" : "Roo.bootstrap.Component"
+ "name" : "tabId",
+ "type" : "String",
+ "desc" : "the tab that this item activates.",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
- "name" : "type",
+ "name" : "tagtype",
"type" : "String",
- "desc" : "b) default nav",
- "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",
+ "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" : "changed",
"type" : "function",
- "desc" : "Fires when the active item changes",
- "sig" : "function (_self, selected, prev)\n{\n\n}",
+ "desc" : "Fires when the active item active state changes",
+ "sig" : "function (_self, state)\n{\n\n}",
"memberOf" : "",
"example" : "",
"deprecated" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.bootstrap.nav.Group",
+ "type" : "Roo.bootstrap.nav.Item",
"desc" : "",
"isOptional" : false
},
{
- "name" : "selected",
- "type" : "Roo.bootstrap.Navbar.Item",
- "desc" : "The item selected",
- "isOptional" : false
- },
- {
- "name" : "prev",
- "type" : "Roo.bootstrap.Navbar.Item",
- "desc" : "The previously selected item",
+ "name" : "state",
+ "type" : "boolean",
+ "desc" : "the new state",
"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" : "destroy",
"type" : "function",
],
"returns" : []
},
+ {
+ "name" : "scrollto",
+ "type" : "function",
+ "desc" : "Fires when scroll to element",
+ "sig" : "function (_self, options, e)\n{\n\n}",
+ "memberOf" : "",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.bootstrap.nav.Item",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "options",
+ "type" : "Object",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "e",
+ "type" : "Roo.EventObject",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
{
"name" : "show",
"type" : "function",
],
"returns" : []
},
- {
- "name" : "addItem",
- "type" : "function",
- "desc" : "adds a Navigation item",
- "sig" : "(the)",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "the",
- "type" : "Roo.bootstrap.nav.Item",
- "desc" : "navitem to add",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
{
"name" : "addListener",
"type" : "function",
],
"returns" : []
},
- {
- "name" : "clearAll",
- "type" : "function",
- "desc" : "clear all the Navigation item",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
{
"name" : "destroy",
"type" : "function",
}
]
},
- {
- "name" : "get",
- "type" : "function",
- "desc" : "fetch a Navigation Group based on the navigation ID",
- "sig" : "(the)",
- "static" : true,
- "memberOf" : "",
- "isStatic" : true,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "the",
- "type" : "string",
- "desc" : "navgroup to add",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "getActive",
- "type" : "function",
- "desc" : "gets the active Navigation item",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : [
- {
- "name" : "",
- "type" : "Roo.bootstrap.nav.Item",
- "desc" : "the current navitem"
- }
- ]
- },
{
"name" : "getChildContainer",
"type" : "function",
"params" : [],
"returns" : []
},
- {
- "name" : "register",
- "type" : "function",
- "desc" : "register a Navigation item",
- "sig" : "(the)",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "the",
- "type" : "Roo.bootstrap.nav.Item",
- "desc" : "navitem to add",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "register",
- "type" : "function",
- "desc" : "register a Navigation Group",
- "sig" : "(the)",
- "static" : true,
- "memberOf" : "",
- "isStatic" : true,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "the",
- "type" : "Roo.bootstrap.nav.Group",
- "desc" : "navgroup to add",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
{
"name" : "releaseCapture",
"type" : "function",
"returns" : []
},
{
- "name" : "setActiveItem",
+ "name" : "setDisabled",
"type" : "function",
- "desc" : "sets the active Navigation item",
- "sig" : "(the)",
+ "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" : "the",
- "type" : "Roo.bootstrap.nav.Item",
- "desc" : "new current navitem",
+ "name" : "disabled",
+ "type" : "Boolean",
+ "desc" : "",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "setDisabled",
+ "name" : "setHtml",
"type" : "function",
- "desc" : "Convenience function for setting disabled/enabled by boolean.",
- "sig" : "(disabled)",
+ "desc" : "Set the HTML (text content) of the item",
+ "sig" : "(html)",
"static" : false,
- "memberOf" : "Roo.Component",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "disabled",
- "type" : "Boolean",
- "desc" : "",
+ "name" : "html",
+ "type" : "string",
+ "desc" : "content for the nav item",
"isOptional" : false
}
],
"desc" : "Fetch the element to display the tooltip on.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.bootstrap.Component",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
],
"isAbstract" : false,
"isBuilderTop" : false,
- "implementations" : [],
- "tree_children" : [
- "Roo.bootstrap.nav.Item",
+ "implementations" : [
"Roo.bootstrap.nav.SidebarItem"
],
- "tree_parent" : []
+ "tree_children" : [
+ "Roo.bootstrap.Button",
+ "Roo.bootstrap.ButtonUploader",
+ "Roo.bootstrap.form.CardUploader"
+ ],
+ "tree_parent" : [
+ "Roo.bootstrap.nav.Group"
+ ]
},
- "Roo.bootstrap.nav.Headerbar" : {
+ "Roo.bootstrap.nav.ProgressBar" : {
"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" : "NavProgressBar:bullets[]",
+ "type" : "Roo.bootstrap.nav.ProgressItem",
+ "desc" : "Bullets for the Nav Progress bar for the toolbar",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
- "name" : "align",
+ "name" : "actionMode",
"type" : "String",
- "desc" : "t) alignment",
- "memberOf" : "Roo.bootstrap.nav.Simplebar"
+ "desc" : "which property holds the 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"
- },
- {
- "name" : "arrangement",
- "type" : "Boolean",
- "desc" : "stacked | justified",
- "memberOf" : "Roo.bootstrap.nav.Simplebar"
- },
- {
- "name" : "autohide",
- "type" : "Boolean",
- "desc" : "a top nav bar header that hides on scroll.",
- "memberOf" : ""
- },
- {
- "name" : "brand",
- "type" : "String",
- "desc" : "what is brand",
- "memberOf" : ""
- },
- {
- "name" : "brand_href",
- "type" : "String",
- "desc" : "href of the brand",
- "memberOf" : ""
+ "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"
- },
- {
- "name" : "desktopCenter",
- "type" : "Boolean",
- "desc" : "should the header be centered on desktop using a container class",
- "memberOf" : ""
+ "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"
- },
- {
- "name" : "inverse",
- "type" : "Boolean",
- "desc" : "is inverted color",
- "memberOf" : "Roo.bootstrap.nav.Simplebar"
+ "desc" : "y)\nHow this component 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"
- },
- {
- "name" : "loadMask",
- "type" : "Boolean",
- "desc" : "e) loadMask on the bar",
- "memberOf" : "Roo.bootstrap.nav.Simplebar"
- },
- {
- "name" : "main",
- "type" : "Boolean",
- "desc" : "e) main nav bar? default false",
- "memberOf" : "Roo.bootstrap.nav.Simplebar"
- },
- {
- "name" : "mobilerow",
- "type" : "Roo.bootstrap.Row",
- "desc" : "- a row to display on mobile only..",
- "memberOf" : ""
+ "memberOf" : "Roo.util.Observable",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "name",
"type" : "string",
"desc" : "Specifies name attribute",
- "memberOf" : "Roo.bootstrap.Component"
- },
- {
- "name" : "position",
- "type" : "String",
- "desc" : "p) position",
- "memberOf" : ""
- },
- {
- "name" : "srButton",
- "type" : "Boolean",
- "desc" : "generate the (screen reader / mobile) sr-only button default true",
- "memberOf" : ""
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "style",
"type" : "String",
"desc" : "any extra css",
- "memberOf" : "Roo.bootstrap.Component"
- },
- {
- "name" : "tag",
- "type" : "String",
- "desc" : "v) default is nav",
- "memberOf" : "Roo.bootstrap.nav.Simplebar"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "tooltip",
"type" : "string",
"desc" : "Text for the tooltip",
- "memberOf" : "Roo.bootstrap.Component"
- },
- {
- "name" : "type",
- "type" : "String",
- "desc" : "s)",
- "memberOf" : "Roo.bootstrap.nav.Simplebar"
+ "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"
- },
- {
- "name" : "weight",
- "type" : "String",
- "desc" : "e) default is light.",
- "memberOf" : "Roo.bootstrap.nav.Simplebar"
+ "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" : [
"returns" : []
},
{
- "name" : "beforetoggle",
+ "name" : "changed",
"type" : "function",
- "desc" : "Fire before toggle the menu",
- "sig" : "function (e)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.nav.Bar",
+ "desc" : "Fires when the active item changes",
+ "sig" : "function (_self, selected, prev)\n{\n\n}",
+ "memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
"params" : [
{
- "name" : "e",
- "type" : "Roo.EventObject",
+ "name" : "this",
+ "type" : "Roo.bootstrap.nav.ProgressBar",
"desc" : "",
"isOptional" : false
+ },
+ {
+ "name" : "selected",
+ "type" : "Roo.bootstrap.nav.ProgressItem",
+ "desc" : "The item selected",
+ "isOptional" : false
+ },
+ {
+ "name" : "prev",
+ "type" : "Roo.bootstrap.nav.ProgressItem",
+ "desc" : "The previously selected item",
+ "isOptional" : false
}
],
"returns" : []
],
"returns" : []
},
- {
- "name" : "collapse",
- "type" : "function",
- "desc" : "Collapse the navbar pulldown",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.nav.Bar",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
{
"name" : "destroy",
"type" : "function",
}
]
},
- {
- "name" : "expand",
- "type" : "function",
- "desc" : "Expand the navbar pulldown",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.nav.Bar",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
{
"name" : "fireEvent",
"type" : "function",
"isBuilderTop" : false,
"implementations" : [],
"tree_children" : [
- "Roo.bootstrap.nav.Group",
- "Roo.bootstrap.form.Form",
- "Roo.bootstrap.Row",
- "Roo.bootstrap.Column",
- "Roo.bootstrap.TabGroup",
- "Roo.bootstrap.Link"
+ "Roo.bootstrap.nav.ProgressBarItem"
],
"tree_parent" : []
},
- "Roo.bootstrap.nav.Item" : {
+ "Roo.bootstrap.nav.ProgressBarItem" : {
"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" : "active",
"type" : "Boolean",
- "desc" : "Is item active",
- "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"
- },
- {
- "name" : "animateRef",
- "type" : "Boolean",
- "desc" : "e) link to element default false",
- "memberOf" : ""
- },
- {
- "name" : "badge",
- "type" : "String",
- "desc" : "text inside badge",
- "memberOf" : ""
- },
- {
- "name" : "badgecls",
- "type" : "String",
- "desc" : "w)the extra classes for the badge",
- "memberOf" : ""
- },
- {
- "name" : "button_outline",
- "type" : "Boolean",
- "desc" : "show and outlined button",
- "memberOf" : ""
- },
- {
- "name" : "button_weight",
- "type" : "String",
- "desc" : "k) default none",
- "memberOf" : ""
+ "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" : "Is item disabled",
- "memberOf" : ""
- },
- {
- "name" : "fa",
- "type" : "String",
- "desc" : "- Fontawsome icon name (can add stuff to it like fa-2x)",
- "memberOf" : ""
- },
- {
- "name" : "glyphicon",
- "type" : "String",
- "desc" : "DEPRICATED - use fa",
- "memberOf" : ""
+ "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"
- },
- {
- "name" : "href",
- "type" : "String",
- "desc" : "link 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" : "html",
"type" : "String",
- "desc" : "content of button",
- "memberOf" : ""
+ "desc" : "",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "icon",
"type" : "String",
- "desc" : "DEPRICATED - use fa",
- "memberOf" : ""
- },
- {
- "name" : "linkcls",
- "type" : "String",
- "desc" : "Link Class",
- "memberOf" : ""
+ "desc" : "show icon instead of number",
+ "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" : "menu",
- "type" : "Roo.bootstrap.menu.Menu",
- "desc" : "a Menu",
- "memberOf" : ""
+ "memberOf" : "Roo.util.Observable",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "name",
"type" : "string",
"desc" : "Specifies name attribute",
- "memberOf" : "Roo.bootstrap.Component"
- },
- {
- "name" : "preventDefault",
- "type" : "Boolean",
- "desc" : "e) default false",
- "memberOf" : ""
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
- "name" : "style",
+ "name" : "position",
"type" : "String",
- "desc" : "any extra css",
- "memberOf" : "Roo.bootstrap.Component"
+ "desc" : "m) text position default bott",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : [
+ "top",
+ "bottom"
+ ]
},
{
- "name" : "tabId",
+ "name" : "rid",
"type" : "String",
- "desc" : "the tab that this item activates.",
- "memberOf" : ""
+ "desc" : "the reference id",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
- "name" : "tagtype",
+ "name" : "style",
"type" : "String",
- "desc" : "n) render as a href or span?",
- "memberOf" : ""
+ "desc" : "any extra css",
+ "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" : [
],
"returns" : []
},
- {
- "name" : "changed",
- "type" : "function",
- "desc" : "Fires when the active item active state changes",
- "sig" : "function (_self, state)\n{\n\n}",
- "memberOf" : "",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.bootstrap.nav.Item",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "state",
- "type" : "boolean",
- "desc" : "the new state",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
{
"name" : "childrenrendered",
"type" : "function",
"name" : "click",
"type" : "function",
"desc" : "The raw click event for the entire grid.",
- "sig" : "function (e)\n{\n\n}",
+ "sig" : "function (_self, e)\n{\n\n}",
"memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
"params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.bootstrap.nav.ProgressBarItem",
+ "desc" : "",
+ "isOptional" : false
+ },
{
"name" : "e",
"type" : "Roo.EventObject",
],
"returns" : []
},
- {
- "name" : "scrollto",
- "type" : "function",
- "desc" : "Fires when scroll to element",
- "sig" : "function (_self, options, e)\n{\n\n}",
- "memberOf" : "",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.bootstrap.nav.Item",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "options",
- "type" : "Object",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "e",
- "type" : "Roo.EventObject",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
{
"name" : "show",
"type" : "function",
],
"returns" : []
},
- {
- "name" : "setHtml",
- "type" : "function",
- "desc" : "Set the HTML (text content) of the item",
- "sig" : "(html)",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "html",
- "type" : "string",
- "desc" : "content for the nav item",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
{
"name" : "setVisibilityEl",
"type" : "function",
"desc" : "Fetch the element to display the tooltip on.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.bootstrap.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
],
"isAbstract" : false,
"isBuilderTop" : false,
- "implementations" : [
- "Roo.bootstrap.nav.SidebarItem"
- ],
- "tree_children" : [
- "Roo.bootstrap.Button",
- "Roo.bootstrap.ButtonUploader",
- "Roo.bootstrap.form.CardUploader"
- ],
- "tree_parent" : [
- "Roo.bootstrap.nav.Group"
- ]
+ "implementations" : [],
+ "tree_children" : [],
+ "tree_parent" : []
},
- "Roo.bootstrap.nav.ProgressBar" : {
+ "Roo.bootstrap.nav.Sidebar" : {
"props" : [
- {
- "name" : "NavProgressBar:bullets[]",
- "type" : "Roo.bootstrap.nav.ProgressItem",
- "desc" : "Bullets for the Nav Progress bar for the toolbar",
- "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" : "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" : [
"returns" : []
},
{
- "name" : "changed",
+ "name" : "beforetoggle",
"type" : "function",
- "desc" : "Fires when the active item changes",
- "sig" : "function (_self, selected, prev)\n{\n\n}",
- "memberOf" : "",
+ "desc" : "Fire before toggle the menu",
+ "sig" : "function (e)\n{\n\n}",
+ "memberOf" : "Roo.bootstrap.nav.Bar",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
"params" : [
{
- "name" : "this",
- "type" : "Roo.bootstrap.nav.ProgressBar",
+ "name" : "e",
+ "type" : "Roo.EventObject",
"desc" : "",
"isOptional" : false
- },
- {
- "name" : "selected",
- "type" : "Roo.bootstrap.nav.ProgressItem",
- "desc" : "The item selected",
- "isOptional" : false
- },
- {
- "name" : "prev",
- "type" : "Roo.bootstrap.nav.ProgressItem",
- "desc" : "The previously selected item",
- "isOptional" : false
}
],
"returns" : []
],
"returns" : []
},
+ {
+ "name" : "collapse",
+ "type" : "function",
+ "desc" : "Collapse the navbar pulldown",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.nav.Bar",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
{
"name" : "destroy",
"type" : "function",
}
]
},
+ {
+ "name" : "expand",
+ "type" : "function",
+ "desc" : "Expand the navbar pulldown",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.nav.Bar",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
{
"name" : "fireEvent",
"type" : "function",
"isBuilderTop" : false,
"implementations" : [],
"tree_children" : [
- "Roo.bootstrap.nav.ProgressBarItem"
+ "Roo.bootstrap.nav.Group",
+ "Roo.bootstrap.form.Form",
+ "Roo.bootstrap.Row",
+ "Roo.bootstrap.Column",
+ "Roo.bootstrap.TabGroup",
+ "Roo.bootstrap.Link"
],
"tree_parent" : []
},
- "Roo.bootstrap.nav.ProgressBarItem" : {
+ "Roo.bootstrap.nav.SidebarItem" : {
"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" : "active",
"type" : "Boolean",
- "desc" : "e) Is item active default false",
- "memberOf" : ""
+ "desc" : "Is item active",
+ "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 fal",
+ "memberOf" : "Roo.bootstrap.nav.Item",
+ "isOptional" : false,
+ "optvals" : [
+ "true",
+ "false"
+ ]
+ },
+ {
+ "name" : "badge",
+ "type" : "String",
+ "desc" : "text inside badge",
+ "memberOf" : "Roo.bootstrap.nav.Item",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "badgecls",
+ "type" : "String",
+ "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",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "button_weight",
+ "type" : "String",
+ "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" : "e) Is item active default false",
- "memberOf" : ""
+ "desc" : "Is item disabled",
+ "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",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "glyphicon",
+ "type" : "String",
+ "desc" : "DEPRICATED - use fa",
+ "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",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "html",
"type" : "String",
- "desc" : "",
- "memberOf" : ""
+ "desc" : "content of button",
+ "memberOf" : "Roo.bootstrap.nav.Item",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "icon",
"type" : "String",
- "desc" : "show icon instead of number",
- "memberOf" : ""
+ "desc" : "DEPRICATED - use fa",
+ "memberOf" : "Roo.bootstrap.nav.Item",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "linkcls",
+ "type" : "String",
+ "desc" : "Link Class",
+ "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",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "name",
"type" : "string",
"desc" : "Specifies name attribute",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
- "name" : "position",
+ "name" : "preventDefault",
+ "type" : "Boolean",
+ "desc" : "e) default fal",
+ "memberOf" : "Roo.bootstrap.nav.Item",
+ "isOptional" : false,
+ "optvals" : [
+ "true",
+ "false"
+ ]
+ },
+ {
+ "name" : "style",
"type" : "String",
- "desc" : "m) text position default bottom",
- "memberOf" : ""
+ "desc" : "any extra css",
+ "memberOf" : "Roo.bootstrap.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
- "name" : "rid",
+ "name" : "tabId",
"type" : "String",
- "desc" : "the reference id",
- "memberOf" : ""
+ "desc" : "the tab that this item activates.",
+ "memberOf" : "Roo.bootstrap.nav.Item",
+ "isOptional" : false,
+ "optvals" : []
},
{
- "name" : "style",
+ "name" : "tagtype",
"type" : "String",
- "desc" : "any extra css",
- "memberOf" : "Roo.bootstrap.Component"
+ "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" : [
],
"returns" : []
},
+ {
+ "name" : "changed",
+ "type" : "function",
+ "desc" : "Fires when the active item active state changes",
+ "sig" : "function (_self, state)\n{\n\n}",
+ "memberOf" : "",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.bootstrap.nav.SidebarItem",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "state",
+ "type" : "boolean",
+ "desc" : "the new state",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
{
"name" : "childrenrendered",
"type" : "function",
"name" : "click",
"type" : "function",
"desc" : "The raw click event for the entire grid.",
- "sig" : "function (_self, e)\n{\n\n}",
+ "sig" : "function (e)\n{\n\n}",
"memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
"params" : [
- {
- "name" : "this",
- "type" : "Roo.bootstrap.nav.ProgressBarItem",
- "desc" : "",
- "isOptional" : false
- },
{
"name" : "e",
"type" : "Roo.EventObject",
],
"returns" : []
},
+ {
+ "name" : "scrollto",
+ "type" : "function",
+ "desc" : "Fires when scroll to element",
+ "sig" : "function (_self, options, e)\n{\n\n}",
+ "memberOf" : "Roo.bootstrap.nav.Item",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.bootstrap.nav.Item",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "options",
+ "type" : "Object",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "e",
+ "type" : "Roo.EventObject",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
{
"name" : "show",
"type" : "function",
],
"returns" : []
},
+ {
+ "name" : "setHtml",
+ "type" : "function",
+ "desc" : "Set the HTML (text content) of the item",
+ "sig" : "(html)",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.nav.Item",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "html",
+ "type" : "string",
+ "desc" : "content for the nav item",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
{
"name" : "setVisibilityEl",
"type" : "function",
"desc" : "Fetch the element to display the tooltip on.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.bootstrap.Component",
+ "memberOf" : "Roo.bootstrap.nav.Item",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"tree_children" : [],
"tree_parent" : []
},
- "Roo.bootstrap.nav.Sidebar" : {
+ "Roo.bootstrap.nav.Simplebar" : {
"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" : "align",
+ "type" : "String",
+ "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" : "",
+ "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" : "",
+ "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 b",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : [
+ "true",
+ "false"
+ ]
+ },
+ {
+ "name" : "main",
+ "type" : "Boolean",
+ "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 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" : "",
+ "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 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,
- "implementations" : [],
+ "implementations" : [
+ "Roo.bootstrap.PagingToolbar",
+ "Roo.bootstrap.PopoverNav",
+ "Roo.bootstrap.form.HtmlEditorToolbar.Standard",
+ "Roo.bootstrap.nav.Headerbar"
+ ],
"tree_children" : [
"Roo.bootstrap.nav.Group",
"Roo.bootstrap.form.Form",
],
"tree_parent" : []
},
- "Roo.bootstrap.nav.SidebarItem" : {
+ "Roo.bootstrap.panel" : {
+ "props" : [],
+ "events" : [],
+ "methods" : [],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "implementations" : [],
+ "tree_children" : [],
+ "tree_parent" : []
+ },
+ "Roo.bootstrap.panel.Content" : {
"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" : "adjustments",
+ "type" : "Array",
+ "desc" : "Values to <b>add</b> to the width/height when doing a {@link #fitToFrame} (default is [0, 0])",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
- "name" : "active",
- "type" : "Boolean",
- "desc" : "Is item active",
- "memberOf" : "Roo.bootstrap.nav.Item"
+ "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" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
- "name" : "allowDomMove",
+ "name" : "autoScroll",
"type" : "Boolean",
- "desc" : "Whether the component can move the Dom node when rendering (defaults to true).",
- "memberOf" : "Roo.Component"
+ "desc" : "True to scroll overflow in this panel (use with {@link #fitToFrame})",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
- "name" : "animateRef",
+ "name" : "background",
"type" : "Boolean",
- "desc" : "e) link to element default false",
- "memberOf" : "Roo.bootstrap.nav.Item"
- },
- {
- "name" : "badge",
- "type" : "String",
- "desc" : "text inside badge",
- "memberOf" : "Roo.bootstrap.nav.Item"
- },
- {
- "name" : "badgecls",
- "type" : "String",
- "desc" : "w)the extra classes for the badge",
- "memberOf" : "Roo.bootstrap.nav.Item"
+ "desc" : "True if the panel should not be activated when it is added (defaults to false)",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
- "name" : "button_outline",
+ "name" : "badges",
"type" : "Boolean",
- "desc" : "show and outlined button",
- "memberOf" : "Roo.bootstrap.nav.Item"
- },
- {
- "name" : "button_weight",
- "type" : "String",
- "desc" : "k) default none",
- "memberOf" : "Roo.bootstrap.nav.Item"
+ "desc" : "render the badges",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
- "name" : "can_build_overlaid",
+ "name" : "closable",
"type" : "Boolean",
- "desc" : "True if element can be rebuild from a HTML page",
- "memberOf" : "Roo.bootstrap.Component"
+ "desc" : "True if the panel can be closed/removed",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "cls",
"type" : "String",
- "desc" : "css class",
- "memberOf" : "Roo.bootstrap.Component"
- },
- {
- "name" : "container_method",
- "type" : "string",
- "desc" : "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)",
- "memberOf" : "Roo.bootstrap.Component"
- },
- {
- "name" : "dataId",
- "type" : "string",
- "desc" : "cutomer id",
- "memberOf" : "Roo.bootstrap.Component"
+ "desc" : "extra classes to use",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
- "name" : "disableClass",
+ "name" : "content",
"type" : "String",
- "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").",
- "memberOf" : "Roo.Component"
+ "desc" : "Raw content to fill content panel with (uses setContent on construction.)",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
- "name" : "disabled",
+ "name" : "fitContainer",
"type" : "Boolean",
- "desc" : "Is item disabled",
- "memberOf" : "Roo.bootstrap.nav.Item"
- },
- {
- "name" : "fa",
- "type" : "String",
- "desc" : "- Fontawsome icon name (can add stuff to it like fa-2x)",
- "memberOf" : "Roo.bootstrap.nav.Item"
- },
- {
- "name" : "glyphicon",
- "type" : "String",
- "desc" : "DEPRICATED - use fa",
- "memberOf" : "Roo.bootstrap.nav.Item"
- },
- {
- "name" : "hideMode",
- "type" : "String",
- "desc" : "y)\nHow this component 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" : "href",
- "type" : "String",
- "desc" : "link to",
- "memberOf" : "Roo.bootstrap.nav.Item"
- },
- {
- "name" : "html",
- "type" : "String",
- "desc" : "content of button",
- "memberOf" : "Roo.bootstrap.nav.Item"
+ "desc" : "When using {@link #fitToFrame} and {@link #resizeEl}, you can also fit the parent container (defaults to false)",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
- "name" : "icon",
- "type" : "String",
- "desc" : "DEPRICATED - use fa",
- "memberOf" : "Roo.bootstrap.nav.Item"
+ "name" : "fitToFrame",
+ "type" : "Boolean",
+ "desc" : "True for this panel to adjust its size to fit when the region resizes (defaults to false)",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
- "name" : "linkcls",
- "type" : "String",
- "desc" : "Link Class",
- "memberOf" : "Roo.bootstrap.nav.Item"
+ "name" : "iframe",
+ "type" : "Boolean",
+ "desc" : "contents are an iframe - makes showing remote sources/CSS feasible..",
+ "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" : "menu",
- "type" : "Roo.bootstrap.menu.Menu",
- "desc" : "a Menu",
- "memberOf" : "Roo.bootstrap.nav.Item"
- },
- {
- "name" : "name",
- "type" : "string",
- "desc" : "Specifies name attribute",
- "memberOf" : "Roo.bootstrap.Component"
+ "memberOf" : "Roo.util.Observable",
+ "isOptional" : false,
+ "optvals" : []
},
{
- "name" : "preventDefault",
+ "name" : "loadOnce",
"type" : "Boolean",
- "desc" : "e) default false",
- "memberOf" : "Roo.bootstrap.nav.Item"
+ "desc" : "When used with {@link #url}, calls {@link #setUrl} with this value",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
- "name" : "style",
- "type" : "String",
- "desc" : "any extra css",
- "memberOf" : "Roo.bootstrap.Component"
+ "name" : "params",
+ "type" : "String/Object",
+ "desc" : "When used with {@link #url}, calls {@link #setUrl} with this value",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
- "name" : "tabId",
+ "name" : "region",
"type" : "String",
- "desc" : "the tab that this item activates.",
- "memberOf" : "Roo.bootstrap.nav.Item"
+ "desc" : "(center|north|south|east|west) which region to put this panel on (when used with xtype constructors)",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
- "name" : "tagtype",
- "type" : "String",
- "desc" : "n) render as a href or span?",
- "memberOf" : "Roo.bootstrap.nav.Item"
+ "name" : "resizeEl",
+ "type" : "String/HTMLElement/Element",
+ "desc" : "An element to resize if {@link #fitToFrame} is true (instead of this panel's element)",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
- "name" : "tooltip",
- "type" : "string",
- "desc" : "Text for the tooltip",
- "memberOf" : "Roo.bootstrap.Component"
+ "name" : "title",
+ "type" : "String",
+ "desc" : "The title for this panel",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
- "name" : "visibilityEl",
- "type" : "string|object",
- "desc" : "t) What element to use for visibility (@see getVisibilityEl())",
- "memberOf" : "Roo.bootstrap.Component"
+ "name" : "toolbar",
+ "type" : "Toolbar",
+ "desc" : "A toolbar for this panel",
+ "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"
+ "name" : "url",
+ "type" : "String",
+ "desc" : "Calls {@link #setUrl} with this value",
+ "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",
- "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",
+ "name" : "activate",
"type" : "function",
- "desc" : "Fires before the component is shown. Return false to stop the show.",
+ "desc" : "Fires when this panel is activated.",
"sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.Component",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "changed",
- "type" : "function",
- "desc" : "Fires when the active item active state changes",
- "sig" : "function (_self, state)\n{\n\n}",
"memberOf" : "",
"example" : "",
"deprecated" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.bootstrap.nav.SidebarItem",
+ "type" : "Roo.ContentPanel",
"desc" : "",
"isOptional" : false
- },
- {
- "name" : "state",
- "type" : "boolean",
- "desc" : "the new state",
- "isOptional" : false
}
],
"returns" : []
},
{
- "name" : "childrenrendered",
+ "name" : "deactivate",
"type" : "function",
- "desc" : "Fires when the children have been rendered..",
+ "desc" : "Fires when this panel is activated.",
"sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.Component",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.bootstrap.Component",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "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" : "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",
+ "type" : "Roo.ContentPanel",
"desc" : "",
"isOptional" : false
}
{
"name" : "render",
"type" : "function",
- "desc" : "Fires after the component is rendered.",
+ "desc" : "Fires when this tab is created",
"sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
+ "memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.Component",
+ "type" : "Roo.ContentPanel",
"desc" : "",
"isOptional" : false
}
"returns" : []
},
{
- "name" : "scrollto",
+ "name" : "resize",
"type" : "function",
- "desc" : "Fires when scroll to element",
- "sig" : "function (_self, options, e)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.nav.Item",
+ "desc" : "Fires when this panel is resized if fitToFrame is true.",
+ "sig" : "function (_self, width, height)\n{\n\n}",
+ "memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.bootstrap.nav.Item",
+ "type" : "Roo.ContentPanel",
"desc" : "",
"isOptional" : false
},
{
- "name" : "options",
- "type" : "Object",
- "desc" : "",
+ "name" : "width",
+ "type" : "Number",
+ "desc" : "The width after any component adjustments",
"isOptional" : false
},
{
- "name" : "e",
- "type" : "Roo.EventObject",
- "desc" : "",
+ "name" : "height",
+ "type" : "Number",
+ "desc" : "The height after any component adjustments",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "show",
- "type" : "function",
- "desc" : "Fires after the component is shown.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
+ "name" : "scroll",
+ "type" : "function",
+ "desc" : "Fires when this content is scrolled",
+ "sig" : "function (_self, scrollEvent)\n{\n\n}",
+ "memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.Component",
+ "type" : "Roo.ContentPanel",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "scrollEvent",
+ "type" : "Event",
"desc" : "",
"isOptional" : false
}
{
"name" : "destroy",
"type" : "function",
- "desc" : "Destroys this component by purging any event listeners, removing 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" : "Destroys this panel",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.Component",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"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" : "getChildContainer",
"type" : "function",
- "desc" : "Try to focus this component.",
- "sig" : "(selectText)",
+ "desc" : "Adds a xtype elements to the panel - currently only supports Forms, View, JsonView.\n<pre><code>\n\nlayout.addxtype({\n xtype : 'Form',\n items: [ .... ]\n }\n);\n\n</code></pre>",
+ "sig" : "(cfg)",
"static" : false,
- "memberOf" : "Roo.Component",
+ "memberOf" : "",
"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" : "cfg",
+ "type" : "Object",
+ "desc" : "Xtype definition of item to add.",
"isOptional" : false
}
],
+ "returns" : []
+ },
+ {
+ "name" : "getEl",
+ "type" : "function",
+ "desc" : "Returns this panel's element - used by regiosn to add.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
"returns" : [
{
"name" : "",
- "type" : "Roo.Component",
- "desc" : "this"
+ "type" : "Roo.Element",
+ "desc" : ""
}
]
},
{
- "name" : "getChildContainer",
+ "name" : "getId",
"type" : "function",
- "desc" : "Fetch the element to add children to",
+ "desc" : "Returns this panel's id",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.bootstrap.Component",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"returns" : [
{
"name" : "",
- "type" : "Roo.Element",
- "desc" : "defaults to this.el"
+ "type" : "String",
+ "desc" : ""
}
]
},
{
- "name" : "getEl",
+ "name" : "getTitle",
"type" : "function",
- "desc" : "Returns the underlying {@link Roo.Element}.",
+ "desc" : "Returns this panel's title",
"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" : "String",
+ "desc" : ""
}
]
},
{
- "name" : "getId",
+ "name" : "getToolbar",
"type" : "function",
- "desc" : "Returns the id of this component.",
+ "desc" : "Returns the toolbar for this Panel if one was configured.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.Component",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"returns" : [
{
"name" : "",
- "type" : "String",
+ "type" : "Roo.Toolbar",
"desc" : ""
}
]
},
{
- "name" : "getVisibilityEl",
+ "name" : "getUpdateManager",
"type" : "function",
- "desc" : "Get the element that will be used to show or hide",
+ "desc" : "Get the {@link Roo.UpdateManager} for this panel. Enables you to perform Ajax updates.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.bootstrap.Component",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"exceptions" : "",
"requires" : "",
"params" : [],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.UpdateManager",
+ "desc" : "The UpdateManager"
+ }
+ ]
},
{
"name" : "hasListener",
]
},
{
- "name" : "hide",
- "type" : "function",
- "desc" : "Hide a component - adds 'hidden' class",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.Component",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
- {
- "name" : "initEvents",
+ "name" : "isClosable",
"type" : "function",
- "desc" : "Initialize Events for the element",
+ "desc" : "Returns true is this panel was configured to be closable",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.bootstrap.Component",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"exceptions" : "",
"requires" : "",
"params" : [],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Boolean",
+ "desc" : ""
+ }
+ ]
},
{
- "name" : "isVisible",
+ "name" : "load",
"type" : "function",
- "desc" : "Returns true if this component is visible.",
- "sig" : "()\n{\n\n}",
+ "desc" : "Loads this content panel immediately with content from XHR. Note: to delay loading until the panel is activated, use {@link #setUrl}.\nDoes not work with IFRAME contents",
+ "sig" : "(url, params, callback, discardUrl)",
"static" : false,
- "memberOf" : "Roo.Component",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
- "returns" : []
+ "params" : [
+ {
+ "name" : "url",
+ "type" : "Object/String/Function",
+ "desc" : "The url for this request or a function to call to get the url or a config object containing any of the following options:\n<pre><code>\npanel.load({\n url: \"your-url.php\",\n params: {param1: \"foo\", param2: \"bar\"}, // or a URL encoded string\n callback: yourFunction,\n scope: yourObject, //(optional scope)\n discardUrl: false,\n nocache: false,\n text: \"Loading...\",\n timeout: 30,\n scripts: false\n});\n</code></pre>\nThe only required property is <i>url</i>. The optional properties <i>nocache</i>, <i>text</i> and <i>scripts</i>\nare shorthand for <i>disableCaching</i>, <i>indicatorText</i> and <i>loadScripts</i> and are used to set their associated property on this panel UpdateManager instance.",
+ "isOptional" : false
+ },
+ {
+ "name" : "params",
+ "type" : "String/Object",
+ "desc" : "(optional) The parameters to pass as either a URL encoded string \"param1=1&param2=2\" or an object {param1: 1, param2: 2}",
+ "isOptional" : false
+ },
+ {
+ "name" : "callback",
+ "type" : "Function",
+ "desc" : "(optional) Callback when transaction is complete -- called with signature (oElement, bSuccess, oResponse)",
+ "isOptional" : false
+ },
+ {
+ "name" : "discardUrl",
+ "type" : "Boolean",
+ "desc" : "(optional) By default when you execute an update the defaultUrl is changed to the last used URL. If true, it will not store the URL.",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.ContentPanel",
+ "desc" : "this"
+ }
+ ]
},
{
"name" : "on",
"params" : [],
"returns" : []
},
+ {
+ "name" : "refresh",
+ "type" : "function",
+ "desc" : "Force a content refresh from the URL specified in the {@link #setUrl} method.\n Will fail silently if the {@link #setUrl} method has not been called.\n This does not activate the panel, just updates its content.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
{
"name" : "releaseCapture",
"type" : "function",
"returns" : []
},
{
- "name" : "render",
+ "name" : "setContent",
"type" : "function",
- "desc" : "If this is a lazy rendering component, render it to its container element.",
- "sig" : "(container)",
+ "desc" : "Updates this panel's element (not for iframe)",
+ "sig" : "(content, loadScripts)",
"static" : false,
- "memberOf" : "Roo.Component",
+ "memberOf" : "",
"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" : "content",
+ "type" : "String",
+ "desc" : "The new content",
"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",
+ "name" : "loadScripts",
"type" : "Boolean",
- "desc" : "",
+ "desc" : "(optional) true to look for and process scripts",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "setHtml",
+ "name" : "setTitle",
"type" : "function",
- "desc" : "Set the HTML (text content) of the item",
- "sig" : "(html)",
+ "desc" : "Set this panel's title",
+ "sig" : "(title)",
"static" : false,
- "memberOf" : "Roo.bootstrap.nav.Item",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "html",
- "type" : "string",
- "desc" : "content for the nav item",
+ "name" : "title",
+ "type" : "String",
+ "desc" : "",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "setVisibilityEl",
- "type" : "function",
- "desc" : "Set the element that will be used to show or hide",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.Component",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
- {
- "name" : "setVisible",
+ "name" : "setUrl",
"type" : "function",
- "desc" : "Convenience function to hide or show this component by boolean.",
- "sig" : "(visible)",
+ "desc" : "Set a URL to be used to load the content for this panel. When this panel is activated, the content will be loaded from that URL.",
+ "sig" : "(url, params, loadOnce)",
"static" : false,
- "memberOf" : "Roo.Component",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "visible",
+ "name" : "url",
+ "type" : "String/Function",
+ "desc" : "The URL to load the content from or a function to call to get the URL",
+ "isOptional" : false
+ },
+ {
+ "name" : "params",
+ "type" : "String/Object",
+ "desc" : "(optional) The string params for the update call or an object of the params. See {@link Roo.UpdateManager#update} for more details. (Defaults to null)",
+ "isOptional" : false
+ },
+ {
+ "name" : "loadOnce",
"type" : "Boolean",
- "desc" : "True to show, false to hide",
+ "desc" : "(optional) Whether to only load the content once. If this is false it makes the Ajax call every time this panel is activated. (Defaults to false)",
"isOptional" : false
}
],
"returns" : [
{
"name" : "",
- "type" : "Roo.Component",
- "desc" : "this"
- }
- ]
- },
- {
- "name" : "show",
- "type" : "function",
- "desc" : "Show a component - removes 'hidden' class",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.Component",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
- {
- "name" : "tooltipEl",
- "type" : "function",
- "desc" : "Fetch the element to display the tooltip on.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.nav.Item",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : [
- {
- "name" : "",
- "type" : "Roo.Element",
- "desc" : "defaults to this.el"
+ "type" : "Roo.UpdateManager|Boolean",
+ "desc" : "The UpdateManager or false if IFRAME"
}
]
},
],
"isAbstract" : false,
"isBuilderTop" : false,
- "implementations" : [],
- "tree_children" : [],
- "tree_parent" : []
+ "implementations" : [
+ "Roo.bootstrap.panel.Grid",
+ "Roo.bootstrap.panel.Nest"
+ ],
+ "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.Password",
+ "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",
+ "Roo.bootstrap.nav.ProgressBarItem",
+ "Roo.bootstrap.nav.Sidebar",
+ "Roo.bootstrap.nav.SidebarItem",
+ "Roo.bootstrap.nav.Simplebar"
+ ],
+ "tree_parent" : [
+ "builder",
+ "Roo.bootstrap.layout.Border"
+ ]
},
- "Roo.bootstrap.nav.Simplebar" : {
+ "Roo.bootstrap.panel.Grid" : {
"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" : "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",
+ "isOptional" : false,
+ "optvals" : []
},
{
- "name" : "align",
- "type" : "String",
- "desc" : "t) alignment",
- "memberOf" : ""
+ "name" : "autoCreate",
+ "type" : "Boolean/Object",
+ "desc" : "True to auto generate the DOM element for this panel, or a {@link Roo.DomHelper} config of the element to create",
+ "memberOf" : "Roo.bootstrap.panel.Content",
+ "isOptional" : false,
+ "optvals" : []
},
{
- "name" : "allowDomMove",
+ "name" : "autoScroll",
"type" : "Boolean",
- "desc" : "Whether the component can move the Dom node when rendering (defaults to true).",
- "memberOf" : "Roo.Component"
+ "desc" : "True to scroll overflow in this panel (use with {@link #fitToFrame})",
+ "memberOf" : "Roo.bootstrap.panel.Content",
+ "isOptional" : false,
+ "optvals" : []
},
{
- "name" : "arrangement",
+ "name" : "background",
"type" : "Boolean",
- "desc" : "stacked | justified",
- "memberOf" : ""
+ "desc" : "True if the panel should not be activated when it is added (defaults to false)",
+ "memberOf" : "Roo.bootstrap.panel.Content",
+ "isOptional" : false,
+ "optvals" : []
},
{
- "name" : "can_build_overlaid",
+ "name" : "badges",
"type" : "Boolean",
- "desc" : "True if element can be rebuild from a HTML page",
- "memberOf" : "Roo.bootstrap.Component"
+ "desc" : "render the badges",
+ "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",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "cls",
"type" : "String",
- "desc" : "css class",
- "memberOf" : "Roo.bootstrap.Component"
+ "desc" : "extra classes to use",
+ "memberOf" : "Roo.bootstrap.panel.Content",
+ "isOptional" : false,
+ "optvals" : []
},
{
- "name" : "container_method",
- "type" : "string",
- "desc" : "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)",
- "memberOf" : "Roo.bootstrap.Component"
+ "name" : "content",
+ "type" : "String",
+ "desc" : "Raw content to fill content panel with (uses setContent on construction.)",
+ "memberOf" : "Roo.bootstrap.panel.Content",
+ "isOptional" : false,
+ "optvals" : []
},
{
- "name" : "dataId",
- "type" : "string",
- "desc" : "cutomer id",
- "memberOf" : "Roo.bootstrap.Component"
+ "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",
+ "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" : "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",
+ "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" : "grid",
+ "type" : "Roo.bootstrap.Table",
+ "desc" : "The grid for this panel",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
- "name" : "inverse",
+ "name" : "iframe",
"type" : "Boolean",
- "desc" : "is inverted color",
- "memberOf" : ""
+ "desc" : "contents are an iframe - makes showing remote sources/CSS feasible..",
+ "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"
- },
- {
- "name" : "loadMask",
- "type" : "Boolean",
- "desc" : "e) loadMask on the bar",
- "memberOf" : ""
+ "memberOf" : "Roo.util.Observable",
+ "isOptional" : false,
+ "optvals" : []
},
{
- "name" : "main",
+ "name" : "loadOnce",
"type" : "Boolean",
- "desc" : "e) main nav bar? default false",
- "memberOf" : ""
- },
- {
- "name" : "name",
- "type" : "string",
- "desc" : "Specifies name attribute",
- "memberOf" : "Roo.bootstrap.Component"
+ "desc" : "When used with {@link #url}, calls {@link #setUrl} with this value",
+ "memberOf" : "Roo.bootstrap.panel.Content",
+ "isOptional" : false,
+ "optvals" : []
},
{
- "name" : "style",
- "type" : "String",
- "desc" : "any extra css",
- "memberOf" : "Roo.bootstrap.Component"
+ "name" : "params",
+ "type" : "String/Object",
+ "desc" : "When used with {@link #url}, calls {@link #setUrl} with this value",
+ "memberOf" : "Roo.bootstrap.panel.Content",
+ "isOptional" : false,
+ "optvals" : []
},
{
- "name" : "tag",
+ "name" : "region",
"type" : "String",
- "desc" : "v) default is nav",
- "memberOf" : ""
+ "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" : "tooltip",
- "type" : "string",
- "desc" : "Text for the tooltip",
- "memberOf" : "Roo.bootstrap.Component"
+ "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",
+ "isOptional" : false,
+ "optvals" : []
},
{
- "name" : "type",
+ "name" : "title",
"type" : "String",
- "desc" : "s)",
- "memberOf" : ""
+ "desc" : "The title for this panel",
+ "memberOf" : "Roo.bootstrap.panel.Content",
+ "isOptional" : false,
+ "optvals" : []
},
{
- "name" : "visibilityEl",
- "type" : "string|object",
- "desc" : "t) What element to use for visibility (@see getVisibilityEl())",
- "memberOf" : "Roo.bootstrap.Component"
+ "name" : "toolbar",
+ "type" : "Roo.bootstrap.nav.Simplebar",
+ "desc" : "the toolbar at the top of the grid.",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
- "name" : "weight",
+ "name" : "url",
"type" : "String",
- "desc" : "e) default is light.",
- "memberOf" : ""
- },
- {
- "name" : "xattr",
- "type" : "Object",
- "desc" : "extra attributes to add to 'element' (used by builder to store stuff.)",
- "memberOf" : "Roo.bootstrap.Component"
+ "desc" : "Calls {@link #setUrl} with this value",
+ "memberOf" : "Roo.bootstrap.panel.Content",
+ "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",
+ "name" : "activate",
"type" : "function",
- "desc" : "Fires before the component is shown. Return false to stop the show.",
+ "desc" : "Fires when this panel is activated.",
"sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
+ "memberOf" : "Roo.bootstrap.panel.Content",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.Component",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "beforetoggle",
- "type" : "function",
- "desc" : "Fire before toggle the menu",
- "sig" : "function (e)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.nav.Bar",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "e",
- "type" : "Roo.EventObject",
+ "type" : "Roo.ContentPanel",
"desc" : "",
"isOptional" : false
}
"returns" : []
},
{
- "name" : "childrenrendered",
+ "name" : "deactivate",
"type" : "function",
- "desc" : "Fires when the children have been rendered..",
+ "desc" : "Fires when this panel is activated.",
"sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.Component",
+ "memberOf" : "Roo.bootstrap.panel.Content",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.bootstrap.Component",
+ "type" : "Roo.ContentPanel",
"desc" : "",
"isOptional" : false
}
"returns" : []
},
{
- "name" : "destroy",
+ "name" : "render",
"type" : "function",
- "desc" : "Fires after the component is destroyed.",
+ "desc" : "Fires when this tab is created",
"sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
+ "memberOf" : "Roo.bootstrap.panel.Content",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.Component",
+ "type" : "Roo.ContentPanel",
"desc" : "",
"isOptional" : false
}
"returns" : []
},
{
- "name" : "disable",
+ "name" : "resize",
"type" : "function",
- "desc" : "Fires after the component is disabled.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
+ "desc" : "Fires when this panel is resized if fitToFrame is true.",
+ "sig" : "function (_self, width, height)\n{\n\n}",
+ "memberOf" : "Roo.bootstrap.panel.Content",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.Component",
+ "type" : "Roo.ContentPanel",
"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" : "",
+ "name" : "width",
+ "type" : "Number",
+ "desc" : "The width after any component adjustments",
"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" : "",
+ "name" : "height",
+ "type" : "Number",
+ "desc" : "The height after any component adjustments",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "render",
+ "name" : "scroll",
"type" : "function",
- "desc" : "Fires after the component is rendered.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.Component",
+ "desc" : "Fires when this content is scrolled",
+ "sig" : "function (_self, scrollEvent)\n{\n\n}",
+ "memberOf" : "Roo.bootstrap.panel.Content",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.Component",
+ "type" : "Roo.ContentPanel",
"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",
+ "name" : "scrollEvent",
+ "type" : "Event",
"desc" : "",
"isOptional" : false
}
],
"returns" : []
},
- {
- "name" : "collapse",
- "type" : "function",
- "desc" : "Collapse the navbar pulldown",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.nav.Bar",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
{
"name" : "destroy",
"type" : "function",
- "desc" : "Destroys this component by purging any event listeners, removing 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" : "Destroys this panel",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.Component",
+ "memberOf" : "Roo.bootstrap.panel.Content",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"returns" : []
},
{
- "name" : "disable",
+ "name" : "fireEvent",
"type" : "function",
- "desc" : "Disable this component.",
- "sig" : "()\n{\n\n}",
+ "desc" : "Fires the specified event with the passed parameters (minus the event name).",
+ "sig" : "(eventName, args)",
"static" : false,
- "memberOf" : "Roo.Component",
+ "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" : "Roo.Component",
- "desc" : "this"
+ "type" : "Boolean",
+ "desc" : "returns false if any of the handlers return false otherwise it returns true"
}
]
},
{
- "name" : "enable",
+ "name" : "getChildContainer",
"type" : "function",
- "desc" : "Enable this component.",
- "sig" : "()\n{\n\n}",
+ "desc" : "Adds a xtype elements to the panel - currently only supports Forms, View, JsonView.\n<pre><code>\n\nlayout.addxtype({\n xtype : 'Form',\n items: [ .... ]\n }\n);\n\n</code></pre>",
+ "sig" : "(cfg)",
"static" : false,
- "memberOf" : "Roo.Component",
+ "memberOf" : "Roo.bootstrap.panel.Content",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
- "returns" : [
+ "params" : [
{
- "name" : "",
- "type" : "Roo.Component",
- "desc" : "this"
+ "name" : "cfg",
+ "type" : "Object",
+ "desc" : "Xtype definition of item to add.",
+ "isOptional" : false
}
- ]
+ ],
+ "returns" : []
},
{
- "name" : "expand",
+ "name" : "getEl",
"type" : "function",
- "desc" : "Expand the navbar pulldown",
+ "desc" : "Returns this panel's element - used by regiosn to add.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.bootstrap.nav.Bar",
+ "memberOf" : "Roo.bootstrap.panel.Content",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"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"
+ "type" : "Roo.Element",
+ "desc" : ""
}
]
},
{
- "name" : "focus",
+ "name" : "getGrid",
"type" : "function",
- "desc" : "Try to focus this component.",
- "sig" : "(selectText)",
+ "desc" : "Returns the grid for this panel",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.Component",
+ "memberOf" : "",
"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" : "Roo.bootstrap.Table",
+ "desc" : ""
}
]
},
{
- "name" : "getChildContainer",
+ "name" : "getId",
"type" : "function",
- "desc" : "Fetch the element to add children to",
+ "desc" : "Returns this panel's id",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.bootstrap.Component",
+ "memberOf" : "Roo.bootstrap.panel.Content",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"returns" : [
{
"name" : "",
- "type" : "Roo.Element",
- "desc" : "defaults to this.el"
+ "type" : "String",
+ "desc" : ""
}
]
},
{
- "name" : "getEl",
+ "name" : "getTitle",
"type" : "function",
- "desc" : "Returns the underlying {@link Roo.Element}.",
+ "desc" : "Returns this panel's title",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.Component",
+ "memberOf" : "Roo.bootstrap.panel.Content",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"returns" : [
{
"name" : "",
- "type" : "Roo.Element",
- "desc" : "The element"
+ "type" : "String",
+ "desc" : ""
}
]
},
{
- "name" : "getId",
+ "name" : "getToolbar",
"type" : "function",
- "desc" : "Returns the id of this component.",
+ "desc" : "Returns the toolbar for this Panel if one was configured.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.Component",
+ "memberOf" : "Roo.bootstrap.panel.Content",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"returns" : [
{
"name" : "",
- "type" : "String",
+ "type" : "Roo.Toolbar",
"desc" : ""
}
]
},
{
- "name" : "getVisibilityEl",
+ "name" : "getUpdateManager",
"type" : "function",
- "desc" : "Get the element that will be used to show or hide",
+ "desc" : "Get the {@link Roo.UpdateManager} for this panel. Enables you to perform Ajax updates.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.bootstrap.Component",
+ "memberOf" : "Roo.bootstrap.panel.Content",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"exceptions" : "",
"requires" : "",
"params" : [],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.UpdateManager",
+ "desc" : "The UpdateManager"
+ }
+ ]
},
{
"name" : "hasListener",
]
},
{
- "name" : "hide",
- "type" : "function",
- "desc" : "Hide a component - adds 'hidden' class",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.Component",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
- {
- "name" : "initEvents",
+ "name" : "isClosable",
"type" : "function",
- "desc" : "Initialize Events for the element",
+ "desc" : "Returns true is this panel was configured to be closable",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.bootstrap.Component",
+ "memberOf" : "Roo.bootstrap.panel.Content",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"exceptions" : "",
"requires" : "",
"params" : [],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Boolean",
+ "desc" : ""
+ }
+ ]
},
{
- "name" : "isVisible",
+ "name" : "load",
"type" : "function",
- "desc" : "Returns true if this component is visible.",
- "sig" : "()\n{\n\n}",
+ "desc" : "Loads this content panel immediately with content from XHR. Note: to delay loading until the panel is activated, use {@link #setUrl}.\nDoes not work with IFRAME contents",
+ "sig" : "(url, params, callback, discardUrl)",
"static" : false,
- "memberOf" : "Roo.Component",
+ "memberOf" : "Roo.bootstrap.panel.Content",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
- "returns" : []
+ "params" : [
+ {
+ "name" : "url",
+ "type" : "Object/String/Function",
+ "desc" : "The url for this request or a function to call to get the url or a config object containing any of the following options:\n<pre><code>\npanel.load({\n url: \"your-url.php\",\n params: {param1: \"foo\", param2: \"bar\"}, // or a URL encoded string\n callback: yourFunction,\n scope: yourObject, //(optional scope)\n discardUrl: false,\n nocache: false,\n text: \"Loading...\",\n timeout: 30,\n scripts: false\n});\n</code></pre>\nThe only required property is <i>url</i>. The optional properties <i>nocache</i>, <i>text</i> and <i>scripts</i>\nare shorthand for <i>disableCaching</i>, <i>indicatorText</i> and <i>loadScripts</i> and are used to set their associated property on this panel UpdateManager instance.",
+ "isOptional" : false
+ },
+ {
+ "name" : "params",
+ "type" : "String/Object",
+ "desc" : "(optional) The parameters to pass as either a URL encoded string \"param1=1&param2=2\" or an object {param1: 1, param2: 2}",
+ "isOptional" : false
+ },
+ {
+ "name" : "callback",
+ "type" : "Function",
+ "desc" : "(optional) Callback when transaction is complete -- called with signature (oElement, bSuccess, oResponse)",
+ "isOptional" : false
+ },
+ {
+ "name" : "discardUrl",
+ "type" : "Boolean",
+ "desc" : "(optional) By default when you execute an update the defaultUrl is changed to the last used URL. If true, it will not store the URL.",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.ContentPanel",
+ "desc" : "this"
+ }
+ ]
},
{
"name" : "on",
"params" : [],
"returns" : []
},
+ {
+ "name" : "refresh",
+ "type" : "function",
+ "desc" : "Force a content refresh from the URL specified in the {@link #setUrl} method.\n Will fail silently if the {@link #setUrl} method has not been called.\n This does not activate the panel, just updates its content.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.bootstrap.panel.Content",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
{
"name" : "releaseCapture",
"type" : "function",
"returns" : []
},
{
- "name" : "render",
+ "name" : "setContent",
"type" : "function",
- "desc" : "If this is a lazy rendering component, render it to its container element.",
- "sig" : "(container)",
+ "desc" : "Updates this panel's element (not for iframe)",
+ "sig" : "(content, loadScripts)",
"static" : false,
- "memberOf" : "Roo.Component",
+ "memberOf" : "Roo.bootstrap.panel.Content",
"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" : "content",
+ "type" : "String",
+ "desc" : "The new content",
+ "isOptional" : false
+ },
+ {
+ "name" : "loadScripts",
+ "type" : "Boolean",
+ "desc" : "(optional) true to look for and process scripts",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "setDisabled",
+ "name" : "setTitle",
"type" : "function",
- "desc" : "Convenience function for setting disabled/enabled by boolean.",
- "sig" : "(disabled)",
+ "desc" : "Set this panel's title",
+ "sig" : "(title)",
"static" : false,
- "memberOf" : "Roo.Component",
+ "memberOf" : "Roo.bootstrap.panel.Content",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "disabled",
- "type" : "Boolean",
+ "name" : "title",
+ "type" : "String",
"desc" : "",
"isOptional" : false
}
"returns" : []
},
{
- "name" : "setVisibilityEl",
- "type" : "function",
- "desc" : "Set the element that will be used to show or hide",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.Component",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
- {
- "name" : "setVisible",
+ "name" : "setUrl",
"type" : "function",
- "desc" : "Convenience function to hide or show this component by boolean.",
- "sig" : "(visible)",
+ "desc" : "Set a URL to be used to load the content for this panel. When this panel is activated, the content will be loaded from that URL.",
+ "sig" : "(url, params, loadOnce)",
"static" : false,
- "memberOf" : "Roo.Component",
+ "memberOf" : "Roo.bootstrap.panel.Content",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "visible",
+ "name" : "url",
+ "type" : "String/Function",
+ "desc" : "The URL to load the content from or a function to call to get the URL",
+ "isOptional" : false
+ },
+ {
+ "name" : "params",
+ "type" : "String/Object",
+ "desc" : "(optional) The string params for the update call or an object of the params. See {@link Roo.UpdateManager#update} for more details. (Defaults to null)",
+ "isOptional" : false
+ },
+ {
+ "name" : "loadOnce",
"type" : "Boolean",
- "desc" : "True to show, false to hide",
+ "desc" : "(optional) Whether to only load the content once. If this is false it makes the Ajax call every time this panel is activated. (Defaults to false)",
"isOptional" : false
}
],
"returns" : [
{
"name" : "",
- "type" : "Roo.Component",
- "desc" : "this"
- }
- ]
- },
- {
- "name" : "show",
- "type" : "function",
- "desc" : "Show a component - removes 'hidden' class",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.Component",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
- {
- "name" : "tooltipEl",
- "type" : "function",
- "desc" : "Fetch the element to display the tooltip on.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.Component",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : [
- {
- "name" : "",
- "type" : "Roo.Element",
- "desc" : "defaults to this.el"
+ "type" : "Roo.UpdateManager|Boolean",
+ "desc" : "The UpdateManager or false if IFRAME"
}
]
},
],
"isAbstract" : false,
"isBuilderTop" : false,
- "implementations" : [
- "Roo.bootstrap.PagingToolbar",
- "Roo.bootstrap.PopoverNav",
- "Roo.bootstrap.form.HtmlEditorToolbarStandard",
- "Roo.bootstrap.nav.Headerbar"
- ],
- "tree_children" : [
- "Roo.bootstrap.nav.Group",
- "Roo.bootstrap.form.Form",
- "Roo.bootstrap.Row",
- "Roo.bootstrap.Column",
- "Roo.bootstrap.TabGroup",
- "Roo.bootstrap.Link"
- ],
- "tree_parent" : []
- },
- "Roo.bootstrap.panel" : {
- "props" : [],
- "events" : [],
- "methods" : [],
- "isAbstract" : false,
- "isBuilderTop" : false,
"implementations" : [],
"tree_children" : [],
"tree_parent" : []
},
- "Roo.bootstrap.panel.Content" : {
+ "Roo.bootstrap.panel.Nest" : {
"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" : ""
+ "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" : ""
+ "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" : ""
+ "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" : ""
+ "memberOf" : "Roo.bootstrap.panel.Content",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "badges",
"type" : "Boolean",
"desc" : "render the badges",
- "memberOf" : ""
+ "memberOf" : "Roo.bootstrap.panel.Content",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "closable",
"type" : "Boolean",
"desc" : "True if the panel can be closed/removed",
- "memberOf" : ""
+ "memberOf" : "Roo.bootstrap.panel.Content",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "cls",
"type" : "String",
"desc" : "extra classes to use",
- "memberOf" : ""
+ "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" : ""
+ "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" : ""
+ "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" : ""
+ "memberOf" : "Roo.bootstrap.panel.Content",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "iframe",
"type" : "Boolean",
"desc" : "contents are an iframe - makes showing remote sources/CSS feasible..",
- "memberOf" : ""
+ "memberOf" : "Roo.bootstrap.panel.Content",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "layout",
+ "type" : "Roo.BorderLayout",
+ "desc" : "The layout for this panel",
+ "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" : "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" : ""
+ "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" : ""
+ "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" : ""
+ "memberOf" : "Roo.bootstrap.panel.Content",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "title",
"type" : "String",
"desc" : "The title for this panel",
- "memberOf" : ""
+ "memberOf" : "Roo.bootstrap.panel.Content",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "toolbar",
"type" : "Toolbar",
"desc" : "A toolbar for this panel",
- "memberOf" : ""
+ "memberOf" : "Roo.bootstrap.panel.Content",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "url",
"type" : "String",
"desc" : "Calls {@link #setUrl} with this value",
- "memberOf" : ""
+ "memberOf" : "Roo.bootstrap.panel.Content",
+ "isOptional" : false,
+ "optvals" : []
}
],
"events" : [
"type" : "function",
"desc" : "Fires when this panel is activated.",
"sig" : "function (_self)\n{\n\n}",
- "memberOf" : "",
+ "memberOf" : "Roo.bootstrap.panel.Content",
"example" : "",
"deprecated" : "",
"since" : "",
"type" : "function",
"desc" : "Fires when this panel is activated.",
"sig" : "function (_self)\n{\n\n}",
- "memberOf" : "",
+ "memberOf" : "Roo.bootstrap.panel.Content",
"example" : "",
"deprecated" : "",
"since" : "",
"type" : "function",
"desc" : "Fires when this tab is created",
"sig" : "function (_self)\n{\n\n}",
- "memberOf" : "",
+ "memberOf" : "Roo.bootstrap.panel.Content",
"example" : "",
"deprecated" : "",
"since" : "",
"type" : "function",
"desc" : "Fires when this panel is resized if fitToFrame is true.",
"sig" : "function (_self, width, height)\n{\n\n}",
- "memberOf" : "",
+ "memberOf" : "Roo.bootstrap.panel.Content",
"example" : "",
"deprecated" : "",
"since" : "",
"type" : "function",
"desc" : "Fires when this content is scrolled",
"sig" : "function (_self, scrollEvent)\n{\n\n}",
- "memberOf" : "",
+ "memberOf" : "Roo.bootstrap.panel.Content",
"example" : "",
"deprecated" : "",
"since" : "",
],
"returns" : []
},
+ {
+ "name" : "addxtype",
+ "type" : "function",
+ "desc" : "Adds a xtype elements to the layout of the nested panel\n<pre><code>\n\npanel.addxtype({\n xtype : 'ContentPanel',\n region: 'west',\n items: [ .... ]\n }\n);\n\npanel.addxtype({\n xtype : 'NestedLayoutPanel',\n region: 'west',\n layout: {\n center: { },\n west: { } \n },\n items : [ ... list of content panels or nested layout panels.. ]\n }\n);\n</code></pre>",
+ "sig" : "(cfg)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "cfg",
+ "type" : "Object",
+ "desc" : "Xtype definition of item to add.",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
{
"name" : "capture",
"type" : "function",
"desc" : "Destroys this panel",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.bootstrap.panel.Content",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"desc" : "Adds a xtype elements to the panel - currently only supports Forms, View, JsonView.\n<pre><code>\n\nlayout.addxtype({\n xtype : 'Form',\n items: [ .... ]\n }\n);\n\n</code></pre>",
"sig" : "(cfg)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.bootstrap.panel.Content",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"desc" : "Returns this panel's element - used by regiosn to add.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.bootstrap.panel.Content",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"desc" : "Returns this panel's id",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.bootstrap.panel.Content",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
}
]
},
+ {
+ "name" : "getLayout",
+ "type" : "function",
+ "desc" : "Returns the nested BorderLayout for this panel",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.BorderLayout",
+ "desc" : ""
+ }
+ ]
+ },
{
"name" : "getTitle",
"type" : "function",
"desc" : "Returns this panel's title",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.bootstrap.panel.Content",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"desc" : "Returns the toolbar for this Panel if one was configured.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.bootstrap.panel.Content",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"desc" : "Get the {@link Roo.UpdateManager} for this panel. Enables you to perform Ajax updates.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.bootstrap.panel.Content",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"desc" : "Returns true is this panel was configured to be closable",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.bootstrap.panel.Content",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"desc" : "Loads this content panel immediately with content from XHR. Note: to delay loading until the panel is activated, use {@link #setUrl}.\nDoes not work with IFRAME contents",
"sig" : "(url, params, callback, discardUrl)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.bootstrap.panel.Content",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"desc" : "Force a content refresh from the URL specified in the {@link #setUrl} method.\n Will fail silently if the {@link #setUrl} method has not been called.\n This does not activate the panel, just updates its content.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.bootstrap.panel.Content",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"desc" : "Updates this panel's element (not for iframe)",
"sig" : "(content, loadScripts)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.bootstrap.panel.Content",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"desc" : "Set this panel's title",
"sig" : "(title)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.bootstrap.panel.Content",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"desc" : "Set a URL to be used to load the content for this panel. When this panel is activated, the content will be loaded from that URL.",
"sig" : "(url, params, loadOnce)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.bootstrap.panel.Content",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
],
"isAbstract" : false,
"isBuilderTop" : false,
- "implementations" : [
- "Roo.bootstrap.panel.Grid",
- "Roo.bootstrap.panel.Nest"
- ],
- "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",
- "Roo.bootstrap.nav.ProgressBarItem",
- "Roo.bootstrap.nav.Sidebar",
- "Roo.bootstrap.nav.SidebarItem",
- "Roo.bootstrap.nav.Simplebar"
- ],
- "tree_parent" : [
- "builder",
- "Roo.bootstrap.layout.Border"
- ]
+ "implementations" : [],
+ "tree_children" : [],
+ "tree_parent" : []
},
- "Roo.bootstrap.panel.Grid" : {
+ "Roo.bootstrap.panel.TabItem" : {
"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"
- },
- {
- "name" : "autoCreate",
- "type" : "Boolean/Object",
- "desc" : "True to auto generate the DOM element for this panel, or a {@link Roo.DomHelper} config of the element to create",
- "memberOf" : "Roo.bootstrap.panel.Content"
- },
- {
- "name" : "autoScroll",
- "type" : "Boolean",
- "desc" : "True to scroll overflow in this panel (use with {@link #fitToFrame})",
- "memberOf" : "Roo.bootstrap.panel.Content"
- },
- {
- "name" : "background",
- "type" : "Boolean",
- "desc" : "True if the panel should not be activated when it is added (defaults to false)",
- "memberOf" : "Roo.bootstrap.panel.Content"
- },
- {
- "name" : "badges",
- "type" : "Boolean",
- "desc" : "render the badges",
- "memberOf" : "Roo.bootstrap.panel.Content"
- },
- {
- "name" : "closable",
- "type" : "Boolean",
- "desc" : "True if the panel can be closed/removed",
- "memberOf" : "Roo.bootstrap.panel.Content"
- },
- {
- "name" : "cls",
- "type" : "String",
- "desc" : "extra classes to use",
- "memberOf" : "Roo.bootstrap.panel.Content"
- },
- {
- "name" : "content",
- "type" : "String",
- "desc" : "Raw content to fill content panel with (uses setContent on construction.)",
- "memberOf" : "Roo.bootstrap.panel.Content"
- },
- {
- "name" : "fitContainer",
- "type" : "Boolean",
- "desc" : "When using {@link #fitToFrame} and {@link #resizeEl}, you can also fit the parent container (defaults to false)",
- "memberOf" : "Roo.bootstrap.panel.Content"
- },
- {
- "name" : "fitToFrame",
- "type" : "Boolean",
- "desc" : "True for this panel to adjust its size to fit when the region resizes (defaults to false)",
- "memberOf" : "Roo.bootstrap.panel.Content"
- },
- {
- "name" : "grid",
- "type" : "Roo.bootstrap.Table",
- "desc" : "The grid for this panel",
- "memberOf" : ""
- },
- {
- "name" : "iframe",
- "type" : "Boolean",
- "desc" : "contents are an iframe - makes showing remote sources/CSS feasible..",
- "memberOf" : "Roo.bootstrap.panel.Content"
- },
{
"name" : "listeners",
"type" : "Object",
"desc" : "list of events and functions to call for 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" : "loadOnce",
- "type" : "Boolean",
- "desc" : "When used with {@link #url}, calls {@link #setUrl} with this value",
- "memberOf" : "Roo.bootstrap.panel.Content"
- },
- {
- "name" : "params",
- "type" : "String/Object",
- "desc" : "When used with {@link #url}, calls {@link #setUrl} with this value",
- "memberOf" : "Roo.bootstrap.panel.Content"
- },
- {
- "name" : "region",
- "type" : "String",
- "desc" : "[required] (center|north|south|east|west) which region to put this panel on (when used with xtype constructors)",
- "memberOf" : "Roo.bootstrap.panel.Content"
- },
- {
- "name" : "resizeEl",
- "type" : "String/HTMLElement/Element",
- "desc" : "An element to resize if {@link #fitToFrame} is true (instead of this panel's element)",
- "memberOf" : "Roo.bootstrap.panel.Content"
- },
- {
- "name" : "title",
- "type" : "String",
- "desc" : "The title for this panel",
- "memberOf" : "Roo.bootstrap.panel.Content"
- },
- {
- "name" : "toolbar",
- "type" : "Roo.bootstrap.nav.Simplebar",
- "desc" : "the toolbar at the top of the grid.",
- "memberOf" : ""
- },
- {
- "name" : "url",
- "type" : "String",
- "desc" : "Calls {@link #setUrl} with this value",
- "memberOf" : "Roo.bootstrap.panel.Content"
+ "memberOf" : "Roo.util.Observable",
+ "isOptional" : false,
+ "optvals" : []
}
],
"events" : [
{
"name" : "activate",
"type" : "function",
- "desc" : "Fires when this panel is activated.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.panel.Content",
+ "desc" : "Fires when this tab becomes the active tab.",
+ "sig" : "function (tabPanel, _self)\n{\n\n}",
+ "memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
"params" : [
{
- "name" : "this",
- "type" : "Roo.ContentPanel",
- "desc" : "",
+ "name" : "tabPanel",
+ "type" : "Roo.TabPanel",
+ "desc" : "The parent TabPanel",
"isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "deactivate",
- "type" : "function",
- "desc" : "Fires when this panel is activated.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.panel.Content",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
+ },
{
"name" : "this",
- "type" : "Roo.ContentPanel",
+ "type" : "Roo.TabPanelItem",
"desc" : "",
"isOptional" : false
}
"returns" : []
},
{
- "name" : "render",
+ "name" : "beforeclose",
"type" : "function",
- "desc" : "Fires when this tab is created",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.panel.Content",
+ "desc" : "Fires before this tab is closed. To cancel the close, set cancel to true on e (e.cancel = true).",
+ "sig" : "function (_self, e)\n{\n\n}",
+ "memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.ContentPanel",
+ "type" : "Roo.TabPanelItem",
"desc" : "",
"isOptional" : false
+ },
+ {
+ "name" : "e",
+ "type" : "Object",
+ "desc" : "Set cancel to true on this object to cancel the close.",
+ "isOptional" : false
}
],
"returns" : []
},
{
- "name" : "resize",
+ "name" : "close",
"type" : "function",
- "desc" : "Fires when this panel is resized if fitToFrame is true.",
- "sig" : "function (_self, width, height)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.panel.Content",
+ "desc" : "Fires when this tab is closed.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
"params" : [
{
- "name" : "this",
- "type" : "Roo.ContentPanel",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "width",
- "type" : "Number",
- "desc" : "The width after any component adjustments",
- "isOptional" : false
- },
- {
- "name" : "height",
- "type" : "Number",
- "desc" : "The height after any component adjustments",
+ "name" : "this",
+ "type" : "Roo.TabPanelItem",
+ "desc" : "",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "scroll",
+ "name" : "deactivate",
"type" : "function",
- "desc" : "Fires when this content is scrolled",
- "sig" : "function (_self, scrollEvent)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.panel.Content",
+ "desc" : "Fires when this tab is no longer the active tab.",
+ "sig" : "function (tabPanel, _self)\n{\n\n}",
+ "memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
"params" : [
{
- "name" : "this",
- "type" : "Roo.ContentPanel",
- "desc" : "",
+ "name" : "tabPanel",
+ "type" : "Roo.TabPanel",
+ "desc" : "The parent TabPanel",
"isOptional" : false
},
{
- "name" : "scrollEvent",
- "type" : "Event",
+ "name" : "this",
+ "type" : "Roo.TabPanelItem",
"desc" : "",
"isOptional" : false
}
}
],
"methods" : [
+ {
+ "name" : "activate",
+ "type" : "function",
+ "desc" : "Activates this TabPanelItem -- this <b>does</b> deactivate the currently active TabPanelItem.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
{
"name" : "addEvents",
"type" : "function",
"returns" : []
},
{
- "name" : "destroy",
+ "name" : "disable",
"type" : "function",
- "desc" : "Destroys this panel",
+ "desc" : "Disables this TabPanelItem -- this does nothing if this is the active TabPanelItem.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.bootstrap.panel.Content",
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
+ {
+ "name" : "enable",
+ "type" : "function",
+ "desc" : "Enables this TabPanelItem if it was previously disabled.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
]
},
{
- "name" : "getChildContainer",
- "type" : "function",
- "desc" : "Adds a xtype elements to the panel - currently only supports Forms, View, JsonView.\n<pre><code>\n\nlayout.addxtype({\n xtype : 'Form',\n items: [ .... ]\n }\n);\n\n</code></pre>",
- "sig" : "(cfg)",
- "static" : false,
- "memberOf" : "Roo.bootstrap.panel.Content",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "cfg",
- "type" : "Object",
- "desc" : "Xtype definition of item to add.",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "getEl",
+ "name" : "getText",
"type" : "function",
- "desc" : "Returns this panel's element - used by regiosn to add.",
+ "desc" : "Returns the text for this tab",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.bootstrap.panel.Content",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"returns" : [
{
"name" : "",
- "type" : "Roo.Element",
+ "type" : "String",
"desc" : ""
}
]
},
{
- "name" : "getGrid",
+ "name" : "getUpdateManager",
"type" : "function",
- "desc" : "Returns the grid for this panel",
+ "desc" : "Gets the {@link Roo.UpdateManager} for the body of this TabPanelItem. Enables you to perform Ajax updates.",
"sig" : "()\n{\n\n}",
"static" : false,
"memberOf" : "",
"returns" : [
{
"name" : "",
- "type" : "Roo.bootstrap.Table",
- "desc" : ""
+ "type" : "Roo.UpdateManager",
+ "desc" : "The UpdateManager"
}
]
},
{
- "name" : "getId",
+ "name" : "hasListener",
"type" : "function",
- "desc" : "Returns this panel's id",
- "sig" : "()\n{\n\n}",
+ "desc" : "Checks to see if this object has any listeners for a specified event",
+ "sig" : "(eventName)",
"static" : false,
- "memberOf" : "Roo.bootstrap.panel.Content",
+ "memberOf" : "Roo.util.Observable",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
- "returns" : [
+ "params" : [
{
- "name" : "",
+ "name" : "eventName",
"type" : "String",
- "desc" : ""
+ "desc" : "The name of the event to check for",
+ "isOptional" : false
}
- ]
- },
- {
- "name" : "getTitle",
- "type" : "function",
- "desc" : "Returns this panel's title",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.panel.Content",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
+ ],
"returns" : [
{
"name" : "",
- "type" : "String",
- "desc" : ""
+ "type" : "Boolean",
+ "desc" : "True if the event is being listened for, else false"
}
]
},
{
- "name" : "getToolbar",
+ "name" : "hide",
"type" : "function",
- "desc" : "Returns the toolbar for this Panel if one was configured.",
+ "desc" : "Hides this TabPanelItem -- if you don't activate another TabPanelItem this could look odd.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.bootstrap.panel.Content",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"exceptions" : "",
"requires" : "",
"params" : [],
- "returns" : [
- {
- "name" : "",
- "type" : "Roo.Toolbar",
- "desc" : ""
- }
- ]
+ "returns" : []
},
{
- "name" : "getUpdateManager",
+ "name" : "isActive",
"type" : "function",
- "desc" : "Get the {@link Roo.UpdateManager} for this panel. Enables you to perform Ajax updates.",
+ "desc" : "Returns true if this tab is the active tab.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.bootstrap.panel.Content",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"exceptions" : "",
"requires" : "",
"params" : [],
- "returns" : [
- {
- "name" : "",
- "type" : "Roo.UpdateManager",
- "desc" : "The UpdateManager"
- }
- ]
- },
- {
- "name" : "hasListener",
- "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"
+ "desc" : ""
}
]
},
{
- "name" : "isClosable",
+ "name" : "isHidden",
"type" : "function",
- "desc" : "Returns true is this panel was configured to be closable",
+ "desc" : "Returns true if this tab is \"hidden\"",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.bootstrap.panel.Content",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
}
]
},
- {
- "name" : "load",
- "type" : "function",
- "desc" : "Loads this content panel immediately with content from XHR. Note: to delay loading until the panel is activated, use {@link #setUrl}.\nDoes not work with IFRAME contents",
- "sig" : "(url, params, callback, discardUrl)",
- "static" : false,
- "memberOf" : "Roo.bootstrap.panel.Content",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "url",
- "type" : "Object/String/Function",
- "desc" : "The url for this request or a function to call to get the url or a config object containing any of the following options:\n<pre><code>\npanel.load({\n url: \"your-url.php\",\n params: {param1: \"foo\", param2: \"bar\"}, // or a URL encoded string\n callback: yourFunction,\n scope: yourObject, //(optional scope)\n discardUrl: false,\n nocache: false,\n text: \"Loading...\",\n timeout: 30,\n scripts: false\n});\n</code></pre>\nThe only required property is <i>url</i>. The optional properties <i>nocache</i>, <i>text</i> and <i>scripts</i>\nare shorthand for <i>disableCaching</i>, <i>indicatorText</i> and <i>loadScripts</i> and are used to set their associated property on this panel UpdateManager instance.",
- "isOptional" : false
- },
- {
- "name" : "params",
- "type" : "String/Object",
- "desc" : "(optional) The parameters to pass as either a URL encoded string \"param1=1&param2=2\" or an object {param1: 1, param2: 2}",
- "isOptional" : false
- },
- {
- "name" : "callback",
- "type" : "Function",
- "desc" : "(optional) Callback when transaction is complete -- called with signature (oElement, bSuccess, oResponse)",
- "isOptional" : false
- },
- {
- "name" : "discardUrl",
- "type" : "Boolean",
- "desc" : "(optional) By default when you execute an update the defaultUrl is changed to the last used URL. If true, it will not store the URL.",
- "isOptional" : false
- }
- ],
- "returns" : [
- {
- "name" : "",
- "type" : "Roo.ContentPanel",
- "desc" : "this"
- }
- ]
- },
{
"name" : "on",
"type" : "function",
{
"name" : "refresh",
"type" : "function",
- "desc" : "Force a content refresh from the URL specified in the {@link #setUrl} method.\n Will fail silently if the {@link #setUrl} method has not been called.\n This does not activate the panel, just updates its content.",
+ "desc" : "Forces a content refresh from the URL specified in the {@link #setUrl} method.\n Will fail silently if the setUrl method has not been called.\n This does not activate the panel, just updates its content.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.bootstrap.panel.Content",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
{
"name" : "setContent",
"type" : "function",
- "desc" : "Updates this panel's element (not for iframe)",
+ "desc" : "Sets the content for this TabPanelItem.",
"sig" : "(content, loadScripts)",
"static" : false,
- "memberOf" : "Roo.bootstrap.panel.Content",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
{
"name" : "content",
"type" : "String",
- "desc" : "The new content",
+ "desc" : "The content",
"isOptional" : false
},
{
"name" : "loadScripts",
"type" : "Boolean",
- "desc" : "(optional) true to look for and process scripts",
+ "desc" : "true to look for and load scripts",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "setTitle",
+ "name" : "setHidden",
"type" : "function",
- "desc" : "Set this panel's title",
- "sig" : "(title)",
+ "desc" : "Show or hide the tab",
+ "sig" : "(hidden)",
"static" : false,
- "memberOf" : "Roo.bootstrap.panel.Content",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "title",
+ "name" : "hidden",
+ "type" : "Boolean",
+ "desc" : "True to hide or false to show.",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "setText",
+ "type" : "function",
+ "desc" : "Sets the text for the tab (Note: this also sets the tooltip text)",
+ "sig" : "(text)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "text",
"type" : "String",
- "desc" : "",
+ "desc" : "The tab's text and tooltip",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "setTooltip",
+ "type" : "function",
+ "desc" : "Set the tooltip for the tab.",
+ "sig" : "(tooltip)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "tooltip",
+ "type" : "String",
+ "desc" : "The tab's tooltip",
"isOptional" : false
}
],
{
"name" : "setUrl",
"type" : "function",
- "desc" : "Set a URL to be used to load the content for this panel. When this panel is activated, the content will be loaded from that URL.",
+ "desc" : "Set a URL to be used to load the content for this TabPanelItem.",
"sig" : "(url, params, loadOnce)",
"static" : false,
- "memberOf" : "Roo.bootstrap.panel.Content",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
{
"name" : "url",
"type" : "String/Function",
- "desc" : "The URL to load the content from or a function to call to get the URL",
+ "desc" : "The URL to load the content from, or a function to call to get the URL",
"isOptional" : false
},
{
{
"name" : "loadOnce",
"type" : "Boolean",
- "desc" : "(optional) Whether to only load the content once. If this is false it makes the Ajax call every time this panel is activated. (Defaults to false)",
+ "desc" : "(optional) Whether to only load the content once. If this is false it makes the Ajax call every time this TabPanelItem is activated. (Defaults to false)",
"isOptional" : false
}
],
"returns" : [
{
"name" : "",
- "type" : "Roo.UpdateManager|Boolean",
- "desc" : "The UpdateManager or false if IFRAME"
+ "type" : "Roo.UpdateManager",
+ "desc" : "The UpdateManager"
}
]
},
+ {
+ "name" : "show",
+ "type" : "function",
+ "desc" : "Shows this TabPanelItem -- this <b>does not</b> deactivate the currently active TabPanelItem.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
{
"name" : "un",
"type" : "function",
"tree_children" : [],
"tree_parent" : []
},
- "Roo.bootstrap.panel.Nest" : {
+ "Roo.bootstrap.panel.Tabs" : {
"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"
- },
- {
- "name" : "autoCreate",
- "type" : "Boolean/Object",
- "desc" : "True to auto generate the DOM element for this panel, or a {@link Roo.DomHelper} config of the element to create",
- "memberOf" : "Roo.bootstrap.panel.Content"
- },
- {
- "name" : "autoScroll",
- "type" : "Boolean",
- "desc" : "True to scroll overflow in this panel (use with {@link #fitToFrame})",
- "memberOf" : "Roo.bootstrap.panel.Content"
- },
- {
- "name" : "background",
- "type" : "Boolean",
- "desc" : "True if the panel should not be activated when it is added (defaults to false)",
- "memberOf" : "Roo.bootstrap.panel.Content"
- },
- {
- "name" : "badges",
- "type" : "Boolean",
- "desc" : "render the badges",
- "memberOf" : "Roo.bootstrap.panel.Content"
- },
- {
- "name" : "closable",
- "type" : "Boolean",
- "desc" : "True if the panel can be closed/removed",
- "memberOf" : "Roo.bootstrap.panel.Content"
- },
- {
- "name" : "cls",
- "type" : "String",
- "desc" : "extra classes to use",
- "memberOf" : "Roo.bootstrap.panel.Content"
- },
- {
- "name" : "content",
- "type" : "String",
- "desc" : "Raw content to fill content panel with (uses setContent on construction.)",
- "memberOf" : "Roo.bootstrap.panel.Content"
- },
- {
- "name" : "fitContainer",
- "type" : "Boolean",
- "desc" : "When using {@link #fitToFrame} and {@link #resizeEl}, you can also fit the parent container (defaults to false)",
- "memberOf" : "Roo.bootstrap.panel.Content"
- },
- {
- "name" : "fitToFrame",
- "type" : "Boolean",
- "desc" : "True for this panel to adjust its size to fit when the region resizes (defaults to false)",
- "memberOf" : "Roo.bootstrap.panel.Content"
- },
- {
- "name" : "iframe",
- "type" : "Boolean",
- "desc" : "contents are an iframe - makes showing remote sources/CSS feasible..",
- "memberOf" : "Roo.bootstrap.panel.Content"
- },
- {
- "name" : "layout",
- "type" : "Roo.BorderLayout",
- "desc" : "The layout for this panel",
- "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" : "loadOnce",
- "type" : "Boolean",
- "desc" : "When used with {@link #url}, calls {@link #setUrl} with this value",
- "memberOf" : "Roo.bootstrap.panel.Content"
- },
- {
- "name" : "params",
- "type" : "String/Object",
- "desc" : "When used with {@link #url}, calls {@link #setUrl} with this value",
- "memberOf" : "Roo.bootstrap.panel.Content"
- },
- {
- "name" : "region",
- "type" : "String",
- "desc" : "[required] (center|north|south|east|west) which region to put this panel on (when used with xtype constructors)",
- "memberOf" : "Roo.bootstrap.panel.Content"
- },
- {
- "name" : "resizeEl",
- "type" : "String/HTMLElement/Element",
- "desc" : "An element to resize if {@link #fitToFrame} is true (instead of this panel's element)",
- "memberOf" : "Roo.bootstrap.panel.Content"
- },
- {
- "name" : "title",
- "type" : "String",
- "desc" : "The title for this panel",
- "memberOf" : "Roo.bootstrap.panel.Content"
- },
- {
- "name" : "toolbar",
- "type" : "Toolbar",
- "desc" : "A toolbar for this panel",
- "memberOf" : "Roo.bootstrap.panel.Content"
- },
- {
- "name" : "url",
- "type" : "String",
- "desc" : "Calls {@link #setUrl} with this value",
- "memberOf" : "Roo.bootstrap.panel.Content"
+ "memberOf" : "Roo.util.Observable",
+ "isOptional" : false,
+ "optvals" : []
}
],
"events" : [
{
- "name" : "activate",
+ "name" : "beforetabchange",
"type" : "function",
- "desc" : "Fires when this panel is activated.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.panel.Content",
+ "desc" : "Fires before the active tab changes, set cancel to true on the \"e\" parameter to cancel the change",
+ "sig" : "function (_self, e, tab)\n{\n\n}",
+ "memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.ContentPanel",
+ "type" : "Roo.TabPanel",
"desc" : "",
"isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "deactivate",
- "type" : "function",
- "desc" : "Fires when this panel is activated.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.panel.Content",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
+ },
{
- "name" : "this",
- "type" : "Roo.ContentPanel",
- "desc" : "",
+ "name" : "e",
+ "type" : "Object",
+ "desc" : "Set cancel to true on this object to cancel the tab change",
"isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "render",
- "type" : "function",
- "desc" : "Fires when this tab is created",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.panel.Content",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
+ },
{
- "name" : "this",
- "type" : "Roo.ContentPanel",
- "desc" : "",
+ "name" : "tab",
+ "type" : "Roo.TabPanelItem",
+ "desc" : "The tab being changed to",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "resize",
+ "name" : "tabchange",
"type" : "function",
- "desc" : "Fires when this panel is resized if fitToFrame is true.",
- "sig" : "function (_self, width, height)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.panel.Content",
+ "desc" : "Fires when the active tab changes",
+ "sig" : "function (_self, activePanel)\n{\n\n}",
+ "memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
"params" : [
{
"name" : "this",
- "type" : "Roo.ContentPanel",
+ "type" : "Roo.TabPanel",
"desc" : "",
"isOptional" : false
},
{
- "name" : "width",
- "type" : "Number",
- "desc" : "The width after any component adjustments",
- "isOptional" : false
- },
- {
- "name" : "height",
- "type" : "Number",
- "desc" : "The height after any component adjustments",
+ "name" : "activePanel",
+ "type" : "Roo.TabPanelItem",
+ "desc" : "The new active tab",
"isOptional" : false
}
],
"returns" : []
- },
+ }
+ ],
+ "methods" : [
{
- "name" : "scroll",
+ "name" : "activate",
"type" : "function",
- "desc" : "Fires when this content is scrolled",
- "sig" : "function (_self, scrollEvent)\n{\n\n}",
- "memberOf" : "Roo.bootstrap.panel.Content",
+ "desc" : "Activates a {@link Roo.TabPanelItem}. The currently active one will be deactivated.",
+ "sig" : "(id)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
- "name" : "this",
- "type" : "Roo.ContentPanel",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "scrollEvent",
- "type" : "Event",
- "desc" : "",
+ "name" : "id",
+ "type" : "String/Number",
+ "desc" : "The id or index of the TabPanelItem to activate.",
"isOptional" : false
}
],
- "returns" : []
- }
- ],
- "methods" : [
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.TabPanelItem",
+ "desc" : "The TabPanelItem."
+ }
+ ]
+ },
{
"name" : "addEvents",
"type" : "function",
"returns" : []
},
{
- "name" : "addxtype",
+ "name" : "addTab",
"type" : "function",
- "desc" : "Adds a xtype elements to the layout of the nested panel\n<pre><code>\n\npanel.addxtype({\n xtype : 'ContentPanel',\n region: 'west',\n items: [ .... ]\n }\n);\n\npanel.addxtype({\n xtype : 'NestedLayoutPanel',\n region: 'west',\n layout: {\n center: { },\n west: { } \n },\n items : [ ... list of content panels or nested layout panels.. ]\n }\n);\n</code></pre>",
- "sig" : "(cfg)",
+ "desc" : "Creates a new {@link Roo.TabPanelItem} by looking for an existing element with the provided id -- if it's not found it creates one.",
+ "sig" : "(id, text, content, closable)",
"static" : false,
"memberOf" : "",
"isStatic" : false,
"requires" : "",
"params" : [
{
- "name" : "cfg",
- "type" : "Object",
- "desc" : "Xtype definition of item to add.",
+ "name" : "id",
+ "type" : "String",
+ "desc" : "The id of the div to use <b>or create</b>",
+ "isOptional" : false
+ },
+ {
+ "name" : "text",
+ "type" : "String",
+ "desc" : "The text for the tab",
+ "isOptional" : false
+ },
+ {
+ "name" : "content",
+ "type" : "String",
+ "desc" : "(optional) Content to put in the TabPanelItem body",
+ "isOptional" : false
+ },
+ {
+ "name" : "closable",
+ "type" : "Boolean",
+ "desc" : "(optional) True to create a close icon on the tab",
"isOptional" : false
}
],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.TabPanelItem",
+ "desc" : "The created TabPanelItem"
+ }
+ ]
},
{
- "name" : "capture",
+ "name" : "addTabItem",
"type" : "function",
- "desc" : "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" : "Adds an existing {@link Roo.TabPanelItem}.",
+ "sig" : "(item)",
+ "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" : "item",
+ "type" : "Roo.TabPanelItem",
+ "desc" : "The TabPanelItem to add",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "destroy",
+ "name" : "autoSizeTabs",
"type" : "function",
- "desc" : "Destroys this panel",
+ "desc" : "Manual call to resize the tabs (if {@link #resizeTabs} is false this does nothing)",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.bootstrap.panel.Content",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"returns" : []
},
{
- "name" : "fireEvent",
+ "name" : "beginUpdate",
"type" : "function",
- "desc" : "Fires the specified event with the passed parameters (minus the event name).",
- "sig" : "(eventName, args)",
+ "desc" : "Disables tab resizing while tabs are being added (if {@link #resizeTabs} is false this does nothing)",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.util.Observable",
+ "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" : "eventName",
- "type" : "String",
- "desc" : "",
+ "name" : "o",
+ "type" : "Observable",
+ "desc" : "The Observable to capture",
"isOptional" : false
},
{
- "name" : "args",
- "type" : "Object...",
- "desc" : "Variable number of parameters are passed to handlers",
+ "name" : "fn",
+ "type" : "Function",
+ "desc" : "The function to call",
"isOptional" : false
- }
- ],
- "returns" : [
+ },
{
- "name" : "",
- "type" : "Boolean",
- "desc" : "returns false if any of the handlers return false otherwise it returns true"
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "(optional) The scope (this object) for the fn",
+ "isOptional" : false
}
- ]
+ ],
+ "returns" : []
},
{
- "name" : "getChildContainer",
+ "name" : "destroy",
"type" : "function",
- "desc" : "Adds a xtype elements to the panel - currently only supports Forms, View, JsonView.\n<pre><code>\n\nlayout.addxtype({\n xtype : 'Form',\n items: [ .... ]\n }\n);\n\n</code></pre>",
- "sig" : "(cfg)",
+ "desc" : "Destroys this TabPanel",
+ "sig" : "(removeEl)",
"static" : false,
- "memberOf" : "Roo.bootstrap.panel.Content",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "cfg",
- "type" : "Object",
- "desc" : "Xtype definition of item to add.",
+ "name" : "removeEl",
+ "type" : "Boolean",
+ "desc" : "(optional) True to remove the element from the DOM as well (defaults to undefined)",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "getEl",
+ "name" : "disableTab",
"type" : "function",
- "desc" : "Returns this panel's element - used by regiosn to add.",
- "sig" : "()\n{\n\n}",
+ "desc" : "Disables a {@link Roo.TabPanelItem}. It cannot be the active tab, if it is this call is ignored.",
+ "sig" : "(id)",
"static" : false,
- "memberOf" : "Roo.bootstrap.panel.Content",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
- "returns" : [
+ "params" : [
{
- "name" : "",
- "type" : "Roo.Element",
- "desc" : ""
+ "name" : "id",
+ "type" : "String/Number",
+ "desc" : "The id or index of the TabPanelItem to disable.",
+ "isOptional" : false
}
- ]
+ ],
+ "returns" : []
},
{
- "name" : "getId",
+ "name" : "enableTab",
"type" : "function",
- "desc" : "Returns this panel's id",
- "sig" : "()\n{\n\n}",
+ "desc" : "Enables a {@link Roo.TabPanelItem} that is disabled.",
+ "sig" : "(id)",
"static" : false,
- "memberOf" : "Roo.bootstrap.panel.Content",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
- "returns" : [
+ "params" : [
{
- "name" : "",
- "type" : "String",
- "desc" : ""
+ "name" : "id",
+ "type" : "String/Number",
+ "desc" : "The id or index of the TabPanelItem to enable.",
+ "isOptional" : false
}
- ]
+ ],
+ "returns" : []
},
{
- "name" : "getLayout",
+ "name" : "endUpdate",
"type" : "function",
- "desc" : "Returns the nested BorderLayout for this panel",
+ "desc" : "Stops an update and resizes the tabs (if {@link #resizeTabs} is false this does nothing)",
"sig" : "()\n{\n\n}",
"static" : false,
"memberOf" : "",
"exceptions" : "",
"requires" : "",
"params" : [],
- "returns" : [
- {
- "name" : "",
- "type" : "Roo.BorderLayout",
- "desc" : ""
- }
- ]
+ "returns" : []
},
{
- "name" : "getTitle",
+ "name" : "fireEvent",
"type" : "function",
- "desc" : "Returns this panel's title",
- "sig" : "()\n{\n\n}",
+ "desc" : "Fires the specified event with the passed parameters (minus the event name).",
+ "sig" : "(eventName, args)",
"static" : false,
- "memberOf" : "Roo.bootstrap.panel.Content",
+ "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" : "String",
- "desc" : ""
+ "type" : "Boolean",
+ "desc" : "returns false if any of the handlers return false otherwise it returns true"
}
]
},
{
- "name" : "getToolbar",
+ "name" : "getActiveTab",
"type" : "function",
- "desc" : "Returns the toolbar for this Panel if one was configured.",
+ "desc" : "Gets the active {@link Roo.TabPanelItem}.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.bootstrap.panel.Content",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"returns" : [
{
"name" : "",
- "type" : "Roo.Toolbar",
- "desc" : ""
+ "type" : "Roo.TabPanelItem",
+ "desc" : "The active TabPanelItem or null if none are active."
}
]
},
{
- "name" : "getUpdateManager",
+ "name" : "getCount",
"type" : "function",
- "desc" : "Get the {@link Roo.UpdateManager} for this panel. Enables you to perform Ajax updates.",
+ "desc" : "Returns the number of tabs in this TabPanel.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.bootstrap.panel.Content",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"returns" : [
{
"name" : "",
- "type" : "Roo.UpdateManager",
- "desc" : "The UpdateManager"
+ "type" : "Number",
+ "desc" : ""
}
]
},
{
- "name" : "hasListener",
+ "name" : "getTab",
"type" : "function",
- "desc" : "Checks to see if this object has any listeners for a specified event",
- "sig" : "(eventName)",
+ "desc" : "Returns the {@link Roo.TabPanelItem} with the specified id/index",
+ "sig" : "(id)",
"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" : "id",
+ "type" : "String/Number",
+ "desc" : "The id or index of the TabPanelItem to fetch.",
"isOptional" : false
}
],
"returns" : [
{
"name" : "",
- "type" : "Boolean",
- "desc" : "True if the event is being listened for, else false"
+ "type" : "Roo.TabPanelItem",
+ "desc" : ""
}
]
},
{
- "name" : "isClosable",
+ "name" : "hasListener",
"type" : "function",
- "desc" : "Returns true is this panel was configured to be closable",
- "sig" : "()\n{\n\n}",
+ "desc" : "Checks to see if this object has any listeners for a specified event",
+ "sig" : "(eventName)",
"static" : false,
- "memberOf" : "Roo.bootstrap.panel.Content",
+ "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" : "Boolean",
- "desc" : ""
+ "desc" : "True if the event is being listened for, else false"
}
]
},
{
- "name" : "load",
+ "name" : "hideTab",
"type" : "function",
- "desc" : "Loads this content panel immediately with content from XHR. Note: to delay loading until the panel is activated, use {@link #setUrl}.\nDoes not work with IFRAME contents",
- "sig" : "(url, params, callback, discardUrl)",
+ "desc" : "Hides the {@link Roo.TabPanelItem} with the specified id/index",
+ "sig" : "(id)",
"static" : false,
- "memberOf" : "Roo.bootstrap.panel.Content",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "url",
- "type" : "Object/String/Function",
- "desc" : "The url for this request or a function to call to get the url or a config object containing any of the following options:\n<pre><code>\npanel.load({\n url: \"your-url.php\",\n params: {param1: \"foo\", param2: \"bar\"}, // or a URL encoded string\n callback: yourFunction,\n scope: yourObject, //(optional scope)\n discardUrl: false,\n nocache: false,\n text: \"Loading...\",\n timeout: 30,\n scripts: false\n});\n</code></pre>\nThe only required property is <i>url</i>. The optional properties <i>nocache</i>, <i>text</i> and <i>scripts</i>\nare shorthand for <i>disableCaching</i>, <i>indicatorText</i> and <i>loadScripts</i> and are used to set their associated property on this panel UpdateManager instance.",
- "isOptional" : false
- },
- {
- "name" : "params",
- "type" : "String/Object",
- "desc" : "(optional) The parameters to pass as either a URL encoded string \"param1=1&param2=2\" or an object {param1: 1, param2: 2}",
- "isOptional" : false
- },
- {
- "name" : "callback",
- "type" : "Function",
- "desc" : "(optional) Callback when transaction is complete -- called with signature (oElement, bSuccess, oResponse)",
- "isOptional" : false
- },
- {
- "name" : "discardUrl",
- "type" : "Boolean",
- "desc" : "(optional) By default when you execute an update the defaultUrl is changed to the last used URL. If true, it will not store the URL.",
+ "name" : "id",
+ "type" : "String/Number",
+ "desc" : "The id or index of the TabPanelItem to hide.",
"isOptional" : false
}
],
- "returns" : [
- {
- "name" : "",
- "type" : "Roo.ContentPanel",
- "desc" : "this"
- }
- ]
+ "returns" : []
},
{
"name" : "on",
"params" : [],
"returns" : []
},
- {
- "name" : "refresh",
- "type" : "function",
- "desc" : "Force a content refresh from the URL specified in the {@link #setUrl} method.\n Will fail silently if the {@link #setUrl} method has not been called.\n This does not activate the panel, just updates its content.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.bootstrap.panel.Content",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
{
"name" : "releaseCapture",
"type" : "function",
"returns" : []
},
{
- "name" : "setContent",
+ "name" : "removeTab",
"type" : "function",
- "desc" : "Updates this panel's element (not for iframe)",
- "sig" : "(content, loadScripts)",
+ "desc" : "Removes a {@link Roo.TabPanelItem}.",
+ "sig" : "(id)",
"static" : false,
- "memberOf" : "Roo.bootstrap.panel.Content",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "content",
+ "name" : "id",
+ "type" : "String/Number",
+ "desc" : "The id or index of the TabPanelItem to remove.",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "setTabWidth",
+ "type" : "function",
+ "desc" : "Resizes all the tabs to the passed width",
+ "sig" : "(The)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "The",
+ "type" : "Number",
+ "desc" : "new width",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "syncHeight",
+ "type" : "function",
+ "desc" : "Updates the tab body element to fit the height of the container element\nfor overflow scrolling",
+ "sig" : "(targetHeight)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "targetHeight",
+ "type" : "Number",
+ "desc" : "(optional) Override the starting height from the elements height",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "un",
+ "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 new content",
+ "desc" : "The type of event to listen for",
"isOptional" : false
},
{
- "name" : "loadScripts",
- "type" : "Boolean",
- "desc" : "(optional) true to look for and process scripts",
+ "name" : "handler",
+ "type" : "Function",
+ "desc" : "The handler to remove",
+ "isOptional" : false
+ },
+ {
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "(optional) The scope (this object) for the handler",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "setTitle",
+ "name" : "unhideTab",
"type" : "function",
- "desc" : "Set this panel's title",
- "sig" : "(title)",
+ "desc" : "\"Unhides\" the {@link Roo.TabPanelItem} with the specified id/index.",
+ "sig" : "(id)",
"static" : false,
- "memberOf" : "Roo.bootstrap.panel.Content",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "title",
- "type" : "String",
- "desc" : "",
+ "name" : "id",
+ "type" : "String/Number",
+ "desc" : "The id or index of the TabPanelItem to unhide.",
"isOptional" : false
}
],
"returns" : []
+ }
+ ],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "implementations" : [],
+ "tree_children" : [],
+ "tree_parent" : []
+ },
+ "Roo.data" : {
+ "props" : [],
+ "events" : [],
+ "methods" : [],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "implementations" : [],
+ "tree_children" : [],
+ "tree_parent" : []
+ },
+ "Roo.data.ArrayReader" : {
+ "props" : [
+ {
+ "name" : "fields",
+ "type" : "Array",
+ "desc" : "Array of field definition objects",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
- "name" : "setUrl",
+ "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" : "",
+ "isOptional" : false,
+ "optvals" : []
+ }
+ ],
+ "events" : [],
+ "methods" : [
+ {
+ "name" : "newRow",
"type" : "function",
- "desc" : "Set a URL to be used to load the content for this panel. When this panel is activated, the content will be loaded from that URL.",
- "sig" : "(url, params, loadOnce)",
+ "desc" : "Create an empty record",
+ "sig" : "(data)",
"static" : false,
- "memberOf" : "Roo.bootstrap.panel.Content",
+ "memberOf" : "Roo.data.DataReader",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "url",
- "type" : "String/Function",
- "desc" : "The URL to load the content from or a function to call to get the URL",
- "isOptional" : false
- },
- {
- "name" : "params",
- "type" : "String/Object",
- "desc" : "(optional) The string params for the update call or an object of the params. See {@link Roo.UpdateManager#update} for more details. (Defaults to null)",
- "isOptional" : false
- },
- {
- "name" : "loadOnce",
- "type" : "Boolean",
- "desc" : "(optional) Whether to only load the content once. If this is false it makes the Ajax call every time this panel is activated. (Defaults to false)",
+ "name" : "data",
+ "type" : "Object",
+ "desc" : "(optional) - overlay some values",
"isOptional" : false
}
],
"returns" : [
{
"name" : "",
- "type" : "Roo.UpdateManager|Boolean",
- "desc" : "The UpdateManager or false if IFRAME"
+ "type" : "Roo.data.Record",
+ "desc" : "record created."
}
]
},
{
- "name" : "un",
+ "name" : "readRecords",
"type" : "function",
- "desc" : "Removes a listener (shorthand for removeListener)",
- "sig" : "(eventName, handler, scope)",
+ "desc" : "Create a data block containing Roo.data.Records from an XML document.",
+ "sig" : "(o)",
"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",
+ "name" : "o",
"type" : "Object",
- "desc" : "(optional) The scope (this object) for the handler",
+ "desc" : "An Array of row objects which represents the dataset.",
"isOptional" : false
}
],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Object",
+ "desc" : "A data block which is used by an {@link Roo.data.Store} object as\na cache of Roo.data.Records."
+ }
+ ]
}
],
"isAbstract" : false,
"tree_children" : [],
"tree_parent" : []
},
- "Roo.bootstrap.panel.TabItem" : {
+ "Roo.data.Connection" : {
"props" : [
+ {
+ "name" : "autoAbort",
+ "type" : "Boolean",
+ "desc" : "Whether this 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\n to each request made by this object. (defaults to undefined)",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "disableCaching",
+ "type" : "Boolean",
+ "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\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" : "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" : "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" : "",
+ "isOptional" : false,
+ "optvals" : []
}
],
"events" : [
{
- "name" : "activate",
+ "name" : "beforerequest",
"type" : "function",
- "desc" : "Fires when this tab becomes the active tab.",
- "sig" : "function (tabPanel, _self)\n{\n\n}",
+ "desc" : "Fires before a network request is made to retrieve a data object.",
+ "sig" : "function (conn, options)\n{\n\n}",
"memberOf" : "",
"example" : "",
"deprecated" : "",
"see" : "",
"params" : [
{
- "name" : "tabPanel",
- "type" : "Roo.TabPanel",
- "desc" : "The parent TabPanel",
+ "name" : "conn",
+ "type" : "Connection",
+ "desc" : "This Connection object.",
"isOptional" : false
},
{
- "name" : "this",
- "type" : "Roo.TabPanelItem",
- "desc" : "",
+ "name" : "options",
+ "type" : "Object",
+ "desc" : "The options config object passed to the {@link #request} method.",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "beforeclose",
+ "name" : "requestcomplete",
"type" : "function",
- "desc" : "Fires before this tab is closed. To cancel the close, set cancel to true on e (e.cancel = true).",
- "sig" : "function (_self, e)\n{\n\n}",
+ "desc" : "Fires if the request was successfully completed.",
+ "sig" : "function (conn, response, options)\n{\n\n}",
"memberOf" : "",
"example" : "",
"deprecated" : "",
"see" : "",
"params" : [
{
- "name" : "this",
- "type" : "Roo.TabPanelItem",
- "desc" : "",
+ "name" : "conn",
+ "type" : "Connection",
+ "desc" : "This Connection object.",
"isOptional" : false
},
{
- "name" : "e",
+ "name" : "response",
"type" : "Object",
- "desc" : "Set cancel to true on this object to cancel the close.",
+ "desc" : "The XHR object containing the response data.\nSee {@link http://www.w3.org/TR/XMLHttpRequest/} for details.",
"isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "close",
- "type" : "function",
- "desc" : "Fires when this tab is closed.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
+ },
{
- "name" : "this",
- "type" : "Roo.TabPanelItem",
- "desc" : "",
+ "name" : "options",
+ "type" : "Object",
+ "desc" : "The options config object passed to the {@link #request} method.",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "deactivate",
+ "name" : "requestexception",
"type" : "function",
- "desc" : "Fires when this tab is no longer the active tab.",
- "sig" : "function (tabPanel, _self)\n{\n\n}",
+ "desc" : "Fires if an error HTTP status was returned from the server.\nSee {@link http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html} for details of HTTP status codes.",
+ "sig" : "function (conn, response, options)\n{\n\n}",
"memberOf" : "",
"example" : "",
"deprecated" : "",
"see" : "",
"params" : [
{
- "name" : "tabPanel",
- "type" : "Roo.TabPanel",
- "desc" : "The parent TabPanel",
+ "name" : "conn",
+ "type" : "Connection",
+ "desc" : "This Connection object.",
"isOptional" : false
},
{
- "name" : "this",
- "type" : "Roo.TabPanelItem",
- "desc" : "",
+ "name" : "response",
+ "type" : "Object",
+ "desc" : "The XHR object containing the response data.\nSee {@link http://www.w3.org/TR/XMLHttpRequest/} for details.",
+ "isOptional" : false
+ },
+ {
+ "name" : "options",
+ "type" : "Object",
+ "desc" : "The options config object passed to the {@link #request} method.",
"isOptional" : false
}
],
],
"methods" : [
{
- "name" : "activate",
+ "name" : "abort",
"type" : "function",
- "desc" : "Activates this TabPanelItem -- this <b>does</b> deactivate the currently active TabPanelItem.",
- "sig" : "()\n{\n\n}",
+ "desc" : "Aborts any outstanding request.",
+ "sig" : "(transactionId)",
"static" : false,
"memberOf" : "",
"isStatic" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
+ "params" : [
+ {
+ "name" : "transactionId",
+ "type" : "Number",
+ "desc" : "defaults to the last transaction",
+ "isOptional" : false
+ }
+ ],
"returns" : []
},
{
],
"returns" : []
},
- {
- "name" : "disable",
- "type" : "function",
- "desc" : "Disables this TabPanelItem -- this does nothing if this is the active TabPanelItem.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
- {
- "name" : "enable",
- "type" : "function",
- "desc" : "Enables this TabPanelItem if it was previously disabled.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
{
"name" : "fireEvent",
"type" : "function",
}
]
},
- {
- "name" : "getText",
- "type" : "function",
- "desc" : "Returns the text for this tab",
- "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" : "getUpdateManager",
- "type" : "function",
- "desc" : "Gets the {@link Roo.UpdateManager} for the body of this TabPanelItem. Enables you to perform Ajax updates.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : [
- {
- "name" : "",
- "type" : "Roo.UpdateManager",
- "desc" : "The UpdateManager"
- }
- ]
- },
{
"name" : "hasListener",
"type" : "function",
]
},
{
- "name" : "hide",
- "type" : "function",
- "desc" : "Hides this TabPanelItem -- if you don't activate another TabPanelItem this could look odd.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
- {
- "name" : "isActive",
+ "name" : "isLoading",
"type" : "function",
- "desc" : "Returns true if this tab is the active tab.",
- "sig" : "()\n{\n\n}",
+ "desc" : "Determine whether this object has a request outstanding.",
+ "sig" : "(transactionId)",
"static" : false,
"memberOf" : "",
"isStatic" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
- "returns" : [
+ "params" : [
{
- "name" : "",
- "type" : "Boolean",
- "desc" : ""
+ "name" : "transactionId",
+ "type" : "Number",
+ "desc" : "defaults to the last transaction",
+ "isOptional" : false
}
- ]
- },
- {
- "name" : "isHidden",
- "type" : "function",
- "desc" : "Returns true if this tab is \"hidden\"",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
+ ],
"returns" : [
{
"name" : "",
"type" : "Boolean",
- "desc" : ""
+ "desc" : "True if there is an outstanding request."
}
]
},
"params" : [],
"returns" : []
},
- {
- "name" : "refresh",
- "type" : "function",
- "desc" : "Forces a content refresh from the URL specified in the {@link #setUrl} method.\n Will fail silently if the setUrl method has not been called.\n This does not activate the panel, just updates its content.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
{
"name" : "releaseCapture",
"type" : "function",
"returns" : []
},
{
- "name" : "setContent",
+ "name" : "request",
"type" : "function",
- "desc" : "Sets the content for this TabPanelItem.",
- "sig" : "(content, loadScripts)",
+ "desc" : "Sends an HTTP request to a remote server.",
+ "sig" : "(options)",
"static" : false,
"memberOf" : "",
"isStatic" : false,
"requires" : "",
"params" : [
{
- "name" : "content",
- "type" : "String",
- "desc" : "The content",
- "isOptional" : false
- },
- {
- "name" : "loadScripts",
- "type" : "Boolean",
- "desc" : "true to look for and load scripts",
+ "name" : "options",
+ "type" : "Object",
+ "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
}
],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Number",
+ "desc" : "transactionId"
+ }
+ ]
},
{
- "name" : "setHidden",
+ "name" : "un",
"type" : "function",
- "desc" : "Show or hide the tab",
- "sig" : "(hidden)",
+ "desc" : "Removes a listener (shorthand for removeListener)",
+ "sig" : "(eventName, handler, scope)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.util.Observable",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "hidden",
- "type" : "Boolean",
- "desc" : "True to hide or false to show.",
+ "name" : "eventName",
+ "type" : "String",
+ "desc" : "The type of event to listen for",
+ "isOptional" : false
+ },
+ {
+ "name" : "handler",
+ "type" : "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" : [
+ "Roo.Ajax"
+ ],
+ "tree_children" : [],
+ "tree_parent" : []
+ },
+ "Roo.data.DataProxy" : {
+ "props" : [
{
- "name" : "setText",
+ "name" : "listeners",
+ "type" : "Object",
+ "desc" : "list of events and functions to call for 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" : "Sets the text for the tab (Note: this also sets the tooltip text)",
- "sig" : "(text)",
- "static" : false,
+ "desc" : "Fires before a network request is made to retrieve a data object.",
+ "sig" : "function (This, params)\n{\n\n}",
"memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
"params" : [
{
- "name" : "text",
- "type" : "String",
- "desc" : "The tab's text and tooltip",
+ "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" : "setTooltip",
+ "name" : "load",
"type" : "function",
- "desc" : "Set the tooltip for the tab.",
- "sig" : "(tooltip)",
- "static" : false,
+ "desc" : "Fires before the load method's callback is called.",
+ "sig" : "function (This, o, arg)\n{\n\n}",
"memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
"params" : [
{
- "name" : "tooltip",
- "type" : "String",
- "desc" : "The tab's tooltip",
+ "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" : "setUrl",
+ "name" : "loadexception",
"type" : "function",
- "desc" : "Set a URL to be used to load the content for this TabPanelItem.",
- "sig" : "(url, params, loadOnce)",
- "static" : false,
+ "desc" : "Fires if an Exception occurs during data retrieval.",
+ "sig" : "function (This, o, arg, e)\n{\n\n}",
"memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
"params" : [
{
- "name" : "url",
- "type" : "String/Function",
- "desc" : "The URL to load the content from, or a function to call to get the URL",
+ "name" : "This",
+ "type" : "Object",
+ "desc" : "DataProxy object.",
"isOptional" : false
},
{
- "name" : "params",
- "type" : "String/Object",
- "desc" : "(optional) The string params for the update call or an object of the params. See {@link Roo.UpdateManager#update} for more details. (Defaults to null)",
+ "name" : "o",
+ "type" : "Object",
+ "desc" : "The data object.",
"isOptional" : false
},
{
- "name" : "loadOnce",
- "type" : "Boolean",
- "desc" : "(optional) Whether to only load the content once. If this is false it makes the Ajax call every time this TabPanelItem is activated. (Defaults to false)",
+ "name" : "arg",
+ "type" : "Object",
+ "desc" : "The callback argument object passed to the load function.",
"isOptional" : false
- }
- ],
- "returns" : [
+ },
{
- "name" : "",
- "type" : "Roo.UpdateManager",
- "desc" : "The UpdateManager"
+ "name" : "e",
+ "type" : "Object",
+ "desc" : "The Exception.",
+ "isOptional" : false
}
- ]
- },
+ ],
+ "returns" : []
+ }
+ ],
+ "methods" : [
{
- "name" : "show",
+ "name" : "addEvents",
"type" : "function",
- "desc" : "Shows this TabPanelItem -- this <b>does not</b> deactivate the currently active TabPanelItem.",
- "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" : [],
+ "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",
- "isOptional" : false
- }
- ],
- "returns" : []
- }
- ],
- "isAbstract" : false,
- "isBuilderTop" : false,
- "implementations" : [],
- "tree_children" : [],
- "tree_parent" : []
- },
- "Roo.bootstrap.panel.Tabs" : {
- "props" : [
- {
- "name" : "listeners",
- "type" : "Object",
- "desc" : "list of events and functions to call for this object, \nFor example :\n<pre><code>\n listeners : { \n 'click' : function(e) {\n ..... \n } ,\n .... \n } \n </code></pre>",
- "memberOf" : "Roo.util.Observable"
- }
- ],
- "events" : [
- {
- "name" : "beforetabchange",
- "type" : "function",
- "desc" : "Fires before the active tab changes, set cancel to true on the \"e\" parameter to cancel the change",
- "sig" : "function (_self, e, tab)\n{\n\n}",
- "memberOf" : "",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "Roo.TabPanel",
- "desc" : "",
+ "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
"isOptional" : false
},
{
- "name" : "e",
+ "name" : "options",
"type" : "Object",
- "desc" : "Set cancel to true on this object to cancel the tab change",
- "isOptional" : false
- },
- {
- "name" : "tab",
- "type" : "Roo.TabPanelItem",
- "desc" : "The tab being changed to",
+ "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" : "tabchange",
+ "name" : "capture",
"type" : "function",
- "desc" : "Fires when the active tab changes",
- "sig" : "function (_self, activePanel)\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" : "Roo.TabPanel",
- "desc" : "",
+ "name" : "o",
+ "type" : "Observable",
+ "desc" : "The Observable to capture",
"isOptional" : false
},
{
- "name" : "activePanel",
- "type" : "Roo.TabPanelItem",
- "desc" : "The new active tab",
+ "name" : "fn",
+ "type" : "Function",
+ "desc" : "The function to call",
+ "isOptional" : false
+ },
+ {
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "(optional) The scope (this object) for the fn",
"isOptional" : false
}
],
"returns" : []
- }
- ],
- "methods" : [
+ },
{
- "name" : "activate",
+ "name" : "fireEvent",
"type" : "function",
- "desc" : "Activates a {@link Roo.TabPanelItem}. The currently active one will be deactivated.",
- "sig" : "(id)",
+ "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" : "id",
- "type" : "String/Number",
- "desc" : "The id or index of the TabPanelItem to activate.",
+ "name" : "eventName",
+ "type" : "String",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "args",
+ "type" : "Object...",
+ "desc" : "Variable number of parameters are passed to handlers",
"isOptional" : false
}
],
"returns" : [
{
"name" : "",
- "type" : "Roo.TabPanelItem",
- "desc" : "The TabPanelItem."
+ "type" : "Boolean",
+ "desc" : "returns false if any of the handlers return false otherwise it returns true"
}
]
},
{
- "name" : "addEvents",
+ "name" : "hasListener",
"type" : "function",
- "desc" : "Used to define events on this Observable",
- "sig" : "(object)",
+ "desc" : "Checks to see if this object has any listeners for a specified event",
+ "sig" : "(eventName)",
"static" : false,
"memberOf" : "Roo.util.Observable",
"isStatic" : false,
"requires" : "",
"params" : [
{
- "name" : "object",
- "type" : "Object",
- "desc" : "The object with the events defined",
+ "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" : "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" : "addTab",
+ "name" : "purgeListeners",
"type" : "function",
- "desc" : "Creates a new {@link Roo.TabPanelItem} by looking for an existing element with the provided id -- if it's not found it creates one.",
- "sig" : "(id, text, content, closable)",
+ "desc" : "Removes all listeners for this object",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "",
+ "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" : "id",
- "type" : "String",
- "desc" : "The id of the div to use <b>or create</b>",
+ "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" : "text",
+ "name" : "eventName",
"type" : "String",
- "desc" : "The text for the tab",
+ "desc" : "The type of event to listen for",
"isOptional" : false
},
{
- "name" : "content",
- "type" : "String",
- "desc" : "(optional) Content to put in the TabPanelItem body",
+ "name" : "handler",
+ "type" : "Function",
+ "desc" : "The handler to remove",
"isOptional" : false
},
{
- "name" : "closable",
- "type" : "Boolean",
- "desc" : "(optional) True to create a close icon on the tab",
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "(optional) The scope (this object) for the handler",
"isOptional" : false
}
],
- "returns" : [
- {
- "name" : "",
- "type" : "Roo.TabPanelItem",
- "desc" : "The created TabPanelItem"
- }
- ]
+ "returns" : []
},
{
- "name" : "addTabItem",
+ "name" : "un",
"type" : "function",
- "desc" : "Adds an existing {@link Roo.TabPanelItem}.",
- "sig" : "(item)",
+ "desc" : "Removes a listener (shorthand for removeListener)",
+ "sig" : "(eventName, handler, scope)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.util.Observable",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "item",
- "type" : "Roo.TabPanelItem",
- "desc" : "The TabPanelItem to add",
+ "name" : "eventName",
+ "type" : "String",
+ "desc" : "The type of event to listen for",
+ "isOptional" : false
+ },
+ {
+ "name" : "handler",
+ "type" : "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" : true,
+ "isBuilderTop" : false,
+ "implementations" : [
+ "Roo.data.HttpProxy",
+ "Roo.data.MemoryProxy"
+ ],
+ "tree_children" : [],
+ "tree_parent" : []
+ },
+ "Roo.data.DataReader" : {
+ "props" : [],
+ "events" : [],
+ "methods" : [
{
- "name" : "autoSizeTabs",
+ "name" : "newRow",
"type" : "function",
- "desc" : "Manual call to resize the tabs (if {@link #resizeTabs} is false this does nothing)",
- "sig" : "()\n{\n\n}",
+ "desc" : "Create an empty record",
+ "sig" : "(data)",
"static" : false,
"memberOf" : "",
"isStatic" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
+ "params" : [
+ {
+ "name" : "data",
+ "type" : "Object",
+ "desc" : "(optional) - overlay some values",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.data.Record",
+ "desc" : "record created."
+ }
+ ]
+ }
+ ],
+ "isAbstract" : true,
+ "isBuilderTop" : false,
+ "implementations" : [
+ "Roo.data.ArrayReader",
+ "Roo.data.JsonReader",
+ "Roo.data.XmlReader"
+ ],
+ "tree_children" : [],
+ "tree_parent" : []
+ },
+ "Roo.data.HttpProxy" : {
+ "props" : [
+ {
+ "name" : "autoAbort",
+ "type" : "Boolean",
+ "desc" : "Whether this 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\n to each request made by this object. (defaults to undefined)",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "disableCaching",
+ "type" : "Boolean",
+ "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\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",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "method",
+ "type" : "String",
+ "desc" : "T) The default HTTP method to be used for requests. (defaults to undefined; if not set but parms are present will use POST, otherwise GE",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : [
+ "GET",
+ "POST"
+ ]
+ },
+ {
+ "name" : "timeout",
+ "type" : "Number",
+ "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" : "",
+ "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" : "beginUpdate",
+ "name" : "load",
"type" : "function",
- "desc" : "Disables tab resizing while tabs are being added (if {@link #resizeTabs} is false this does nothing)",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
+ "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" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
+ "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" : "capture",
+ "name" : "loadexception",
"type" : "function",
- "desc" : "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 if an Exception occurs during data retrieval.",
+ "sig" : "function (This, o, arg, e)\n{\n\n}",
+ "memberOf" : "Roo.data.DataProxy",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
"params" : [
+ {
+ "name" : "This",
+ "type" : "Object",
+ "desc" : "DataProxy object.",
+ "isOptional" : false
+ },
{
"name" : "o",
- "type" : "Observable",
- "desc" : "The Observable to capture",
+ "type" : "Object",
+ "desc" : "The data object.",
"isOptional" : false
},
{
- "name" : "fn",
- "type" : "Function",
- "desc" : "The function to call",
+ "name" : "arg",
+ "type" : "Object",
+ "desc" : "The callback argument object passed to the load function.",
"isOptional" : false
},
{
- "name" : "scope",
+ "name" : "e",
"type" : "Object",
- "desc" : "(optional) The scope (this object) for the fn",
+ "desc" : "The Exception.",
"isOptional" : false
}
],
"returns" : []
- },
+ }
+ ],
+ "methods" : [
{
- "name" : "destroy",
+ "name" : "addEvents",
"type" : "function",
- "desc" : "Destroys this TabPanel",
- "sig" : "(removeEl)",
+ "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" : "removeEl",
- "type" : "Boolean",
- "desc" : "(optional) True to remove the element from the DOM as well (defaults to undefined)",
+ "name" : "object",
+ "type" : "Object",
+ "desc" : "The object with the events defined",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "disableTab",
+ "name" : "addListener",
"type" : "function",
- "desc" : "Disables a {@link Roo.TabPanelItem}. It cannot be the active tab, if it is this call is ignored.",
- "sig" : "(id)",
+ "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" : "id",
- "type" : "String/Number",
- "desc" : "The id or index of the TabPanelItem to disable.",
+ "name" : "eventName",
+ "type" : "String",
+ "desc" : "The type of event to listen for",
+ "isOptional" : false
+ },
+ {
+ "name" : "handler",
+ "type" : "Function",
+ "desc" : "The method the event invokes",
+ "isOptional" : false
+ },
+ {
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"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" : "enableTab",
+ "name" : "capture",
"type" : "function",
- "desc" : "Enables a {@link Roo.TabPanelItem} that is disabled.",
- "sig" : "(id)",
- "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" : "id",
- "type" : "String/Number",
- "desc" : "The id or index of the TabPanelItem to enable.",
+ "name" : "o",
+ "type" : "Observable",
+ "desc" : "The Observable to capture",
+ "isOptional" : false
+ },
+ {
+ "name" : "fn",
+ "type" : "Function",
+ "desc" : "The function to call",
+ "isOptional" : false
+ },
+ {
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "(optional) The scope (this object) for the fn",
"isOptional" : false
}
],
"returns" : []
},
- {
- "name" : "endUpdate",
- "type" : "function",
- "desc" : "Stops an update and resizes the tabs (if {@link #resizeTabs} is false this does nothing)",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
{
"name" : "fireEvent",
"type" : "function",
]
},
{
- "name" : "getActiveTab",
- "type" : "function",
- "desc" : "Gets the active {@link Roo.TabPanelItem}.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : [
- {
- "name" : "",
- "type" : "Roo.TabPanelItem",
- "desc" : "The active TabPanelItem or null if none are active."
- }
- ]
- },
- {
- "name" : "getCount",
+ "name" : "getConnection",
"type" : "function",
- "desc" : "Returns the number of tabs in this TabPanel.",
+ "desc" : "Return the {@link Roo.data.Connection} object being used by this Proxy.",
"sig" : "()\n{\n\n}",
"static" : false,
"memberOf" : "",
"returns" : [
{
"name" : "",
- "type" : "Number",
- "desc" : ""
- }
- ]
- },
- {
- "name" : "getTab",
- "type" : "function",
- "desc" : "Returns the {@link Roo.TabPanelItem} with the specified id/index",
- "sig" : "(id)",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "id",
- "type" : "String/Number",
- "desc" : "The id or index of the TabPanelItem to fetch.",
- "isOptional" : false
- }
- ],
- "returns" : [
- {
- "name" : "",
- "type" : "Roo.TabPanelItem",
- "desc" : ""
+ "type" : "Connection",
+ "desc" : "The Connection object. This object may be used to subscribe to events on\na finer-grained basis than the DataProxy events."
}
]
},
]
},
{
- "name" : "hideTab",
+ "name" : "load",
"type" : "function",
- "desc" : "Hides the {@link Roo.TabPanelItem} with the specified id/index",
- "sig" : "(id)",
+ "desc" : "Load data from the configured {@link Roo.data.Connection}, read the data object into\na block of Roo.data.Records using the passed {@link Roo.data.DataReader} implementation, and\nprocess that block using the passed callback.",
+ "sig" : "(params, reader, callback, scope, arg)",
"static" : false,
"memberOf" : "",
"isStatic" : false,
"requires" : "",
"params" : [
{
- "name" : "id",
- "type" : "String/Number",
- "desc" : "The id or index of the TabPanelItem to hide.",
+ "name" : "params",
+ "type" : "Object",
+ "desc" : "An object containing properties which are to be used as HTTP parameters\nfor the request to the remote server.",
+ "isOptional" : false
+ },
+ {
+ "name" : "reader",
+ "type" : "Roo.data.DataReader",
+ "desc" : "The Reader object which converts the data\nobject into a block of Roo.data.Records.",
+ "isOptional" : false
+ },
+ {
+ "name" : "callback",
+ "type" : "Function",
+ "desc" : "The function into which to pass the block of Roo.data.Records.\nThe function must be passed <ul>\n<li>The Record block object</li>\n<li>The \"arg\" argument from the load function</li>\n<li>A boolean success indicator</li>\n</ul>",
+ "isOptional" : false
+ },
+ {
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "The scope in which to call the callback",
+ "isOptional" : false
+ },
+ {
+ "name" : "arg",
+ "type" : "Object",
+ "desc" : "An optional argument which is passed to the callback as its second parameter.",
"isOptional" : false
}
],
],
"returns" : []
},
- {
- "name" : "removeTab",
- "type" : "function",
- "desc" : "Removes a {@link Roo.TabPanelItem}.",
- "sig" : "(id)",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "id",
- "type" : "String/Number",
- "desc" : "The id or index of the TabPanelItem to remove.",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "setTabWidth",
- "type" : "function",
- "desc" : "Resizes all the tabs to the passed width",
- "sig" : "(The)",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "The",
- "type" : "Number",
- "desc" : "new width",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "syncHeight",
- "type" : "function",
- "desc" : "Updates the tab body element to fit the height of the container element\nfor overflow scrolling",
- "sig" : "(targetHeight)",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "targetHeight",
- "type" : "Number",
- "desc" : "(optional) Override the starting height from the elements height",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
{
"name" : "un",
"type" : "function",
}
],
"returns" : []
- },
- {
- "name" : "unhideTab",
- "type" : "function",
- "desc" : "\"Unhides\" the {@link Roo.TabPanelItem} with the specified id/index.",
- "sig" : "(id)",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "id",
- "type" : "String/Number",
- "desc" : "The id or index of the TabPanelItem to unhide.",
- "isOptional" : false
- }
- ],
- "returns" : []
}
],
"isAbstract" : false,
"tree_children" : [],
"tree_parent" : []
},
- "Roo.data" : {
- "props" : [],
- "events" : [],
- "methods" : [],
- "isAbstract" : false,
- "isBuilderTop" : false,
- "implementations" : [],
- "tree_children" : [],
- "tree_parent" : []
- },
- "Roo.data.ArrayReader" : {
+ "Roo.data.JsonReader" : {
"props" : [
{
"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" : ""
+ "desc" : "Name of the property within a row object that contains a record identifier value.",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "root",
+ "type" : "String",
+ "desc" : "name of the property which contains the Array of row objects.",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "successProperty",
+ "type" : "String",
+ "desc" : "Name of the property from which to retrieve the success attribute used by forms.",
+ "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" : "",
+ "isOptional" : false,
+ "optvals" : []
}
],
"events" : [],
}
]
},
+ {
+ "name" : "read",
+ "type" : "function",
+ "desc" : "This method is only used by a DataProxy which has retrieved data from a remote server.",
+ "sig" : "(response)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "response",
+ "type" : "Object",
+ "desc" : "The XHR object which contains the JSON data in its responseText.",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Object",
+ "desc" : "data A data block which is used by an Roo.data.Store object as\na cache of Roo.data.Records."
+ }
+ ]
+ },
{
"name" : "readRecords",
"type" : "function",
{
"name" : "o",
"type" : "Object",
- "desc" : "An Array of row objects which represents the dataset.",
+ "desc" : "An object which contains an Array of row objects in the property specified\nin the config as 'root, and optionally a property, specified in the config as 'totalProperty'\nwhich contains the total size of the dataset.",
"isOptional" : false
}
],
{
"name" : "",
"type" : "Object",
- "desc" : "A data block which is used by an {@link Roo.data.Store} object as\na cache of Roo.data.Records."
+ "desc" : "data A data block which is used by an Roo.data.Store object as\na cache of Roo.data.Records."
}
]
}
"tree_children" : [],
"tree_parent" : []
},
- "Roo.data.Connection" : {
+ "Roo.data.JsonStore" : {
"props" : [
{
- "name" : "autoAbort",
- "type" : "Boolean",
- "desc" : "(Optional) Whether this request should abort any pending requests. (defaults to false)",
- "memberOf" : ""
+ "name" : "baseParams",
+ "type" : "Object",
+ "desc" : "An object containing properties which are to be sent as parameters\non any HTTP request",
+ "memberOf" : "Roo.data.Store",
+ "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" : ""
+ "name" : "data",
+ "type" : "Array",
+ "desc" : "Inline data to be loaded when the store is initialized.",
+ "memberOf" : "Roo.data.Store",
+ "isOptional" : false,
+ "optvals" : []
},
{
- "name" : "disableCaching",
- "type" : "Boolean",
- "desc" : "(Optional) True to add a unique cache-buster param to GET requests. (defaults to true)",
- "memberOf" : ""
+ "name" : "fields",
+ "type" : "Array",
+ "desc" : "An array of field definition objects, or field name strings.",
+ "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" : ""
+ "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",
+ "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" : ""
+ "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",
+ "isOptional" : false,
+ "optvals" : []
},
{
- "name" : "timeout",
- "type" : "Number",
- "desc" : "(Optional) The timeout in milliseconds to be used for requests. (defaults to 30000)",
- "memberOf" : ""
+ "name" : "proxy",
+ "type" : "Roo.data.DataProxy",
+ "desc" : "The Proxy object which provides access to a data object.",
+ "memberOf" : "Roo.data.Store",
+ "isOptional" : false,
+ "optvals" : []
},
{
- "name" : "url",
- "type" : "String",
- "desc" : "(Optional) The default URL to be used for requests to the server. (defaults to undefined)",
- "memberOf" : ""
+ "name" : "pruneModifiedRecords",
+ "type" : "boolean",
+ "desc" : "True to clear all modified record information each time the store is\nloaded or when a record is removed. (defaults to false).",
+ "memberOf" : "Roo.data.Store",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "reader",
+ "type" : "Roo.data.DataReader",
+ "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",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "sortInfo",
+ "type" : "Object",
+ "desc" : "A config object in the format: {field: \"fieldName\", direction: \"ASC|DESC\"}",
+ "memberOf" : "Roo.data.Store",
+ "isOptional" : false,
+ "optvals" : []
}
],
"events" : [
{
- "name" : "beforerequest",
+ "name" : "add",
"type" : "function",
- "desc" : "Fires before a network request is made to retrieve a data object.",
- "sig" : "function (conn, options)\n{\n\n}",
- "memberOf" : "",
+ "desc" : "Fires when Records have been added to the Store",
+ "sig" : "function (_self, records, index)\n{\n\n}",
+ "memberOf" : "Roo.data.Store",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
"params" : [
{
- "name" : "conn",
- "type" : "Connection",
- "desc" : "This Connection object.",
+ "name" : "this",
+ "type" : "Store",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "records",
+ "type" : "Roo.data.Record[]",
+ "desc" : "The array of Records added",
+ "isOptional" : false
+ },
+ {
+ "name" : "index",
+ "type" : "Number",
+ "desc" : "The index at which the record(s) were added",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "beforeload",
+ "type" : "function",
+ "desc" : "Fires before a request is made for a new data object. If the beforeload handler returns false\nthe load action will be canceled.",
+ "sig" : "function (_self, options)\n{\n\n}",
+ "memberOf" : "Roo.data.Store",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Store",
+ "desc" : "",
"isOptional" : false
},
{
"name" : "options",
"type" : "Object",
- "desc" : "The options config object passed to the {@link #request} method.",
+ "desc" : "The loading options that were specified (see {@link #load} for details)",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "requestcomplete",
+ "name" : "beforeloadadd",
"type" : "function",
- "desc" : "Fires if the request was successfully completed.",
- "sig" : "function (conn, response, options)\n{\n\n}",
- "memberOf" : "",
+ "desc" : "Fires after a new set of Records has been loaded.",
+ "sig" : "function (_self, records, options)\n{\n\n}",
+ "memberOf" : "Roo.data.Store",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
"params" : [
{
- "name" : "conn",
- "type" : "Connection",
- "desc" : "This Connection object.",
+ "name" : "this",
+ "type" : "Store",
+ "desc" : "",
"isOptional" : false
},
{
- "name" : "response",
+ "name" : "records",
+ "type" : "Roo.data.Record[]",
+ "desc" : "The Records that were loaded",
+ "isOptional" : false
+ },
+ {
+ "name" : "options",
"type" : "Object",
- "desc" : "The XHR object containing the response data.\nSee {@link http://www.w3.org/TR/XMLHttpRequest/} for details.",
+ "desc" : "The loading options that were specified (see {@link #load} for details)",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "clear",
+ "type" : "function",
+ "desc" : "Fires when the data cache has been cleared.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.data.Store",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Store",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "datachanged",
+ "type" : "function",
+ "desc" : "Fires when the data cache has changed, and a widget which is using this Store\nas a Record cache should refresh its view.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.data.Store",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Store",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "load",
+ "type" : "function",
+ "desc" : "Fires after a new set of Records has been loaded, before they are added to the store.",
+ "sig" : "function (_self, records, options)\n{\n\n}",
+ "memberOf" : "Roo.data.Store",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Store",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "records",
+ "type" : "Roo.data.Record[]",
+ "desc" : "The Records that were loaded",
"isOptional" : false
},
{
"name" : "options",
"type" : "Object",
- "desc" : "The options config object passed to the {@link #request} method.",
+ "desc" : "The loading options that were specified (see {@link #load} for details)",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "requestexception",
+ "name" : "loadexception",
"type" : "function",
- "desc" : "Fires if an error HTTP status was returned from the server.\nSee {@link http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html} for details of HTTP status codes.",
- "sig" : "function (conn, response, options)\n{\n\n}",
- "memberOf" : "",
+ "desc" : "Fires if an exception occurs in the Proxy during loading.\nCalled with the signature of the Proxy's \"loadexception\" event.\nIf you return Json { data: [] , success: false, .... } then this will be thrown with the following args",
+ "sig" : "function (, ret, opts, jsonData)\n{\n\n}",
+ "memberOf" : "Roo.data.Store",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
"params" : [
{
- "name" : "conn",
- "type" : "Connection",
- "desc" : "This Connection object.",
+ "name" : "",
+ "type" : "Proxy",
+ "desc" : "",
"isOptional" : false
},
{
- "name" : "response",
+ "name" : "ret",
"type" : "Object",
- "desc" : "The XHR object containing the response data.\nSee {@link http://www.w3.org/TR/XMLHttpRequest/} for details.",
+ "desc" : "return data from JsonData.reader() - success, totalRecords, records",
"isOptional" : false
},
{
- "name" : "options",
+ "name" : "opts",
"type" : "Object",
- "desc" : "The options config object passed to the {@link #request} method.",
+ "desc" : "- load Options",
+ "isOptional" : false
+ },
+ {
+ "name" : "jsonData",
+ "type" : "Object",
+ "desc" : "from your request (normally this contains the Exception)",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "metachange",
+ "type" : "function",
+ "desc" : "Fires when this store's reader provides new metadata (fields). This is currently only support for JsonReaders.",
+ "sig" : "function (_self, meta)\n{\n\n}",
+ "memberOf" : "Roo.data.Store",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Store",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "meta",
+ "type" : "Object",
+ "desc" : "The JSON metadata",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "remove",
+ "type" : "function",
+ "desc" : "Fires when a Record has been removed from the Store",
+ "sig" : "function (_self, record, index)\n{\n\n}",
+ "memberOf" : "Roo.data.Store",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Store",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "record",
+ "type" : "Roo.data.Record",
+ "desc" : "The Record that was removed",
+ "isOptional" : false
+ },
+ {
+ "name" : "index",
+ "type" : "Number",
+ "desc" : "The index at which the record was removed",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "update",
+ "type" : "function",
+ "desc" : "Fires when a Record has been updated",
+ "sig" : "function (_self, record, operation)\n{\n\n}",
+ "memberOf" : "Roo.data.Store",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Store",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "record",
+ "type" : "Roo.data.Record",
+ "desc" : "The Record that was updated",
+ "isOptional" : false
+ },
+ {
+ "name" : "operation",
+ "type" : "String",
+ "desc" : "The update operation being performed. Value may be one of:\n<pre><code>\n Roo.data.Record.EDIT\n Roo.data.Record.REJECT\n Roo.data.Record.COMMIT\n</code></pre>",
"isOptional" : false
}
],
],
"methods" : [
{
- "name" : "abort",
+ "name" : "add",
"type" : "function",
- "desc" : "Aborts any outstanding request.",
- "sig" : "(transactionId)",
+ "desc" : "Add Records to the Store and fires the add event.",
+ "sig" : "(records)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.data.Store",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "transactionId",
- "type" : "Number",
- "desc" : "(Optional) defaults to the last transaction",
+ "name" : "records",
+ "type" : "Roo.data.Record[]",
+ "desc" : "An Array of Roo.data.Record objects to add to the cache.",
"isOptional" : false
}
],
],
"returns" : []
},
+ {
+ "name" : "clearFilter",
+ "type" : "function",
+ "desc" : "Revert to a view of the Record cache with no filtering applied.",
+ "sig" : "(suppressEvent)",
+ "static" : false,
+ "memberOf" : "Roo.data.Store",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "suppressEvent",
+ "type" : "Boolean",
+ "desc" : "If true the filter is cleared silently without notifying listeners",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "collect",
+ "type" : "function",
+ "desc" : "Collects unique values for a particular dataIndex from this store.",
+ "sig" : "(dataIndex, allowNull, bypassFilter)",
+ "static" : false,
+ "memberOf" : "Roo.data.Store",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "dataIndex",
+ "type" : "String",
+ "desc" : "The property to collect",
+ "isOptional" : false
+ },
+ {
+ "name" : "allowNull",
+ "type" : "Boolean",
+ "desc" : "(optional) Pass true to allow null, undefined or empty string values",
+ "isOptional" : false
+ },
+ {
+ "name" : "bypassFilter",
+ "type" : "Boolean",
+ "desc" : "(optional) Pass true to collect from all records, even ones which are filtered",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Array",
+ "desc" : "An array of the unique values"
+ }
+ ]
+ },
+ {
+ "name" : "commitChanges",
+ "type" : "function",
+ "desc" : "Commit all Records with outstanding changes. To handle updates for changes, subscribe to the\nStore's \"update\" event, and perform updating when the third parameter is Roo.data.Record.COMMIT.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.data.Store",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
+ {
+ "name" : "each",
+ "type" : "function",
+ "desc" : "Calls the specified function for each of the Records in the cache.",
+ "sig" : "(fn, scope)",
+ "static" : false,
+ "memberOf" : "Roo.data.Store",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "fn",
+ "type" : "Function",
+ "desc" : "The function to call. The Record is passed as the first parameter.\nReturning <em>false</em> aborts and exits the iteration.",
+ "isOptional" : false
+ },
+ {
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "(optional) The scope in which to call the function (defaults to the Record).",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "filter",
+ "type" : "function",
+ "desc" : "Filter the records by a specified property.",
+ "sig" : "(field, value, anyMatch)",
+ "static" : false,
+ "memberOf" : "Roo.data.Store",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "field",
+ "type" : "String",
+ "desc" : "A field on your records",
+ "isOptional" : false
+ },
+ {
+ "name" : "value",
+ "type" : "String/RegExp",
+ "desc" : "Either a string that the field\nshould start with or a RegExp to test against the field",
+ "isOptional" : false
+ },
+ {
+ "name" : "anyMatch",
+ "type" : "Boolean",
+ "desc" : "True to match any part not just the beginning",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "filterBy",
+ "type" : "function",
+ "desc" : "Filter by a function. The specified function will be called with each\nrecord in this data source. If the function returns true the record is included,\notherwise it is filtered.",
+ "sig" : "(fn, scope)",
+ "static" : false,
+ "memberOf" : "Roo.data.Store",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "fn",
+ "type" : "Function",
+ "desc" : "The function to be called, it will receive 2 args (record, id)",
+ "isOptional" : false
+ },
+ {
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "(optional) The scope of the function (defaults to this)",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
{
"name" : "fireEvent",
"type" : "function",
]
},
{
- "name" : "hasListener",
+ "name" : "getAt",
"type" : "function",
- "desc" : "Checks to see if this object has any listeners for a specified event",
- "sig" : "(eventName)",
+ "desc" : "Get the Record at the specified index.",
+ "sig" : "(index)",
"static" : false,
- "memberOf" : "Roo.util.Observable",
+ "memberOf" : "Roo.data.Store",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "eventName",
- "type" : "String",
- "desc" : "The name of the event to check for",
+ "name" : "index",
+ "type" : "Number",
+ "desc" : "The index of the Record to find.",
"isOptional" : false
}
],
"returns" : [
{
"name" : "",
- "type" : "Boolean",
- "desc" : "True if the event is being listened for, else false"
+ "type" : "Roo.data.Record",
+ "desc" : "The Record at the passed index. Returns undefined if not found."
}
]
},
{
- "name" : "isLoading",
+ "name" : "getById",
"type" : "function",
- "desc" : "Determine whether this object has a request outstanding.",
- "sig" : "(transactionId)",
+ "desc" : "Get the Record with the specified id.",
+ "sig" : "(id)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.data.Store",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "transactionId",
- "type" : "Number",
- "desc" : "(Optional) defaults to the last transaction",
+ "name" : "id",
+ "type" : "String",
+ "desc" : "The id of the Record to find.",
"isOptional" : false
}
],
"returns" : [
{
"name" : "",
- "type" : "Boolean",
- "desc" : "True if there is an outstanding request."
+ "type" : "Roo.data.Record",
+ "desc" : "The Record with the passed id. Returns undefined if not found."
}
]
},
{
- "name" : "on",
+ "name" : "getCount",
"type" : "function",
- "desc" : "Appends an event handler to this element (shorthand for addListener)",
- "sig" : "(eventName, handler, scope, options)",
+ "desc" : "Gets the number of cached records.\n<p>\n<em>If using paging, this may not be the total size of the dataset. If the data object\nused by the Reader contains the dataset size, then the getTotalCount() function returns\nthe data set size</em>",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.util.Observable",
+ "memberOf" : "Roo.data.Store",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "eventName",
- "type" : "String",
- "desc" : "The type of event to listen for",
- "isOptional" : false
- },
+ "params" : [],
+ "returns" : []
+ },
+ {
+ "name" : "getModifiedRecords",
+ "type" : "function",
+ "desc" : "Gets all records modified since the last commit. Modified records are persisted across load operations\n(e.g., during paging).",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.data.Store",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : [
{
- "name" : "handler",
- "type" : "Function",
- "desc" : "The method the event invokes",
- "isOptional" : false
- },
+ "name" : "",
+ "type" : "Roo.data.Record[]",
+ "desc" : "An array of Records containing outstanding modifications."
+ }
+ ]
+ },
+ {
+ "name" : "getRange",
+ "type" : "function",
+ "desc" : "Returns a range of Records between specified indices.",
+ "sig" : "(startIndex, endIndex)",
+ "static" : false,
+ "memberOf" : "Roo.data.Store",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
{
- "name" : "scope",
- "type" : "Object",
- "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
+ "name" : "startIndex",
+ "type" : "Number",
+ "desc" : "(optional) The starting index (defaults to 0)",
"isOptional" : false
},
{
- "name" : "options",
- "type" : "Object",
- "desc" : "(optional)",
+ "name" : "endIndex",
+ "type" : "Number",
+ "desc" : "(optional) The ending index (defaults to the last Record in the Store)",
"isOptional" : false
}
],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.data.Record[]",
+ "desc" : "An array of Records"
+ }
+ ]
},
{
- "name" : "purgeListeners",
+ "name" : "getSortState",
"type" : "function",
- "desc" : "Removes all listeners for this object",
+ "desc" : "Returns the sort state of the Store as an object with two properties:\n<pre><code>\n field {String} The name of the field by which the Records are sorted\n direction {String} The sort order, \"ASC\" or \"DESC\"\n</code></pre>",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.util.Observable",
+ "memberOf" : "Roo.data.Store",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"returns" : []
},
{
- "name" : "releaseCapture",
+ "name" : "getTotalCount",
"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 total number of records in the dataset as returned by the server.\n<p>\n<em>If using paging, for this to be accurate, the data object used by the Reader must contain\nthe dataset size</em>",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.data.Store",
+ "isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"example" : "",
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "o",
- "type" : "Observable",
- "desc" : "The Observable to release",
- "isOptional" : false
- }
- ],
+ "params" : [],
"returns" : []
},
{
- "name" : "removeListener",
+ "name" : "hasListener",
"type" : "function",
- "desc" : "Removes a listener",
- "sig" : "(eventName, handler, scope)",
+ "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" : "The type of event to listen for",
- "isOptional" : false
- },
- {
- "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" : "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" : "request",
+ "name" : "indexOf",
"type" : "function",
- "desc" : "Sends an HTTP request to a remote server.",
- "sig" : "(options)",
+ "desc" : "Get the index within the cache of the passed Record.",
+ "sig" : "(record)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.data.Store",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "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>",
+ "name" : "record",
+ "type" : "Roo.data.Record",
+ "desc" : "The Roo.data.Record object to to find.",
"isOptional" : false
}
],
{
"name" : "",
"type" : "Number",
- "desc" : "transactionId"
+ "desc" : "The index of the passed Record. Returns -1 if not found."
}
]
},
{
- "name" : "un",
+ "name" : "indexOfId",
"type" : "function",
- "desc" : "Removes a listener (shorthand for removeListener)",
- "sig" : "(eventName, handler, scope)",
+ "desc" : "Get the index within the cache of the Record with the passed id.",
+ "sig" : "(id)",
"static" : false,
- "memberOf" : "Roo.util.Observable",
+ "memberOf" : "Roo.data.Store",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "eventName",
+ "name" : "id",
"type" : "String",
- "desc" : "The type of event to listen for",
- "isOptional" : false
- },
- {
- "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" : "The id of the Record to find.",
"isOptional" : false
}
],
- "returns" : []
- }
- ],
- "isAbstract" : false,
- "isBuilderTop" : false,
- "implementations" : [
- "Roo.Ajax"
- ],
- "tree_children" : [],
- "tree_parent" : []
- },
- "Roo.data.DataProxy" : {
- "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" : [
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Number",
+ "desc" : "The index of the Record. Returns -1 if not found."
+ }
+ ]
+ },
{
- "name" : "beforeload",
+ "name" : "insert",
"type" : "function",
- "desc" : "Fires before a network request is made to retrieve a data object.",
- "sig" : "function (This, params)\n{\n\n}",
- "memberOf" : "",
+ "desc" : "Inserts Records to the Store at the given index and fires the add event.",
+ "sig" : "(index, records)",
+ "static" : false,
+ "memberOf" : "Roo.data.Store",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
- "name" : "This",
- "type" : "Object",
- "desc" : "DataProxy object.",
+ "name" : "index",
+ "type" : "Number",
+ "desc" : "The start index at which to insert the passed Records.",
"isOptional" : false
},
{
- "name" : "params",
- "type" : "Object",
- "desc" : "The params parameter to the load function.",
+ "name" : "records",
+ "type" : "Roo.data.Record[]",
+ "desc" : "An Array of Roo.data.Record objects to add to the cache.",
"isOptional" : false
}
],
{
"name" : "load",
"type" : "function",
- "desc" : "Fires before the load method's callback is called.",
- "sig" : "function (This, o, arg)\n{\n\n}",
- "memberOf" : "",
+ "desc" : "Loads the Record cache from the configured Proxy using the configured Reader.\n<p>\nIf using remote paging, then the first load call must specify the <em>start</em>\nand <em>limit</em> properties in the options.params property to establish the initial\nposition within the dataset, and the number of Records to cache on each read from the Proxy.\n<p>\n<strong>It is important to note that for remote data sources, loading is asynchronous,\nand this call will return before the new data has been loaded. Perform any post-processing\nin a callback function, or in a \"load\" event handler.</strong>\n<p>",
+ "sig" : "(options)",
+ "static" : false,
+ "memberOf" : "Roo.data.Store",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
- "name" : "This",
- "type" : "Object",
- "desc" : "DataProxy object.",
- "isOptional" : false
- },
- {
- "name" : "o",
- "type" : "Object",
- "desc" : "The data object.",
- "isOptional" : false
- },
- {
- "name" : "arg",
+ "name" : "options",
"type" : "Object",
- "desc" : "The callback argument object passed to the load function.",
+ "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
}
],
"returns" : []
},
{
- "name" : "loadexception",
+ "name" : "loadData",
"type" : "function",
- "desc" : "Fires if an Exception occurs during data retrieval.",
- "sig" : "function (This, o, arg, e)\n{\n\n}",
- "memberOf" : "",
+ "desc" : "Loads data from a passed data block. A Reader which understands the format of the data\nmust have been configured in the constructor.",
+ "sig" : "(data, append)",
+ "static" : false,
+ "memberOf" : "Roo.data.Store",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
- "name" : "This",
- "type" : "Object",
- "desc" : "DataProxy object.",
- "isOptional" : false
- },
- {
- "name" : "o",
- "type" : "Object",
- "desc" : "The data object.",
- "isOptional" : false
- },
- {
- "name" : "arg",
+ "name" : "data",
"type" : "Object",
- "desc" : "The callback argument object passed to the load function.",
+ "desc" : "The data block from which to read the Records. The format of the data expected\nis dependent on the type of Reader that is configured and should correspond to that Reader's readRecords parameter.",
"isOptional" : false
},
{
- "name" : "e",
- "type" : "Object",
- "desc" : "The Exception.",
+ "name" : "append",
+ "type" : "Boolean",
+ "desc" : "True to append the new Records rather than replace the existing cache.",
"isOptional" : false
}
],
"returns" : []
- }
- ],
- "methods" : [
+ },
{
- "name" : "addEvents",
+ "name" : "loadDataFromChildren",
"type" : "function",
- "desc" : "Used to define events on this Observable",
- "sig" : "(object)",
+ "desc" : "using 'cn' the nested child reader read the child array into it's child stores.",
+ "sig" : "(rec)",
"static" : false,
- "memberOf" : "Roo.util.Observable",
+ "memberOf" : "Roo.data.Store",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "object",
+ "name" : "rec",
"type" : "Object",
- "desc" : "The object with the events defined",
+ "desc" : "The record with a 'children array",
"isOptional" : false
}
],
"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" : "capture",
+ "name" : "purgeListeners",
"type" : "function",
- "desc" : "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 all listeners for this object",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
"memberOf" : "Roo.util.Observable",
- "isStatic" : true,
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
+ {
+ "name" : "query",
+ "type" : "function",
+ "desc" : "Query the records by a specified property.",
+ "sig" : "(field, value, anyMatch)",
+ "static" : false,
+ "memberOf" : "Roo.data.Store",
+ "isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"example" : "",
"requires" : "",
"params" : [
{
- "name" : "o",
- "type" : "Observable",
- "desc" : "The Observable to capture",
+ "name" : "field",
+ "type" : "String",
+ "desc" : "A field on your records",
"isOptional" : false
},
{
- "name" : "fn",
- "type" : "Function",
- "desc" : "The function to call",
+ "name" : "value",
+ "type" : "String/RegExp",
+ "desc" : "Either a string that the field\nshould start with or a RegExp to test against the field",
"isOptional" : false
},
{
- "name" : "scope",
- "type" : "Object",
- "desc" : "(optional) The scope (this object) for the fn",
+ "name" : "anyMatch",
+ "type" : "Boolean",
+ "desc" : "True to match any part not just the beginning",
"isOptional" : false
}
],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "MixedCollection",
+ "desc" : "Returns an Roo.util.MixedCollection of the matched records"
+ }
+ ]
},
{
- "name" : "fireEvent",
+ "name" : "queryBy",
"type" : "function",
- "desc" : "Fires the specified event with the passed parameters (minus the event name).",
- "sig" : "(eventName, args)",
+ "desc" : "Query by a function. The specified function will be called with each\nrecord in this data source. If the function returns true the record is included\nin the results.",
+ "sig" : "(fn, scope)",
"static" : false,
- "memberOf" : "Roo.util.Observable",
+ "memberOf" : "Roo.data.Store",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "eventName",
- "type" : "String",
- "desc" : "",
+ "name" : "fn",
+ "type" : "Function",
+ "desc" : "The function to be called, it will receive 2 args (record, id)",
"isOptional" : false
},
{
- "name" : "args",
- "type" : "Object...",
- "desc" : "Variable number of parameters are passed to handlers",
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "(optional) The scope of the function (defaults to this)",
"isOptional" : false
}
],
"returns" : [
{
"name" : "",
- "type" : "Boolean",
- "desc" : "returns false if any of the handlers return false otherwise it returns true"
+ "type" : "MixedCollection",
+ "desc" : "Returns an Roo.util.MixedCollection of the matched records"
}
]
},
{
- "name" : "hasListener",
+ "name" : "rejectChanges",
"type" : "function",
- "desc" : "Checks to see if this object has any listeners for a specified event",
- "sig" : "(eventName)",
+ "desc" : "Cancel outstanding changes on all changed records.",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.util.Observable",
+ "memberOf" : "Roo.data.Store",
"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" : "eventName",
- "type" : "String",
- "desc" : "The name of the event to check for",
+ "name" : "o",
+ "type" : "Observable",
+ "desc" : "The Observable to release",
"isOptional" : false
}
],
- "returns" : [
- {
- "name" : "",
- "type" : "Boolean",
- "desc" : "True if the event is being listened for, else false"
- }
- ]
+ "returns" : []
},
{
- "name" : "on",
+ "name" : "reload",
"type" : "function",
- "desc" : "Appends an event handler to this element (shorthand for addListener)",
- "sig" : "(eventName, handler, scope, options)",
+ "desc" : "Reloads the Record cache from the configured Proxy using the configured Reader and\nthe options from the last load operation performed.",
+ "sig" : "(options)",
"static" : false,
- "memberOf" : "Roo.util.Observable",
+ "memberOf" : "Roo.data.Store",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"exceptions" : "",
"requires" : "",
"params" : [
- {
- "name" : "eventName",
- "type" : "String",
- "desc" : "The type of event to listen for",
- "isOptional" : false
- },
- {
- "name" : "handler",
- "type" : "Function",
- "desc" : "The method the event invokes",
- "isOptional" : false
- },
- {
- "name" : "scope",
- "type" : "Object",
- "desc" : "(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) An object containing properties which may override the options\nused in the last load operation. See {@link #load} for details (defaults to null, in which case\nthe most recently used options are reused).",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "purgeListeners",
+ "name" : "remove",
"type" : "function",
- "desc" : "Removes all listeners for this object",
- "sig" : "()\n{\n\n}",
+ "desc" : "Remove a Record from the Store and fires the remove event.",
+ "sig" : "(record)",
"static" : false,
- "memberOf" : "Roo.util.Observable",
+ "memberOf" : "Roo.data.Store",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
+ "params" : [
+ {
+ "name" : "record",
+ "type" : "Ext.data.Record",
+ "desc" : "The Roo.data.Record object to remove from the cache.",
+ "isOptional" : false
+ }
+ ],
"returns" : []
},
{
- "name" : "releaseCapture",
+ "name" : "removeAll",
"type" : "function",
- "desc" : "Removes <b>all</b> added captures from the Observable.",
- "sig" : "(o)",
- "static" : true,
- "memberOf" : "Roo.util.Observable",
- "isStatic" : true,
+ "desc" : "Remove all Records from the Store and fires the clear event.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.data.Store",
+ "isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"example" : "",
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "o",
- "type" : "Observable",
- "desc" : "The Observable to release",
- "isOptional" : false
- }
- ],
+ "params" : [],
"returns" : []
},
{
"returns" : []
},
{
- "name" : "un",
+ "name" : "setDefaultSort",
"type" : "function",
- "desc" : "Removes a listener (shorthand for removeListener)",
- "sig" : "(eventName, handler, scope)",
+ "desc" : "Sets the default sort column and order to be used by the next load operation.",
+ "sig" : "(fieldName, dir)",
"static" : false,
- "memberOf" : "Roo.util.Observable",
+ "memberOf" : "Roo.data.Store",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "eventName",
+ "name" : "fieldName",
"type" : "String",
- "desc" : "The type of event to listen for",
+ "desc" : "The name of the field to sort by.",
"isOptional" : false
},
{
- "name" : "handler",
- "type" : "Function",
- "desc" : "The handler to remove",
+ "name" : "dir",
+ "type" : "String",
+ "desc" : "(optional) The sort order, \"ASC\" or \"DESC\" (defaults to \"ASC\")",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "sort",
+ "type" : "function",
+ "desc" : "Sort the Records.\nIf remote sorting is used, the sort is performed on the server, and the cache is\nreloaded. If local sorting is used, the cache is sorted internally.",
+ "sig" : "(fieldName, dir)",
+ "static" : false,
+ "memberOf" : "Roo.data.Store",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "fieldName",
+ "type" : "String",
+ "desc" : "The name of the field to sort by.",
"isOptional" : false
},
{
- "name" : "scope",
- "type" : "Object",
- "desc" : "(optional) The scope (this object) for the handler",
+ "name" : "dir",
+ "type" : "String",
+ "desc" : "(optional) The sort order, \"ASC\" or \"DESC\" (defaults to \"ASC\")",
"isOptional" : false
}
],
"returns" : []
- }
- ],
- "isAbstract" : true,
- "isBuilderTop" : false,
- "implementations" : [
- "Roo.data.HttpProxy"
- ],
- "tree_children" : [],
- "tree_parent" : []
- },
- "Roo.data.DataReader" : {
- "props" : [],
- "events" : [],
- "methods" : [
+ },
{
- "name" : "newRow",
+ "name" : "sum",
"type" : "function",
- "desc" : "Create an empty record",
- "sig" : "(data)",
+ "desc" : "Sums the value of <i>property</i> for each record between start and end and returns the result.",
+ "sig" : "(property, start, end)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.data.Store",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "data",
- "type" : "Object",
- "desc" : "(optional) - overlay some values",
+ "name" : "property",
+ "type" : "String",
+ "desc" : "A field on your records",
+ "isOptional" : false
+ },
+ {
+ "name" : "start",
+ "type" : "Number",
+ "desc" : "The record index to start at (defaults to 0)",
+ "isOptional" : false
+ },
+ {
+ "name" : "end",
+ "type" : "Number",
+ "desc" : "The last record index to include (defaults to length - 1)",
"isOptional" : false
}
],
"returns" : [
{
"name" : "",
- "type" : "Roo.data.Record",
- "desc" : "record created."
+ "type" : "Number",
+ "desc" : "The sum"
}
]
+ },
+ {
+ "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" : true,
+ "isAbstract" : false,
"isBuilderTop" : false,
- "implementations" : [
- "Roo.data.ArrayReader",
- "Roo.data.JsonReader",
- "Roo.data.XmlReader"
- ],
+ "implementations" : [],
"tree_children" : [],
"tree_parent" : []
},
- "Roo.data.HttpProxy" : {
+ "Roo.data.MemoryProxy" : {
"props" : [
{
- "name" : "autoAbort",
- "type" : "Boolean",
- "desc" : "(Optional) Whether this request should abort any pending requests. (defaults to false)",
- "memberOf" : ""
- },
- {
- "name" : "defaultHeaders",
- "type" : "Object",
- "desc" : "(Optional) An object containing request headers which are added\n to each request made by this object. (defaults to undefined)",
- "memberOf" : ""
- },
- {
- "name" : "disableCaching",
- "type" : "Boolean",
- "desc" : "(Optional) True to add a unique cache-buster param to GET requests. (defaults to true)",
- "memberOf" : ""
- },
- {
- "name" : "extraParams",
+ "name" : "data",
"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" : "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"
- },
- {
- "name" : "method",
- "type" : "String",
- "desc" : "(Optional) The default HTTP method to be used for requests. (defaults to undefined; if not set but parms are present will use POST, otherwise GET)",
- "memberOf" : ""
- },
- {
- "name" : "timeout",
- "type" : "Number",
- "desc" : "(Optional) The timeout in milliseconds to be used for requests. (defaults to 30000)",
- "memberOf" : ""
- },
- {
- "name" : "url",
- "type" : "String",
- "desc" : "(Optional) The default URL to be used for requests to the server. (defaults to undefined)",
- "memberOf" : ""
+ "memberOf" : "Roo.util.Observable",
+ "isOptional" : false,
+ "optvals" : []
}
],
"events" : [
}
]
},
- {
- "name" : "getConnection",
- "type" : "function",
- "desc" : "Return the {@link Roo.data.Connection} object being used by this Proxy.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : [
- {
- "name" : "",
- "type" : "Connection",
- "desc" : "The Connection object. This object may be used to subscribe to events on\na finer-grained basis than the DataProxy events."
- }
- ]
- },
{
"name" : "hasListener",
"type" : "function",
{
"name" : "load",
"type" : "function",
- "desc" : "Load data from the configured {@link Roo.data.Connection}, read the data object into\na block of Roo.data.Records using the passed {@link Roo.data.DataReader} implementation, and\nprocess that block using the passed callback.",
+ "desc" : "Load data from the requested source (in this case an in-memory\ndata object passed to the constructor), read the data object into\na block of Roo.data.Records using the passed Roo.data.DataReader implementation, and\nprocess that block using the passed callback.",
"sig" : "(params, reader, callback, scope, arg)",
"static" : false,
"memberOf" : "",
{
"name" : "params",
"type" : "Object",
- "desc" : "An object containing properties which are to be used as HTTP parameters\nfor the request to the remote server.",
+ "desc" : "This parameter is not used by the MemoryProxy class.",
"isOptional" : false
},
{
{
"name" : "callback",
"type" : "Function",
- "desc" : "The function into which to pass the block of Roo.data.
Records.\nThe function must be passed <ul>\n<li>The Record block object</li>\n<li>The \"arg\" argument from the load function</li>\n<li>A boolean success indicator</li>\n</ul>",
+ "desc" : "The function into which to pass the block of Roo.data.
records.\nThe function must be passed <ul>\n<li>The Record block object</li>\n<li>The \"arg\" argument from the load function</li>\n<li>A boolean success indicator</li>\n</ul>",
"isOptional" : false
},
{
"tree_children" : [],
"tree_parent" : []
},
- "Roo.data.JsonReader" : {
+ "Roo.data.Node" : {
"props" : [
- {
- "name" : "fields",
- "type" : "Array",
- "desc" : "Array of field definition objects",
- "memberOf" : ""
- },
{
"name" : "id",
"type" : "String",
- "desc" : "Name of the property within a row object that contains a record identifier value.",
- "memberOf" : ""
- },
- {
- "name" : "root",
- "type" : "String",
- "desc" : "name of the property which contains the Array of row objects.",
- "memberOf" : ""
- },
- {
- "name" : "successProperty",
- "type" : "String",
- "desc" : "Name of the property from which to retrieve the success attribute used by forms.",
- "memberOf" : ""
- },
- {
- "name" : "totalProperty",
- "type" : "String",
- "desc" : "Name of the property from which to retrieve the total number of records\nin the dataset. This is only needed if the whole dataset is not passed in one go, but is being\npaged from the remote server.",
- "memberOf" : ""
- }
- ],
- "events" : [],
- "methods" : [
- {
- "name" : "newRow",
- "type" : "function",
- "desc" : "Create an empty record",
- "sig" : "(data)",
- "static" : false,
- "memberOf" : "Roo.data.DataReader",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "data",
- "type" : "Object",
- "desc" : "(optional) - overlay some values",
- "isOptional" : false
- }
- ],
- "returns" : [
- {
- "name" : "",
- "type" : "Roo.data.Record",
- "desc" : "record created."
- }
- ]
- },
- {
- "name" : "read",
- "type" : "function",
- "desc" : "This method is only used by a DataProxy which has retrieved data from a remote server.",
- "sig" : "(response)",
- "static" : false,
+ "desc" : "The id for this node. If one is not specified, one is generated.",
"memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "response",
- "type" : "Object",
- "desc" : "The XHR object which contains the JSON data in its responseText.",
- "isOptional" : false
- }
- ],
- "returns" : [
- {
- "name" : "",
- "type" : "Object",
- "desc" : "data A data block which is used by an Roo.data.Store object as\na cache of Roo.data.Records."
- }
- ]
+ "isOptional" : false,
+ "optvals" : []
},
{
- "name" : "readRecords",
- "type" : "function",
- "desc" : "Create a data block containing Roo.data.Records from an XML document.",
- "sig" : "(o)",
- "static" : false,
+ "name" : "leaf",
+ "type" : "Boolean",
+ "desc" : "true if this node is a leaf and does not have children",
"memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "o",
- "type" : "Object",
- "desc" : "An object which contains an Array of row objects in the property specified\nin the config as 'root, and optionally a property, specified in the config as 'totalProperty'\nwhich contains the total size of the dataset.",
- "isOptional" : false
- }
- ],
- "returns" : [
- {
- "name" : "",
- "type" : "Object",
- "desc" : "data A data block which is used by an Roo.data.Store object as\na cache of Roo.data.Records."
- }
- ]
- }
- ],
- "isAbstract" : false,
- "isBuilderTop" : false,
- "implementations" : [],
- "tree_children" : [],
- "tree_parent" : []
- },
- "Roo.data.JsonStore" : {
- "props" : [
- {
- "name" : "baseParams",
- "type" : "Object",
- "desc" : "An object containing properties which are to be sent as parameters\non any HTTP request",
- "memberOf" : "Roo.data.Store"
- },
- {
- "name" : "data",
- "type" : "Array",
- "desc" : "Inline data to be loaded when the store is initialized.",
- "memberOf" : "Roo.data.Store"
- },
- {
- "name" : "fields",
- "type" : "Array",
- "desc" : "An array of field definition objects, or field name strings.",
- "memberOf" : ""
- },
- {
- "name" : "isLocal",
- "type" : "boolean",
- "desc" : "flag if data is locally available (and can be always looked up\nwithout a remote query - used by combo/forms at present.",
- "memberOf" : "Roo.data.Store"
+ "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" : "multiSort",
- "type" : "Boolean",
- "desc" : "enable multi column sorting (sort is based on the order of columns, remote only at present)",
- "memberOf" : "Roo.data.Store"
- },
- {
- "name" : "proxy",
- "type" : "Roo.data.DataProxy",
- "desc" : "[required] The Proxy object which provides access to a data object.",
- "memberOf" : "Roo.data.Store"
- },
- {
- "name" : "pruneModifiedRecords",
- "type" : "boolean",
- "desc" : "True to clear all modified record information each time the store is\nloaded or when a record is removed. (defaults to false).",
- "memberOf" : "Roo.data.Store"
- },
- {
- "name" : "reader",
- "type" : "Roo.data.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"
- },
- {
- "name" : "remoteSort",
- "type" : "boolean",
- "desc" : "True if sorting is to be handled by requesting the Proxy to provide a refreshed\nversion of the data object in sorted order, as opposed to sorting the Record cache in place (defaults to false).",
- "memberOf" : "Roo.data.Store"
- },
- {
- "name" : "sortInfo",
- "type" : "Object",
- "desc" : "A config object in the format: {field: \"fieldName\", direction: \"ASC|DESC\"}",
- "memberOf" : "Roo.data.Store"
+ "memberOf" : "Roo.util.Observable",
+ "isOptional" : false,
+ "optvals" : []
}
],
"events" : [
{
- "name" : "add",
+ "name" : "append",
"type" : "function",
- "desc" : "Fires when Records have been added to the Store",
- "sig" : "function (_self, records, index)\n{\n\n}",
- "memberOf" : "Roo.data.Store",
+ "desc" : "Fires when a new child node is appended",
+ "sig" : "function (tree, _self, node, index)\n{\n\n}",
+ "memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
"params" : [
+ {
+ "name" : "tree",
+ "type" : "Tree",
+ "desc" : "The owner tree",
+ "isOptional" : false
+ },
{
"name" : "this",
- "type" : "Store",
- "desc" : "",
+ "type" : "Node",
+ "desc" : "This node",
"isOptional" : false
},
{
- "name" : "records",
- "type" : "Roo.data.Record[]",
- "desc" : "The array of Records added",
+ "name" : "node",
+ "type" : "Node",
+ "desc" : "The newly appended node",
"isOptional" : false
},
{
"name" : "index",
"type" : "Number",
- "desc" : "The index at which the record(s) were added",
+ "desc" : "The index of the newly appended node",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "beforeload",
+ "name" : "beforeappend",
"type" : "function",
- "desc" : "Fires before a request is made for a new data object. If the beforeload handler returns false\nthe load action will be canceled.",
- "sig" : "function (_self, options)\n{\n\n}",
- "memberOf" : "Roo.data.Store",
+ "desc" : "Fires before a new child is appended, return false to cancel the append.",
+ "sig" : "function (tree, _self, node)\n{\n\n}",
+ "memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
"params" : [
+ {
+ "name" : "tree",
+ "type" : "Tree",
+ "desc" : "The owner tree",
+ "isOptional" : false
+ },
{
"name" : "this",
- "type" : "Store",
- "desc" : "",
+ "type" : "Node",
+ "desc" : "This node",
"isOptional" : false
},
{
- "name" : "options",
- "type" : "Object",
- "desc" : "The loading options that were specified (see {@link #load} for details)",
+ "name" : "node",
+ "type" : "Node",
+ "desc" : "The child node to be appended",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "beforeloadadd",
+ "name" : "beforeinsert",
"type" : "function",
- "desc" : "Fires after a new set of Records has been loaded.",
- "sig" : "function (_self, records, options)\n{\n\n}",
- "memberOf" : "Roo.data.Store",
+ "desc" : "Fires before a new child is inserted, return false to cancel the insert.",
+ "sig" : "function (tree, _self, node, refNode)\n{\n\n}",
+ "memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
"params" : [
+ {
+ "name" : "tree",
+ "type" : "Tree",
+ "desc" : "The owner tree",
+ "isOptional" : false
+ },
{
"name" : "this",
- "type" : "Store",
- "desc" : "",
+ "type" : "Node",
+ "desc" : "This node",
"isOptional" : false
},
{
- "name" : "records",
- "type" : "Roo.data.Record[]",
- "desc" : "The Records that were loaded",
+ "name" : "node",
+ "type" : "Node",
+ "desc" : "The child node to be inserted",
"isOptional" : false
},
{
- "name" : "options",
- "type" : "Object",
- "desc" : "The loading options that were specified (see {@link #load} for details)",
+ "name" : "refNode",
+ "type" : "Node",
+ "desc" : "The child node the node is being inserted before",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "clear",
+ "name" : "beforemove",
"type" : "function",
- "desc" : "Fires when the data cache has been cleared.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.data.Store",
+ "desc" : "Fires before this node is moved to a new location in the tree. Return false to cancel the move.",
+ "sig" : "function (tree, _self, oldParent, newParent, index)\n{\n\n}",
+ "memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
"params" : [
{
- "name" : "this",
- "type" : "Store",
- "desc" : "",
+ "name" : "tree",
+ "type" : "Tree",
+ "desc" : "The owner tree",
"isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "datachanged",
- "type" : "function",
- "desc" : "Fires when the data cache has changed, and a widget which is using this Store\nas a Record cache should refresh its view.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.data.Store",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
+ },
{
"name" : "this",
- "type" : "Store",
- "desc" : "",
+ "type" : "Node",
+ "desc" : "This node",
"isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "load",
- "type" : "function",
- "desc" : "Fires after a new set of Records has been loaded, before they are added to the store.",
- "sig" : "function (_self, records, options)\n{\n\n}",
- "memberOf" : "Roo.data.Store",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
+ },
{
- "name" : "this",
- "type" : "Store",
- "desc" : "",
+ "name" : "oldParent",
+ "type" : "Node",
+ "desc" : "The parent of this node",
"isOptional" : false
},
{
- "name" : "records",
- "type" : "Roo.data.Record[]",
- "desc" : "The Records that were loaded",
+ "name" : "newParent",
+ "type" : "Node",
+ "desc" : "The new parent this node is moving to",
"isOptional" : false
},
{
- "name" : "options",
- "type" : "Object",
- "desc" : "The loading options that were specified (see {@link #load} for details)",
+ "name" : "index",
+ "type" : "Number",
+ "desc" : "The index it is being moved to",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "loadexception",
+ "name" : "beforeremove",
"type" : "function",
- "desc" : "Fires if an exception occurs in the Proxy during loading.\nCalled with the signature of the Proxy's \"loadexception\" event.\nIf you return Json { data: [] , success: false, .... } then this will be thrown with the following args",
- "sig" : "function (, return, load, jsonData)\n{\n\n}",
- "memberOf" : "Roo.data.Store",
+ "desc" : "Fires before a child is removed, return false to cancel the remove.",
+ "sig" : "function (tree, _self, node)\n{\n\n}",
+ "memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
"params" : [
{
- "name" : "",
- "type" : "Proxy",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "return",
- "type" : "Object",
- "desc" : "from JsonData.reader() - success, totalRecords, records",
+ "name" : "tree",
+ "type" : "Tree",
+ "desc" : "The owner tree",
"isOptional" : false
},
{
- "name" : "load",
- "type" : "Object",
- "desc" : "options",
+ "name" : "this",
+ "type" : "Node",
+ "desc" : "This node",
"isOptional" : false
},
{
- "name" : "jsonData",
- "type" : "Object",
- "desc" : "from your request (normally this contains the Exception)",
+ "name" : "node",
+ "type" : "Node",
+ "desc" : "The child node to be removed",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "metachange",
+ "name" : "insert",
"type" : "function",
- "desc" : "Fires when this store's reader provides new metadata (fields). This is currently only support for JsonReaders.",
- "sig" : "function (_self, meta)\n{\n\n}",
- "memberOf" : "Roo.data.Store",
+ "desc" : "Fires when a new child node is inserted.",
+ "sig" : "function (tree, _self, node, refNode)\n{\n\n}",
+ "memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
"params" : [
+ {
+ "name" : "tree",
+ "type" : "Tree",
+ "desc" : "The owner tree",
+ "isOptional" : false
+ },
{
"name" : "this",
- "type" : "Store",
- "desc" : "",
+ "type" : "Node",
+ "desc" : "This node",
"isOptional" : false
},
{
- "name" : "meta",
- "type" : "Object",
- "desc" : "The JSON metadata",
+ "name" : "node",
+ "type" : "Node",
+ "desc" : "The child node inserted",
+ "isOptional" : false
+ },
+ {
+ "name" : "refNode",
+ "type" : "Node",
+ "desc" : "The child node the node was inserted before",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "remove",
+ "name" : "move",
"type" : "function",
- "desc" : "Fires when a Record has been removed from the Store",
- "sig" : "function (_self, record, index)\n{\n\n}",
- "memberOf" : "Roo.data.Store",
+ "desc" : "Fires when this node is moved to a new location in the tree",
+ "sig" : "function (tree, _self, oldParent, newParent, index)\n{\n\n}",
+ "memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
"params" : [
+ {
+ "name" : "tree",
+ "type" : "Tree",
+ "desc" : "The owner tree",
+ "isOptional" : false
+ },
{
"name" : "this",
- "type" : "Store",
- "desc" : "",
+ "type" : "Node",
+ "desc" : "This node",
"isOptional" : false
},
{
- "name" : "record",
- "type" : "Roo.data.Record",
- "desc" : "The Record that was removed",
+ "name" : "oldParent",
+ "type" : "Node",
+ "desc" : "The old parent of this node",
+ "isOptional" : false
+ },
+ {
+ "name" : "newParent",
+ "type" : "Node",
+ "desc" : "The new parent of this node",
"isOptional" : false
},
{
"name" : "index",
"type" : "Number",
- "desc" : "The index at which the record was removed",
+ "desc" : "The index it was moved to",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "update",
+ "name" : "remove",
"type" : "function",
- "desc" : "Fires when a Record has been updated",
- "sig" : "function (_self, record, operation)\n{\n\n}",
- "memberOf" : "Roo.data.Store",
+ "desc" : "Fires when a child node is removed",
+ "sig" : "function (tree, _self, node)\n{\n\n}",
+ "memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
"params" : [
{
- "name" : "this",
- "type" : "Store",
- "desc" : "",
+ "name" : "tree",
+ "type" : "Tree",
+ "desc" : "The owner tree",
"isOptional" : false
},
{
- "name" : "record",
- "type" : "Roo.data.Record",
- "desc" : "The Record that was updated",
+ "name" : "this",
+ "type" : "Node",
+ "desc" : "This node",
"isOptional" : false
},
{
- "name" : "operation",
- "type" : "String",
- "desc" : "The update operation being performed. Value may be one of:\n<pre><code>\n Roo.data.Record.EDIT\n Roo.data.Record.REJECT\n Roo.data.Record.COMMIT\n</code></pre>",
+ "name" : "node",
+ "type" : "Node",
+ "desc" : "The removed node",
"isOptional" : false
}
],
}
],
"methods" : [
- {
- "name" : "add",
- "type" : "function",
- "desc" : "Add Records to the Store and fires the add event.",
- "sig" : "(records)",
- "static" : false,
- "memberOf" : "Roo.data.Store",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "records",
- "type" : "Roo.data.Record[]",
- "desc" : "An Array of Roo.data.Record objects to add to the cache.",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
{
"name" : "addEvents",
"type" : "function",
"returns" : []
},
{
- "name" : "capture",
+ "name" : "appendChild",
"type" : "function",
- "desc" : "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" : "Insert node(s) as the last child node of this node.",
+ "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" : "Node/Array",
+ "desc" : "The node or Array of nodes to append",
"isOptional" : false
}
],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Node",
+ "desc" : "The appended node if single append, or null if an array was passed"
+ }
+ ]
},
{
- "name" : "clearFilter",
+ "name" : "bubble",
"type" : "function",
- "desc" : "Revert to a view of the Record cache with no filtering applied.",
- "sig" : "(suppressEvent)",
+ "desc" : "Bubbles up the tree from this node, calling the specified function with each node. The scope (<i>this</i>) of\nfunction call will be the scope provided or the current node. The arguments to the function\nwill be the args provided or the current node. If the function returns false at any point,\nthe bubble is stopped.",
+ "sig" : "(fn, scope, args)",
"static" : false,
- "memberOf" : "Roo.data.Store",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "suppressEvent",
- "type" : "Boolean",
- "desc" : "If true the filter is cleared silently without notifying listeners",
+ "name" : "fn",
+ "type" : "Function",
+ "desc" : "The function to call",
+ "isOptional" : false
+ },
+ {
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "(optional) The scope of the function (defaults to current node)",
+ "isOptional" : false
+ },
+ {
+ "name" : "args",
+ "type" : "Array",
+ "desc" : "(optional) The args to call the function with (default to passing the current node)",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "collect",
+ "name" : "capture",
"type" : "function",
- "desc" : "Collects unique values for a particular dataIndex from this store.",
- "sig" : "(dataIndex, allowNull, bypassFilter)",
- "static" : false,
- "memberOf" : "Roo.data.Store",
- "isStatic" : false,
+ "desc" : "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" : "dataIndex",
- "type" : "String",
- "desc" : "The property to collect",
+ "name" : "o",
+ "type" : "Observable",
+ "desc" : "The Observable to capture",
"isOptional" : false
},
{
- "name" : "allowNull",
- "type" : "Boolean",
- "desc" : "(optional) Pass true to allow null, undefined or empty string values",
+ "name" : "fn",
+ "type" : "Function",
+ "desc" : "The function to call",
"isOptional" : false
},
{
- "name" : "bypassFilter",
- "type" : "Boolean",
- "desc" : "(optional) Pass true to collect from all records, even ones which are filtered",
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "(optional) The scope (this object) for the fn",
"isOptional" : false
}
],
- "returns" : [
- {
- "name" : "",
- "type" : "Array",
- "desc" : "An array of the unique values"
- }
- ]
- },
- {
- "name" : "commitChanges",
- "type" : "function",
- "desc" : "Commit all Records with outstanding changes. To handle updates for changes, subscribe to the\nStore's \"update\" event, and perform updating when the third parameter is Roo.data.Record.COMMIT.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.data.Store",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
"returns" : []
},
{
- "name" : "each",
+ "name" : "cascade",
"type" : "function",
- "desc" : "Calls the specified function for each of the Records in the cache.",
- "sig" : "(fn, scope)",
+ "desc" : "Cascades down the tree from this node, calling the specified function with each node. The scope (<i>this</i>) of\nfunction call will be the scope provided or the current node. The arguments to the function\nwill be the args provided or the current node. If the function returns false at any point,\nthe cascade is stopped on that branch.",
+ "sig" : "(fn, scope, args)",
"static" : false,
- "memberOf" : "Roo.data.Store",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
{
"name" : "fn",
"type" : "Function",
- "desc" : "The function to call. The Record is passed as the first parameter.\nReturning <em>false</em> aborts and exits the iteration.",
+ "desc" : "The function to call",
"isOptional" : false
},
{
"name" : "scope",
"type" : "Object",
- "desc" : "(optional) The scope in which to call the function (defaults to the Record).",
+ "desc" : "(optional) The scope of the function (defaults to current node)",
+ "isOptional" : false
+ },
+ {
+ "name" : "args",
+ "type" : "Array",
+ "desc" : "(optional) The args to call the function with (default to passing the current node)",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "filter",
+ "name" : "contains",
"type" : "function",
- "desc" : "Filter the records by a specified property.",
- "sig" : "(field, value, anyMatch)",
+ "desc" : "Returns true if this node is an ancestor (at any point) of the passed node.",
+ "sig" : "(node)",
"static" : false,
- "memberOf" : "Roo.data.Store",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "field",
- "type" : "String",
- "desc" : "A field on your records",
- "isOptional" : false
- },
- {
- "name" : "value",
- "type" : "String/RegExp",
- "desc" : "Either a string that the field\nshould start with or a RegExp to test against the field",
+ "name" : "node",
+ "type" : "Node",
+ "desc" : "",
"isOptional" : false
- },
+ }
+ ],
+ "returns" : [
{
- "name" : "anyMatch",
+ "name" : "",
"type" : "Boolean",
- "desc" : "True to match any part not just the beginning",
- "isOptional" : false
+ "desc" : ""
}
- ],
- "returns" : []
+ ]
},
{
- "name" : "filterBy",
+ "name" : "eachChild",
"type" : "function",
- "desc" : "Filter by a function. The specified function will be called with each\nrecord in this data source. If the function returns true the record is included,\notherwise it is filtered.",
- "sig" : "(fn, scope)",
+ "desc" : "Interates the child nodes of this node, calling the specified function with each node. The scope (<i>this</i>) of\nfunction call will be the scope provided or the current node. The arguments to the function\nwill be the args provided or the current node. If the function returns false at any point,\nthe iteration stops.",
+ "sig" : "(fn, scope, args)",
"static" : false,
- "memberOf" : "Roo.data.Store",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
{
"name" : "fn",
"type" : "Function",
- "desc" : "The function to be called, it will receive 2 args (record, id)",
+ "desc" : "The function to call",
"isOptional" : false
},
{
"name" : "scope",
"type" : "Object",
- "desc" : "(optional) The scope of the function (defaults to this)",
+ "desc" : "(optional) The scope of the function (defaults to current node)",
+ "isOptional" : false
+ },
+ {
+ "name" : "args",
+ "type" : "Array",
+ "desc" : "(optional) The args to call the function with (default to passing the current node)",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "fireEvent",
+ "name" : "findChild",
"type" : "function",
- "desc" : "Fires the specified event with the passed parameters (minus the event name).",
- "sig" : "(eventName, args)",
+ "desc" : "Finds the first child that has the attribute with the specified value.",
+ "sig" : "(attribute, value)",
"static" : false,
- "memberOf" : "Roo.util.Observable",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "eventName",
+ "name" : "attribute",
"type" : "String",
- "desc" : "",
+ "desc" : "The attribute name",
"isOptional" : false
},
{
- "name" : "args",
- "type" : "Object...",
- "desc" : "Variable number of parameters are passed to handlers",
+ "name" : "value",
+ "type" : "Mixed",
+ "desc" : "The value to search for",
"isOptional" : false
}
],
"returns" : [
{
"name" : "",
- "type" : "Boolean",
- "desc" : "returns false if any of the handlers return false otherwise it returns true"
+ "type" : "Node",
+ "desc" : "The found child or null if none was found"
}
]
},
{
- "name" : "getAt",
+ "name" : "findChildBy",
"type" : "function",
- "desc" : "Get the Record at the specified index.",
- "sig" : "(index)",
+ "desc" : "Finds the first child by a custom function. The child matches if the function passed\nreturns true.",
+ "sig" : "(fn, scope)",
"static" : false,
- "memberOf" : "Roo.data.Store",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "index",
- "type" : "Number",
- "desc" : "The index of the Record to find.",
+ "name" : "fn",
+ "type" : "Function",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "(optional)",
"isOptional" : false
}
],
"returns" : [
{
"name" : "",
- "type" : "Roo.data.Record",
- "desc" : "The Record at the passed index. Returns undefined if not found."
+ "type" : "Node",
+ "desc" : "The found child or null if none was found"
}
]
},
{
- "name" : "getById",
+ "name" : "fireEvent",
"type" : "function",
- "desc" : "Get the Record with the specified id.",
- "sig" : "(id)",
+ "desc" : "Fires the specified event with the passed parameters (minus the event name).",
+ "sig" : "(eventName, args)",
"static" : false,
- "memberOf" : "Roo.data.Store",
+ "memberOf" : "Roo.util.Observable",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "id",
+ "name" : "eventName",
"type" : "String",
- "desc" : "The id of the Record to find.",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "args",
+ "type" : "Object...",
+ "desc" : "Variable number of parameters are passed to handlers",
"isOptional" : false
}
],
"returns" : [
{
"name" : "",
- "type" : "Roo.data.Record",
- "desc" : "The Record with the passed id. Returns undefined if not found."
+ "type" : "Boolean",
+ "desc" : "returns false if any of the handlers return false otherwise it returns true"
}
]
},
{
- "name" : "getCount",
+ "name" : "getDepth",
"type" : "function",
- "desc" : "Gets the number of cached records.\n<p>\n<em>If using paging, this may not be the total size of the dataset. If the data object\nused by the Reader contains the dataset size, then the getTotalCount() function returns\nthe data set size</em>",
+ "desc" : "Returns depth of this node (the root node has a depth of 0)",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.data.Store",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"exceptions" : "",
"requires" : "",
"params" : [],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Number",
+ "desc" : ""
+ }
+ ]
},
{
- "name" : "getModifiedRecords",
+ "name" : "getOwnerTree",
"type" : "function",
- "desc" : "Gets all records modified since the last commit. Modified records are persisted across load operations\n(e.g., during paging).",
+ "desc" : "Returns the tree this node is in.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.data.Store",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"returns" : [
{
"name" : "",
- "type" : "Roo.data.Record[]",
- "desc" : "An array of Records containing outstanding modifications."
+ "type" : "Tree",
+ "desc" : ""
}
]
},
{
- "name" : "getRange",
+ "name" : "getPath",
"type" : "function",
- "desc" : "Returns a range of Records between specified indices.",
- "sig" : "(startIndex, endIndex)",
+ "desc" : "Returns the path for this node. The path can be used to expand or select this node programmatically.",
+ "sig" : "(attr)",
"static" : false,
- "memberOf" : "Roo.data.Store",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "startIndex",
- "type" : "Number",
- "desc" : "(optional) The starting index (defaults to 0)",
- "isOptional" : false
- },
- {
- "name" : "endIndex",
- "type" : "Number",
- "desc" : "(optional) The ending index (defaults to the last Record in the Store)",
+ "name" : "attr",
+ "type" : "String",
+ "desc" : "(optional) The attr to use for the path (defaults to the node's id)",
"isOptional" : false
}
],
"returns" : [
{
"name" : "",
- "type" : "Roo.data.Record[]",
- "desc" : "An array of Records"
+ "type" : "String",
+ "desc" : "The path"
}
]
},
- {
- "name" : "getSortState",
- "type" : "function",
- "desc" : "Returns the sort state of the Store as an object with two properties:\n<pre><code>\n field {String} The name of the field by which the Records are sorted\n direction {String} The sort order, \"ASC\" or \"DESC\"\n</code></pre>",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.data.Store",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
- {
- "name" : "getTotalCount",
- "type" : "function",
- "desc" : "Gets the total number of records in the dataset as returned by the server.\n<p>\n<em>If using paging, for this to be accurate, the data object used by the Reader must contain\nthe dataset size</em>",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.data.Store",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
{
"name" : "hasListener",
"type" : "function",
{
"name" : "indexOf",
"type" : "function",
- "desc" : "Get the index within the cache of the passed Record.",
- "sig" : "(record)",
+ "desc" : "Returns the index of a child node",
+ "sig" : "(node)",
"static" : false,
- "memberOf" : "Roo.data.Store",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "record",
- "type" : "Roo.data.Record",
- "desc" : "The Roo.data.Record object to to find.",
+ "name" : "node",
+ "type" : "Node",
+ "desc" : "",
"isOptional" : false
}
],
{
"name" : "",
"type" : "Number",
- "desc" : "The index of the passed Record. Returns -1 if not found."
+ "desc" : "The index of the node or -1 if it was not found"
}
]
},
{
- "name" : "indexOfId",
+ "name" : "insertBefore",
"type" : "function",
- "desc" : "Get the index within the cache of the Record with the passed id.",
- "sig" : "(id)",
+ "desc" : "Inserts the first node before the second node in this nodes childNodes collection.",
+ "sig" : "(node, refNode)",
"static" : false,
- "memberOf" : "Roo.data.Store",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "id",
- "type" : "String",
- "desc" : "The id of the Record to find.",
+ "name" : "node",
+ "type" : "Node",
+ "desc" : "The node to insert",
+ "isOptional" : false
+ },
+ {
+ "name" : "refNode",
+ "type" : "Node",
+ "desc" : "The node to insert before (if null the node is appended)",
"isOptional" : false
}
],
"returns" : [
{
"name" : "",
- "type" : "Number",
- "desc" : "The index of the Record. Returns -1 if not found."
+ "type" : "Node",
+ "desc" : "The inserted node"
}
]
},
{
- "name" : "insert",
+ "name" : "isAncestor",
"type" : "function",
- "desc" : "Inserts Records to the Store at the given index and fires the add event.",
- "sig" : "(index, records)",
+ "desc" : "Returns true if the passed node is an ancestor (at any point) of this node.",
+ "sig" : "(node)",
"static" : false,
- "memberOf" : "Roo.data.Store",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "index",
- "type" : "Number",
- "desc" : "The start index at which to insert the passed Records.",
- "isOptional" : false
- },
- {
- "name" : "records",
- "type" : "Roo.data.Record[]",
- "desc" : "An Array of Roo.data.Record objects to add to the cache.",
+ "name" : "node",
+ "type" : "Node",
+ "desc" : "",
"isOptional" : false
}
],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Boolean",
+ "desc" : ""
+ }
+ ]
},
{
- "name" : "load",
+ "name" : "isFirst",
"type" : "function",
- "desc" : "Loads the Record cache from the configured Proxy using the configured Reader.\n<p>\nIf using remote paging, then the first load call must specify the <em>start</em>\nand <em>limit</em> properties in the options.params property to establish the initial\nposition within the dataset, and the number of Records to cache on each read from the Proxy.\n<p>\n<strong>It is important to note that for remote data sources, loading is asynchronous,\nand this call will return before the new data has been loaded. Perform any post-processing\nin a callback function, or in a \"load\" event handler.</strong>\n<p>",
- "sig" : "(options)",
+ "desc" : "Returns true if this node is the first child of its parent",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.data.Store",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
+ "params" : [],
+ "returns" : [
{
- "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>",
- "isOptional" : false
+ "name" : "",
+ "type" : "Boolean",
+ "desc" : ""
}
- ],
- "returns" : []
+ ]
},
{
- "name" : "loadData",
+ "name" : "isLast",
"type" : "function",
- "desc" : "Loads data from a passed data block. A Reader which understands the format of the data\nmust have been configured in the constructor.",
- "sig" : "(data, append)",
+ "desc" : "Returns true if this node is the last child of its parent",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.data.Store",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
+ "params" : [],
+ "returns" : [
{
- "name" : "data",
- "type" : "Object",
- "desc" : "The data block from which to read the Records. The format of the data expected\nis dependent on the type of Reader that is configured and should correspond to that Reader's readRecords parameter.",
- "isOptional" : false
- },
+ "name" : "",
+ "type" : "Boolean",
+ "desc" : ""
+ }
+ ]
+ },
+ {
+ "name" : "isLeaf",
+ "type" : "function",
+ "desc" : "Returns true if this node is a leaf",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : [
{
- "name" : "append",
+ "name" : "",
"type" : "Boolean",
- "desc" : "(Optional) True to append the new Records rather than replace the existing cache.",
- "isOptional" : false
+ "desc" : ""
}
- ],
- "returns" : []
+ ]
},
{
- "name" : "loadDataFromChildren",
+ "name" : "item",
"type" : "function",
- "desc" : "using 'cn' the nested child reader read the child array into it's child stores.",
- "sig" : "(rec)",
+ "desc" : "Returns the child node at the specified index.",
+ "sig" : "(index)",
"static" : false,
- "memberOf" : "Roo.data.Store",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "rec",
- "type" : "Object",
- "desc" : "The record with a 'children array",
+ "name" : "index",
+ "type" : "Number",
+ "desc" : "",
"isOptional" : false
}
],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Node",
+ "desc" : ""
+ }
+ ]
},
{
"name" : "on",
"returns" : []
},
{
- "name" : "query",
+ "name" : "releaseCapture",
"type" : "function",
- "desc" : "Query the records by a specified property.",
- "sig" : "(field, value, anyMatch)",
- "static" : false,
- "memberOf" : "Roo.data.Store",
- "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" : "field",
- "type" : "String",
- "desc" : "A field on your records",
- "isOptional" : false
- },
- {
- "name" : "value",
- "type" : "String/RegExp",
- "desc" : "Either a string that the field\nshould start with or a RegExp to test against the field",
- "isOptional" : false
- },
- {
- "name" : "anyMatch",
- "type" : "Boolean",
- "desc" : "True to match any part not just the beginning",
+ "name" : "o",
+ "type" : "Observable",
+ "desc" : "The Observable to release",
"isOptional" : false
}
],
- "returns" : [
- {
- "name" : "",
- "type" : "MixedCollection",
- "desc" : "Returns an Roo.util.MixedCollection of the matched records"
- }
- ]
+ "returns" : []
},
{
- "name" : "queryBy",
+ "name" : "removeChild",
"type" : "function",
- "desc" : "Query by a function. The specified function will be called with each\nrecord in this data source. If the function returns true the record is included\nin the results.",
- "sig" : "(fn, scope)",
+ "desc" : "Removes a child node from this node.",
+ "sig" : "(node)",
"static" : false,
- "memberOf" : "Roo.data.Store",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "fn",
- "type" : "Function",
- "desc" : "The function to be called, it will receive 2 args (record, id)",
- "isOptional" : false
- },
- {
- "name" : "scope",
- "type" : "Object",
- "desc" : "(optional) The scope of the function (defaults to this)",
+ "name" : "node",
+ "type" : "Node",
+ "desc" : "The node to remove",
"isOptional" : false
}
],
"returns" : [
{
"name" : "",
- "type" : "MixedCollection",
- "desc" : "Returns an Roo.util.MixedCollection of the matched records"
+ "type" : "Node",
+ "desc" : "The removed node"
}
]
},
{
- "name" : "rejectChanges",
+ "name" : "removeListener",
"type" : "function",
- "desc" : "Cancel outstanding changes on all changed records.",
- "sig" : "()\n{\n\n}",
+ "desc" : "Removes a listener",
+ "sig" : "(eventName, handler, scope)",
"static" : false,
- "memberOf" : "Roo.data.Store",
- "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,
+ "isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"example" : "",
"requires" : "",
"params" : [
{
- "name" : "o",
- "type" : "Observable",
- "desc" : "The Observable to release",
+ "name" : "eventName",
+ "type" : "String",
+ "desc" : "The type of event to listen for",
+ "isOptional" : false
+ },
+ {
+ "name" : "handler",
+ "type" : "Function",
+ "desc" : "The handler to remove",
+ "isOptional" : false
+ },
+ {
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "(optional) The scope (this object) for the handler",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "reload",
+ "name" : "replaceChild",
"type" : "function",
- "desc" : "Reloads the Record cache from the configured Proxy using the configured Reader and\nthe options from the last load operation performed.",
- "sig" : "(options)",
+ "desc" : "Replaces one child node in this node with another.",
+ "sig" : "(newChild, oldChild)",
"static" : false,
- "memberOf" : "Roo.data.Store",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "options",
- "type" : "Object",
- "desc" : "(optional) An object containing properties which may override the options\nused in the last load operation. See {@link #load} for details (defaults to null, in which case\nthe most recently used options are reused).",
+ "name" : "newChild",
+ "type" : "Node",
+ "desc" : "The replacement node",
+ "isOptional" : false
+ },
+ {
+ "name" : "oldChild",
+ "type" : "Node",
+ "desc" : "The node to replace",
"isOptional" : false
}
],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Node",
+ "desc" : "The replaced node"
+ }
+ ]
},
{
- "name" : "remove",
+ "name" : "sort",
"type" : "function",
- "desc" : "Remove a Record from the Store and fires the remove event.",
- "sig" : "(record)",
+ "desc" : "Sorts this nodes children using the supplied sort function",
+ "sig" : "(fn, scope)",
"static" : false,
- "memberOf" : "Roo.data.Store",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "record",
- "type" : "Ext.data.Record",
- "desc" : "The Roo.data.Record object to remove from the cache.",
+ "name" : "fn",
+ "type" : "Function",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "(optional)",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "removeAll",
- "type" : "function",
- "desc" : "Remove all Records from the Store and fires the clear event.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.data.Store",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "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" : []
+ }
+ ],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "implementations" : [
+ "Roo.tree.AsyncTreeNode",
+ "Roo.tree.TreeNode"
+ ],
+ "tree_children" : [],
+ "tree_parent" : []
+ },
+ "Roo.data.Record" : {
+ "props" : [],
+ "events" : [],
+ "methods" : [
+ {
+ "name" : "commit",
+ "type" : "function",
+ "desc" : "Usually called by the {@link Roo.data.Store} which owns the Record.\nCommits all changes made to the Record since either creation, or the last commit operation.\n<p>\nDevelopers should subscribe to the {@link Roo.data.Store#update} event to have their code notified\nof commit operations.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
},
{
- "name" : "setDefaultSort",
+ "name" : "copy",
"type" : "function",
- "desc" : "Sets the default sort column and order to be used by the next load operation.",
- "sig" : "(fieldName, dir)",
+ "desc" : "Creates a copy of this record.",
+ "sig" : "(id)",
"static" : false,
- "memberOf" : "Roo.data.Store",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "fieldName",
- "type" : "String",
- "desc" : "The name of the field to sort by.",
- "isOptional" : false
- },
- {
- "name" : "dir",
+ "name" : "id",
"type" : "String",
- "desc" : "(optional) The sort order, \"ASC\" or \"DESC\" (defaults to \"ASC\")",
+ "desc" : "(optional) A new record id if you don't want to use this record's id",
"isOptional" : false
}
],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Record",
+ "desc" : ""
+ }
+ ]
},
{
- "name" : "sort",
+ "name" : "create",
"type" : "function",
- "desc" : "Sort the Records.\nIf remote sorting is used, the sort is performed on the server, and the cache is\nreloaded. If local sorting is used, the cache is sorted internally.",
- "sig" : "(fieldName, dir)",
- "static" : false,
- "memberOf" : "Roo.data.Store",
- "isStatic" : false,
+ "desc" : "Generate a constructor for a specific record layout.",
+ "sig" : "(o)",
+ "static" : true,
+ "memberOf" : "",
+ "isStatic" : true,
"isConstructor" : false,
"isPrivate" : false,
"example" : "",
"requires" : "",
"params" : [
{
- "name" : "fieldName",
- "type" : "String",
- "desc" : "The name of the field to sort by.",
- "isOptional" : false
- },
- {
- "name" : "dir",
- "type" : "String",
- "desc" : "(optional) The sort order, \"ASC\" or \"DESC\" (defaults to \"ASC\")",
+ "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\"> 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
}
],
"returns" : []
},
{
- "name" : "sum",
+ "name" : "get",
"type" : "function",
- "desc" : "Sums the value of <i>property</i> for each record between start and end and returns the result.",
- "sig" : "(property, start, end)",
+ "desc" : "Get the value of the named field.",
+ "sig" : "(name)",
"static" : false,
- "memberOf" : "Roo.data.Store",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "property",
+ "name" : "name",
"type" : "String",
- "desc" : "A field on your records",
- "isOptional" : false
- },
- {
- "name" : "start",
- "type" : "Number",
- "desc" : "The record index to start at (defaults to 0)",
- "isOptional" : false
- },
- {
- "name" : "end",
- "type" : "Number",
- "desc" : "The last record index to include (defaults to length - 1)",
+ "desc" : "The name of the field to get the value of.",
"isOptional" : false
}
],
"returns" : [
{
"name" : "",
- "type" : "Number",
- "desc" : "The sum"
+ "type" : "Object",
+ "desc" : "The value of the field."
}
]
},
{
- "name" : "un",
+ "name" : "reject",
"type" : "function",
- "desc" : "Removes a listener (shorthand for removeListener)",
- "sig" : "(eventName, handler, scope)",
+ "desc" : "Usually called by the {@link Roo.data.Store} which owns the Record.\nRejects all changes made to the Record since either creation, or the last commit operation.\nModified fields are reverted to their original values.\n<p>\nDevelopers should subscribe to the {@link Roo.data.Store#update} event to have their code notified\nof reject operations.",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.util.Observable",
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
+ {
+ "name" : "set",
+ "type" : "function",
+ "desc" : "Set the named field to the specified value.",
+ "sig" : "(name, value)",
+ "static" : false,
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "eventName",
+ "name" : "name",
"type" : "String",
- "desc" : "The type of event to listen for",
- "isOptional" : false
- },
- {
- "name" : "handler",
- "type" : "Function",
- "desc" : "The handler to remove",
+ "desc" : "The name of the field to set.",
"isOptional" : false
},
{
- "name" : "scope",
+ "name" : "value",
"type" : "Object",
- "desc" : "(optional) The scope (this object) for the handler",
+ "desc" : "The value to set the field to.",
"isOptional" : false
}
],
"tree_children" : [],
"tree_parent" : []
},
- "Roo.data.MemoryProxy" : {
- "props" : [],
+ "Roo.data.ScriptTagProxy" : {
+ "props" : [
+ {
+ "name" : "callbackParam",
+ "type" : "String",
+ "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" : "Defaults to true. Disable cacheing by adding a unique parameter\nname to the request.",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "timeout",
+ "type" : "Number",
+ "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" : "",
+ "isOptional" : false,
+ "optvals" : []
+ }
+ ],
"events" : [],
"methods" : [
+ {
+ "name" : "abort",
+ "type" : "function",
+ "desc" : "Abort the current server request.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
{
"name" : "load",
"type" : "function",
- "desc" : "Load data from the requested source (in this case an in-memory\ndata object passed to the constructor), read the data object into\na block of Roo.data.Records using the passed Roo.data.DataReader implementation, and\nprocess that block using the passed callback.",
+ "desc" : "Load data from the configured URL, read the data object into\na block of Roo.data.Records using the passed Roo.data.DataReader implementation, and\nprocess that block using the passed callback.",
"sig" : "(params, reader, callback, scope, arg)",
"static" : false,
"memberOf" : "",
{
"name" : "params",
"type" : "Object",
- "desc" : "This parameter is not used by the MemoryProxy class.",
+ "desc" : "An object containing properties which are to be used as HTTP parameters\nfor the request to the remote server.",
"isOptional" : false
},
{
{
"name" : "callback",
"type" : "Function",
- "desc" : "The function into which to pass the block of Roo.data.
records.\nThe function must be passed <ul>\n<li>The Record block object</li>\n<li>The \"arg\" argument from the load function</li>\n<li>A boolean success indicator</li>\n</ul>",
+ "desc" : "The function into which to pass the block of Roo.data.
Records.\nThe function must be passed <ul>\n<li>The Record block object</li>\n<li>The \"arg\" argument from the load function</li>\n<li>A boolean success indicator</li>\n</ul>",
"isOptional" : false
},
{
"tree_children" : [],
"tree_parent" : []
},
- "Roo.data.Node" : {
+ "Roo.data.SimpleStore" : {
"props" : [
+ {
+ "name" : "an",
+ "type" : "Object",
+ "desc" : "existing reader (eg. copied from another store)",
+ "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",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "data",
+ "type" : "Array",
+ "desc" : "The multi-dimensional array of data",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "fields",
+ "type" : "Array",
+ "desc" : "An array of field definition objects, or field name strings.",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
{
"name" : "id",
- "type" : "String",
- "desc" : "The id for this node. If one is not specified, one is generated.",
- "memberOf" : ""
+ "type" : "Number",
+ "desc" : "The array index of the record id. Leave blank to auto generate ids.",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
- "name" : "leaf",
- "type" : "Boolean",
- "desc" : "true if this node is a leaf and does not have children",
- "memberOf" : ""
+ "name" : "isLocal",
+ "type" : "boolean",
+ "desc" : "flag if data is locally available (and can be always looked up\nwithout a remote query - used by combo/forms at present.",
+ "memberOf" : "Roo.data.Store",
+ "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",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "proxy",
+ "type" : "Roo.data.DataProxy",
+ "desc" : "[not-required]",
+ "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",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "reader",
+ "type" : "Roo.data.Reader",
+ "desc" : "[not-required]",
+ "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",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "sortInfo",
+ "type" : "Object",
+ "desc" : "A config object in the format: {field: \"fieldName\", direction: \"ASC|DESC\"}",
+ "memberOf" : "Roo.data.Store",
+ "isOptional" : false,
+ "optvals" : []
}
],
"events" : [
{
- "name" : "append",
+ "name" : "add",
"type" : "function",
- "desc" : "Fires when a new child node is appended",
- "sig" : "function (tree, _self, node, index)\n{\n\n}",
- "memberOf" : "",
+ "desc" : "Fires when Records have been added to the Store",
+ "sig" : "function (_self, records, index)\n{\n\n}",
+ "memberOf" : "Roo.data.Store",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "params" : [
- {
- "name" : "tree",
- "type" : "Tree",
- "desc" : "The owner tree",
- "isOptional" : false
- },
+ "params" : [
{
"name" : "this",
- "type" : "Node",
- "desc" : "This node",
+ "type" : "Store",
+ "desc" : "",
"isOptional" : false
},
{
- "name" : "node",
- "type" : "Node",
- "desc" : "The newly appended node",
+ "name" : "records",
+ "type" : "Roo.data.Record[]",
+ "desc" : "The array of Records added",
"isOptional" : false
},
{
"name" : "index",
"type" : "Number",
- "desc" : "The index of the newly appended node",
+ "desc" : "The index at which the record(s) were added",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "beforeappend",
+ "name" : "beforeload",
"type" : "function",
- "desc" : "Fires before a new child is appended, return false to cancel the append.",
- "sig" : "function (tree, _self, node)\n{\n\n}",
- "memberOf" : "",
+ "desc" : "Fires before a request is made for a new data object. If the beforeload handler returns false\nthe load action will be canceled.",
+ "sig" : "function (_self, options)\n{\n\n}",
+ "memberOf" : "Roo.data.Store",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
"params" : [
- {
- "name" : "tree",
- "type" : "Tree",
- "desc" : "The owner tree",
- "isOptional" : false
- },
{
"name" : "this",
- "type" : "Node",
- "desc" : "This node",
+ "type" : "Store",
+ "desc" : "",
"isOptional" : false
},
{
- "name" : "node",
- "type" : "Node",
- "desc" : "The child node to be appended",
+ "name" : "options",
+ "type" : "Object",
+ "desc" : "The loading options that were specified (see {@link #load} for details)",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "beforeinsert",
+ "name" : "beforeloadadd",
"type" : "function",
- "desc" : "Fires before a new child is inserted, return false to cancel the insert.",
- "sig" : "function (tree, _self, node, refNode)\n{\n\n}",
- "memberOf" : "",
+ "desc" : "Fires after a new set of Records has been loaded.",
+ "sig" : "function (_self, records, options)\n{\n\n}",
+ "memberOf" : "Roo.data.Store",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
"params" : [
- {
- "name" : "tree",
- "type" : "Tree",
- "desc" : "The owner tree",
- "isOptional" : false
- },
{
"name" : "this",
- "type" : "Node",
- "desc" : "This node",
+ "type" : "Store",
+ "desc" : "",
"isOptional" : false
},
{
- "name" : "node",
- "type" : "Node",
- "desc" : "The child node to be inserted",
+ "name" : "records",
+ "type" : "Roo.data.Record[]",
+ "desc" : "The Records that were loaded",
"isOptional" : false
},
{
- "name" : "refNode",
- "type" : "Node",
- "desc" : "The child node the node is being inserted before",
+ "name" : "options",
+ "type" : "Object",
+ "desc" : "The loading options that were specified (see {@link #load} for details)",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "beforemove",
+ "name" : "clear",
"type" : "function",
- "desc" : "Fires before this node is moved to a new location in the tree. Return false to cancel the move.",
- "sig" : "function (tree, _self, oldParent, newParent, index)\n{\n\n}",
- "memberOf" : "",
+ "desc" : "Fires when the data cache has been cleared.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.data.Store",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
"params" : [
- {
- "name" : "tree",
- "type" : "Tree",
- "desc" : "The owner tree",
- "isOptional" : false
- },
{
"name" : "this",
- "type" : "Node",
- "desc" : "This node",
- "isOptional" : false
- },
- {
- "name" : "oldParent",
- "type" : "Node",
- "desc" : "The parent of this node",
- "isOptional" : false
- },
- {
- "name" : "newParent",
- "type" : "Node",
- "desc" : "The new parent this node is moving to",
+ "type" : "Store",
+ "desc" : "",
"isOptional" : false
- },
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "datachanged",
+ "type" : "function",
+ "desc" : "Fires when the data cache has changed, and a widget which is using this Store\nas a Record cache should refresh its view.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.data.Store",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
{
- "name" : "index",
- "type" : "Number",
- "desc" : "The index it is being moved to",
+ "name" : "this",
+ "type" : "Store",
+ "desc" : "",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "beforeremove",
+ "name" : "load",
"type" : "function",
- "desc" : "Fires before a child is removed, return false to cancel the remove.",
- "sig" : "function (tree, _self, node)\n{\n\n}",
- "memberOf" : "",
+ "desc" : "Fires after a new set of Records has been loaded, before they are added to the store.",
+ "sig" : "function (_self, records, options)\n{\n\n}",
+ "memberOf" : "Roo.data.Store",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
"params" : [
{
- "name" : "tree",
- "type" : "Tree",
- "desc" : "The owner tree",
+ "name" : "this",
+ "type" : "Store",
+ "desc" : "",
"isOptional" : false
},
{
- "name" : "this",
- "type" : "Node",
- "desc" : "This node",
+ "name" : "records",
+ "type" : "Roo.data.Record[]",
+ "desc" : "The Records that were loaded",
"isOptional" : false
},
{
- "name" : "node",
- "type" : "Node",
- "desc" : "The child node to be removed",
+ "name" : "options",
+ "type" : "Object",
+ "desc" : "The loading options that were specified (see {@link #load} for details)",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "insert",
+ "name" : "loadexception",
"type" : "function",
- "desc" : "Fires when a new child node is inserted.",
- "sig" : "function (tree, _self, node, refNode)\n{\n\n}",
- "memberOf" : "",
+ "desc" : "Fires if an exception occurs in the Proxy during loading.\nCalled with the signature of the Proxy's \"loadexception\" event.\nIf you return Json { data: [] , success: false, .... } then this will be thrown with the following args",
+ "sig" : "function (, ret, opts, jsonData)\n{\n\n}",
+ "memberOf" : "Roo.data.Store",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
"params" : [
{
- "name" : "tree",
- "type" : "Tree",
- "desc" : "The owner tree",
+ "name" : "",
+ "type" : "Proxy",
+ "desc" : "",
"isOptional" : false
},
{
- "name" : "this",
- "type" : "Node",
- "desc" : "This node",
+ "name" : "ret",
+ "type" : "Object",
+ "desc" : "return data from JsonData.reader() - success, totalRecords, records",
"isOptional" : false
},
{
- "name" : "node",
- "type" : "Node",
- "desc" : "The child node inserted",
+ "name" : "opts",
+ "type" : "Object",
+ "desc" : "- load Options",
"isOptional" : false
},
{
- "name" : "refNode",
- "type" : "Node",
- "desc" : "The child node the node was inserted before",
+ "name" : "jsonData",
+ "type" : "Object",
+ "desc" : "from your request (normally this contains the Exception)",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "move",
+ "name" : "metachange",
"type" : "function",
- "desc" : "Fires when this node is moved to a new location in the tree",
- "sig" : "function (tree, _self, oldParent, newParent, index)\n{\n\n}",
- "memberOf" : "",
+ "desc" : "Fires when this store's reader provides new metadata (fields). This is currently only support for JsonReaders.",
+ "sig" : "function (_self, meta)\n{\n\n}",
+ "memberOf" : "Roo.data.Store",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
"params" : [
{
- "name" : "tree",
- "type" : "Tree",
- "desc" : "The owner tree",
+ "name" : "this",
+ "type" : "Store",
+ "desc" : "",
"isOptional" : false
},
{
- "name" : "this",
- "type" : "Node",
- "desc" : "This node",
+ "name" : "meta",
+ "type" : "Object",
+ "desc" : "The JSON metadata",
"isOptional" : false
- },
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "remove",
+ "type" : "function",
+ "desc" : "Fires when a Record has been removed from the Store",
+ "sig" : "function (_self, record, index)\n{\n\n}",
+ "memberOf" : "Roo.data.Store",
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "params" : [
{
- "name" : "oldParent",
- "type" : "Node",
- "desc" : "The old parent of this node",
+ "name" : "this",
+ "type" : "Store",
+ "desc" : "",
"isOptional" : false
},
{
- "name" : "newParent",
- "type" : "Node",
- "desc" : "The new parent of this node",
+ "name" : "record",
+ "type" : "Roo.data.Record",
+ "desc" : "The Record that was removed",
"isOptional" : false
},
{
"name" : "index",
"type" : "Number",
- "desc" : "The index it was moved to",
+ "desc" : "The index at which the record was removed",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "remove",
+ "name" : "update",
"type" : "function",
- "desc" : "Fires when a child node is removed",
- "sig" : "function (tree, _self, node)\n{\n\n}",
- "memberOf" : "",
+ "desc" : "Fires when a Record has been updated",
+ "sig" : "function (_self, record, operation)\n{\n\n}",
+ "memberOf" : "Roo.data.Store",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
"params" : [
{
- "name" : "tree",
- "type" : "Tree",
- "desc" : "The owner tree",
+ "name" : "this",
+ "type" : "Store",
+ "desc" : "",
"isOptional" : false
},
{
- "name" : "this",
- "type" : "Node",
- "desc" : "This node",
+ "name" : "record",
+ "type" : "Roo.data.Record",
+ "desc" : "The Record that was updated",
"isOptional" : false
},
{
- "name" : "node",
- "type" : "Node",
- "desc" : "The removed node",
+ "name" : "operation",
+ "type" : "String",
+ "desc" : "The update operation being performed. Value may be one of:\n<pre><code>\n Roo.data.Record.EDIT\n Roo.data.Record.REJECT\n Roo.data.Record.COMMIT\n</code></pre>",
"isOptional" : false
}
],
}
],
"methods" : [
+ {
+ "name" : "add",
+ "type" : "function",
+ "desc" : "Add Records to the Store and fires the add event.",
+ "sig" : "(records)",
+ "static" : false,
+ "memberOf" : "Roo.data.Store",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "records",
+ "type" : "Roo.data.Record[]",
+ "desc" : "An Array of Roo.data.Record objects to add to the cache.",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
{
"name" : "addEvents",
"type" : "function",
"returns" : []
},
{
- "name" : "appendChild",
+ "name" : "capture",
"type" : "function",
- "desc" : "Insert node(s) as the last child node of this node.",
- "sig" : "(node)",
- "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" : "node",
- "type" : "Node/Array",
- "desc" : "The node or Array of nodes to append",
+ "name" : "o",
+ "type" : "Observable",
+ "desc" : "The Observable to capture",
"isOptional" : false
- }
- ],
- "returns" : [
+ },
{
- "name" : "",
- "type" : "Node",
- "desc" : "The appended node if single append, or null if an array was passed"
+ "name" : "fn",
+ "type" : "Function",
+ "desc" : "The function to call",
+ "isOptional" : false
+ },
+ {
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "(optional) The scope (this object) for the fn",
+ "isOptional" : false
}
- ]
+ ],
+ "returns" : []
},
{
- "name" : "bubble",
+ "name" : "clearFilter",
"type" : "function",
- "desc" : "Bubbles up the tree from this node, calling the specified function with each node. The scope (<i>this</i>) of\nfunction call will be the scope provided or the current node. The arguments to the function\nwill be the args provided or the current node. If the function returns false at any point,\nthe bubble is stopped.",
- "sig" : "(fn, scope, args)",
+ "desc" : "Revert to a view of the Record cache with no filtering applied.",
+ "sig" : "(suppressEvent)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.data.Store",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "fn",
- "type" : "Function",
- "desc" : "The function to call",
- "isOptional" : false
- },
- {
- "name" : "scope",
- "type" : "Object",
- "desc" : "(optional) The scope of the function (defaults to current node)",
- "isOptional" : false
- },
- {
- "name" : "args",
- "type" : "Array",
- "desc" : "(optional) The args to call the function with (default to passing the current node)",
+ "name" : "suppressEvent",
+ "type" : "Boolean",
+ "desc" : "If true the filter is cleared silently without notifying listeners",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "capture",
+ "name" : "collect",
"type" : "function",
- "desc" : "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" : "Collects unique values for a particular dataIndex from this store.",
+ "sig" : "(dataIndex, allowNull, bypassFilter)",
+ "static" : false,
+ "memberOf" : "Roo.data.Store",
+ "isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"example" : "",
"requires" : "",
"params" : [
{
- "name" : "o",
- "type" : "Observable",
- "desc" : "The Observable to capture",
+ "name" : "dataIndex",
+ "type" : "String",
+ "desc" : "The property to collect",
"isOptional" : false
},
{
- "name" : "fn",
- "type" : "Function",
- "desc" : "The function to call",
+ "name" : "allowNull",
+ "type" : "Boolean",
+ "desc" : "(optional) Pass true to allow null, undefined or empty string values",
"isOptional" : false
},
{
- "name" : "scope",
- "type" : "Object",
- "desc" : "(optional) The scope (this object) for the fn",
+ "name" : "bypassFilter",
+ "type" : "Boolean",
+ "desc" : "(optional) Pass true to collect from all records, even ones which are filtered",
"isOptional" : false
}
],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Array",
+ "desc" : "An array of the unique values"
+ }
+ ]
+ },
+ {
+ "name" : "commitChanges",
+ "type" : "function",
+ "desc" : "Commit all Records with outstanding changes. To handle updates for changes, subscribe to the\nStore's \"update\" event, and perform updating when the third parameter is Roo.data.Record.COMMIT.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.data.Store",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
"returns" : []
},
{
- "name" : "cascade",
+ "name" : "each",
"type" : "function",
- "desc" : "Cascades down the tree from this node, calling the specified function with each node. The scope (<i>this</i>) of\nfunction call will be the scope provided or the current node. The arguments to the function\nwill be the args provided or the current node. If the function returns false at any point,\nthe cascade is stopped on that branch.",
- "sig" : "(fn, scope, args)",
+ "desc" : "Calls the specified function for each of the Records in the cache.",
+ "sig" : "(fn, scope)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.data.Store",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
{
"name" : "fn",
"type" : "Function",
- "desc" : "The function to call",
+ "desc" : "The function to call. The Record is passed as the first parameter.\nReturning <em>false</em> aborts and exits the iteration.",
"isOptional" : false
},
{
"name" : "scope",
"type" : "Object",
- "desc" : "(optional) The scope of the function (defaults to current node)",
- "isOptional" : false
- },
- {
- "name" : "args",
- "type" : "Array",
- "desc" : "(optional) The args to call the function with (default to passing the current node)",
+ "desc" : "(optional) The scope in which to call the function (defaults to the Record).",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "contains",
+ "name" : "filter",
"type" : "function",
- "desc" : "Returns true if this node is an ancestor (at any point) of the passed node.",
- "sig" : "(node)",
+ "desc" : "Filter the records by a specified property.",
+ "sig" : "(field, value, anyMatch)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.data.Store",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "node",
- "type" : "Node",
- "desc" : "",
+ "name" : "field",
+ "type" : "String",
+ "desc" : "A field on your records",
"isOptional" : false
- }
- ],
- "returns" : [
+ },
{
- "name" : "",
+ "name" : "value",
+ "type" : "String/RegExp",
+ "desc" : "Either a string that the field\nshould start with or a RegExp to test against the field",
+ "isOptional" : false
+ },
+ {
+ "name" : "anyMatch",
"type" : "Boolean",
- "desc" : ""
+ "desc" : "True to match any part not just the beginning",
+ "isOptional" : false
}
- ]
+ ],
+ "returns" : []
},
{
- "name" : "eachChild",
+ "name" : "filterBy",
"type" : "function",
- "desc" : "Interates the child nodes of this node, calling the specified function with each node. The scope (<i>this</i>) of\nfunction call will be the scope provided or the current node. The arguments to the function\nwill be the args provided or the current node. If the function returns false at any point,\nthe iteration stops.",
- "sig" : "(fn, scope, args)",
+ "desc" : "Filter by a function. The specified function will be called with each\nrecord in this data source. If the function returns true the record is included,\notherwise it is filtered.",
+ "sig" : "(fn, scope)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.data.Store",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
{
"name" : "fn",
"type" : "Function",
- "desc" : "The function to call",
+ "desc" : "The function to be called, it will receive 2 args (record, id)",
"isOptional" : false
},
{
"name" : "scope",
"type" : "Object",
- "desc" : "(optional) The scope of the function (defaults to current node)",
- "isOptional" : false
- },
- {
- "name" : "args",
- "type" : "Array",
- "desc" : "(optional) The args to call the function with (default to passing the current node)",
+ "desc" : "(optional) The scope of the function (defaults to this)",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "findChild",
+ "name" : "fireEvent",
"type" : "function",
- "desc" : "Finds the first child that has the attribute with the specified value.",
- "sig" : "(attribute, 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" : "attribute",
+ "name" : "eventName",
"type" : "String",
- "desc" : "The attribute name",
+ "desc" : "",
"isOptional" : false
},
{
- "name" : "value",
- "type" : "Mixed",
- "desc" : "The value to search for",
+ "name" : "args",
+ "type" : "Object...",
+ "desc" : "Variable number of parameters are passed to handlers",
"isOptional" : false
}
],
"returns" : [
{
"name" : "",
- "type" : "Node",
- "desc" : "The found child or null if none was found"
+ "type" : "Boolean",
+ "desc" : "returns false if any of the handlers return false otherwise it returns true"
}
]
},
{
- "name" : "findChildBy",
+ "name" : "getAt",
"type" : "function",
- "desc" : "Finds the first child by a custom function. The child matches if the function passed\nreturns true.",
- "sig" : "(fn, scope)",
+ "desc" : "Get the Record at the specified index.",
+ "sig" : "(index)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.data.Store",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "fn",
- "type" : "Function",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "scope",
- "type" : "Object",
- "desc" : "(optional)",
+ "name" : "index",
+ "type" : "Number",
+ "desc" : "The index of the Record to find.",
"isOptional" : false
}
],
"returns" : [
{
"name" : "",
- "type" : "Node",
- "desc" : "The found child or null if none was found"
+ "type" : "Roo.data.Record",
+ "desc" : "The Record at the passed index. Returns undefined if not found."
}
]
},
{
- "name" : "fireEvent",
+ "name" : "getById",
"type" : "function",
- "desc" : "Fires the specified event with the passed parameters (minus the event name).",
- "sig" : "(eventName, args)",
+ "desc" : "Get the Record with the specified id.",
+ "sig" : "(id)",
"static" : false,
- "memberOf" : "Roo.util.Observable",
+ "memberOf" : "Roo.data.Store",
"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 id of the Record to find.",
"isOptional" : false
}
],
"returns" : [
{
"name" : "",
- "type" : "Boolean",
- "desc" : "returns false if any of the handlers return false otherwise it returns true"
+ "type" : "Roo.data.Record",
+ "desc" : "The Record with the passed id. Returns undefined if not found."
}
]
},
{
- "name" : "getDepth",
+ "name" : "getCount",
"type" : "function",
- "desc" : "Returns depth of this node (the root node has a depth of 0)",
+ "desc" : "Gets the number of cached records.\n<p>\n<em>If using paging, this may not be the total size of the dataset. If the data object\nused by the Reader contains the dataset size, then the getTotalCount() function returns\nthe data set size</em>",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.data.Store",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"exceptions" : "",
"requires" : "",
"params" : [],
- "returns" : [
- {
- "name" : "",
- "type" : "Number",
- "desc" : ""
- }
- ]
+ "returns" : []
},
{
- "name" : "getOwnerTree",
+ "name" : "getModifiedRecords",
"type" : "function",
- "desc" : "Returns the tree this node is in.",
+ "desc" : "Gets all records modified since the last commit. Modified records are persisted across load operations\n(e.g., during paging).",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.data.Store",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"returns" : [
{
"name" : "",
- "type" : "Tree",
- "desc" : ""
+ "type" : "Roo.data.Record[]",
+ "desc" : "An array of Records containing outstanding modifications."
}
]
},
{
- "name" : "getPath",
+ "name" : "getRange",
"type" : "function",
- "desc" : "Returns the path for this node. The path can be used to expand or select this node programmatically.",
- "sig" : "(attr)",
+ "desc" : "Returns a range of Records between specified indices.",
+ "sig" : "(startIndex, endIndex)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.data.Store",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "attr",
- "type" : "String",
- "desc" : "(optional) The attr to use for the path (defaults to the node's id)",
+ "name" : "startIndex",
+ "type" : "Number",
+ "desc" : "(optional) The starting index (defaults to 0)",
+ "isOptional" : false
+ },
+ {
+ "name" : "endIndex",
+ "type" : "Number",
+ "desc" : "(optional) The ending index (defaults to the last Record in the Store)",
"isOptional" : false
}
],
"returns" : [
{
"name" : "",
- "type" : "String",
- "desc" : "The path"
+ "type" : "Roo.data.Record[]",
+ "desc" : "An array of Records"
}
]
},
+ {
+ "name" : "getSortState",
+ "type" : "function",
+ "desc" : "Returns the sort state of the Store as an object with two properties:\n<pre><code>\n field {String} The name of the field by which the Records are sorted\n direction {String} The sort order, \"ASC\" or \"DESC\"\n</code></pre>",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.data.Store",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
+ {
+ "name" : "getTotalCount",
+ "type" : "function",
+ "desc" : "Gets the total number of records in the dataset as returned by the server.\n<p>\n<em>If using paging, for this to be accurate, the data object used by the Reader must contain\nthe dataset size</em>",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.data.Store",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
{
"name" : "hasListener",
"type" : "function",
{
"name" : "indexOf",
"type" : "function",
- "desc" : "Returns the index of a child node",
- "sig" : "(node)",
+ "desc" : "Get the index within the cache of the passed Record.",
+ "sig" : "(record)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.data.Store",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "node",
- "type" : "Node",
- "desc" : "",
+ "name" : "record",
+ "type" : "Roo.data.Record",
+ "desc" : "The Roo.data.Record object to to find.",
"isOptional" : false
}
],
{
"name" : "",
"type" : "Number",
- "desc" : "The index of the node or -1 if it was not found"
+ "desc" : "The index of the passed Record. Returns -1 if not found."
}
]
},
{
- "name" : "insertBefore",
+ "name" : "indexOfId",
"type" : "function",
- "desc" : "Inserts the first node before the second node in this nodes childNodes collection.",
- "sig" : "(node, refNode)",
+ "desc" : "Get the index within the cache of the Record with the passed id.",
+ "sig" : "(id)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.data.Store",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "node",
- "type" : "Node",
- "desc" : "The node to insert",
- "isOptional" : false
- },
- {
- "name" : "refNode",
- "type" : "Node",
- "desc" : "The node to insert before (if null the node is appended)",
+ "name" : "id",
+ "type" : "String",
+ "desc" : "The id of the Record to find.",
"isOptional" : false
}
],
"returns" : [
{
"name" : "",
- "type" : "Node",
- "desc" : "The inserted node"
+ "type" : "Number",
+ "desc" : "The index of the Record. Returns -1 if not found."
}
]
},
{
- "name" : "isAncestor",
+ "name" : "insert",
"type" : "function",
- "desc" : "Returns true if the passed node is an ancestor (at any point) of this node.",
- "sig" : "(node)",
+ "desc" : "Inserts Records to the Store at the given index and fires the add event.",
+ "sig" : "(index, records)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.data.Store",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "node",
- "type" : "Node",
- "desc" : "",
+ "name" : "index",
+ "type" : "Number",
+ "desc" : "The start index at which to insert the passed Records.",
"isOptional" : false
- }
- ],
- "returns" : [
+ },
{
- "name" : "",
- "type" : "Boolean",
- "desc" : ""
+ "name" : "records",
+ "type" : "Roo.data.Record[]",
+ "desc" : "An Array of Roo.data.Record objects to add to the cache.",
+ "isOptional" : false
}
- ]
+ ],
+ "returns" : []
},
{
- "name" : "isFirst",
+ "name" : "load",
"type" : "function",
- "desc" : "Returns true if this node is the first child of its parent",
- "sig" : "()\n{\n\n}",
+ "desc" : "Loads the Record cache from the configured Proxy using the configured Reader.\n<p>\nIf using remote paging, then the first load call must specify the <em>start</em>\nand <em>limit</em> properties in the options.params property to establish the initial\nposition within the dataset, and the number of Records to cache on each read from the Proxy.\n<p>\n<strong>It is important to note that for remote data sources, loading is asynchronous,\nand this call will return before the new data has been loaded. Perform any post-processing\nin a callback function, or in a \"load\" event handler.</strong>\n<p>",
+ "sig" : "(options)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.data.Store",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
- "returns" : [
+ "params" : [
{
- "name" : "",
- "type" : "Boolean",
- "desc" : ""
+ "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>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
}
- ]
+ ],
+ "returns" : []
},
{
- "name" : "isLast",
+ "name" : "loadData",
"type" : "function",
- "desc" : "Returns true if this node is the last child of its parent",
- "sig" : "()\n{\n\n}",
+ "desc" : "Loads data from a passed data block. A Reader which understands the format of the data\nmust have been configured in the constructor.",
+ "sig" : "(data, append)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.data.Store",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
- "returns" : [
+ "params" : [
{
- "name" : "",
- "type" : "Boolean",
- "desc" : ""
- }
- ]
- },
- {
- "name" : "isLeaf",
- "type" : "function",
- "desc" : "Returns true if this node is a leaf",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : [
+ "name" : "data",
+ "type" : "Object",
+ "desc" : "The data block from which to read the Records. The format of the data expected\nis dependent on the type of Reader that is configured and should correspond to that Reader's readRecords parameter.",
+ "isOptional" : false
+ },
{
- "name" : "",
+ "name" : "append",
"type" : "Boolean",
- "desc" : ""
+ "desc" : "True to append the new Records rather than replace the existing cache.",
+ "isOptional" : false
}
- ]
+ ],
+ "returns" : []
},
{
- "name" : "item",
+ "name" : "loadDataFromChildren",
"type" : "function",
- "desc" : "Returns the child node at the specified index.",
- "sig" : "(index)",
+ "desc" : "using 'cn' the nested child reader read the child array into it's child stores.",
+ "sig" : "(rec)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.data.Store",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "index",
- "type" : "Number",
- "desc" : "",
+ "name" : "rec",
+ "type" : "Object",
+ "desc" : "The record with a 'children array",
"isOptional" : false
}
],
- "returns" : [
- {
- "name" : "",
- "type" : "Node",
- "desc" : ""
- }
- ]
+ "returns" : []
},
{
"name" : "on",
"params" : [],
"returns" : []
},
+ {
+ "name" : "query",
+ "type" : "function",
+ "desc" : "Query the records by a specified property.",
+ "sig" : "(field, value, anyMatch)",
+ "static" : false,
+ "memberOf" : "Roo.data.Store",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "field",
+ "type" : "String",
+ "desc" : "A field on your records",
+ "isOptional" : false
+ },
+ {
+ "name" : "value",
+ "type" : "String/RegExp",
+ "desc" : "Either a string that the field\nshould start with or a RegExp to test against the field",
+ "isOptional" : false
+ },
+ {
+ "name" : "anyMatch",
+ "type" : "Boolean",
+ "desc" : "True to match any part not just the beginning",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "MixedCollection",
+ "desc" : "Returns an Roo.util.MixedCollection of the matched records"
+ }
+ ]
+ },
+ {
+ "name" : "queryBy",
+ "type" : "function",
+ "desc" : "Query by a function. The specified function will be called with each\nrecord in this data source. If the function returns true the record is included\nin the results.",
+ "sig" : "(fn, scope)",
+ "static" : false,
+ "memberOf" : "Roo.data.Store",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "fn",
+ "type" : "Function",
+ "desc" : "The function to be called, it will receive 2 args (record, id)",
+ "isOptional" : false
+ },
+ {
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "(optional) The scope of the function (defaults to this)",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "MixedCollection",
+ "desc" : "Returns an Roo.util.MixedCollection of the matched records"
+ }
+ ]
+ },
+ {
+ "name" : "rejectChanges",
+ "type" : "function",
+ "desc" : "Cancel outstanding changes on all changed records.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.data.Store",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
{
"name" : "releaseCapture",
"type" : "function",
"returns" : []
},
{
- "name" : "removeChild",
+ "name" : "reload",
"type" : "function",
- "desc" : "Removes a child node from this node.",
- "sig" : "(node)",
+ "desc" : "Reloads the Record cache from the configured Proxy using the configured Reader and\nthe options from the last load operation performed.",
+ "sig" : "(options)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.data.Store",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "node",
- "type" : "Node",
- "desc" : "The node to remove",
+ "name" : "options",
+ "type" : "Object",
+ "desc" : "(optional) An object containing properties which may override the options\nused in the last load operation. See {@link #load} for details (defaults to null, in which case\nthe most recently used options are reused).",
"isOptional" : false
}
],
- "returns" : [
+ "returns" : []
+ },
+ {
+ "name" : "remove",
+ "type" : "function",
+ "desc" : "Remove a Record from the Store and fires the remove event.",
+ "sig" : "(record)",
+ "static" : false,
+ "memberOf" : "Roo.data.Store",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
{
- "name" : "",
- "type" : "Node",
- "desc" : "The removed node"
+ "name" : "record",
+ "type" : "Ext.data.Record",
+ "desc" : "The Roo.data.Record object to remove from the cache.",
+ "isOptional" : false
}
- ]
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "removeAll",
+ "type" : "function",
+ "desc" : "Remove all Records from the Store and fires the clear event.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.data.Store",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
},
{
"name" : "removeListener",
"returns" : []
},
{
- "name" : "replaceChild",
+ "name" : "setDefaultSort",
"type" : "function",
- "desc" : "Replaces one child node in this node with another.",
- "sig" : "(newChild, oldChild)",
+ "desc" : "Sets the default sort column and order to be used by the next load operation.",
+ "sig" : "(fieldName, dir)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.data.Store",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "newChild",
- "type" : "Node",
- "desc" : "The replacement node",
+ "name" : "fieldName",
+ "type" : "String",
+ "desc" : "The name of the field to sort by.",
"isOptional" : false
},
{
- "name" : "oldChild",
- "type" : "Node",
- "desc" : "The node to replace",
+ "name" : "dir",
+ "type" : "String",
+ "desc" : "(optional) The sort order, \"ASC\" or \"DESC\" (defaults to \"ASC\")",
"isOptional" : false
}
],
- "returns" : [
- {
- "name" : "",
- "type" : "Node",
- "desc" : "The replaced node"
- }
- ]
+ "returns" : []
},
{
"name" : "sort",
"type" : "function",
- "desc" : "Sorts this nodes children using the supplied sort function",
- "sig" : "(fn, scope)",
+ "desc" : "Sort the Records.\nIf remote sorting is used, the sort is performed on the server, and the cache is\nreloaded. If local sorting is used, the cache is sorted internally.",
+ "sig" : "(fieldName, dir)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.data.Store",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "fn",
- "type" : "Function",
- "desc" : "",
+ "name" : "fieldName",
+ "type" : "String",
+ "desc" : "The name of the field to sort by.",
"isOptional" : false
},
{
- "name" : "scope",
- "type" : "Object",
- "desc" : "(optional)",
+ "name" : "dir",
+ "type" : "String",
+ "desc" : "(optional) The sort order, \"ASC\" or \"DESC\" (defaults to \"ASC\")",
"isOptional" : false
}
],
"returns" : []
},
+ {
+ "name" : "sum",
+ "type" : "function",
+ "desc" : "Sums the value of <i>property</i> for each record between start and end and returns the result.",
+ "sig" : "(property, start, end)",
+ "static" : false,
+ "memberOf" : "Roo.data.Store",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "property",
+ "type" : "String",
+ "desc" : "A field on your records",
+ "isOptional" : false
+ },
+ {
+ "name" : "start",
+ "type" : "Number",
+ "desc" : "The record index to start at (defaults to 0)",
+ "isOptional" : false
+ },
+ {
+ "name" : "end",
+ "type" : "Number",
+ "desc" : "The last record index to include (defaults to length - 1)",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Number",
+ "desc" : "The sum"
+ }
+ ]
+ },
{
"name" : "un",
"type" : "function",
],
"isAbstract" : false,
"isBuilderTop" : false,
- "implementations" : [
- "Roo.tree.AsyncTreeNode",
- "Roo.tree.TreeNode"
- ],
+ "implementations" : [],
"tree_children" : [],
"tree_parent" : []
},
- "Roo.data.Record" : {
+ "Roo.data.SortTypes" : {
"props" : [],
"events" : [],
"methods" : [
{
- "name" : "commit",
- "type" : "function",
- "desc" : "Usually called by the {@link Roo.data.Store} which owns the Record.\nCommits all changes made to the Record since either creation, or the last commit operation.\n<p>\nDevelopers should subscribe to the {@link Roo.data.Store#update} event to have their code notified\nof commit operations.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
- {
- "name" : "copy",
+ "name" : "asDate",
"type" : "function",
- "desc" : "Creates a copy of this record.",
- "sig" : "(id)",
- "static" : false,
+ "desc" : "Date sorting",
+ "sig" : "(s)",
+ "static" : true,
"memberOf" : "",
- "isStatic" : false,
+ "isStatic" : true,
"isConstructor" : false,
"isPrivate" : false,
"example" : "",
"requires" : "",
"params" : [
{
- "name" : "id",
- "type" : "String",
- "desc" : "(optional) A new record id if you don't want to use this record's id",
+ "name" : "s",
+ "type" : "Mixed",
+ "desc" : "The value being converted",
"isOptional" : false
}
],
"returns" : [
{
"name" : "",
- "type" : "Record",
- "desc" : ""
+ "type" : "Number",
+ "desc" : "The comparison value"
}
]
},
{
- "name" : "create",
+ "name" : "asFloat",
"type" : "function",
- "desc" : "Generate a constructor for a specific record layout.",
- "sig" : "(o)",
+ "desc" : "Float sorting",
+ "sig" : "(s)",
"static" : true,
"memberOf" : "",
"isStatic" : true,
"requires" : "",
"params" : [
{
- "name" : "o",
- "type" : "Array",
- "desc" : "An Array of field definition objects which specify field names, and optionally,\ndata types, and a mapping for an {@link Roo.data.Reader} to extract the field's value from a data object.\nEach field definition object may contain the following properties: <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>",
+ "name" : "s",
+ "type" : "Mixed",
+ "desc" : "The value being converted",
"isOptional" : false
}
],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Float",
+ "desc" : "The comparison value"
+ }
+ ]
},
{
- "name" : "get",
+ "name" : "asInt",
"type" : "function",
- "desc" : "Get the value of the named field.",
- "sig" : "(name)",
- "static" : false,
+ "desc" : "Integer sorting",
+ "sig" : "(s)",
+ "static" : true,
"memberOf" : "",
- "isStatic" : false,
+ "isStatic" : true,
"isConstructor" : false,
"isPrivate" : false,
"example" : "",
"requires" : "",
"params" : [
{
- "name" : "name",
- "type" : "String",
- "desc" : "The name of the field to get the value of.",
+ "name" : "s",
+ "type" : "Mixed",
+ "desc" : "The value being converted",
"isOptional" : false
}
],
"returns" : [
{
"name" : "",
- "type" : "Object",
- "desc" : "The value of the field."
+ "type" : "Number",
+ "desc" : "The comparison value"
}
]
},
{
- "name" : "reject",
+ "name" : "asText",
"type" : "function",
- "desc" : "Usually called by the {@link Roo.data.Store} which owns the Record.\nRejects all changes made to the Record since either creation, or the last commit operation.\nModified fields are reverted to their original values.\n<p>\nDevelopers should subscribe to the {@link Roo.data.Store#update} event to have their code notified\nof reject operations.",
- "sig" : "()\n{\n\n}",
- "static" : false,
+ "desc" : "Strips all HTML tags to sort on text only",
+ "sig" : "(s)",
+ "static" : true,
"memberOf" : "",
- "isStatic" : false,
+ "isStatic" : true,
"isConstructor" : false,
"isPrivate" : false,
"example" : "",
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
- "returns" : []
+ "params" : [
+ {
+ "name" : "s",
+ "type" : "Mixed",
+ "desc" : "The value being converted",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "String",
+ "desc" : "The comparison value"
+ }
+ ]
},
{
- "name" : "set",
+ "name" : "asUCString",
"type" : "function",
- "desc" : "Set the named field to the specified value.",
- "sig" : "(name, value)",
- "static" : false,
+ "desc" : "Case insensitive string",
+ "sig" : "(s)",
+ "static" : true,
"memberOf" : "",
- "isStatic" : false,
+ "isStatic" : true,
"isConstructor" : false,
"isPrivate" : false,
"example" : "",
"requires" : "",
"params" : [
{
- "name" : "name",
- "type" : "String",
- "desc" : "The name of the field to set.",
- "isOptional" : false
- },
- {
- "name" : "value",
- "type" : "Object",
- "desc" : "The value to set the field to.",
+ "name" : "s",
+ "type" : "Mixed",
+ "desc" : "The value being converted",
"isOptional" : false
}
],
- "returns" : []
- }
- ],
- "isAbstract" : false,
- "isBuilderTop" : false,
- "implementations" : [],
- "tree_children" : [],
- "tree_parent" : []
- },
- "Roo.data.ScriptTagProxy" : {
- "props" : [
- {
- "name" : "callbackParam",
- "type" : "String",
- "desc" : "(Optional) The name of the parameter to pass to the server which tells\nthe server the name of the callback function set up by the load call to process the returned data object.\nDefaults to \"callback\".<p>The server-side processing must read this parameter value, and generate\njavascript output which calls this named function passing the data object as its only parameter.",
- "memberOf" : ""
- },
- {
- "name" : "nocache",
- "type" : "Boolean",
- "desc" : "(Optional) Defaults to true. Disable cacheing by adding a unique parameter\nname to the request.",
- "memberOf" : ""
- },
- {
- "name" : "timeout",
- "type" : "Number",
- "desc" : "(Optional) The number of milliseconds to wait for a response. Defaults to 30 seconds.",
- "memberOf" : ""
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "String",
+ "desc" : "The comparison value"
+ }
+ ]
},
{
- "name" : "url",
- "type" : "String",
- "desc" : "The URL from which to request the data object.",
- "memberOf" : ""
- }
- ],
- "events" : [],
- "methods" : [
- {
- "name" : "abort",
+ "name" : "asUCText",
"type" : "function",
- "desc" : "Abort the current server request.",
- "sig" : "()\n{\n\n}",
- "static" : false,
+ "desc" : "Strips all HTML tags to sort on text only - Case insensitive",
+ "sig" : "(s)",
+ "static" : true,
"memberOf" : "",
- "isStatic" : false,
+ "isStatic" : true,
"isConstructor" : false,
"isPrivate" : false,
"example" : "",
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
- "returns" : []
+ "params" : [
+ {
+ "name" : "s",
+ "type" : "Mixed",
+ "desc" : "The value being converted",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "String",
+ "desc" : "The comparison value"
+ }
+ ]
},
{
- "name" : "load",
+ "name" : "none",
"type" : "function",
- "desc" : "Load data from the configured URL, read the data object into\na block of Roo.data.Records using the passed Roo.data.DataReader implementation, and\nprocess that block using the passed callback.",
- "sig" : "(params, reader, callback, scope, arg)",
- "static" : false,
+ "desc" : "Default sort that does nothing",
+ "sig" : "(s)",
+ "static" : true,
"memberOf" : "",
- "isStatic" : false,
+ "isStatic" : true,
"isConstructor" : false,
"isPrivate" : false,
"example" : "",
"requires" : "",
"params" : [
{
- "name" : "params",
- "type" : "Object",
- "desc" : "An object containing properties which are to be used as HTTP parameters\nfor the request to the remote server.",
- "isOptional" : false
- },
- {
- "name" : "reader",
- "type" : "Roo.data.DataReader",
- "desc" : "The Reader object which converts the data\nobject into a block of Roo.data.Records.",
- "isOptional" : false
- },
- {
- "name" : "callback",
- "type" : "Function",
- "desc" : "The function into which to pass the block of Roo.data.Records.\nThe function must be passed <ul>\n<li>The Record block object</li>\n<li>The \"arg\" argument from the load function</li>\n<li>A boolean success indicator</li>\n</ul>",
- "isOptional" : false
- },
- {
- "name" : "scope",
- "type" : "Object",
- "desc" : "The scope in which to call the callback",
- "isOptional" : false
- },
- {
- "name" : "arg",
- "type" : "Object",
- "desc" : "An optional argument which is passed to the callback as its second parameter.",
+ "name" : "s",
+ "type" : "Mixed",
+ "desc" : "The value being converted",
"isOptional" : false
}
],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Mixed",
+ "desc" : "The comparison value"
+ }
+ ]
}
],
"isAbstract" : false,
"tree_children" : [],
"tree_parent" : []
},
- "Roo.data.SimpleStore" : {
+ "Roo.data.Store" : {
"props" : [
- {
- "name" : "an",
- "type" : "Object",
- "desc" : "existing reader (eg. copied from another store)",
- "memberOf" : ""
- },
{
"name" : "baseParams",
"type" : "Object",
"desc" : "An object containing properties which are to be sent as parameters\non any HTTP request",
- "memberOf" : "Roo.data.Store"
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "data",
"type" : "Array",
- "desc" : "The multi-dimensional array of data",
- "memberOf" : ""
- },
- {
- "name" : "fields",
- "type" : "Array",
- "desc" : "An array of field definition objects, or field name strings.",
- "memberOf" : ""
- },
- {
- "name" : "id",
- "type" : "Number",
- "desc" : "The array index of the record id. Leave blank to auto generate ids.",
- "memberOf" : ""
+ "desc" : "Inline data to be loaded when the store is initialized.",
+ "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" : "",
+ "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" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "proxy",
"type" : "Roo.data.DataProxy",
- "desc" : "[not-required]",
- "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" : "Roo.data.Store"
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "reader",
- "type" : "Roo.data.Reader",
- "desc" : "[not-required]",
- "memberOf" : ""
+ "type" : "Roo.data.DataReader",
+ "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" : "Roo.data.Store"
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "sortInfo",
"type" : "Object",
"desc" : "A config object in the format: {field: \"fieldName\", direction: \"ASC|DESC\"}",
- "memberOf" : "Roo.data.Store"
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
}
],
"events" : [
"type" : "function",
"desc" : "Fires when Records have been added to the Store",
"sig" : "function (_self, records, index)\n{\n\n}",
- "memberOf" : "Roo.data.Store",
+ "memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
"type" : "function",
"desc" : "Fires before a request is made for a new data object. If the beforeload handler returns false\nthe load action will be canceled.",
"sig" : "function (_self, options)\n{\n\n}",
- "memberOf" : "Roo.data.Store",
+ "memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
"type" : "function",
"desc" : "Fires after a new set of Records has been loaded.",
"sig" : "function (_self, records, options)\n{\n\n}",
- "memberOf" : "Roo.data.Store",
+ "memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
"type" : "function",
"desc" : "Fires when the data cache has been cleared.",
"sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.data.Store",
+ "memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
"type" : "function",
"desc" : "Fires when the data cache has changed, and a widget which is using this Store\nas a Record cache should refresh its view.",
"sig" : "function (_self)\n{\n\n}",
- "memberOf" : "Roo.data.Store",
+ "memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
"type" : "function",
"desc" : "Fires after a new set of Records has been loaded, before they are added to the store.",
"sig" : "function (_self, records, options)\n{\n\n}",
- "memberOf" : "Roo.data.Store",
+ "memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
"name" : "loadexception",
"type" : "function",
"desc" : "Fires if an exception occurs in the Proxy during loading.\nCalled with the signature of the Proxy's \"loadexception\" event.\nIf you return Json { data: [] , success: false, .... } then this will be thrown with the following args",
- "sig" : "function (, return, load, jsonData)\n{\n\n}",
- "memberOf" : "Roo.data.Store",
+ "sig" : "function (, ret, opts, jsonData)\n{\n\n}",
+ "memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
"isOptional" : false
},
{
- "name" : "return",
+ "name" : "ret",
"type" : "Object",
- "desc" : "from JsonData.reader() - success, totalRecords, records",
+ "desc" : "return data from JsonData.reader() - success, totalRecords, records",
"isOptional" : false
},
{
- "name" : "load",
+ "name" : "opts",
"type" : "Object",
- "desc" : "options",
+ "desc" : "- load Options",
"isOptional" : false
},
{
"type" : "function",
"desc" : "Fires when this store's reader provides new metadata (fields). This is currently only support for JsonReaders.",
"sig" : "function (_self, meta)\n{\n\n}",
- "memberOf" : "Roo.data.Store",
+ "memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
"type" : "function",
"desc" : "Fires when a Record has been removed from the Store",
"sig" : "function (_self, record, index)\n{\n\n}",
- "memberOf" : "Roo.data.Store",
+ "memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
"type" : "function",
"desc" : "Fires when a Record has been updated",
"sig" : "function (_self, record, operation)\n{\n\n}",
- "memberOf" : "Roo.data.Store",
+ "memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
"desc" : "Add Records to the Store and fires the add event.",
"sig" : "(records)",
"static" : false,
- "memberOf" : "Roo.data.Store",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"desc" : "Revert to a view of the Record cache with no filtering applied.",
"sig" : "(suppressEvent)",
"static" : false,
- "memberOf" : "Roo.data.Store",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"desc" : "Collects unique values for a particular dataIndex from this store.",
"sig" : "(dataIndex, allowNull, bypassFilter)",
"static" : false,
- "memberOf" : "Roo.data.Store",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"desc" : "Commit all Records with outstanding changes. To handle updates for changes, subscribe to the\nStore's \"update\" event, and perform updating when the third parameter is Roo.data.Record.COMMIT.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.data.Store",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"desc" : "Calls the specified function for each of the Records in the cache.",
"sig" : "(fn, scope)",
"static" : false,
- "memberOf" : "Roo.data.Store",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"desc" : "Filter the records by a specified property.",
"sig" : "(field, value, anyMatch)",
"static" : false,
- "memberOf" : "Roo.data.Store",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"desc" : "Filter by a function. The specified function will be called with each\nrecord in this data source. If the function returns true the record is included,\notherwise it is filtered.",
"sig" : "(fn, scope)",
"static" : false,
- "memberOf" : "Roo.data.Store",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"desc" : "Get the Record at the specified index.",
"sig" : "(index)",
"static" : false,
- "memberOf" : "Roo.data.Store",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"desc" : "Get the Record with the specified id.",
"sig" : "(id)",
"static" : false,
- "memberOf" : "Roo.data.Store",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"desc" : "Gets the number of cached records.\n<p>\n<em>If using paging, this may not be the total size of the dataset. If the data object\nused by the Reader contains the dataset size, then the getTotalCount() function returns\nthe data set size</em>",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.data.Store",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"desc" : "Gets all records modified since the last commit. Modified records are persisted across load operations\n(e.g., during paging).",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.data.Store",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"desc" : "Returns a range of Records between specified indices.",
"sig" : "(startIndex, endIndex)",
"static" : false,
- "memberOf" : "Roo.data.Store",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"desc" : "Returns the sort state of the Store as an object with two properties:\n<pre><code>\n field {String} The name of the field by which the Records are sorted\n direction {String} The sort order, \"ASC\" or \"DESC\"\n</code></pre>",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.data.Store",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"desc" : "Gets the total number of records in the dataset as returned by the server.\n<p>\n<em>If using paging, for this to be accurate, the data object used by the Reader must contain\nthe dataset size</em>",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.data.Store",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"desc" : "Get the index within the cache of the passed Record.",
"sig" : "(record)",
"static" : false,
- "memberOf" : "Roo.data.Store",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"desc" : "Get the index within the cache of the Record with the passed id.",
"sig" : "(id)",
"static" : false,
- "memberOf" : "Roo.data.Store",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"desc" : "Inserts Records to the Store at the given index and fires the add event.",
"sig" : "(index, records)",
"static" : false,
- "memberOf" : "Roo.data.Store",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"desc" : "Loads the Record cache from the configured Proxy using the configured Reader.\n<p>\nIf using remote paging, then the first load call must specify the <em>start</em>\nand <em>limit</em> properties in the options.params property to establish the initial\nposition within the dataset, and the number of Records to cache on each read from the Proxy.\n<p>\n<strong>It is important to note that for remote data sources, loading is asynchronous,\nand this call will return before the new data has been loaded. Perform any post-processing\nin a callback function, or in a \"load\" event handler.</strong>\n<p>",
"sig" : "(options)",
"static" : false,
- "memberOf" : "Roo.data.Store",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
{
"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
}
],
"desc" : "Loads data from a passed data block. A Reader which understands the format of the data\nmust have been configured in the constructor.",
"sig" : "(data, append)",
"static" : false,
- "memberOf" : "Roo.data.Store",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : 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
}
],
"desc" : "using 'cn' the nested child reader read the child array into it's child stores.",
"sig" : "(rec)",
"static" : false,
- "memberOf" : "Roo.data.Store",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"desc" : "Query the records by a specified property.",
"sig" : "(field, value, anyMatch)",
"static" : false,
- "memberOf" : "Roo.data.Store",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"desc" : "Query by a function. The specified function will be called with each\nrecord in this data source. If the function returns true the record is included\nin the results.",
"sig" : "(fn, scope)",
"static" : false,
- "memberOf" : "Roo.data.Store",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"desc" : "Cancel outstanding changes on all changed records.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.data.Store",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"desc" : "Reloads the Record cache from the configured Proxy using the configured Reader and\nthe options from the last load operation performed.",
"sig" : "(options)",
"static" : false,
- "memberOf" : "Roo.data.Store",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"desc" : "Remove a Record from the Store and fires the remove event.",
"sig" : "(record)",
"static" : false,
- "memberOf" : "Roo.data.Store",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"desc" : "Remove all Records from the Store and fires the clear event.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.data.Store",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"desc" : "Sets the default sort column and order to be used by the next load operation.",
"sig" : "(fieldName, dir)",
"static" : false,
- "memberOf" : "Roo.data.Store",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"desc" : "Sort the Records.\nIf remote sorting is used, the sort is performed on the server, and the cache is\nreloaded. If local sorting is used, the cache is sorted internally.",
"sig" : "(fieldName, dir)",
"static" : false,
- "memberOf" : "Roo.data.Store",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"desc" : "Sums the value of <i>property</i> for each record between start and end and returns the result.",
"sig" : "(property, start, end)",
"static" : false,
- "memberOf" : "Roo.data.Store",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
],
"isAbstract" : false,
"isBuilderTop" : false,
- "implementations" : [],
- "tree_children" : [],
- "tree_parent" : []
- },
- "Roo.data.SortTypes" : {
- "props" : [],
- "events" : [],
- "methods" : [
- {
- "name" : "asDate",
- "type" : "function",
- "desc" : "Date sorting",
- "sig" : "(s)",
- "static" : true,
- "memberOf" : "",
- "isStatic" : true,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "s",
- "type" : "Mixed",
- "desc" : "The value being converted",
- "isOptional" : false
- }
- ],
- "returns" : [
- {
- "name" : "",
- "type" : "Number",
- "desc" : "The comparison value"
- }
- ]
- },
- {
- "name" : "asFloat",
- "type" : "function",
- "desc" : "Float sorting",
- "sig" : "(s)",
- "static" : true,
- "memberOf" : "",
- "isStatic" : true,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "s",
- "type" : "Mixed",
- "desc" : "The value being converted",
- "isOptional" : false
- }
- ],
- "returns" : [
- {
- "name" : "",
- "type" : "Float",
- "desc" : "The comparison value"
- }
- ]
- },
- {
- "name" : "asInt",
- "type" : "function",
- "desc" : "Integer sorting",
- "sig" : "(s)",
- "static" : true,
- "memberOf" : "",
- "isStatic" : true,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "s",
- "type" : "Mixed",
- "desc" : "The value being converted",
- "isOptional" : false
- }
- ],
- "returns" : [
- {
- "name" : "",
- "type" : "Number",
- "desc" : "The comparison value"
- }
- ]
- },
- {
- "name" : "asText",
- "type" : "function",
- "desc" : "Strips all HTML tags to sort on text only",
- "sig" : "(s)",
- "static" : true,
- "memberOf" : "",
- "isStatic" : true,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "s",
- "type" : "Mixed",
- "desc" : "The value being converted",
- "isOptional" : false
- }
- ],
- "returns" : [
- {
- "name" : "",
- "type" : "String",
- "desc" : "The comparison value"
- }
- ]
- },
- {
- "name" : "asUCString",
- "type" : "function",
- "desc" : "Case insensitive string",
- "sig" : "(s)",
- "static" : true,
- "memberOf" : "",
- "isStatic" : true,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "s",
- "type" : "Mixed",
- "desc" : "The value being converted",
- "isOptional" : false
- }
- ],
- "returns" : [
- {
- "name" : "",
- "type" : "String",
- "desc" : "The comparison value"
- }
- ]
- },
- {
- "name" : "asUCText",
- "type" : "function",
- "desc" : "Strips all HTML tags to sort on text only - Case insensitive",
- "sig" : "(s)",
- "static" : true,
- "memberOf" : "",
- "isStatic" : true,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "s",
- "type" : "Mixed",
- "desc" : "The value being converted",
- "isOptional" : false
- }
- ],
- "returns" : [
- {
- "name" : "",
- "type" : "String",
- "desc" : "The comparison value"
- }
- ]
- },
- {
- "name" : "none",
- "type" : "function",
- "desc" : "Default sort that does nothing",
- "sig" : "(s)",
- "static" : true,
- "memberOf" : "",
- "isStatic" : true,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "s",
- "type" : "Mixed",
- "desc" : "The value being converted",
- "isOptional" : false
- }
- ],
- "returns" : [
- {
- "name" : "",
- "type" : "Mixed",
- "desc" : "The comparison value"
- }
- ]
- }
+ "implementations" : [
+ "Roo.data.JsonStore",
+ "Roo.data.SimpleStore"
],
- "isAbstract" : false,
- "isBuilderTop" : false,
- "implementations" : [],
"tree_children" : [],
"tree_parent" : []
},
- "Roo.data.Store" : {
+ "Roo.data.Tree" : {
"props" : [
- {
- "name" : "baseParams",
- "type" : "Object",
- "desc" : "An object containing properties which are to be sent as parameters\non any HTTP request",
- "memberOf" : ""
- },
- {
- "name" : "data",
- "type" : "Array",
- "desc" : "Inline data to be loaded when the store is initialized.",
- "memberOf" : ""
- },
- {
- "name" : "isLocal",
- "type" : "boolean",
- "desc" : "flag if data is locally available (and can be always looked up\nwithout a remote query - used by combo/forms at present.",
- "memberOf" : ""
- },
{
"name" : "listeners",
"type" : "Object",
"desc" : "list of events and functions to call for this object, \nFor example :\n<pre><code>\n listeners : { \n 'click' : function(e) {\n ..... \n } ,\n .... \n } \n </code></pre>",
- "memberOf" : "Roo.util.Observable"
- },
- {
- "name" : "multiSort",
- "type" : "Boolean",
- "desc" : "enable multi column sorting (sort is based on the order of columns, remote only at present)",
- "memberOf" : ""
- },
- {
- "name" : "proxy",
- "type" : "Roo.data.DataProxy",
- "desc" : "[required] The Proxy object which provides access to a data object.",
- "memberOf" : ""
- },
- {
- "name" : "pruneModifiedRecords",
- "type" : "boolean",
- "desc" : "True to clear all modified record information each time the store is\nloaded or when a record is removed. (defaults to false).",
- "memberOf" : ""
- },
- {
- "name" : "reader",
- "type" : "Roo.data.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" : ""
- },
- {
- "name" : "remoteSort",
- "type" : "boolean",
- "desc" : "True if sorting is to be handled by requesting the Proxy to provide a refreshed\nversion of the data object in sorted order, as opposed to sorting the Record cache in place (defaults to false).",
- "memberOf" : ""
- },
- {
- "name" : "sortInfo",
- "type" : "Object",
- "desc" : "A config object in the format: {field: \"fieldName\", direction: \"ASC|DESC\"}",
- "memberOf" : ""
+ "memberOf" : "Roo.util.Observable",
+ "isOptional" : false,
+ "optvals" : []
}
],
"events" : [
{
- "name" : "add",
+ "name" : "append",
"type" : "function",
- "desc" : "Fires when Records have been added to the Store",
- "sig" : "function (_self, records, index)\n{\n\n}",
+ "desc" : "Fires when a new child node is appended to a node in this tree.",
+ "sig" : "function (tree, parent, node, index)\n{\n\n}",
"memberOf" : "",
"example" : "",
"deprecated" : "",
"see" : "",
"params" : [
{
- "name" : "this",
- "type" : "Store",
- "desc" : "",
+ "name" : "tree",
+ "type" : "Tree",
+ "desc" : "The owner tree",
"isOptional" : false
},
{
- "name" : "records",
- "type" : "Roo.data.Record[]",
- "desc" : "The array of Records added",
+ "name" : "parent",
+ "type" : "Node",
+ "desc" : "The parent node",
+ "isOptional" : false
+ },
+ {
+ "name" : "node",
+ "type" : "Node",
+ "desc" : "The newly appended node",
"isOptional" : false
},
{
"name" : "index",
"type" : "Number",
- "desc" : "The index at which the record(s) were added",
+ "desc" : "The index of the newly appended node",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "beforeload",
+ "name" : "beforeappend",
"type" : "function",
- "desc" : "Fires before a request is made for a new data object. If the beforeload handler returns false\nthe load action will be canceled.",
- "sig" : "function (_self, options)\n{\n\n}",
+ "desc" : "Fires before a new child is appended to a node in this tree, return false to cancel the append.",
+ "sig" : "function (tree, parent, node)\n{\n\n}",
"memberOf" : "",
"example" : "",
"deprecated" : "",
"see" : "",
"params" : [
{
- "name" : "this",
- "type" : "Store",
- "desc" : "",
+ "name" : "tree",
+ "type" : "Tree",
+ "desc" : "The owner tree",
"isOptional" : false
},
{
- "name" : "options",
- "type" : "Object",
- "desc" : "The loading options that were specified (see {@link #load} for details)",
+ "name" : "parent",
+ "type" : "Node",
+ "desc" : "The parent node",
+ "isOptional" : false
+ },
+ {
+ "name" : "node",
+ "type" : "Node",
+ "desc" : "The child node to be appended",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "beforeloadadd",
+ "name" : "beforeinsert",
"type" : "function",
- "desc" : "Fires after a new set of Records has been loaded.",
- "sig" : "function (_self, records, options)\n{\n\n}",
+ "desc" : "Fires before a new child is inserted in a node in this tree, return false to cancel the insert.",
+ "sig" : "function (tree, parent, node, refNode)\n{\n\n}",
"memberOf" : "",
"example" : "",
"deprecated" : "",
"see" : "",
"params" : [
{
- "name" : "this",
- "type" : "Store",
- "desc" : "",
+ "name" : "tree",
+ "type" : "Tree",
+ "desc" : "The owner tree",
"isOptional" : false
},
{
- "name" : "records",
- "type" : "Roo.data.Record[]",
- "desc" : "The Records that were loaded",
+ "name" : "parent",
+ "type" : "Node",
+ "desc" : "The parent node",
"isOptional" : false
},
{
- "name" : "options",
- "type" : "Object",
- "desc" : "The loading options that were specified (see {@link #load} for details)",
+ "name" : "node",
+ "type" : "Node",
+ "desc" : "The child node to be inserted",
"isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "clear",
- "type" : "function",
- "desc" : "Fires when the data cache has been cleared.",
- "sig" : "function (_self)\n{\n\n}",
- "memberOf" : "",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
+ },
{
- "name" : "this",
- "type" : "Store",
- "desc" : "",
+ "name" : "refNode",
+ "type" : "Node",
+ "desc" : "The child node the node is being inserted before",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "datachanged",
+ "name" : "beforemove",
"type" : "function",
- "desc" : "Fires when the data cache has changed, and a widget which is using this Store\nas a Record cache should refresh its view.",
- "sig" : "function (_self)\n{\n\n}",
+ "desc" : "Fires before a node is moved to a new location in the tree. Return false to cancel the move.",
+ "sig" : "function (tree, node, oldParent, newParent, index)\n{\n\n}",
"memberOf" : "",
"example" : "",
"deprecated" : "",
"see" : "",
"params" : [
{
- "name" : "this",
- "type" : "Store",
- "desc" : "",
+ "name" : "tree",
+ "type" : "Tree",
+ "desc" : "The owner tree",
+ "isOptional" : false
+ },
+ {
+ "name" : "node",
+ "type" : "Node",
+ "desc" : "The node being moved",
+ "isOptional" : false
+ },
+ {
+ "name" : "oldParent",
+ "type" : "Node",
+ "desc" : "The parent of the node",
+ "isOptional" : false
+ },
+ {
+ "name" : "newParent",
+ "type" : "Node",
+ "desc" : "The new parent the node is moving to",
+ "isOptional" : false
+ },
+ {
+ "name" : "index",
+ "type" : "Number",
+ "desc" : "The index it is being moved to",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "load",
+ "name" : "beforeremove",
"type" : "function",
- "desc" : "Fires after a new set of Records has been loaded, before they are added to the store.",
- "sig" : "function (_self, records, options)\n{\n\n}",
+ "desc" : "Fires before a child is removed from a node in this tree, return false to cancel the remove.",
+ "sig" : "function (tree, parent, node)\n{\n\n}",
"memberOf" : "",
"example" : "",
"deprecated" : "",
"see" : "",
"params" : [
{
- "name" : "this",
- "type" : "Store",
- "desc" : "",
+ "name" : "tree",
+ "type" : "Tree",
+ "desc" : "The owner tree",
"isOptional" : false
},
{
- "name" : "records",
- "type" : "Roo.data.Record[]",
- "desc" : "The Records that were loaded",
+ "name" : "parent",
+ "type" : "Node",
+ "desc" : "The parent node",
"isOptional" : false
},
{
- "name" : "options",
- "type" : "Object",
- "desc" : "The loading options that were specified (see {@link #load} for details)",
+ "name" : "node",
+ "type" : "Node",
+ "desc" : "The child node to be removed",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "loadexception",
+ "name" : "insert",
"type" : "function",
- "desc" : "Fires if an exception occurs in the Proxy during loading.\nCalled with the signature of the Proxy's \"loadexception\" event.\nIf you return Json { data: [] , success: false, .... } then this will be thrown with the following args",
- "sig" : "function (, return, load, jsonData)\n{\n\n}",
+ "desc" : "Fires when a new child node is inserted in a node in this tree.",
+ "sig" : "function (tree, parent, node, refNode)\n{\n\n}",
"memberOf" : "",
"example" : "",
"deprecated" : "",
"see" : "",
"params" : [
{
- "name" : "",
- "type" : "Proxy",
- "desc" : "",
+ "name" : "tree",
+ "type" : "Tree",
+ "desc" : "The owner tree",
"isOptional" : false
},
{
- "name" : "return",
- "type" : "Object",
- "desc" : "from JsonData.reader() - success, totalRecords, records",
+ "name" : "parent",
+ "type" : "Node",
+ "desc" : "The parent node",
"isOptional" : false
},
{
- "name" : "load",
- "type" : "Object",
- "desc" : "options",
+ "name" : "node",
+ "type" : "Node",
+ "desc" : "The child node inserted",
"isOptional" : false
},
{
- "name" : "jsonData",
- "type" : "Object",
- "desc" : "from your request (normally this contains the Exception)",
+ "name" : "refNode",
+ "type" : "Node",
+ "desc" : "The child node the node was inserted before",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "metachange",
+ "name" : "move",
"type" : "function",
- "desc" : "Fires when this store's reader provides new metadata (fields). This is currently only support for JsonReaders.",
- "sig" : "function (_self, meta)\n{\n\n}",
+ "desc" : "Fires when a node is moved to a new location in the tree",
+ "sig" : "function (tree, node, oldParent, newParent, index)\n{\n\n}",
"memberOf" : "",
"example" : "",
"deprecated" : "",
"see" : "",
"params" : [
{
- "name" : "this",
- "type" : "Store",
- "desc" : "",
+ "name" : "tree",
+ "type" : "Tree",
+ "desc" : "The owner tree",
"isOptional" : false
},
{
- "name" : "meta",
- "type" : "Object",
- "desc" : "The JSON metadata",
+ "name" : "node",
+ "type" : "Node",
+ "desc" : "The node moved",
"isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "remove",
- "type" : "function",
- "desc" : "Fires when a Record has been removed from the Store",
- "sig" : "function (_self, record, index)\n{\n\n}",
- "memberOf" : "",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
+ },
{
- "name" : "this",
- "type" : "Store",
- "desc" : "",
+ "name" : "oldParent",
+ "type" : "Node",
+ "desc" : "The old parent of this node",
"isOptional" : false
},
{
- "name" : "record",
- "type" : "Roo.data.Record",
- "desc" : "The Record that was removed",
+ "name" : "newParent",
+ "type" : "Node",
+ "desc" : "The new parent of this node",
"isOptional" : false
},
{
"name" : "index",
"type" : "Number",
- "desc" : "The index at which the record was removed",
+ "desc" : "The index it was moved to",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "update",
+ "name" : "remove",
"type" : "function",
- "desc" : "Fires when a Record has been updated",
- "sig" : "function (_self, record, operation)\n{\n\n}",
+ "desc" : "Fires when a child node is removed from a node in this tree.",
+ "sig" : "function (tree, parent, node)\n{\n\n}",
"memberOf" : "",
"example" : "",
"deprecated" : "",
"see" : "",
"params" : [
{
- "name" : "this",
- "type" : "Store",
- "desc" : "",
+ "name" : "tree",
+ "type" : "Tree",
+ "desc" : "The owner tree",
"isOptional" : false
},
{
- "name" : "record",
- "type" : "Roo.data.Record",
- "desc" : "The Record that was updated",
+ "name" : "parent",
+ "type" : "Node",
+ "desc" : "The parent node",
"isOptional" : false
},
{
- "name" : "operation",
- "type" : "String",
- "desc" : "The update operation being performed. Value may be one of:\n<pre><code>\n Roo.data.Record.EDIT\n Roo.data.Record.REJECT\n Roo.data.Record.COMMIT\n</code></pre>",
+ "name" : "node",
+ "type" : "Node",
+ "desc" : "The child node removed",
"isOptional" : false
}
],
}
],
"methods" : [
- {
- "name" : "add",
- "type" : "function",
- "desc" : "Add Records to the Store and fires the add event.",
- "sig" : "(records)",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "records",
- "type" : "Roo.data.Record[]",
- "desc" : "An Array of Roo.data.Record objects to add to the cache.",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
{
"name" : "addEvents",
"type" : "function",
"returns" : []
},
{
- "name" : "clearFilter",
+ "name" : "fireEvent",
"type" : "function",
- "desc" : "Revert to a view of the Record cache with no filtering applied.",
- "sig" : "(suppressEvent)",
+ "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" : "suppressEvent",
- "type" : "Boolean",
- "desc" : "If true the filter is cleared silently without notifying listeners",
+ "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" : "collect",
+ "name" : "getNodeById",
"type" : "function",
- "desc" : "Collects unique values for a particular dataIndex from this store.",
- "sig" : "(dataIndex, allowNull, bypassFilter)",
+ "desc" : "Gets a node in this tree by its id.",
+ "sig" : "(id)",
"static" : false,
"memberOf" : "",
"isStatic" : false,
"requires" : "",
"params" : [
{
- "name" : "dataIndex",
+ "name" : "id",
"type" : "String",
- "desc" : "The property to collect",
- "isOptional" : false
- },
- {
- "name" : "allowNull",
- "type" : "Boolean",
- "desc" : "(optional) Pass true to allow null, undefined or empty string values",
- "isOptional" : false
- },
- {
- "name" : "bypassFilter",
- "type" : "Boolean",
- "desc" : "(optional) Pass true to collect from all records, even ones which are filtered",
+ "desc" : "",
"isOptional" : false
}
],
"returns" : [
{
"name" : "",
- "type" : "Array",
- "desc" : "An array of the unique values"
+ "type" : "Node",
+ "desc" : ""
}
]
},
{
- "name" : "commitChanges",
+ "name" : "getRootNode",
"type" : "function",
- "desc" : "Commit all Records with outstanding changes. To handle updates for changes, subscribe to the\nStore's \"update\" event, and perform updating when the third parameter is Roo.data.Record.COMMIT.",
+ "desc" : "Returns the root node for this tree.",
"sig" : "()\n{\n\n}",
"static" : false,
"memberOf" : "",
"exceptions" : "",
"requires" : "",
"params" : [],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Node",
+ "desc" : ""
+ }
+ ]
},
{
- "name" : "each",
+ "name" : "hasListener",
"type" : "function",
- "desc" : "Calls the specified function for each of the Records in the cache.",
- "sig" : "(fn, scope)",
+ "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" : "fn",
- "type" : "Function",
- "desc" : "The function to call. The Record is passed as the first parameter.\nReturning <em>false</em> aborts and exits the iteration.",
- "isOptional" : false
- },
- {
- "name" : "scope",
- "type" : "Object",
- "desc" : "(optional) The scope in which to call the function (defaults to the Record).",
+ "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" : "filter",
+ "name" : "on",
"type" : "function",
- "desc" : "Filter the records by a specified property.",
- "sig" : "(field, value, anyMatch)",
+ "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" : "field",
+ "name" : "eventName",
"type" : "String",
- "desc" : "A field on your records",
+ "desc" : "The type of event to listen for",
"isOptional" : false
},
{
- "name" : "value",
- "type" : "String/RegExp",
- "desc" : "Either a string that the field\nshould start with or a RegExp to test against the field",
+ "name" : "handler",
+ "type" : "Function",
+ "desc" : "The method the event invokes",
"isOptional" : false
},
{
- "name" : "anyMatch",
- "type" : "Boolean",
- "desc" : "True to match any part not just the beginning",
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
+ "isOptional" : false
+ },
+ {
+ "name" : "options",
+ "type" : "Object",
+ "desc" : "(optional)",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "filterBy",
+ "name" : "purgeListeners",
"type" : "function",
- "desc" : "Filter by a function. The specified function will be called with each\nrecord in this data source. If the function returns true the record is included,\notherwise it is filtered.",
- "sig" : "(fn, scope)",
+ "desc" : "Removes all listeners for this object",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "",
+ "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" : "fn",
- "type" : "Function",
- "desc" : "The function to be called, it will receive 2 args (record, id)",
- "isOptional" : false
- },
- {
- "name" : "scope",
- "type" : "Object",
- "desc" : "(optional) The scope of the function (defaults to this)",
+ "name" : "o",
+ "type" : "Observable",
+ "desc" : "The Observable to release",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "fireEvent",
+ "name" : "removeListener",
"type" : "function",
- "desc" : "Fires the specified event with the passed parameters (minus the event name).",
- "sig" : "(eventName, args)",
+ "desc" : "Removes a listener",
+ "sig" : "(eventName, handler, scope)",
"static" : false,
"memberOf" : "Roo.util.Observable",
"isStatic" : false,
{
"name" : "eventName",
"type" : "String",
- "desc" : "",
+ "desc" : "The type of event to listen for",
"isOptional" : false
},
{
- "name" : "args",
- "type" : "Object...",
- "desc" : "Variable number of parameters are passed to handlers",
+ "name" : "handler",
+ "type" : "Function",
+ "desc" : "The handler to remove",
"isOptional" : false
- }
- ],
- "returns" : [
+ },
{
- "name" : "",
- "type" : "Boolean",
- "desc" : "returns false if any of the handlers return false otherwise it returns true"
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "(optional) The scope (this object) for the handler",
+ "isOptional" : false
}
- ]
+ ],
+ "returns" : []
},
{
- "name" : "getAt",
+ "name" : "setRootNode",
"type" : "function",
- "desc" : "Get the Record at the specified index.",
- "sig" : "(index)",
+ "desc" : "Sets the root node for this tree.",
+ "sig" : "(node)",
"static" : false,
"memberOf" : "",
"isStatic" : false,
"requires" : "",
"params" : [
{
- "name" : "index",
- "type" : "Number",
- "desc" : "The index of the Record to find.",
+ "name" : "node",
+ "type" : "Node",
+ "desc" : "",
"isOptional" : false
}
],
"returns" : [
{
"name" : "",
- "type" : "Roo.data.Record",
- "desc" : "The Record at the passed index. Returns undefined if not found."
+ "type" : "Node",
+ "desc" : ""
}
]
},
{
- "name" : "getById",
+ "name" : "un",
"type" : "function",
- "desc" : "Get the Record with the specified id.",
- "sig" : "(id)",
+ "desc" : "Removes a listener (shorthand for removeListener)",
+ "sig" : "(eventName, handler, scope)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.util.Observable",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "id",
+ "name" : "eventName",
"type" : "String",
- "desc" : "The id of the Record to find.",
+ "desc" : "The type of event to listen for",
"isOptional" : false
- }
- ],
- "returns" : [
+ },
{
- "name" : "",
- "type" : "Roo.data.Record",
- "desc" : "The Record with the passed id. Returns undefined if not found."
+ "name" : "handler",
+ "type" : "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" : [
+ "Roo.tree.ColumnTree",
+ "Roo.tree.TreePanel"
+ ],
+ "tree_children" : [],
+ "tree_parent" : []
+ },
+ "Roo.data.XmlReader" : {
+ "props" : [
+ {
+ "name" : "id",
+ "type" : "String",
+ "desc" : "The DomQuery path relative from the record element to the element that contains\na record identifier value.",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
- "name" : "getCount",
+ "name" : "record",
+ "type" : "String",
+ "desc" : "The DomQuery path to the repeated element which contains record information.",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "success",
+ "type" : "String",
+ "desc" : "The DomQuery path to the success attribute used by forms.",
+ "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" : "",
+ "isOptional" : false,
+ "optvals" : []
+ }
+ ],
+ "events" : [],
+ "methods" : [
+ {
+ "name" : "newRow",
"type" : "function",
- "desc" : "Gets the number of cached records.\n<p>\n<em>If using paging, this may not be the total size of the dataset. If the data object\nused by the Reader contains the dataset size, then the getTotalCount() function returns\nthe data set size</em>",
- "sig" : "()\n{\n\n}",
+ "desc" : "Create an empty record",
+ "sig" : "(data)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.data.DataReader",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
- "returns" : []
+ "params" : [
+ {
+ "name" : "data",
+ "type" : "Object",
+ "desc" : "(optional) - overlay some values",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.data.Record",
+ "desc" : "record created."
+ }
+ ]
},
{
- "name" : "getModifiedRecords",
+ "name" : "read",
"type" : "function",
- "desc" : "Gets all records modified since the last commit. Modified records are persisted across load operations\n(e.g., during paging).",
- "sig" : "()\n{\n\n}",
+ "desc" : "This method is only used by a DataProxy which has retrieved data from a remote server.",
+ "sig" : "(response)",
"static" : false,
"memberOf" : "",
"isStatic" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
+ "params" : [
+ {
+ "name" : "response",
+ "type" : "Object",
+ "desc" : "The XHR object which contains the parsed XML document. The response is expected\nto contain a method called 'responseXML' that returns an XML document object.",
+ "isOptional" : false
+ }
+ ],
"returns" : [
{
"name" : "",
- "type" : "Roo.data.Record[]",
- "desc" : "An array of Records containing outstanding modifications."
+ "type" : "Object",
+ "desc" : "records A data block which is used by an {@link Roo.data.Store} as\na cache of Roo.data.Records."
}
]
},
{
- "name" : "getRange",
+ "name" : "readRecords",
"type" : "function",
- "desc" : "Returns a range of Records between specified indices.",
- "sig" : "(startIndex, endIndex)",
+ "desc" : "Create a data block containing Roo.data.Records from an XML document.",
+ "sig" : "(doc)",
"static" : false,
"memberOf" : "",
"isStatic" : false,
"requires" : "",
"params" : [
{
- "name" : "startIndex",
- "type" : "Number",
- "desc" : "(optional) The starting index (defaults to 0)",
- "isOptional" : false
- },
- {
- "name" : "endIndex",
- "type" : "Number",
- "desc" : "(optional) The ending index (defaults to the last Record in the Store)",
+ "name" : "doc",
+ "type" : "Object",
+ "desc" : "A parsed XML document.",
"isOptional" : false
}
],
"returns" : [
{
"name" : "",
- "type" : "Roo.data.Record[]",
- "desc" : "An array of Records"
+ "type" : "Object",
+ "desc" : "records A data block which is used by an {@link Roo.data.Store} as\na cache of Roo.data.Records."
}
]
- },
+ }
+ ],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "implementations" : [],
+ "tree_children" : [],
+ "tree_parent" : []
+ },
+ "Roo.dd" : {
+ "props" : [],
+ "events" : [],
+ "methods" : [],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "implementations" : [],
+ "tree_children" : [],
+ "tree_parent" : []
+ },
+ "Roo.dd.DD" : {
+ "props" : [
{
- "name" : "getSortState",
+ "name" : "listeners",
+ "type" : "Object",
+ "desc" : "list of events and functions to call for 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" : "Returns the sort state of the Store as an object with two properties:\n<pre><code>\n field {String} The name of the field by which the Records are sorted\n direction {String} The sort order, \"ASC\" or \"DESC\"\n</code></pre>",
- "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" : [],
+ "params" : [
+ {
+ "name" : "object",
+ "type" : "Object",
+ "desc" : "The object with the events defined",
+ "isOptional" : false
+ }
+ ],
"returns" : []
},
{
- "name" : "getTotalCount",
+ "name" : "addInvalidHandleClass",
"type" : "function",
- "desc" : "Gets the total number of records in the dataset as returned by the server.\n<p>\n<em>If using paging, for this to be accurate, the data object used by the Reader must contain\nthe dataset size</em>",
- "sig" : "()\n{\n\n}",
+ "desc" : "Lets you specify a css class of elements that will not initiate a drag",
+ "sig" : "(cssClass)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.dd.DragDrop",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
+ "params" : [
+ {
+ "name" : "cssClass",
+ "type" : "string",
+ "desc" : "the class of the elements you wish to ignore",
+ "isOptional" : false
+ }
+ ],
"returns" : []
},
{
- "name" : "hasListener",
+ "name" : "addInvalidHandleId",
"type" : "function",
- "desc" : "Checks to see if this object has any listeners for a specified event",
- "sig" : "(eventName)",
+ "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.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" : "string",
+ "desc" : "the element id of the element you wish to ignore",
"isOptional" : false
}
],
- "returns" : [
- {
- "name" : "",
- "type" : "Boolean",
- "desc" : "True if the event is being listened for, else false"
- }
- ]
+ "returns" : []
},
{
- "name" : "indexOf",
+ "name" : "addInvalidHandleType",
"type" : "function",
- "desc" : "Get the index within the cache of the passed Record.",
- "sig" : "(record)",
+ "desc" : "Allows you to specify a tag name that should not start a drag operation\nwhen clicked. This is designed to facilitate embedding links within a\ndrag handle that do something other than start the drag.",
+ "sig" : "(tagName)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.dd.DragDrop",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "record",
- "type" : "Roo.data.Record",
- "desc" : "The Roo.data.Record object to to find.",
+ "name" : "tagName",
+ "type" : "string",
+ "desc" : "the type of element to exclude",
"isOptional" : false
}
],
- "returns" : [
- {
- "name" : "",
- "type" : "Number",
- "desc" : "The index of the passed Record. Returns -1 if not found."
- }
- ]
+ "returns" : []
},
{
- "name" : "indexOfId",
+ "name" : "addListener",
"type" : "function",
- "desc" : "Get the index within the cache of the Record with the passed id.",
- "sig" : "(id)",
+ "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" : "id",
+ "name" : "eventName",
"type" : "String",
- "desc" : "The id of the Record to find.",
+ "desc" : "The type of event to listen for",
"isOptional" : false
- }
- ],
- "returns" : [
+ },
{
- "name" : "",
- "type" : "Number",
- "desc" : "The index of the Record. Returns -1 if not found."
+ "name" : "handler",
+ "type" : "Function",
+ "desc" : "The method the event invokes",
+ "isOptional" : false
+ },
+ {
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"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" : "insert",
+ "name" : "addToGroup",
"type" : "function",
- "desc" : "Inserts Records to the Store at the given index and fires the add event.",
- "sig" : "(index, records)",
+ "desc" : "Add this instance to a group of related drag/drop objects. All\ninstances belong to at least one group, and can belong to as many\ngroups as needed.",
+ "sig" : "(sGroup)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.dd.DragDrop",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "index",
- "type" : "Number",
- "desc" : "The start index at which to insert the passed Records.",
- "isOptional" : false
- },
- {
- "name" : "records",
- "type" : "Roo.data.Record[]",
- "desc" : "An Array of Roo.data.Record objects to add to the cache.",
+ "name" : "sGroup",
+ "type" : "",
+ "desc" : "{string} the name of the group",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "load",
+ "name" : "alignElWithMouse",
"type" : "function",
- "desc" : "Loads the Record cache from the configured Proxy using the configured Reader.\n<p>\nIf using remote paging, then the first load call must specify the <em>start</em>\nand <em>limit</em> properties in the options.params property to establish the initial\nposition within the dataset, and the number of Records to cache on each read from the Proxy.\n<p>\n<strong>It is important to note that for remote data sources, loading is asynchronous,\nand this call will return before the new data has been loaded. Perform any post-processing\nin a callback function, or in a \"load\" event handler.</strong>\n<p>",
- "sig" : "(options)",
+ "desc" : "Sets the element to the location of the mousedown or click event,\nmaintaining the cursor location relative to the location on the element\nthat was clicked. Override this if you want to place the element in a\nlocation other than where the cursor is.",
+ "sig" : "(el, iPageX, iPageY)",
"static" : false,
"memberOf" : "",
"isStatic" : false,
"requires" : "",
"params" : [
{
- "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>",
+ "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" : "loadData",
+ "name" : "applyConfig",
"type" : "function",
- "desc" : "Loads data from a passed data block. A Reader which understands the format of the data\nmust have been configured in the constructor.",
- "sig" : "(data, append)",
+ "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" : "",
"isStatic" : false,
"requires" : "",
"params" : [
{
- "name" : "data",
- "type" : "Object",
- "desc" : "The data block from which to read the Records. The format of the data expected\nis dependent on the type of Reader that is configured and should correspond to that Reader's readRecords parameter.",
+ "name" : "iPageX",
+ "type" : "int",
+ "desc" : "the X coordinate of the click",
"isOptional" : false
},
{
- "name" : "append",
- "type" : "Boolean",
- "desc" : "(Optional) True to append the new Records rather than replace the existing cache.",
+ "name" : "iPageY",
+ "type" : "int",
+ "desc" : "the Y coordinate of the click",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "loadDataFromChildren",
+ "name" : "cachePosition",
"type" : "function",
- "desc" : "using 'cn' the nested child reader read the child array into it's child stores.",
- "sig" : "(rec)",
+ "desc" : "Saves the most recent position so that we can reset the constraints and\ntick marks on-demand. We need to know this so that we can calculate the\nnumber of pixels the element is offset from its original position.",
+ "sig" : "(iPageX, iPageY)",
"static" : false,
"memberOf" : "",
"isStatic" : false,
"requires" : "",
"params" : [
{
- "name" : "rec",
- "type" : "Object",
- "desc" : "The record with a 'children array",
+ "name" : "iPageX",
+ "type" : "",
+ "desc" : "the current x position (optional, this just makes it so we\ndon't have to look it up again)",
+ "isOptional" : false
+ },
+ {
+ "name" : "iPageY",
+ "type" : "",
+ "desc" : "the current y position (optional, this just makes it so we\ndon't have to look it up again)",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "on",
+ "name" : "capture",
"type" : "function",
- "desc" : "Appends an event handler to this element (shorthand for addListener)",
- "sig" : "(eventName, handler, scope, options)",
- "static" : 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" : false,
+ "isStatic" : true,
"isConstructor" : false,
"isPrivate" : false,
"example" : "",
"requires" : "",
"params" : [
{
- "name" : "eventName",
- "type" : "String",
- "desc" : "The type of event to listen for",
+ "name" : "o",
+ "type" : "Observable",
+ "desc" : "The Observable to capture",
"isOptional" : false
},
{
- "name" : "handler",
+ "name" : "fn",
"type" : "Function",
- "desc" : "The method the event invokes",
+ "desc" : "The function to call",
"isOptional" : false
},
{
"name" : "scope",
"type" : "Object",
- "desc" : "(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 fn",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "purgeListeners",
+ "name" : "clearConstraints",
"type" : "function",
- "desc" : "Removes all listeners for this object",
+ "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.util.Observable",
+ "memberOf" : "Roo.dd.DragDrop",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"returns" : []
},
{
- "name" : "query",
+ "name" : "clearTicks",
"type" : "function",
- "desc" : "Query the records by a specified property.",
- "sig" : "(field, value, anyMatch)",
+ "desc" : "Clears any tick interval defined for this instance",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.dd.DragDrop",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
+ {
+ "name" : "endDrag",
+ "type" : "function",
+ "desc" : "Fired when we are done dragging the object",
+ "sig" : "(e)",
+ "static" : false,
+ "memberOf" : "Roo.dd.DragDrop",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "field",
+ "name" : "e",
+ "type" : "Event",
+ "desc" : "the mouseup event",
+ "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" : "A field on your records",
+ "desc" : "",
"isOptional" : false
},
{
- "name" : "value",
- "type" : "String/RegExp",
- "desc" : "Either a string that the field\nshould start with or a RegExp to test against the field",
+ "name" : "args",
+ "type" : "Object...",
+ "desc" : "Variable number of parameters are passed to handlers",
"isOptional" : false
- },
+ }
+ ],
+ "returns" : [
{
- "name" : "anyMatch",
+ "name" : "",
"type" : "Boolean",
- "desc" : "True to match any part not just the beginning",
+ "desc" : "returns false if any of the handlers return false otherwise it returns true"
+ }
+ ]
+ },
+ {
+ "name" : "getDragEl",
+ "type" : "function",
+ "desc" : "Returns a reference to the actual element to drag. By default this is\nthe same as the html element, but it can be assigned to another\nelement. An example of this can be found in Roo.dd.DDProxy",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.dd.DragDrop",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "HTMLElement",
+ "desc" : "the html element"
+ }
+ ]
+ },
+ {
+ "name" : "getEl",
+ "type" : "function",
+ "desc" : "Returns a reference to the linked element",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.dd.DragDrop",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "HTMLElement",
+ "desc" : "the html element"
+ }
+ ]
+ },
+ {
+ "name" : "hasListener",
+ "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" : "MixedCollection",
- "desc" : "Returns an Roo.util.MixedCollection of the matched records"
+ "type" : "Boolean",
+ "desc" : "True if the event is being listened for, else false"
}
]
},
{
- "name" : "queryBy",
+ "name" : "init",
"type" : "function",
- "desc" : "Query by a function. The specified function will be called with each\nrecord in this data source. If the function returns true the record is included\nin the results.",
- "sig" : "(fn, scope)",
+ "desc" : "Sets up the DragDrop object. Must be called in the constructor of any\nRoo.dd.DragDrop subclass",
+ "sig" : "(id, sGroup, config)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.dd.DragDrop",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "fn",
- "type" : "Function",
- "desc" : "The function to be called, it will receive 2 args (record, id)",
+ "name" : "id",
+ "type" : "",
+ "desc" : "the id of the linked element",
"isOptional" : false
},
{
- "name" : "scope",
- "type" : "Object",
- "desc" : "(optional) The scope of the function (defaults to this)",
+ "name" : "sGroup",
+ "type" : "String",
+ "desc" : "the group of related items",
+ "isOptional" : false
+ },
+ {
+ "name" : "config",
+ "type" : "object",
+ "desc" : "configuration attributes",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "initTarget",
+ "type" : "function",
+ "desc" : "Initializes Targeting functionality only... the object does not\nget a mousedown handler.",
+ "sig" : "(id, sGroup, config)",
+ "static" : false,
+ "memberOf" : "Roo.dd.DragDrop",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "id",
+ "type" : "",
+ "desc" : "the id of the linked element",
+ "isOptional" : false
+ },
+ {
+ "name" : "sGroup",
+ "type" : "String",
+ "desc" : "the group of related items",
+ "isOptional" : false
+ },
+ {
+ "name" : "config",
+ "type" : "object",
+ "desc" : "configuration attributes",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "isLocked",
+ "type" : "function",
+ "desc" : "Returns true if this instance is locked, or the drag drop mgr is locked\n(meaning that all drag/drop is disabled on the page.)",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.dd.DragDrop",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "boolean",
+ "desc" : "true if this obj or all drag/drop is locked, else\nfalse"
+ }
+ ]
+ },
+ {
+ "name" : "isTarget",
+ "type" : "function",
+ "desc" : "By default, all insances can be a drop target. This can be disabled by\nsetting isTarget to false.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.dd.DragDrop",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
+ {
+ "name" : "isValidHandleChild",
+ "type" : "function",
+ "desc" : "Checks the tag exclusion list to see if this click should be ignored",
+ "sig" : "(node)",
+ "static" : false,
+ "memberOf" : "Roo.dd.DragDrop",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "node",
+ "type" : "HTMLElement",
+ "desc" : "the HTMLElement to evaluate",
"isOptional" : false
}
],
"returns" : [
{
"name" : "",
- "type" : "MixedCollection",
- "desc" : "Returns an Roo.util.MixedCollection of the matched records"
+ "type" : "boolean",
+ "desc" : "true if this is a valid tag type, false if not"
}
]
},
{
- "name" : "rejectChanges",
+ "name" : "lock",
"type" : "function",
- "desc" : "Cancel outstanding changes on all changed records.",
+ "desc" : "Lock this instance",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.dd.DragDrop",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"returns" : []
},
{
- "name" : "releaseCapture",
+ "name" : "on",
"type" : "function",
- "desc" : "Removes <b>all</b> added captures from the Observable.",
- "sig" : "(o)",
- "static" : true,
+ "desc" : "Appends an event handler to this element (shorthand for addListener)",
+ "sig" : "(eventName, handler, scope, options)",
+ "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 release",
+ "name" : "eventName",
+ "type" : "String",
+ "desc" : "The type of event to listen for",
+ "isOptional" : false
+ },
+ {
+ "name" : "handler",
+ "type" : "Function",
+ "desc" : "The method the event invokes",
+ "isOptional" : false
+ },
+ {
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
+ "isOptional" : false
+ },
+ {
+ "name" : "options",
+ "type" : "Object",
+ "desc" : "(optional)",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "reload",
+ "name" : "onAvailable",
"type" : "function",
- "desc" : "Reloads the Record cache from the configured Proxy using the configured Reader and\nthe options from the last load operation performed.",
- "sig" : "(options)",
+ "desc" : "Override the onAvailable method to do what is needed after the initial\nposition was determined.",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.dd.DragDrop",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "options",
- "type" : "Object",
- "desc" : "(optional) An object containing properties which may override the options\nused in the last load operation. See {@link #load} for details (defaults to null, in which case\nthe most recently used options are reused).",
- "isOptional" : false
- }
- ],
+ "params" : [],
"returns" : []
},
{
- "name" : "remove",
+ "name" : "onDrag",
"type" : "function",
- "desc" : "Remove a Record from the Store and fires the remove event.",
- "sig" : "(record)",
+ "desc" : "Abstract method called during the onMouseMove event while dragging an\nobject.",
+ "sig" : "(e)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.dd.DragDrop",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "record",
- "type" : "Ext.data.Record",
- "desc" : "The Roo.data.Record object to remove from the cache.",
+ "name" : "e",
+ "type" : "Event",
+ "desc" : "the mousemove event",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "removeAll",
+ "name" : "onDragDrop",
"type" : "function",
- "desc" : "Remove all Records from the Store and fires the clear event.",
- "sig" : "()\n{\n\n}",
+ "desc" : "Abstract method called when this item is dropped on another DragDrop\nobj",
+ "sig" : "(e, id)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.dd.DragDrop",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
+ "params" : [
+ {
+ "name" : "e",
+ "type" : "Event",
+ "desc" : "the mouseup event",
+ "isOptional" : false
+ },
+ {
+ "name" : "id",
+ "type" : "String|DragDrop[]",
+ "desc" : "In POINT mode, the element\nid this was dropped on. In INTERSECT mode, an array of dd items this\nwas dropped on.",
+ "isOptional" : false
+ }
+ ],
"returns" : []
},
{
- "name" : "removeListener",
+ "name" : "onDragEnter",
"type" : "function",
- "desc" : "Removes a listener",
- "sig" : "(eventName, handler, scope)",
+ "desc" : "Abstract method called when this element fist begins hovering over\nanother DragDrop obj",
+ "sig" : "(e, 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 type of event to listen for",
- "isOptional" : false
- },
- {
- "name" : "handler",
- "type" : "Function",
- "desc" : "The handler to remove",
+ "name" : "e",
+ "type" : "Event",
+ "desc" : "the mousemove event",
"isOptional" : false
},
{
- "name" : "scope",
- "type" : "Object",
- "desc" : "(optional) The scope (this object) for the handler",
+ "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" : "setDefaultSort",
+ "name" : "onDragOut",
"type" : "function",
- "desc" : "Sets the default sort column and order to be used by the next load operation.",
- "sig" : "(fieldName, dir)",
+ "desc" : "Abstract method called when we are no longer hovering over an element",
+ "sig" : "(e, id)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.dd.DragDrop",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "fieldName",
- "type" : "String",
- "desc" : "The name of the field to sort by.",
+ "name" : "e",
+ "type" : "Event",
+ "desc" : "the mousemove event",
"isOptional" : false
},
{
- "name" : "dir",
- "type" : "String",
- "desc" : "(optional) The sort order, \"ASC\" or \"DESC\" (defaults to \"ASC\")",
+ "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" : "sort",
+ "name" : "onDragOver",
"type" : "function",
- "desc" : "Sort the Records.\nIf remote sorting is used, the sort is performed on the server, and the cache is\nreloaded. If local sorting is used, the cache is sorted internally.",
- "sig" : "(fieldName, dir)",
+ "desc" : "Abstract method called when this element is hovering over another\nDragDrop obj",
+ "sig" : "(e, id)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.dd.DragDrop",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "fieldName",
- "type" : "String",
- "desc" : "The name of the field to sort by.",
+ "name" : "e",
+ "type" : "Event",
+ "desc" : "the mousemove event",
"isOptional" : false
},
{
- "name" : "dir",
- "type" : "String",
- "desc" : "(optional) The sort order, \"ASC\" or \"DESC\" (defaults to \"ASC\")",
+ "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" : "sum",
+ "name" : "onInvalidDrop",
"type" : "function",
- "desc" : "Sums the value of <i>property</i> for each record between start and end and returns the result.",
- "sig" : "(property, start, end)",
+ "desc" : "Abstract method called when this item is dropped on an area with no\ndrop target",
+ "sig" : "(e)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.dd.DragDrop",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "property",
- "type" : "String",
- "desc" : "A field on your records",
- "isOptional" : false
- },
- {
- "name" : "start",
- "type" : "Number",
- "desc" : "The record index to start at (defaults to 0)",
- "isOptional" : false
- },
- {
- "name" : "end",
- "type" : "Number",
- "desc" : "The last record index to include (defaults to length - 1)",
+ "name" : "e",
+ "type" : "Event",
+ "desc" : "the mouseup event",
"isOptional" : false
}
],
- "returns" : [
- {
- "name" : "",
- "type" : "Number",
- "desc" : "The sum"
- }
- ]
+ "returns" : []
},
{
- "name" : "un",
+ "name" : "onMouseDown",
"type" : "function",
- "desc" : "Removes a listener (shorthand for removeListener)",
- "sig" : "(eventName, handler, scope)",
+ "desc" : "Event handler that fires when a drag/drop obj gets a mousedown",
+ "sig" : "(e)",
"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 handler to remove",
- "isOptional" : false
- },
- {
- "name" : "scope",
- "type" : "Object",
- "desc" : "(optional) The scope (this object) for the handler",
+ "name" : "e",
+ "type" : "Event",
+ "desc" : "the mousedown event",
"isOptional" : false
}
],
"returns" : []
- }
- ],
- "isAbstract" : false,
- "isBuilderTop" : false,
- "implementations" : [
- "Roo.data.JsonStore",
- "Roo.data.SimpleStore"
- ],
- "tree_children" : [],
- "tree_parent" : []
- },
- "Roo.data.Tree" : {
- "props" : [
- {
- "name" : "listeners",
- "type" : "Object",
- "desc" : "list of events and functions to call for this object, \nFor example :\n<pre><code>\n listeners : { \n 'click' : function(e) {\n ..... \n } ,\n .... \n } \n </code></pre>",
- "memberOf" : "Roo.util.Observable"
- }
- ],
- "events" : [
+ },
{
- "name" : "append",
+ "name" : "onMouseUp",
"type" : "function",
- "desc" : "Fires when a new child node is appended to a node in this tree.",
- "sig" : "function (tree, parent, node, index)\n{\n\n}",
- "memberOf" : "",
+ "desc" : "Event handler that fires when a drag/drop obj gets a mouseup",
+ "sig" : "(e)",
+ "static" : false,
+ "memberOf" : "Roo.dd.DragDrop",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
- "name" : "tree",
- "type" : "Tree",
- "desc" : "The owner tree",
- "isOptional" : false
- },
- {
- "name" : "parent",
- "type" : "Node",
- "desc" : "The parent node",
- "isOptional" : false
- },
- {
- "name" : "node",
- "type" : "Node",
- "desc" : "The newly appended node",
- "isOptional" : false
- },
- {
- "name" : "index",
- "type" : "Number",
- "desc" : "The index of the newly appended node",
+ "name" : "e",
+ "type" : "Event",
+ "desc" : "the mouseup event",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "beforeappend",
+ "name" : "padding",
"type" : "function",
- "desc" : "Fires before a new child is appended to a node in this tree, return false to cancel the append.",
- "sig" : "function (tree, parent, node)\n{\n\n}",
- "memberOf" : "",
+ "desc" : "The padding configured for this drag and drop object for calculating\nthe drop zone intersection with this object.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.dd.DragDrop",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "params" : [
- {
- "name" : "tree",
- "type" : "Tree",
- "desc" : "The owner tree",
- "isOptional" : false
- },
- {
- "name" : "parent",
- "type" : "Node",
- "desc" : "The parent node",
- "isOptional" : false
- },
- {
- "name" : "node",
- "type" : "Node",
- "desc" : "The child node to be appended",
- "isOptional" : false
- }
- ],
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
"returns" : []
},
{
- "name" : "beforeinsert",
+ "name" : "purgeListeners",
"type" : "function",
- "desc" : "Fires before a new child is inserted in a node in this tree, return false to cancel the insert.",
- "sig" : "function (tree, parent, node, refNode)\n{\n\n}",
- "memberOf" : "",
+ "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" : "tree",
- "type" : "Tree",
- "desc" : "The owner tree",
- "isOptional" : false
- },
- {
- "name" : "parent",
- "type" : "Node",
- "desc" : "The parent node",
- "isOptional" : false
- },
- {
- "name" : "node",
- "type" : "Node",
- "desc" : "The child node to be inserted",
- "isOptional" : false
- },
- {
- "name" : "refNode",
- "type" : "Node",
- "desc" : "The child node the node is being inserted before",
+ "name" : "o",
+ "type" : "Observable",
+ "desc" : "The Observable to release",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "beforemove",
+ "name" : "removeFromGroup",
"type" : "function",
- "desc" : "Fires before a node is moved to a new location in the tree. Return false to cancel the move.",
- "sig" : "function (tree, node, oldParent, newParent, index)\n{\n\n}",
- "memberOf" : "",
+ "desc" : "Remove's this instance from the supplied interaction group",
+ "sig" : "(sGroup)",
+ "static" : false,
+ "memberOf" : "Roo.dd.DragDrop",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
- "name" : "tree",
- "type" : "Tree",
- "desc" : "The owner tree",
- "isOptional" : false
- },
- {
- "name" : "node",
- "type" : "Node",
- "desc" : "The node being moved",
- "isOptional" : false
- },
- {
- "name" : "oldParent",
- "type" : "Node",
- "desc" : "The parent of the node",
- "isOptional" : false
- },
- {
- "name" : "newParent",
- "type" : "Node",
- "desc" : "The new parent the node is moving to",
- "isOptional" : false
- },
- {
- "name" : "index",
- "type" : "Number",
- "desc" : "The index it is being moved to",
+ "name" : "sGroup",
+ "type" : "string",
+ "desc" : "The group to drop",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "beforeremove",
+ "name" : "removeInvalidHandleClass",
"type" : "function",
- "desc" : "Fires before a child is removed from a node in this tree, return false to cancel the remove.",
- "sig" : "function (tree, parent, node)\n{\n\n}",
- "memberOf" : "",
+ "desc" : "Unsets an invalid css class",
+ "sig" : "(cssClass)",
+ "static" : false,
+ "memberOf" : "Roo.dd.DragDrop",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
- "name" : "tree",
- "type" : "Tree",
- "desc" : "The owner tree",
- "isOptional" : false
- },
- {
- "name" : "parent",
- "type" : "Node",
- "desc" : "The parent node",
- "isOptional" : false
- },
- {
- "name" : "node",
- "type" : "Node",
- "desc" : "The child node to be removed",
+ "name" : "cssClass",
+ "type" : "string",
+ "desc" : "the class of the element(s) you wish to\nre-enable",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "insert",
+ "name" : "removeInvalidHandleId",
"type" : "function",
- "desc" : "Fires when a new child node is inserted in a node in this tree.",
- "sig" : "function (tree, parent, node, refNode)\n{\n\n}",
- "memberOf" : "",
+ "desc" : "Unsets an invalid handle id",
+ "sig" : "(id)",
+ "static" : false,
+ "memberOf" : "Roo.dd.DragDrop",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
- "name" : "tree",
- "type" : "Tree",
- "desc" : "The owner tree",
- "isOptional" : false
- },
- {
- "name" : "parent",
- "type" : "Node",
- "desc" : "The parent node",
- "isOptional" : false
- },
- {
- "name" : "node",
- "type" : "Node",
- "desc" : "The child node inserted",
- "isOptional" : false
- },
- {
- "name" : "refNode",
- "type" : "Node",
- "desc" : "The child node the node was inserted before",
+ "name" : "id",
+ "type" : "string",
+ "desc" : "the id of the element to re-enable",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "move",
+ "name" : "removeInvalidHandleType",
"type" : "function",
- "desc" : "Fires when a node is moved to a new location in the tree",
- "sig" : "function (tree, node, oldParent, newParent, index)\n{\n\n}",
- "memberOf" : "",
+ "desc" : "Unsets an excluded tag name set by addInvalidHandleType",
+ "sig" : "(tagName)",
+ "static" : false,
+ "memberOf" : "Roo.dd.DragDrop",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
- "name" : "tree",
- "type" : "Tree",
- "desc" : "The owner tree",
- "isOptional" : false
- },
- {
- "name" : "node",
- "type" : "Node",
- "desc" : "The node moved",
- "isOptional" : false
- },
- {
- "name" : "oldParent",
- "type" : "Node",
- "desc" : "The old parent of this node",
- "isOptional" : false
- },
- {
- "name" : "newParent",
- "type" : "Node",
- "desc" : "The new parent of this node",
- "isOptional" : false
- },
- {
- "name" : "index",
- "type" : "Number",
- "desc" : "The index it was moved to",
+ "name" : "tagName",
+ "type" : "string",
+ "desc" : "the type of element to unexclude",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "remove",
+ "name" : "removeListener",
"type" : "function",
- "desc" : "Fires when a child node is removed from a node in this tree.",
- "sig" : "function (tree, parent, node)\n{\n\n}",
- "memberOf" : "",
+ "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" : "tree",
- "type" : "Tree",
- "desc" : "The owner tree",
+ "name" : "eventName",
+ "type" : "String",
+ "desc" : "The type of event to listen for",
"isOptional" : false
},
{
- "name" : "parent",
- "type" : "Node",
- "desc" : "The parent node",
+ "name" : "handler",
+ "type" : "Function",
+ "desc" : "The handler to remove",
"isOptional" : false
},
{
- "name" : "node",
- "type" : "Node",
- "desc" : "The child node removed",
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "(optional) The scope (this object) for the handler",
"isOptional" : false
}
],
"returns" : []
- }
- ],
- "methods" : [
+ },
{
- "name" : "addEvents",
+ "name" : "resetConstraints",
"type" : "function",
- "desc" : "Used to define events on this Observable",
- "sig" : "(object)",
+ "desc" : "resetConstraints must be called if you manually reposition a dd element.",
+ "sig" : "(maintainOffset)",
"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" : "maintainOffset",
+ "type" : "boolean",
+ "desc" : "",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "addListener",
+ "name" : "setDelta",
"type" : "function",
- "desc" : "Appends an event handler to this component",
- "sig" : "(eventName, handler, scope, options)",
+ "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.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" : "iDeltaX",
+ "type" : "int",
+ "desc" : "the distance from the left",
"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" : "iDeltaY",
+ "type" : "int",
+ "desc" : "the distance from the top",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "capture",
+ "name" : "setDragElId",
"type" : "function",
- "desc" : "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" : "Allows you to specify that an element other than the linked element\nwill be moved with the cursor during a drag",
+ "sig" : "(id)",
+ "static" : false,
+ "memberOf" : "Roo.dd.DragDrop",
+ "isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"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" : "id",
+ "type" : "",
+ "desc" : "{string} the id of the element that will be used to initiate the drag",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "fireEvent",
+ "name" : "setDragElPos",
"type" : "function",
- "desc" : "Fires the specified event with the passed parameters (minus the event name).",
- "sig" : "(eventName, args)",
+ "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.util.Observable",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "eventName",
- "type" : "String",
- "desc" : "",
+ "name" : "iPageX",
+ "type" : "int",
+ "desc" : "the X coordinate of the mousedown or drag event",
"isOptional" : false
},
{
- "name" : "args",
- "type" : "Object...",
- "desc" : "Variable number of parameters are passed to handlers",
+ "name" : "iPageY",
+ "type" : "int",
+ "desc" : "the Y coordinate of the mousedown or drag event",
"isOptional" : false
}
],
- "returns" : [
- {
- "name" : "",
- "type" : "Boolean",
- "desc" : "returns false if any of the handlers return false otherwise it returns true"
- }
- ]
+ "returns" : []
},
{
- "name" : "getNodeById",
+ "name" : "setHandleElId",
"type" : "function",
- "desc" : "Gets a node in this tree by its id.",
+ "desc" : "Allows you to specify a child of the linked element that should be\nused to initiate the drag operation. An example of this would be if\nyou have a content div with text and links. Clicking anywhere in the\ncontent area would normally start the drag operation. Use this method\nto specify that an element inside of the content div is the element\nthat starts the drag operation.",
"sig" : "(id)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.dd.DragDrop",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"params" : [
{
"name" : "id",
- "type" : "String",
- "desc" : "",
+ "type" : "",
+ "desc" : "{string} the id of the element that will be used to\ninitiate the drag.",
"isOptional" : false
}
],
- "returns" : [
- {
- "name" : "",
- "type" : "Node",
- "desc" : ""
- }
- ]
+ "returns" : []
},
{
- "name" : "getRootNode",
+ "name" : "setInitPosition",
"type" : "function",
- "desc" : "Returns the root node for this tree.",
- "sig" : "()\n{\n\n}",
+ "desc" : "Stores the initial placement of the linked element.",
+ "sig" : "(diffX, diffY)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.dd.DragDrop",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
- "returns" : [
+ "params" : [
{
- "name" : "",
- "type" : "Node",
- "desc" : ""
+ "name" : "diffX",
+ "type" : "int",
+ "desc" : "the X offset, default 0",
+ "isOptional" : false
+ },
+ {
+ "name" : "diffY",
+ "type" : "int",
+ "desc" : "the Y offset, default 0",
+ "isOptional" : false
}
- ]
+ ],
+ "returns" : []
},
{
- "name" : "hasListener",
+ "name" : "setOuterHandleElId",
"type" : "function",
- "desc" : "Checks to see if this object has any listeners for a specified event",
- "sig" : "(eventName)",
+ "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,
"requires" : "",
"params" : [
{
- "name" : "eventName",
- "type" : "String",
- "desc" : "The name of the event to check for",
+ "name" : "id",
+ "type" : "",
+ "desc" : "the id of the element that will be used to initiate the drag",
"isOptional" : false
}
],
- "returns" : [
- {
- "name" : "",
- "type" : "Boolean",
- "desc" : "True if the event is being listened for, else false"
- }
- ]
+ "returns" : []
},
{
- "name" : "on",
+ "name" : "setPadding",
"type" : "function",
- "desc" : "Appends an event handler to this element (shorthand for addListener)",
- "sig" : "(eventName, handler, scope, options)",
+ "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.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" : "iTop",
+ "type" : "int",
+ "desc" : "Top pad",
"isOptional" : false
},
{
- "name" : "handler",
- "type" : "Function",
- "desc" : "The method the event invokes",
+ "name" : "iRight",
+ "type" : "int",
+ "desc" : "Right pad",
"isOptional" : false
},
{
- "name" : "scope",
- "type" : "Object",
- "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
+ "name" : "iBot",
+ "type" : "int",
+ "desc" : "Bot pad",
"isOptional" : false
},
{
- "name" : "options",
- "type" : "Object",
- "desc" : "(optional)",
+ "name" : "iLeft",
+ "type" : "int",
+ "desc" : "Left pad",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "purgeListeners",
+ "name" : "setXConstraint",
"type" : "function",
- "desc" : "Removes all listeners for this object",
- "sig" : "()\n{\n\n}",
+ "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.util.Observable",
+ "memberOf" : "Roo.dd.DragDrop",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
+ "params" : [
+ {
+ "name" : "iLeft",
+ "type" : "int",
+ "desc" : "the number of pixels the element can move to the left",
+ "isOptional" : false
+ },
+ {
+ "name" : "iRight",
+ "type" : "int",
+ "desc" : "the number of pixels the element can move to the\nright",
+ "isOptional" : false
+ },
+ {
+ "name" : "iTickSize",
+ "type" : "int",
+ "desc" : "optional parameter for specifying that the\nelement\nshould move iTickSize pixels at a time.",
+ "isOptional" : false
+ }
+ ],
"returns" : []
},
{
- "name" : "releaseCapture",
+ "name" : "setYConstraint",
"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. Set\nthis to limit the vertical travel of the element. Pass in 0,0 for the\nparameters if you want to lock the drag to the x axis.",
+ "sig" : "(iUp, iDown, iTickSize)",
+ "static" : false,
+ "memberOf" : "Roo.dd.DragDrop",
+ "isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"example" : "",
"requires" : "",
"params" : [
{
- "name" : "o",
- "type" : "Observable",
- "desc" : "The Observable to release",
+ "name" : "iUp",
+ "type" : "int",
+ "desc" : "the number of pixels the element can move up",
+ "isOptional" : false
+ },
+ {
+ "name" : "iDown",
+ "type" : "int",
+ "desc" : "the number of pixels the element can move down",
+ "isOptional" : false
+ },
+ {
+ "name" : "iTickSize",
+ "type" : "int",
+ "desc" : "optional parameter for specifying that the\nelement should move iTickSize pixels at a time.",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "removeListener",
+ "name" : "startDrag",
"type" : "function",
- "desc" : "Removes a listener",
- "sig" : "(eventName, handler, scope)",
+ "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.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 handler to remove",
+ "name" : "X",
+ "type" : "int",
+ "desc" : "click location",
"isOptional" : false
},
{
- "name" : "scope",
- "type" : "Object",
- "desc" : "(optional) The scope (this object) for the handler",
+ "name" : "Y",
+ "type" : "int",
+ "desc" : "click location",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "setRootNode",
+ "name" : "toString",
"type" : "function",
- "desc" : "Sets the root node for this tree.",
- "sig" : "(node)",
+ "desc" : "toString method",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.dd.DragDrop",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "node",
- "type" : "Node",
- "desc" : "",
- "isOptional" : false
- }
- ],
+ "params" : [],
"returns" : [
{
"name" : "",
- "type" : "Node",
- "desc" : ""
+ "type" : "string",
+ "desc" : "string representation of the dd obj"
}
]
},
}
],
"returns" : []
- }
- ],
- "isAbstract" : false,
- "isBuilderTop" : false,
- "implementations" : [
- "Roo.tree.ColumnTree",
- "Roo.tree.TreePanel"
- ],
- "tree_children" : [],
- "tree_parent" : []
- },
- "Roo.data.XmlReader" : {
- "props" : [
- {
- "name" : "id",
- "type" : "String",
- "desc" : "The DomQuery path relative from the record element to the element that contains\na record identifier value.",
- "memberOf" : ""
- },
- {
- "name" : "record",
- "type" : "String",
- "desc" : "The DomQuery path to the repeated element which contains record information.",
- "memberOf" : ""
- },
- {
- "name" : "success",
- "type" : "String",
- "desc" : "The DomQuery path to the success attribute used by forms.",
- "memberOf" : ""
- },
- {
- "name" : "totalRecords",
- "type" : "String",
- "desc" : "The DomQuery path from which to retrieve the total number of records\nin the dataset. This is only needed if the whole dataset is not passed in one go, but is being\npaged from the remote server.",
- "memberOf" : ""
- }
- ],
- "events" : [],
- "methods" : [
- {
- "name" : "newRow",
- "type" : "function",
- "desc" : "Create an empty record",
- "sig" : "(data)",
- "static" : false,
- "memberOf" : "Roo.data.DataReader",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "data",
- "type" : "Object",
- "desc" : "(optional) - overlay some values",
- "isOptional" : false
- }
- ],
- "returns" : [
- {
- "name" : "",
- "type" : "Roo.data.Record",
- "desc" : "record created."
- }
- ]
},
{
- "name" : "read",
+ "name" : "unlock",
"type" : "function",
- "desc" : "This method is only used by a DataProxy which has retrieved data from a remote server.",
- "sig" : "(response)",
+ "desc" : "Unlock this instace",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.dd.DragDrop",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "response",
- "type" : "Object",
- "desc" : "The XHR object which contains the parsed XML document. The response is expected\nto contain a method called 'responseXML' that returns an XML document object.",
- "isOptional" : false
- }
- ],
- "returns" : [
- {
- "name" : "",
- "type" : "Object",
- "desc" : "records A data block which is used by an {@link Roo.data.Store} as\na cache of Roo.data.Records."
- }
- ]
+ "params" : [],
+ "returns" : []
},
{
- "name" : "readRecords",
+ "name" : "unreg",
"type" : "function",
- "desc" : "Create a data block containing Roo.data.Records from an XML document.",
- "sig" : "(doc)",
+ "desc" : "Remove all drag and drop hooks for this element",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.dd.DragDrop",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "doc",
- "type" : "Object",
- "desc" : "A parsed XML document.",
- "isOptional" : false
- }
- ],
- "returns" : [
- {
- "name" : "",
- "type" : "Object",
- "desc" : "records A data block which is used by an {@link Roo.data.Store} as\na cache of Roo.data.Records."
- }
- ]
+ "params" : [],
+ "returns" : []
}
],
"isAbstract" : false,
"isBuilderTop" : false,
- "implementations" : [],
- "tree_children" : [],
- "tree_parent" : []
- },
- "Roo.dd" : {
- "props" : [],
- "events" : [],
- "methods" : [],
- "isAbstract" : false,
- "isBuilderTop" : false,
- "implementations" : [],
+ "implementations" : [
+ "Roo.dd.DDProxy",
+ "Roo.dd.DragSource",
+ "Roo.dd.DragZone",
+ "Roo.grid.SplitDragZone"
+ ],
"tree_children" : [],
"tree_parent" : []
},
- "Roo.dd.DD" : {
+ "Roo.dd.DDProxy" : {
"props" : [
{
"name" : "listeners",
"type" : "Object",
"desc" : "list of events and functions to call for this object, \nFor example :\n<pre><code>\n listeners : { \n 'click' : function(e) {\n ..... \n } ,\n .... \n } \n </code></pre>",
- "memberOf" : "Roo.util.Observable"
+ "memberOf" : "Roo.util.Observable",
+ "isOptional" : false,
+ "optvals" : []
}
],
"events" : [],
"desc" : "Sets the element to the location of the mousedown or click event,\nmaintaining the cursor location relative to the location on the element\nthat was clicked. Override this if you want to place the element in a\nlocation other than where the cursor is.",
"sig" : "(el, iPageX, iPageY)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.dd.DD",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"desc" : "Sets the pointer offset to the distance between the linked element's top\nleft corner and the location the element was clicked",
"sig" : "(iPageX, iPageY)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.dd.DD",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"desc" : "Saves the most recent position so that we can reset the constraints and\ntick marks on-demand. We need to know this so that we can calculate the\nnumber of pixels the element is offset from its original position.",
"sig" : "(iPageX, iPageY)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.dd.DD",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"params" : [],
"returns" : []
},
+ {
+ "name" : "createFrame",
+ "type" : "function",
+ "desc" : "Creates the proxy element if it does not yet exist",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
{
"name" : "endDrag",
"type" : "function",
],
"returns" : []
},
+ {
+ "name" : "initFrame",
+ "type" : "function",
+ "desc" : "Initialization for the drag frame element. Must be called in the\nconstructor of all subclasses",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
{
"name" : "initTarget",
"type" : "function",
"desc" : "Sets the pointer offset. You can call this directly to force the\noffset to be in a particular location (e.g., pass in 0,0 to set it\nto the center of the object)",
"sig" : "(iDeltaX, iDeltaY)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.dd.DD",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"desc" : "Sets the drag element to the location of the mousedown or click event,\nmaintaining the cursor location relative to the location on the element\nthat was clicked. Override this if you want to place the element in a\nlocation other than where the cursor is.",
"sig" : "(iPageX, iPageY)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.dd.DD",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"isAbstract" : false,
"isBuilderTop" : false,
"implementations" : [
- "Roo.dd.DDProxy",
"Roo.dd.DragSource",
"Roo.dd.DragZone",
"Roo.grid.SplitDragZone"
"tree_children" : [],
"tree_parent" : []
},
- "Roo.dd.DDProxy" : {
+ "Roo.dd.DDTarget" : {
"props" : [
{
"name" : "listeners",
"type" : "Object",
"desc" : "list of events and functions to call for this object, \nFor example :\n<pre><code>\n listeners : { \n 'click' : function(e) {\n ..... \n } ,\n .... \n } \n </code></pre>",
- "memberOf" : "Roo.util.Observable"
+ "memberOf" : "Roo.util.Observable",
+ "isOptional" : false,
+ "optvals" : []
}
],
"events" : [],
],
"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",
"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" : "cachePosition",
- "type" : "function",
- "desc" : "Saves the most recent position so that we can reset the constraints and\ntick marks on-demand. We need to know this so that we can calculate the\nnumber of pixels the element is offset from its original position.",
- "sig" : "(iPageX, iPageY)",
- "static" : false,
- "memberOf" : "Roo.dd.DD",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "iPageX",
- "type" : "",
- "desc" : "the current x position (optional, this just makes it so we\ndon't have to look it up again)",
- "isOptional" : false
- },
- {
- "name" : "iPageY",
- "type" : "",
- "desc" : "the current y position (optional, this just makes it so we\ndon't have to look it up again)",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
{
"name" : "capture",
"type" : "function",
"params" : [],
"returns" : []
},
- {
- "name" : "createFrame",
- "type" : "function",
- "desc" : "Creates the proxy element if it does not yet exist",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
{
"name" : "endDrag",
"type" : "function",
],
"returns" : []
},
- {
- "name" : "initFrame",
- "type" : "function",
- "desc" : "Initialization for the drag frame element. Must be called in the\nconstructor of all subclasses",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
{
"name" : "initTarget",
"type" : "function",
],
"returns" : []
},
- {
- "name" : "setDelta",
- "type" : "function",
- "desc" : "Sets the pointer offset. You can call this directly to force the\noffset to be in a particular location (e.g., pass in 0,0 to set it\nto the center of the object)",
- "sig" : "(iDeltaX, iDeltaY)",
- "static" : false,
- "memberOf" : "Roo.dd.DD",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "iDeltaX",
- "type" : "int",
- "desc" : "the distance from the left",
- "isOptional" : false
- },
- {
- "name" : "iDeltaY",
- "type" : "int",
- "desc" : "the distance from the top",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
{
"name" : "setDragElId",
"type" : "function",
],
"returns" : []
},
- {
- "name" : "setDragElPos",
- "type" : "function",
- "desc" : "Sets the drag element to the location of the mousedown or click event,\nmaintaining the cursor location relative to the location on the element\nthat was clicked. Override this if you want to place the element in a\nlocation other than where the cursor is.",
- "sig" : "(iPageX, iPageY)",
- "static" : false,
- "memberOf" : "Roo.dd.DD",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "iPageX",
- "type" : "int",
- "desc" : "the X coordinate of the mousedown or drag event",
- "isOptional" : false
- },
- {
- "name" : "iPageY",
- "type" : "int",
- "desc" : "the Y coordinate of the mousedown or drag event",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
{
"name" : "setHandleElId",
"type" : "function",
"isAbstract" : false,
"isBuilderTop" : false,
"implementations" : [
- "Roo.dd.DragSource",
- "Roo.dd.DragZone",
- "Roo.grid.SplitDragZone"
+ "Roo.dd.DropTarget",
+ "Roo.dd.DropZone"
],
"tree_children" : [],
"tree_parent" : []
},
- "Roo.dd.DDTarget" : {
+ "Roo.dd.DragDrop" : {
"props" : [
{
"name" : "listeners",
"type" : "Object",
"desc" : "list of events and functions to call for this object, \nFor example :\n<pre><code>\n listeners : { \n 'click' : function(e) {\n ..... \n } ,\n .... \n } \n </code></pre>",
- "memberOf" : "Roo.util.Observable"
+ "memberOf" : "Roo.util.Observable",
+ "isOptional" : false,
+ "optvals" : []
}
],
"events" : [],
"desc" : "Lets you specify a css class of elements that will not initiate a drag",
"sig" : "(cssClass)",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"desc" : "Lets you to specify an element id for a child of a drag handle\nthat should not initiate a drag",
"sig" : "(id)",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"desc" : "Allows you to specify a tag name that should not start a drag operation\nwhen clicked. This is designed to facilitate embedding links within a\ndrag handle that do something other than start the drag.",
"sig" : "(tagName)",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"desc" : "Add this instance to a group of related drag/drop objects. All\ninstances belong to at least one group, and can belong to as many\ngroups as needed.",
"sig" : "(sGroup)",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"desc" : "Applies the configuration parameters that were passed into the constructor.\nThis is supposed to happen at each level through the inheritance chain. So\na DDProxy implentation will execute apply config on DDProxy, DD, and\nDragDrop in order to get all of the parameters that are available in\neach object.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"desc" : "Clears any constraints applied to this instance. Also clears ticks\nsince they can't exist independent of a constraint at this time.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"desc" : "Clears any tick interval defined for this instance",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"desc" : "Fired when we are done dragging the object",
"sig" : "(e)",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"desc" : "Returns a reference to the actual element to drag. By default this is\nthe same as the html element, but it can be assigned to another\nelement. An example of this can be found in Roo.dd.DDProxy",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"desc" : "Returns a reference to the linked element",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"desc" : "Sets up the DragDrop object. Must be called in the constructor of any\nRoo.dd.DragDrop subclass",
"sig" : "(id, sGroup, config)",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"desc" : "Initializes Targeting functionality only... the object does not\nget a mousedown handler.",
"sig" : "(id, sGroup, config)",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"desc" : "Returns true if this instance is locked, or the drag drop mgr is locked\n(meaning that all drag/drop is disabled on the page.)",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"desc" : "By default, all insances can be a drop target. This can be disabled by\nsetting isTarget to false.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"desc" : "Checks the tag exclusion list to see if this click should be ignored",
"sig" : "(node)",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"desc" : "Lock this instance",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"desc" : "Override the onAvailable method to do what is needed after the initial\nposition was determined.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"desc" : "Abstract method called during the onMouseMove event while dragging an\nobject.",
"sig" : "(e)",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"desc" : "Abstract method called when this item is dropped on another DragDrop\nobj",
"sig" : "(e, id)",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"desc" : "Abstract method called when this element fist begins hovering over\nanother DragDrop obj",
"sig" : "(e, id)",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"desc" : "Abstract method called when we are no longer hovering over an element",
"sig" : "(e, id)",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"desc" : "Abstract method called when this element is hovering over another\nDragDrop obj",
"sig" : "(e, id)",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"desc" : "Abstract method called when this item is dropped on an area with no\ndrop target",
"sig" : "(e)",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"desc" : "Event handler that fires when a drag/drop obj gets a mousedown",
"sig" : "(e)",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"desc" : "Event handler that fires when a drag/drop obj gets a mouseup",
"sig" : "(e)",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"desc" : "The padding configured for this drag and drop object for calculating\nthe drop zone intersection with this object.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"desc" : "Remove's this instance from the supplied interaction group",
"sig" : "(sGroup)",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"desc" : "Unsets an invalid css class",
"sig" : "(cssClass)",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"desc" : "Unsets an invalid handle id",
"sig" : "(id)",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"desc" : "Unsets an excluded tag name set by addInvalidHandleType",
"sig" : "(tagName)",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"desc" : "resetConstraints must be called if you manually reposition a dd element.",
"sig" : "(maintainOffset)",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"desc" : "Allows you to specify that an element other than the linked element\nwill be moved with the cursor during a drag",
"sig" : "(id)",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"desc" : "Allows you to specify a child of the linked element that should be\nused to initiate the drag operation. An example of this would be if\nyou have a content div with text and links. Clicking anywhere in the\ncontent area would normally start the drag operation. Use this method\nto specify that an element inside of the content div is the element\nthat starts the drag operation.",
"sig" : "(id)",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"desc" : "Stores the initial placement of the linked element.",
"sig" : "(diffX, diffY)",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"isOptional" : false
},
{
- "name" : "diffY",
- "type" : "int",
- "desc" : "the Y offset, default 0",
+ "name" : "diffY",
+ "type" : "int",
+ "desc" : "the Y offset, default 0",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "setOuterHandleElId",
+ "type" : "function",
+ "desc" : "Allows you to set an element outside of the linked element as a drag\nhandle",
+ "sig" : "(id)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "id",
+ "type" : "",
+ "desc" : "the id of the element that will be used to initiate the drag",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "setPadding",
+ "type" : "function",
+ "desc" : "Configures the padding for the target zone in px. Effectively expands\n(or reduces) the virtual object size for targeting calculations.\nSupports css-style shorthand; if only one parameter is passed, all sides\nwill have that padding, and if only two are passed, the top and bottom\nwill have the first param, the left and right the second.",
+ "sig" : "(iTop, iRight, iBot, iLeft)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "iTop",
+ "type" : "int",
+ "desc" : "Top pad",
+ "isOptional" : false
+ },
+ {
+ "name" : "iRight",
+ "type" : "int",
+ "desc" : "Right pad",
+ "isOptional" : false
+ },
+ {
+ "name" : "iBot",
+ "type" : "int",
+ "desc" : "Bot pad",
+ "isOptional" : false
+ },
+ {
+ "name" : "iLeft",
+ "type" : "int",
+ "desc" : "Left pad",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "setXConstraint",
+ "type" : "function",
+ "desc" : "By default, the element can be dragged any place on the screen. Use\nthis method to limit the horizontal travel of the element. Pass in\n0,0 for the parameters if you want to lock the drag to the y axis.",
+ "sig" : "(iLeft, iRight, iTickSize)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "iLeft",
+ "type" : "int",
+ "desc" : "the number of pixels the element can move to the left",
+ "isOptional" : false
+ },
+ {
+ "name" : "iRight",
+ "type" : "int",
+ "desc" : "the number of pixels the element can move to the\nright",
+ "isOptional" : false
+ },
+ {
+ "name" : "iTickSize",
+ "type" : "int",
+ "desc" : "optional parameter for specifying that the\nelement\nshould move iTickSize pixels at a time.",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "setYConstraint",
+ "type" : "function",
+ "desc" : "By default, the element can be dragged any place on the screen. Set\nthis to limit the vertical travel of the element. Pass in 0,0 for the\nparameters if you want to lock the drag to the x axis.",
+ "sig" : "(iUp, iDown, iTickSize)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "iUp",
+ "type" : "int",
+ "desc" : "the number of pixels the element can move up",
+ "isOptional" : false
+ },
+ {
+ "name" : "iDown",
+ "type" : "int",
+ "desc" : "the number of pixels the element can move down",
+ "isOptional" : false
+ },
+ {
+ "name" : "iTickSize",
+ "type" : "int",
+ "desc" : "optional parameter for specifying that the\nelement should move iTickSize pixels at a time.",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "startDrag",
+ "type" : "function",
+ "desc" : "Abstract method called after a drag/drop object is clicked\nand the drag or mousedown time thresholds have beeen met.",
+ "sig" : "(X, Y)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "X",
+ "type" : "int",
+ "desc" : "click location",
+ "isOptional" : false
+ },
+ {
+ "name" : "Y",
+ "type" : "int",
+ "desc" : "click location",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "toString",
+ "type" : "function",
+ "desc" : "toString method",
+ "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" : "string representation of the dd obj"
+ }
+ ]
+ },
+ {
+ "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" : "unlock",
+ "type" : "function",
+ "desc" : "Unlock this instace",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
+ {
+ "name" : "unreg",
+ "type" : "function",
+ "desc" : "Remove all drag and drop hooks for this element",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ }
+ ],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "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" : []
+ },
+ "Roo.dd.DragSource" : {
+ "props" : [
+ {
+ "name" : "dropAllowed",
+ "type" : "String",
+ "desc" : "The CSS class returned to the drag source when drop is allowed (defaults to \"x-dd-drop-ok\").",
+ "memberOf" : "",
+ "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" : "",
+ "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" : [],
+ "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" : "addInvalidHandleClass",
+ "type" : "function",
+ "desc" : "Lets you specify a css class of elements that will not initiate a drag",
+ "sig" : "(cssClass)",
+ "static" : false,
+ "memberOf" : "Roo.dd.DragDrop",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "cssClass",
+ "type" : "string",
+ "desc" : "the class of the elements you wish to ignore",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "addInvalidHandleId",
+ "type" : "function",
+ "desc" : "Lets you to specify an element id for a child of a drag handle\nthat should not initiate a drag",
+ "sig" : "(id)",
+ "static" : false,
+ "memberOf" : "Roo.dd.DragDrop",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "id",
+ "type" : "string",
+ "desc" : "the element id of the element you wish to ignore",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "addInvalidHandleType",
+ "type" : "function",
+ "desc" : "Allows you to specify a tag name that should not start a drag operation\nwhen clicked. This is designed to facilitate embedding links within a\ndrag handle that do something other than start the drag.",
+ "sig" : "(tagName)",
+ "static" : false,
+ "memberOf" : "Roo.dd.DragDrop",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "tagName",
+ "type" : "string",
+ "desc" : "the type of element to exclude",
+ "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" : "setOuterHandleElId",
+ "name" : "addToGroup",
"type" : "function",
- "desc" : "Allows you to set an element outside of the linked element as a drag\nhandle",
- "sig" : "(id)",
+ "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,
"requires" : "",
"params" : [
{
- "name" : "id",
+ "name" : "sGroup",
"type" : "",
- "desc" : "the id of the element that will be used to initiate the drag",
+ "desc" : "{string} the name of the group",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "setPadding",
+ "name" : "afterDragDrop",
"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" : "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.DragDrop",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "iTop",
- "type" : "int",
- "desc" : "Top pad",
- "isOptional" : false
- },
- {
- "name" : "iRight",
- "type" : "int",
- "desc" : "Right pad",
+ "name" : "target",
+ "type" : "Roo.dd.DragDrop",
+ "desc" : "The drop target",
"isOptional" : false
},
{
- "name" : "iBot",
- "type" : "int",
- "desc" : "Bot pad",
+ "name" : "e",
+ "type" : "Event",
+ "desc" : "The event object",
"isOptional" : false
},
{
- "name" : "iLeft",
- "type" : "int",
- "desc" : "Left pad",
+ "name" : "id",
+ "type" : "String",
+ "desc" : "The id of the dropped element",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "setXConstraint",
+ "name" : "afterDragEnter",
"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" : "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.DragDrop",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "iLeft",
- "type" : "int",
- "desc" : "the number of pixels the element can move to the left",
+ "name" : "target",
+ "type" : "Roo.dd.DragDrop",
+ "desc" : "The drop target",
"isOptional" : false
},
{
- "name" : "iRight",
- "type" : "int",
- "desc" : "the number of pixels the element can move to the\nright",
+ "name" : "e",
+ "type" : "Event",
+ "desc" : "The event object",
"isOptional" : false
},
{
- "name" : "iTickSize",
- "type" : "int",
- "desc" : "optional parameter for specifying that the\nelement\nshould move iTickSize pixels at a time.",
+ "name" : "id",
+ "type" : "String",
+ "desc" : "The id of the dragged element",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "setYConstraint",
+ "name" : "afterDragOut",
"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" : "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.DragDrop",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "iUp",
- "type" : "int",
- "desc" : "the number of pixels the element can move up",
+ "name" : "target",
+ "type" : "Roo.dd.DragDrop",
+ "desc" : "The drop target",
"isOptional" : false
},
{
- "name" : "iDown",
- "type" : "int",
- "desc" : "the number of pixels the element can move down",
+ "name" : "e",
+ "type" : "Event",
+ "desc" : "The event object",
"isOptional" : false
},
{
- "name" : "iTickSize",
- "type" : "int",
- "desc" : "optional parameter for specifying that the\nelement should move iTickSize pixels at a time.",
+ "name" : "id",
+ "type" : "String",
+ "desc" : "The id of the dragged element",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "startDrag",
+ "name" : "afterDragOver",
"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" : "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.DragDrop",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "X",
- "type" : "int",
- "desc" : "click location",
+ "name" : "target",
+ "type" : "Roo.dd.DragDrop",
+ "desc" : "The drop target",
"isOptional" : false
},
{
- "name" : "Y",
- "type" : "int",
- "desc" : "click location",
+ "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" : "toString",
+ "name" : "afterInvalidDrop",
"type" : "function",
- "desc" : "toString method",
- "sig" : "()\n{\n\n}",
+ "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.DragDrop",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
- "returns" : [
+ "params" : [
{
- "name" : "",
- "type" : "string",
- "desc" : "string representation of the dd obj"
+ "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" : "un",
+ "name" : "afterValidDrop",
"type" : "function",
- "desc" : "Removes a listener (shorthand for removeListener)",
- "sig" : "(eventName, handler, scope)",
+ "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.util.Observable",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "eventName",
- "type" : "String",
- "desc" : "The type of event to listen for",
+ "name" : "target",
+ "type" : "Object",
+ "desc" : "The target DD",
"isOptional" : false
},
{
- "name" : "handler",
- "type" : "Function",
- "desc" : "The handler to remove",
+ "name" : "e",
+ "type" : "Event",
+ "desc" : "The event object",
"isOptional" : false
},
{
- "name" : "scope",
- "type" : "Object",
- "desc" : "(optional) The scope (this object) for the handler",
+ "name" : "id",
+ "type" : "String",
+ "desc" : "The id of the dropped element",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "unlock",
+ "name" : "alignElWithMouse",
"type" : "function",
- "desc" : "Unlock this instace",
- "sig" : "()\n{\n\n}",
+ "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.DragDrop",
+ "memberOf" : "Roo.dd.DD",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
+ "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" : "unreg",
+ "name" : "applyConfig",
"type" : "function",
- "desc" : "Remove all drag and drop hooks for this element",
+ "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",
"requires" : "",
"params" : [],
"returns" : []
- }
- ],
- "isAbstract" : false,
- "isBuilderTop" : false,
- "implementations" : [
- "Roo.dd.DropTarget",
- "Roo.dd.DropZone"
- ],
- "tree_children" : [],
- "tree_parent" : []
- },
- "Roo.dd.DragDrop" : {
- "props" : [
- {
- "name" : "listeners",
- "type" : "Object",
- "desc" : "list of events and functions to call for this object, \nFor example :\n<pre><code>\n listeners : { \n 'click' : function(e) {\n ..... \n } ,\n .... \n } \n </code></pre>",
- "memberOf" : "Roo.util.Observable"
- }
- ],
- "events" : [],
- "methods" : [
+ },
{
- "name" : "addEvents",
+ "name" : "autoOffset",
"type" : "function",
- "desc" : "Used to define events on this Observable",
- "sig" : "(object)",
+ "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.util.Observable",
+ "memberOf" : "Roo.dd.DD",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "object",
- "type" : "Object",
- "desc" : "The object with the events defined",
+ "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" : "addInvalidHandleClass",
+ "name" : "beforeDragDrop",
"type" : "function",
- "desc" : "Lets you specify a css class of elements that will not initiate a drag",
- "sig" : "(cssClass)",
+ "desc" : "An empty function by default, but provided so that you can perform a custom action before the dragged\nitem is dropped onto the target and optionally cancel the onDragDrop.",
+ "sig" : "(target, e, id)",
"static" : false,
"memberOf" : "",
"isStatic" : false,
"requires" : "",
"params" : [
{
- "name" : "cssClass",
- "type" : "string",
- "desc" : "the class of the elements you wish to ignore",
+ "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" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Boolean",
+ "desc" : "isValid True if the drag drop event is valid, else false to cancel"
+ }
+ ]
},
{
- "name" : "addInvalidHandleId",
+ "name" : "beforeDragEnter",
"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" : "An empty function by default, but provided so that you can perform a custom action\nbefore the dragged item enters the drop target and optionally cancel the onDragEnter.",
+ "sig" : "(target, e, id)",
"static" : false,
"memberOf" : "",
"isStatic" : false,
"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 element id of the element you wish to ignore",
+ "type" : "String",
+ "desc" : "The id of the dragged element",
"isOptional" : false
}
],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Boolean",
+ "desc" : "isValid True if the drag event is valid, else false to cancel"
+ }
+ ]
},
{
- "name" : "addInvalidHandleType",
+ "name" : "beforeDragOut",
"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" : "An empty function by default, but provided so that you can perform a custom action before the dragged\nitem is dragged out of the target without dropping, and optionally cancel the onDragOut.",
+ "sig" : "(target, e, id)",
"static" : false,
"memberOf" : "",
"isStatic" : false,
"requires" : "",
"params" : [
{
- "name" : "tagName",
- "type" : "string",
- "desc" : "the type of element to exclude",
+ "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" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Boolean",
+ "desc" : "isValid True if the drag event is valid, else false to cancel"
+ }
+ ]
},
{
- "name" : "addListener",
+ "name" : "beforeDragOver",
"type" : "function",
- "desc" : "Appends an event handler to this component",
- "sig" : "(eventName, handler, scope, options)",
+ "desc" : "An empty function by default, but provided so that you can perform a custom action\nwhile the dragged item is over the drop target and optionally cancel the onDragOver.",
+ "sig" : "(target, e, id)",
"static" : false,
- "memberOf" : "Roo.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",
+ "name" : "target",
+ "type" : "Roo.dd.DragDrop",
+ "desc" : "The drop target",
"isOptional" : false
},
{
- "name" : "scope",
- "type" : "Object",
- "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
+ "name" : "e",
+ "type" : "Event",
+ "desc" : "The event object",
"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" : "id",
+ "type" : "String",
+ "desc" : "The id of the dragged element",
"isOptional" : false
}
],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Boolean",
+ "desc" : "isValid True if the drag event is valid, else false to cancel"
+ }
+ ]
},
{
- "name" : "addToGroup",
+ "name" : "beforeInvalidDrop",
"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" : "An empty function by default, but provided so that you can perform a custom action after an invalid\ndrop has occurred.",
+ "sig" : "(target, e, id)",
"static" : false,
"memberOf" : "",
"isStatic" : false,
"requires" : "",
"params" : [
{
- "name" : "sGroup",
- "type" : "",
- "desc" : "{string} the name of the group",
+ "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" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Boolean",
+ "desc" : "isValid True if the invalid drop should proceed, else false to cancel"
+ }
+ ]
},
{
- "name" : "applyConfig",
+ "name" : "cachePosition",
"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}",
+ "desc" : "Saves the most recent position so that we can reset the constraints and\ntick marks on-demand. We need to know this so that we can calculate the\nnumber of pixels the element is offset from its original position.",
+ "sig" : "(iPageX, iPageY)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.dd.DD",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
+ "params" : [
+ {
+ "name" : "iPageX",
+ "type" : "",
+ "desc" : "the current x position (optional, this just makes it so we\ndon't have to look it up again)",
+ "isOptional" : false
+ },
+ {
+ "name" : "iPageY",
+ "type" : "",
+ "desc" : "the current y position (optional, this just makes it so we\ndon't have to look it up again)",
+ "isOptional" : false
+ }
+ ],
"returns" : []
},
{
"desc" : "Clears any constraints applied to this instance. Also clears ticks\nsince they can't exist independent of a constraint at this time.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.dd.DragDrop",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"desc" : "Clears any tick interval defined for this instance",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.dd.DragDrop",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
+ {
+ "name" : "createFrame",
+ "type" : "function",
+ "desc" : "Creates the proxy element if it does not yet exist",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.dd.DDProxy",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"desc" : "Fired when we are done dragging the object",
"sig" : "(e)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.dd.DragDrop",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
}
]
},
+ {
+ "name" : "getDragData",
+ "type" : "function",
+ "desc" : "Returns the data object associated with this drag source",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Object",
+ "desc" : "data An object containing arbitrary data"
+ }
+ ]
+ },
{
"name" : "getDragEl",
"type" : "function",
"desc" : "Returns a reference to the actual element to drag. By default this is\nthe same as the html element, but it can be assigned to another\nelement. An example of this can be found in Roo.dd.DDProxy",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.dd.DragDrop",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"desc" : "Returns a reference to the linked element",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.dd.DragDrop",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
}
]
},
+ {
+ "name" : "getProxy",
+ "type" : "function",
+ "desc" : "Returns the drag source's underlying {@link Roo.dd.StatusProxy}",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.dd.StatusProxy",
+ "desc" : "proxy The StatusProxy"
+ }
+ ]
+ },
{
"name" : "hasListener",
"type" : "function",
}
]
},
+ {
+ "name" : "hideProxy",
+ "type" : "function",
+ "desc" : "Hides the drag source's {@link Roo.dd.StatusProxy}",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
{
"name" : "init",
"type" : "function",
"desc" : "Sets up the DragDrop object. Must be called in the constructor of any\nRoo.dd.DragDrop subclass",
"sig" : "(id, sGroup, config)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.dd.DragDrop",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
],
"returns" : []
},
+ {
+ "name" : "initFrame",
+ "type" : "function",
+ "desc" : "Initialization for the drag frame element. Must be called in the\nconstructor of all subclasses",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.dd.DDProxy",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
{
"name" : "initTarget",
"type" : "function",
"desc" : "Initializes Targeting functionality only... the object does not\nget a mousedown handler.",
"sig" : "(id, sGroup, config)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.dd.DragDrop",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"desc" : "Returns true if this instance is locked, or the drag drop mgr is locked\n(meaning that all drag/drop is disabled on the page.)",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.dd.DragDrop",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"desc" : "By default, all insances can be a drop target. This can be disabled by\nsetting isTarget to false.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.dd.DragDrop",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"desc" : "Checks the tag exclusion list to see if this click should be ignored",
"sig" : "(node)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.dd.DragDrop",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"desc" : "Lock this instance",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.dd.DragDrop",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"desc" : "Override the onAvailable method to do what is needed after the initial\nposition was determined.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.dd.DragDrop",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"params" : [],
"returns" : []
},
+ {
+ "name" : "onBeforeDrag",
+ "type" : "function",
+ "desc" : "An empty function by default, but provided so that you can perform a custom action before the initial\ndrag event begins and optionally cancel it.",
+ "sig" : "(data, e)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "data",
+ "type" : "Object",
+ "desc" : "An object containing arbitrary data to be shared with drop targets",
+ "isOptional" : false
+ },
+ {
+ "name" : "e",
+ "type" : "Event",
+ "desc" : "The event object",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Boolean",
+ "desc" : "isValid True if the drag event is valid, else false to cancel"
+ }
+ ]
+ },
{
"name" : "onDrag",
"type" : "function",
"desc" : "Abstract method called during the onMouseMove event while dragging an\nobject.",
"sig" : "(e)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.dd.DragDrop",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"desc" : "Abstract method called when this item is dropped on another DragDrop\nobj",
"sig" : "(e, id)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.dd.DragDrop",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"desc" : "Abstract method called when this element fist begins hovering over\nanother DragDrop obj",
"sig" : "(e, id)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.dd.DragDrop",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"desc" : "Abstract method called when we are no longer hovering over an element",
"sig" : "(e, id)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.dd.DragDrop",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"desc" : "Abstract method called when this element is hovering over another\nDragDrop obj",
"sig" : "(e, id)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.dd.DragDrop",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"desc" : "Abstract method called when this item is dropped on an area with no\ndrop target",
"sig" : "(e)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.dd.DragDrop",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"desc" : "Event handler that fires when a drag/drop obj gets a mousedown",
"sig" : "(e)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.dd.DragDrop",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"desc" : "Event handler that fires when a drag/drop obj gets a mouseup",
"sig" : "(e)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.dd.DragDrop",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
],
"returns" : []
},
+ {
+ "name" : "onStartDrag",
+ "type" : "function",
+ "desc" : "An empty function by default, but provided so that you can perform a custom action once the initial\ndrag event has begun. The drag cannot be canceled from this function.",
+ "sig" : "(x, y)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "x",
+ "type" : "Number",
+ "desc" : "The x position of the click on the dragged object",
+ "isOptional" : false
+ },
+ {
+ "name" : "y",
+ "type" : "Number",
+ "desc" : "The y position of the click on the dragged object",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
{
"name" : "padding",
"type" : "function",
"desc" : "The padding configured for this drag and drop object for calculating\nthe drop zone intersection with this object.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.dd.DragDrop",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"desc" : "Remove's this instance from the supplied interaction group",
"sig" : "(sGroup)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.dd.DragDrop",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"desc" : "Unsets an invalid css class",
"sig" : "(cssClass)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.dd.DragDrop",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"desc" : "Unsets an invalid handle id",
"sig" : "(id)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.dd.DragDrop",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"desc" : "Unsets an excluded tag name set by addInvalidHandleType",
"sig" : "(tagName)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.dd.DragDrop",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"returns" : []
},
{
- "name" : "resetConstraints",
- "type" : "function",
- "desc" : "resetConstraints must be called if you manually reposition a dd element.",
- "sig" : "(maintainOffset)",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "maintainOffset",
- "type" : "boolean",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "setDragElId",
- "type" : "function",
- "desc" : "Allows you to specify that an element other than the linked element\nwill be moved with the cursor during a drag",
- "sig" : "(id)",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "id",
- "type" : "",
- "desc" : "{string} the id of the element that will be used to initiate the drag",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "setHandleElId",
- "type" : "function",
- "desc" : "Allows you to specify a child of the linked element that should be\nused to initiate the drag operation. An example of this would be if\nyou have a content div with text and links. Clicking anywhere in the\ncontent area would normally start the drag operation. Use this method\nto specify that an element inside of the content div is the element\nthat starts the drag operation.",
- "sig" : "(id)",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "id",
- "type" : "",
- "desc" : "{string} the id of the element that will be used to\ninitiate the drag.",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "setInitPosition",
- "type" : "function",
- "desc" : "Stores the initial placement of the linked element.",
- "sig" : "(diffX, diffY)",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "diffX",
- "type" : "int",
- "desc" : "the X offset, default 0",
- "isOptional" : false
- },
- {
- "name" : "diffY",
- "type" : "int",
- "desc" : "the Y offset, default 0",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "setOuterHandleElId",
- "type" : "function",
- "desc" : "Allows you to set an element outside of the linked element as a drag\nhandle",
- "sig" : "(id)",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "id",
- "type" : "",
- "desc" : "the id of the element that will be used to initiate the drag",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "setPadding",
- "type" : "function",
- "desc" : "Configures the padding for the target zone in px. Effectively expands\n(or reduces) the virtual object size for targeting calculations.\nSupports css-style shorthand; if only one parameter is passed, all sides\nwill have that padding, and if only two are passed, the top and bottom\nwill have the first param, the left and right the second.",
- "sig" : "(iTop, iRight, iBot, iLeft)",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "iTop",
- "type" : "int",
- "desc" : "Top pad",
- "isOptional" : false
- },
- {
- "name" : "iRight",
- "type" : "int",
- "desc" : "Right pad",
- "isOptional" : false
- },
- {
- "name" : "iBot",
- "type" : "int",
- "desc" : "Bot pad",
- "isOptional" : false
- },
- {
- "name" : "iLeft",
- "type" : "int",
- "desc" : "Left pad",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "setXConstraint",
- "type" : "function",
- "desc" : "By default, the element can be dragged any place on the screen. Use\nthis method to limit the horizontal travel of the element. Pass in\n0,0 for the parameters if you want to lock the drag to the y axis.",
- "sig" : "(iLeft, iRight, iTickSize)",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "iLeft",
- "type" : "int",
- "desc" : "the number of pixels the element can move to the left",
- "isOptional" : false
- },
- {
- "name" : "iRight",
- "type" : "int",
- "desc" : "the number of pixels the element can move to the\nright",
- "isOptional" : false
- },
- {
- "name" : "iTickSize",
- "type" : "int",
- "desc" : "optional parameter for specifying that the\nelement\nshould move iTickSize pixels at a time.",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "setYConstraint",
- "type" : "function",
- "desc" : "By default, the element can be dragged any place on the screen. Set\nthis to limit the vertical travel of the element. Pass in 0,0 for the\nparameters if you want to lock the drag to the x axis.",
- "sig" : "(iUp, iDown, iTickSize)",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "iUp",
- "type" : "int",
- "desc" : "the number of pixels the element can move up",
- "isOptional" : false
- },
- {
- "name" : "iDown",
- "type" : "int",
- "desc" : "the number of pixels the element can move down",
- "isOptional" : false
- },
- {
- "name" : "iTickSize",
- "type" : "int",
- "desc" : "optional parameter for specifying that the\nelement should move iTickSize pixels at a time.",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "startDrag",
- "type" : "function",
- "desc" : "Abstract method called after a drag/drop object is clicked\nand the drag or mousedown time thresholds have beeen met.",
- "sig" : "(X, Y)",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "X",
- "type" : "int",
- "desc" : "click location",
- "isOptional" : false
- },
- {
- "name" : "Y",
- "type" : "int",
- "desc" : "click location",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "toString",
- "type" : "function",
- "desc" : "toString method",
- "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" : "string representation of the dd obj"
- }
- ]
- },
- {
- "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" : "unlock",
- "type" : "function",
- "desc" : "Unlock this instace",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
- {
- "name" : "unreg",
- "type" : "function",
- "desc" : "Remove all drag and drop hooks for this element",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- }
- ],
- "isAbstract" : false,
- "isBuilderTop" : false,
- "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" : []
- },
- "Roo.dd.DragDropMgr" : {
- "props" : [],
- "events" : [],
- "methods" : [
- {
- "name" : "getBestMatch",
+ "name" : "resetConstraints",
"type" : "function",
- "desc" : "Helper function for getting the best match from the list of drag\nand drop objects returned by the drag and drop events when we are\nin INTERSECT mode. It returns either the first object that the\ncursor is over, or the object that has the greatest overlap with\nthe dragged element.",
- "sig" : "(dds)",
+ "desc" : "resetConstraints must be called if you manually reposition a dd element.",
+ "sig" : "(maintainOffset)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.dd.DragDrop",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "dds",
- "type" : "DragDrop[]",
- "desc" : "The array of drag and drop objects\ntargeted",
+ "name" : "maintainOffset",
+ "type" : "boolean",
+ "desc" : "",
"isOptional" : false
}
],
- "returns" : [
- {
- "name" : "",
- "type" : "DragDrop",
- "desc" : "The best single match"
- }
- ]
+ "returns" : []
},
{
- "name" : "getCss",
+ "name" : "setDelta",
"type" : "function",
- "desc" : "Returns the style property for the DOM element (i.e.,\ndocument.getElById(id).style)",
- "sig" : "(id)",
+ "desc" : "Sets the pointer offset. You can call this directly to force the\noffset to be in a particular location (e.g., pass in 0,0 to set it\nto the center of the object)",
+ "sig" : "(iDeltaX, iDeltaY)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.dd.DD",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"example" : "",
- "deprecated" : "This has been deprecated: use Roo.getDom instead",
+ "deprecated" : "",
"since" : "",
"see" : "",
"exceptions" : "",
"requires" : "",
"params" : [
{
- "name" : "id",
- "type" : "String",
- "desc" : "the id of the elment to get",
+ "name" : "iDeltaX",
+ "type" : "int",
+ "desc" : "the distance from the left",
"isOptional" : false
- }
- ],
- "returns" : [
- {
- "name" : "",
- "type" : "Object",
- "desc" : "The style property of the element"
- }
- ]
- },
- {
- "name" : "getDDById",
- "type" : "function",
- "desc" : "Returns the DragDrop instance for a given id",
- "sig" : "(id)",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
+ },
{
- "name" : "id",
- "type" : "String",
- "desc" : "the id of the DragDrop object",
+ "name" : "iDeltaY",
+ "type" : "int",
+ "desc" : "the distance from the top",
"isOptional" : false
}
],
- "returns" : [
- {
- "name" : "",
- "type" : "DragDrop",
- "desc" : "the drag drop object, null if it is not found"
- }
- ]
+ "returns" : []
},
{
- "name" : "getElement",
+ "name" : "setDragElId",
"type" : "function",
- "desc" : "Returns the actual DOM element",
+ "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,
"example" : "",
- "deprecated" : "This has been deprecated: use Roo.getDom instead",
+ "deprecated" : "",
"since" : "",
"see" : "",
"exceptions" : "",
"params" : [
{
"name" : "id",
- "type" : "String",
- "desc" : "the id of the elment to get",
+ "type" : "",
+ "desc" : "{string} the id of the element that will be used to initiate the drag",
"isOptional" : false
}
],
- "returns" : [
- {
- "name" : "",
- "type" : "Object",
- "desc" : "The element"
- }
- ]
+ "returns" : []
},
{
- "name" : "getLocation",
+ "name" : "setDragElPos",
"type" : "function",
- "desc" : "Returns a Region object containing the drag and drop element's position\nand size, including the padding configured for it",
- "sig" : "(oDD)",
+ "desc" : "Sets the drag element to the location of the mousedown or click event,\nmaintaining the cursor location relative to the location on the element\nthat was clicked. Override this if you want to place the element in a\nlocation other than where the cursor is.",
+ "sig" : "(iPageX, iPageY)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.dd.DD",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "oDD",
- "type" : "DragDrop",
- "desc" : "the drag and drop object to get the\n location for",
- "isOptional" : false
- }
- ],
- "returns" : [
- {
- "name" : "",
- "type" : "Roo.lib.Region",
- "desc" : "a Region object representing the total area\n the element occupies, including any padding\n the instance is configured for."
- }
- ]
- },
- {
- "name" : "getPosX",
- "type" : "function",
- "desc" : "Returns the X position of an html element",
- "sig" : "(el)",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "This has been deprecated: use Roo.lib.Dom.getX instead",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "el",
- "type" : "",
- "desc" : "the element for which to get the position",
+ "name" : "iPageX",
+ "type" : "int",
+ "desc" : "the X coordinate of the mousedown or drag event",
"isOptional" : false
- }
- ],
- "returns" : [
+ },
{
- "name" : "",
+ "name" : "iPageY",
"type" : "int",
- "desc" : "the X coordinate"
- }
- ]
- },
- {
- "name" : "getPosY",
- "type" : "function",
- "desc" : "Returns the Y position of an html element",
- "sig" : "(el)",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "This has been deprecated: use Roo.lib.Dom.getY instead",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "el",
- "type" : "",
- "desc" : "the element for which to get the position",
+ "desc" : "the Y coordinate of the mousedown or drag event",
"isOptional" : false
}
],
- "returns" : [
- {
- "name" : "",
- "type" : "int",
- "desc" : "the Y coordinate"
- }
- ]
+ "returns" : []
},
{
- "name" : "getRelated",
+ "name" : "setHandleElId",
"type" : "function",
- "desc" : "Returns the drag and drop instances that are in all groups the\npassed in instance belongs to.",
- "sig" : "(p_oDD, bTargetsOnly)",
+ "desc" : "Allows you to specify a child of the linked element that should be\nused to initiate the drag operation. An example of this would be if\nyou have a content div with text and links. Clicking anywhere in the\ncontent area would normally start the drag operation. Use this method\nto specify that an element inside of the content div is the element\nthat starts the drag operation.",
+ "sig" : "(id)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.dd.DragDrop",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "p_oDD",
- "type" : "DragDrop",
- "desc" : "the obj to get related data for",
- "isOptional" : false
- },
- {
- "name" : "bTargetsOnly",
- "type" : "boolean",
- "desc" : "if true, only return targetable objs",
+ "name" : "id",
+ "type" : "",
+ "desc" : "{string} the id of the element that will be used to\ninitiate the drag.",
"isOptional" : false
}
],
- "returns" : [
- {
- "name" : "",
- "type" : "DragDrop[]",
- "desc" : "the related instances"
- }
- ]
- },
- {
- "name" : "getScrollLeft",
- "type" : "function",
- "desc" : "Gets the scrollLeft",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : [
- {
- "name" : "",
- "type" : "int",
- "desc" : "the document's scrollTop"
- }
- ]
+ "returns" : []
},
{
- "name" : "getScrollTop",
+ "name" : "setInitPosition",
"type" : "function",
- "desc" : "Gets the scrollTop",
- "sig" : "()\n{\n\n}",
+ "desc" : "Stores the initial placement of the linked element.",
+ "sig" : "(diffX, diffY)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.dd.DragDrop",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
- "returns" : [
- {
- "name" : "",
- "type" : "int",
- "desc" : "the document's scrollTop"
- }
- ]
- },
- {
- "name" : "getStyle",
- "type" : "function",
- "desc" : "Returns the specified element style property",
- "sig" : "(el, styleProp)",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "This has been deprecated: use Roo.lib.Dom.getStyle",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
"params" : [
{
- "name" : "el",
- "type" : "HTMLElement",
- "desc" : "the element",
+ "name" : "diffX",
+ "type" : "int",
+ "desc" : "the X offset, default 0",
"isOptional" : false
},
{
- "name" : "styleProp",
- "type" : "string",
- "desc" : "the style property",
- "isOptional" : false
- }
- ],
- "returns" : [
- {
- "name" : "",
- "type" : "string",
- "desc" : "The value of the style property"
- }
- ]
- },
- {
- "name" : "handleWasClicked",
- "type" : "function",
- "desc" : "Recursively searches the immediate parent and all child nodes for\nthe handle element in order to determine wheter or not it was\nclicked.",
- "sig" : "(node)",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "node",
- "type" : "",
- "desc" : "the html element to inspect",
+ "name" : "diffY",
+ "type" : "int",
+ "desc" : "the Y offset, default 0",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "isDragDrop",
+ "name" : "setOuterHandleElId",
"type" : "function",
- "desc" : "Utility function to determine if a given element has been\nregistered as a drag drop item.",
+ "desc" : "Allows you to set an element outside of the linked element as a drag\nhandle",
"sig" : "(id)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.dd.DragDrop",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"params" : [
{
"name" : "id",
- "type" : "String",
- "desc" : "the element id to check",
+ "type" : "",
+ "desc" : "the id of the element that will be used to initiate the drag",
"isOptional" : false
}
],
- "returns" : [
- {
- "name" : "",
- "type" : "boolean",
- "desc" : "true if this element is a DragDrop item,\nfalse otherwise"
- }
- ]
+ "returns" : []
},
{
- "name" : "isHandle",
+ "name" : "setPadding",
"type" : "function",
- "desc" : "Utility function to determine if a given element has been\nregistered as a drag drop handle for the given Drag Drop object.",
- "sig" : "(id)",
+ "desc" : "Configures the padding for the target zone in px. Effectively expands\n(or reduces) the virtual object size for targeting calculations.\nSupports css-style shorthand; if only one parameter is passed, all sides\nwill have that padding, and if only two are passed, the top and bottom\nwill have the first param, the left and right the second.",
+ "sig" : "(iTop, iRight, iBot, iLeft)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.dd.DragDrop",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "id",
- "type" : "String",
- "desc" : "the element id to check",
+ "name" : "iTop",
+ "type" : "int",
+ "desc" : "Top pad",
"isOptional" : false
- }
- ],
- "returns" : [
- {
- "name" : "",
- "type" : "boolean",
- "desc" : "true if this element is a DragDrop handle, false\notherwise"
- }
- ]
- },
- {
- "name" : "isLegalTarget",
- "type" : "function",
- "desc" : "Returns true if the specified dd target is a legal target for\nthe specifice drag obj",
- "sig" : "(the, the)",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
+ },
{
- "name" : "the",
- "type" : "DragDrop",
- "desc" : "drag obj",
+ "name" : "iRight",
+ "type" : "int",
+ "desc" : "Right pad",
"isOptional" : false
},
{
- "name" : "the",
- "type" : "DragDrop",
- "desc" : "target",
+ "name" : "iBot",
+ "type" : "int",
+ "desc" : "Bot pad",
"isOptional" : false
- }
- ],
- "returns" : [
- {
- "name" : "",
- "type" : "boolean",
- "desc" : "true if the target is a legal target for the\ndd obj"
- }
- ]
- },
- {
- "name" : "isLocked",
- "type" : "function",
- "desc" : "Is drag and drop locked?",
- "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 drag and drop is locked, false otherwise."
- }
- ]
- },
- {
- "name" : "isTypeOfDD",
- "type" : "function",
- "desc" : "My goal is to be able to transparently determine if an object is\ntypeof DragDrop, and the exact subclass of DragDrop. typeof\nreturns \"object\", oDD.constructor.toString() always returns\n\"DragDrop\" and not the name of the subclass. So for now it just\nevaluates a well-known variable in DragDrop.",
- "sig" : "(the)",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
+ },
{
- "name" : "the",
- "type" : "Object",
- "desc" : "object to evaluate",
+ "name" : "iLeft",
+ "type" : "int",
+ "desc" : "Left pad",
"isOptional" : false
}
],
- "returns" : [
- {
- "name" : "",
- "type" : "boolean",
- "desc" : "true if typeof oDD = DragDrop"
- }
- ]
- },
- {
- "name" : "lock",
- "type" : "function",
- "desc" : "Lock all drag and drop functionality",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
"returns" : []
},
{
- "name" : "moveToEl",
+ "name" : "setXConstraint",
"type" : "function",
- "desc" : "Sets the x/y position of an element to the location of the\ntarget element.",
- "sig" : "(moveEl, targetEl)",
+ "desc" : "By default, the element can be dragged any place on the screen. Use\nthis method to limit the horizontal travel of the element. Pass in\n0,0 for the parameters if you want to lock the drag to the y axis.",
+ "sig" : "(iLeft, iRight, iTickSize)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.dd.DragDrop",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "moveEl",
- "type" : "HTMLElement",
- "desc" : "The element to move",
+ "name" : "iLeft",
+ "type" : "int",
+ "desc" : "the number of pixels the element can move to the left",
"isOptional" : false
},
{
- "name" : "targetEl",
- "type" : "HTMLElement",
- "desc" : "The position reference element",
+ "name" : "iRight",
+ "type" : "int",
+ "desc" : "the number of pixels the element can move to the\nright",
"isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "numericSort",
- "type" : "function",
- "desc" : "Numeric array sort function",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
- {
- "name" : "refreshCache",
- "type" : "function",
- "desc" : "Refreshes the cache of the top-left and bottom-right points of the\ndrag and drop objects in the specified group(s). This is in the\nformat that is stored in the drag and drop instance, so typical\nusage is:\n<code>\nRoo.dd.DragDropMgr.refreshCache(ddinstance.groups);\n</code>\nAlternatively:\n<code>\nRoo.dd.DragDropMgr.refreshCache({group1:true, group2:true});\n</code>",
- "sig" : "(groups)",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
+ },
{
- "name" : "groups",
- "type" : "Object",
- "desc" : "an associative array of groups to refresh",
+ "name" : "iTickSize",
+ "type" : "int",
+ "desc" : "optional parameter for specifying that the\nelement\nshould move iTickSize pixels at a time.",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "regDragDrop",
+ "name" : "setYConstraint",
"type" : "function",
- "desc" : "Each DragDrop instance must be registered with the DragDropMgr.\nThis is executed in DragDrop.init()",
- "sig" : "(oDD, sGroup)",
+ "desc" : "By default, the element can be dragged any place on the screen. Set\nthis to limit the vertical travel of the element. Pass in 0,0 for the\nparameters if you want to lock the drag to the x axis.",
+ "sig" : "(iUp, iDown, iTickSize)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.dd.DragDrop",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "oDD",
- "type" : "DragDrop",
- "desc" : "the DragDrop object to register",
+ "name" : "iUp",
+ "type" : "int",
+ "desc" : "the number of pixels the element can move up",
"isOptional" : false
},
{
- "name" : "sGroup",
- "type" : "String",
- "desc" : "the name of the group this element belongs to",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "regHandle",
- "type" : "function",
- "desc" : "Each DragDrop handle element must be registered. This is done\nautomatically when executing DragDrop.setHandleElId()",
- "sig" : "(sDDId, sHandleId)",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "sDDId",
- "type" : "String",
- "desc" : "the DragDrop id this element is a handle for",
+ "name" : "iDown",
+ "type" : "int",
+ "desc" : "the number of pixels the element can move down",
"isOptional" : false
},
{
- "name" : "sHandleId",
- "type" : "String",
- "desc" : "the id of the element that is the drag\nhandle",
+ "name" : "iTickSize",
+ "type" : "int",
+ "desc" : "optional parameter for specifying that the\nelement should move iTickSize pixels at a time.",
"isOptional" : false
}
],
{
"name" : "startDrag",
"type" : "function",
- "desc" : "Fired when either the drag pixel threshol or the mousedown hold\ntime threshold has been met.",
- "sig" : "(x, y)",
+ "desc" : "Abstract method called after a drag/drop object is clicked\nand the drag or mousedown time thresholds have beeen met.",
+ "sig" : "(X, Y)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.dd.DragDrop",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "x",
- "type" : "",
- "desc" : "{int} the X position of the original mousedown",
+ "name" : "X",
+ "type" : "int",
+ "desc" : "click location",
"isOptional" : false
},
{
- "name" : "y",
- "type" : "",
- "desc" : "{int} the Y position of the original mousedown",
+ "name" : "Y",
+ "type" : "int",
+ "desc" : "click location",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "stopEvent",
+ "name" : "toString",
"type" : "function",
- "desc" : "Utility to stop event propagation and event default, if these\nfeatures are turned on.",
- "sig" : "(e)",
+ "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" : "e",
- "type" : "Event",
- "desc" : "the event as returned by this.getEvent()",
- "isOptional" : false
+ "name" : "",
+ "type" : "string",
+ "desc" : "string representation of the dd obj"
}
- ],
- "returns" : []
+ ]
},
{
- "name" : "swapNode",
+ "name" : "un",
"type" : "function",
- "desc" : "Swap two nodes. In IE, we use the native method, for others we\nemulate the IE behavior",
- "sig" : "(n1, n2)",
+ "desc" : "Removes a listener (shorthand for removeListener)",
+ "sig" : "(eventName, handler, scope)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.util.Observable",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "n1",
- "type" : "",
- "desc" : "the first node to swap",
+ "name" : "eventName",
+ "type" : "String",
+ "desc" : "The type of event to listen for",
"isOptional" : false
},
{
- "name" : "n2",
- "type" : "",
- "desc" : "the other node to swap",
+ "name" : "handler",
+ "type" : "Function",
+ "desc" : "The handler to remove",
+ "isOptional" : false
+ },
+ {
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "(optional) The scope (this object) for the handler",
"isOptional" : false
}
],
{
"name" : "unlock",
"type" : "function",
- "desc" : "Unlock all drag and drop functionality",
+ "desc" : "Unlock this instace",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.dd.DragDrop",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"returns" : []
},
{
- "name" : "verifyEl",
+ "name" : "unreg",
"type" : "function",
- "desc" : "This checks to make sure an element exists and is in the DOM. The\nmain purpose is to handle cases where innerHTML is used to remove\ndrag and drop objects from the DOM. IE provides an 'unspecified\nerror' when trying to access the offsetParent of such an element",
- "sig" : "(el)",
+ "desc" : "Remove all drag and drop hooks for this element",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.dd.DragDrop",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "el",
- "type" : "HTMLElement",
- "desc" : "the element to check",
- "isOptional" : false
- }
- ],
- "returns" : [
- {
- "name" : "",
- "type" : "boolean",
- "desc" : "true if the element looks usable"
- }
- ]
+ "params" : [],
+ "returns" : []
}
],
"isAbstract" : false,
"isBuilderTop" : false,
- "implementations" : [],
+ "implementations" : [
+ "Roo.dd.DragZone"
+ ],
"tree_children" : [],
"tree_parent" : []
},
- "Roo.dd.DragSource" : {
+ "Roo.dd.DragZone" : {
"props" : [
+ {
+ "name" : "containerScroll",
+ "type" : "Boolean",
+ "desc" : "True to register this container with the Scrollmanager\nfor auto scrolling during drag operations.",
+ "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" : "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" : ""
+ "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" : "",
+ "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" : [],
"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" : "",
+ "memberOf" : "Roo.dd.DragSource",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"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" : "",
+ "memberOf" : "Roo.dd.DragSource",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"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" : "",
+ "memberOf" : "Roo.dd.DragSource",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"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" : "",
+ "memberOf" : "Roo.dd.DragSource",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"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" : "",
+ "memberOf" : "Roo.dd.DragSource",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : 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" : "",
+ "memberOf" : "Roo.dd.DragSource",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"desc" : "An empty function by default, but provided so that you can perform a custom action before the dragged\nitem is dropped onto the target and optionally cancel the onDragDrop.",
"sig" : "(target, e, id)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.dd.DragSource",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"desc" : "An empty function by default, but provided so that you can perform a custom action\nbefore the dragged item enters the drop target and optionally cancel the onDragEnter.",
"sig" : "(target, e, id)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.dd.DragSource",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"desc" : "An empty function by default, but provided so that you can perform a custom action before the dragged\nitem is dragged out of the target without dropping, and optionally cancel the onDragOut.",
"sig" : "(target, e, id)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.dd.DragSource",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"desc" : "An empty function by default, but provided so that you can perform a custom action\nwhile the dragged item is over the drop target and optionally cancel the onDragOver.",
"sig" : "(target, e, id)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.dd.DragSource",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"desc" : "An empty function by default, but provided so that you can perform a custom action after an invalid\ndrop has occurred.",
"sig" : "(target, e, id)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.dd.DragSource",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
{
"name" : "getDragData",
"type" : "function",
- "desc" : "Returns the data object associated with this drag source",
- "sig" : "()\n{\n\n}",
+ "desc" : "Called when a mousedown occurs in this container. Looks in {@link Roo.dd.Registry}\nfor a valid target to drag based on the mouse down. Override this method\nto provide your own lookup logic (e.g. finding a child by class name). Make sure your returned\nobject has a \"ddel\" attribute (with an HTML Element) for other functions to work.",
+ "sig" : "(e)",
"static" : false,
"memberOf" : "",
"isStatic" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
+ "params" : [
+ {
+ "name" : "e",
+ "type" : "EventObject",
+ "desc" : "The mouse down event",
+ "isOptional" : false
+ }
+ ],
"returns" : [
{
"name" : "",
"type" : "Object",
- "desc" : "data An object containing arbitrary data"
+ "desc" : "The dragData"
}
]
},
"desc" : "Returns the drag source's underlying {@link Roo.dd.StatusProxy}",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.dd.DragSource",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
}
]
},
+ {
+ "name" : "getRepairXY",
+ "type" : "function",
+ "desc" : "Called before a repair of an invalid drop to get the XY to animate to. By default returns\nthe XY of this.dragData.ddel",
+ "sig" : "(e)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "e",
+ "type" : "EventObject",
+ "desc" : "The mouse up event",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Array",
+ "desc" : "The xy location (e.g. [100, 200])"
+ }
+ ]
+ },
{
"name" : "hasListener",
"type" : "function",
"desc" : "Hides the drag source's {@link Roo.dd.StatusProxy}",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.dd.DragSource",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"desc" : "An empty function by default, but provided so that you can perform a custom action before the initial\ndrag event begins and optionally cancel it.",
"sig" : "(data, e)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.dd.DragSource",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
],
"returns" : []
},
+ {
+ "name" : "onInitDrag",
+ "type" : "function",
+ "desc" : "Called once drag threshold has been reached to initialize the proxy element. By default, it clones the\nthis.dragData.ddel",
+ "sig" : "(x, y)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "x",
+ "type" : "Number",
+ "desc" : "The x position of the click on the dragged object",
+ "isOptional" : false
+ },
+ {
+ "name" : "y",
+ "type" : "Number",
+ "desc" : "The y position of the click on the dragged object",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Boolean",
+ "desc" : "true to continue the drag, false to cancel"
+ }
+ ]
+ },
{
"name" : "onInvalidDrop",
"type" : "function",
"desc" : "An empty function by default, but provided so that you can perform a custom action once the initial\ndrag event has begun. The drag cannot be canceled from this function.",
"sig" : "(x, y)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.dd.DragSource",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
],
"isAbstract" : false,
"isBuilderTop" : false,
- "implementations" : [
- "Roo.dd.DragZone"
- ],
+ "implementations" : [],
"tree_children" : [],
"tree_parent" : []
},
- "Roo.dd.DragZone" : {
+ "Roo.dd.DropTarget" : {
"props" : [
{
- "name" : "containerScroll",
- "type" : "Boolean",
- "desc" : "True to register this container with the Scrollmanager\nfor auto scrolling during drag operations.",
- "memberOf" : ""
+ "name" : "ddGroup",
+ "type" : "String",
+ "desc" : "The drag drop group to handle drop events for",
+ "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" : "",
+ "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"
- },
- {
- "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"
- }
- ],
- "events" : [],
- "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" : []
+ "isOptional" : false,
+ "optvals" : []
},
{
- "name" : "addInvalidHandleClass",
- "type" : "function",
- "desc" : "Lets you specify a css class of elements that will not initiate a drag",
- "sig" : "(cssClass)",
- "static" : false,
- "memberOf" : "Roo.dd.DragDrop",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "cssClass",
- "type" : "string",
- "desc" : "the class of the elements you wish to ignore",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "addInvalidHandleId",
- "type" : "function",
- "desc" : "Lets you to specify an element id for a child of a drag handle\nthat should not initiate a drag",
- "sig" : "(id)",
- "static" : false,
- "memberOf" : "Roo.dd.DragDrop",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "id",
- "type" : "string",
- "desc" : "the element id of the element you wish to ignore",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "addInvalidHandleType",
- "type" : "function",
- "desc" : "Allows you to specify a tag name that should not start a drag operation\nwhen clicked. This is designed to facilitate embedding links within a\ndrag handle that do something other than start the drag.",
- "sig" : "(tagName)",
- "static" : false,
- "memberOf" : "Roo.dd.DragDrop",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "tagName",
- "type" : "string",
- "desc" : "the type of element to exclude",
- "isOptional" : false
- }
- ],
- "returns" : []
+ "name" : "overClass",
+ "type" : "String",
+ "desc" : "The CSS class applied to the drop target element while the drag source is over it (defaults to \"\").",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
- "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" : "success",
+ "type" : "boolean",
+ "desc" : "set this after drop listener..",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
- "name" : "addToGroup",
- "type" : "function",
- "desc" : "Add this instance to a group of related drag/drop objects. All\ninstances belong to at least one group, and can belong to as many\ngroups as needed.",
- "sig" : "(sGroup)",
- "static" : false,
- "memberOf" : "Roo.dd.DragDrop",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "sGroup",
- "type" : "",
- "desc" : "{string} the name of the group",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
+ "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" : "",
+ "isOptional" : false,
+ "optvals" : []
+ }
+ ],
+ "events" : [
{
- "name" : "afterDragDrop",
+ "name" : "drop",
"type" : "function",
- "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.DragSource",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
+ "desc" : "The function a {@link Roo.dd.DragSource} calls once to notify this drop target that the dragged item has\nbeen dropped on it. This method has no default implementation and returns false, so you must provide an\nimplementation that does something to process the drop event and returns true so that the drag source's\nrepair action does not run.\n\nIMPORTANT : it should set this.success",
+ "sig" : "function (source, e, data)\n{\n\n}",
+ "memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
"params" : [
{
- "name" : "target",
- "type" : "Roo.dd.DragDrop",
- "desc" : "The drop target",
+ "name" : "source",
+ "type" : "Roo.dd.DragSource",
+ "desc" : "The drag source that was dragged over this drop target",
"isOptional" : false
},
{
"name" : "e",
"type" : "Event",
- "desc" : "The event object",
+ "desc" : "The event",
"isOptional" : false
},
{
- "name" : "id",
- "type" : "String",
- "desc" : "The id of the dropped element",
+ "name" : "data",
+ "type" : "Object",
+ "desc" : "An object containing arbitrary data supplied by the drag source",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "afterDragEnter",
+ "name" : "enter",
"type" : "function",
- "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.DragSource",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
+ "desc" : "The function a {@link Roo.dd.DragSource} calls once to notify this drop target that the source is now over the\ntarget. This default implementation adds the CSS class specified by overClass (if any) to the drop element\nand returns the dropAllowed config value. This method should be overridden if drop validation is required.\n\nIMPORTANT : it should set this.valid to true|false",
+ "sig" : "function (source, e, data)\n{\n\n}",
+ "memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
"params" : [
{
- "name" : "target",
- "type" : "Roo.dd.DragDrop",
- "desc" : "The drop target",
+ "name" : "source",
+ "type" : "Roo.dd.DragSource",
+ "desc" : "The drag source that was dragged over this drop target",
"isOptional" : false
},
{
"name" : "e",
"type" : "Event",
- "desc" : "The event object",
+ "desc" : "The event",
"isOptional" : false
},
{
- "name" : "id",
- "type" : "String",
- "desc" : "The id of the dragged element",
+ "name" : "data",
+ "type" : "Object",
+ "desc" : "An object containing arbitrary data supplied by the drag source",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "afterDragOut",
+ "name" : "out",
"type" : "function",
- "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,
+ "desc" : "The function a {@link Roo.dd.DragSource} calls once to notify this drop target that the source has been dragged\nout of the target without dropping. This default implementation simply removes the CSS class specified by\noverClass (if any) from the drop element.",
+ "sig" : "function (source, e, data)\n{\n\n}",
+ "memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
"params" : [
{
- "name" : "target",
- "type" : "Roo.dd.DragDrop",
- "desc" : "The drop target",
+ "name" : "source",
+ "type" : "Roo.dd.DragSource",
+ "desc" : "The drag source that was dragged over this drop target",
"isOptional" : false
},
{
"name" : "e",
"type" : "Event",
- "desc" : "The event object",
+ "desc" : "The event",
"isOptional" : false
},
{
- "name" : "id",
- "type" : "String",
- "desc" : "The id of the dragged element",
+ "name" : "data",
+ "type" : "Object",
+ "desc" : "An object containing arbitrary data supplied by the drag source",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "afterDragOver",
+ "name" : "over",
"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,
+ "desc" : "The function a {@link Roo.dd.DragSource} calls continuously while it is being dragged over the target.\nThis method will be called on every mouse movement while the drag source is over the drop target.\nThis default implementation simply returns the dropAllowed config value.\n\nIMPORTANT : it should set this.valid to true|false",
+ "sig" : "function (source, e, data)\n{\n\n}",
+ "memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
"params" : [
{
- "name" : "target",
- "type" : "Roo.dd.DragDrop",
- "desc" : "The drop target",
+ "name" : "source",
+ "type" : "Roo.dd.DragSource",
+ "desc" : "The drag source that was dragged over this drop target",
"isOptional" : false
},
{
"name" : "e",
"type" : "Event",
- "desc" : "The event 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",
+ "desc" : "The event",
"isOptional" : false
},
{
- "name" : "id",
- "type" : "String",
- "desc" : "The id of the dropped element",
+ "name" : "data",
+ "type" : "Object",
+ "desc" : "An object containing arbitrary data supplied by the drag source",
"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" : []
- },
+ }
+ ],
+ "methods" : [
{
- "name" : "afterValidDrop",
+ "name" : "addEvents",
"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)",
+ "desc" : "Used to define events on this Observable",
+ "sig" : "(object)",
"static" : false,
- "memberOf" : "Roo.dd.DragSource",
+ "memberOf" : "Roo.util.Observable",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "target",
+ "name" : "object",
"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",
+ "desc" : "The object with the events defined",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "alignElWithMouse",
+ "name" : "addInvalidHandleClass",
"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" : "Lets you specify a css class of elements that will not initiate a drag",
+ "sig" : "(cssClass)",
"static" : false,
- "memberOf" : "Roo.dd.DD",
+ "memberOf" : "Roo.dd.DragDrop",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"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",
+ "name" : "cssClass",
+ "type" : "string",
+ "desc" : "the class of the elements you wish to ignore",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "applyConfig",
+ "name" : "addInvalidHandleId",
"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}",
+ "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,
"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",
+ "name" : "id",
+ "type" : "string",
+ "desc" : "the element id of the element you wish to ignore",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "beforeDragDrop",
+ "name" : "addInvalidHandleType",
"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)",
+ "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.DragSource",
+ "memberOf" : "Roo.dd.DragDrop",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"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",
+ "name" : "tagName",
+ "type" : "string",
+ "desc" : "the type of element to exclude",
"isOptional" : false
}
],
- "returns" : [
- {
- "name" : "",
- "type" : "Boolean",
- "desc" : "isValid True if the drag drop event is valid, else false to cancel"
- }
- ]
+ "returns" : []
},
{
- "name" : "beforeDragEnter",
+ "name" : "addListener",
"type" : "function",
- "desc" : "An empty function by default, but provided so that you can perform a custom action\nbefore the dragged item enters the drop target and optionally cancel the onDragEnter.",
- "sig" : "(target, e, id)",
+ "desc" : "Appends an event handler to this component",
+ "sig" : "(eventName, handler, scope, options)",
"static" : false,
- "memberOf" : "Roo.dd.DragSource",
+ "memberOf" : "Roo.util.Observable",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"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",
+ "name" : "eventName",
"type" : "String",
- "desc" : "The id of the dragged element",
- "isOptional" : false
- }
- ],
- "returns" : [
- {
- "name" : "",
- "type" : "Boolean",
- "desc" : "isValid True if the drag event is valid, else false to cancel"
- }
- ]
- },
- {
- "name" : "beforeDragOut",
- "type" : "function",
- "desc" : "An empty function by default, but provided so that you can perform a custom action before the dragged\nitem is dragged out of the target without dropping, and optionally cancel the onDragOut.",
- "sig" : "(target, e, id)",
- "static" : false,
- "memberOf" : "Roo.dd.DragSource",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "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",
+ "desc" : "The type of event to listen for",
"isOptional" : false
},
{
- "name" : "id",
- "type" : "String",
- "desc" : "The id of the dragged element",
- "isOptional" : false
- }
- ],
- "returns" : [
- {
- "name" : "",
- "type" : "Boolean",
- "desc" : "isValid True if the drag event is valid, else false to cancel"
- }
- ]
- },
- {
- "name" : "beforeDragOver",
- "type" : "function",
- "desc" : "An empty function by default, but provided so that you can perform a custom action\nwhile the dragged item is over the drop target and optionally cancel the onDragOver.",
- "sig" : "(target, e, id)",
- "static" : false,
- "memberOf" : "Roo.dd.DragSource",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "target",
- "type" : "Roo.dd.DragDrop",
- "desc" : "The drop target",
+ "name" : "handler",
+ "type" : "Function",
+ "desc" : "The method the event invokes",
"isOptional" : false
},
{
- "name" : "e",
- "type" : "Event",
- "desc" : "The event 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" : "id",
- "type" : "String",
- "desc" : "The id of the dragged element",
+ "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" : "",
- "type" : "Boolean",
- "desc" : "isValid True if the drag event is valid, else false to cancel"
- }
- ]
+ "returns" : []
},
{
- "name" : "beforeInvalidDrop",
+ "name" : "addToGroup",
"type" : "function",
- "desc" : "An empty function by default, but provided so that you can perform a custom action after an invalid\ndrop has occurred.",
- "sig" : "(target, e, id)",
+ "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.DragSource",
+ "memberOf" : "Roo.dd.DragDrop",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"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",
+ "name" : "sGroup",
+ "type" : "",
+ "desc" : "{string} the name of the group",
"isOptional" : false
}
],
- "returns" : [
- {
- "name" : "",
- "type" : "Boolean",
- "desc" : "isValid True if the invalid drop should proceed, else false to cancel"
- }
- ]
+ "returns" : []
},
{
- "name" : "cachePosition",
+ "name" : "applyConfig",
"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" : "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.DD",
+ "memberOf" : "Roo.dd.DragDrop",
"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
- },
- {
- "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
- }
- ],
+ "params" : [],
"returns" : []
},
{
"params" : [],
"returns" : []
},
- {
- "name" : "createFrame",
- "type" : "function",
- "desc" : "Creates the proxy element if it does not yet exist",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.dd.DDProxy",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
{
"name" : "endDrag",
"type" : "function",
}
]
},
- {
- "name" : "getDragData",
- "type" : "function",
- "desc" : "Called when a mousedown occurs in this container. Looks in {@link Roo.dd.Registry}\nfor a valid target to drag based on the mouse down. Override this method\nto provide your own lookup logic (e.g. finding a child by class name). Make sure your returned\nobject has a \"ddel\" attribute (with an HTML Element) for other functions to work.",
- "sig" : "(e)",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "e",
- "type" : "EventObject",
- "desc" : "The mouse down event",
- "isOptional" : false
- }
- ],
- "returns" : [
- {
- "name" : "",
- "type" : "Object",
- "desc" : "The dragData"
- }
- ]
- },
{
"name" : "getDragEl",
"type" : "function",
}
]
},
- {
- "name" : "getProxy",
- "type" : "function",
- "desc" : "Returns the drag source's underlying {@link Roo.dd.StatusProxy}",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.dd.DragSource",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : [
- {
- "name" : "",
- "type" : "Roo.dd.StatusProxy",
- "desc" : "proxy The StatusProxy"
- }
- ]
- },
- {
- "name" : "getRepairXY",
- "type" : "function",
- "desc" : "Called before a repair of an invalid drop to get the XY to animate to. By default returns\nthe XY of this.dragData.ddel",
- "sig" : "(e)",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "e",
- "type" : "EventObject",
- "desc" : "The mouse up event",
- "isOptional" : false
- }
- ],
- "returns" : [
- {
- "name" : "",
- "type" : "Array",
- "desc" : "The xy location (e.g. [100, 200])"
- }
- ]
- },
{
"name" : "hasListener",
"type" : "function",
}
]
},
- {
- "name" : "hideProxy",
- "type" : "function",
- "desc" : "Hides the drag source's {@link Roo.dd.StatusProxy}",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.dd.DragSource",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
{
"name" : "init",
"type" : "function",
],
"returns" : []
},
- {
- "name" : "initFrame",
- "type" : "function",
- "desc" : "Initialization for the drag frame element. Must be called in the\nconstructor of all subclasses",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.dd.DDProxy",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- },
{
"name" : "initTarget",
"type" : "function",
"params" : [],
"returns" : []
},
+ {
+ "name" : "notifyDrop",
+ "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" : "notifyEnter",
+ "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" : "notifyOut",
+ "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" : "notifyOver",
+ "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" : "on",
"type" : "function",
"params" : [],
"returns" : []
},
- {
- "name" : "onBeforeDrag",
- "type" : "function",
- "desc" : "An empty function by default, but provided so that you can perform a custom action before the initial\ndrag event begins and optionally cancel it.",
- "sig" : "(data, e)",
- "static" : false,
- "memberOf" : "Roo.dd.DragSource",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "data",
- "type" : "Object",
- "desc" : "An object containing arbitrary data to be shared with drop targets",
- "isOptional" : false
- },
- {
- "name" : "e",
- "type" : "Event",
- "desc" : "The event object",
- "isOptional" : false
- }
- ],
- "returns" : [
- {
- "name" : "",
- "type" : "Boolean",
- "desc" : "isValid True if the drag event is valid, else false to cancel"
- }
- ]
- },
{
"name" : "onDrag",
"type" : "function",
],
"returns" : []
},
- {
- "name" : "onInitDrag",
- "type" : "function",
- "desc" : "Called once drag threshold has been reached to initialize the proxy element. By default, it clones the\nthis.dragData.ddel",
- "sig" : "(x, y)",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "x",
- "type" : "Number",
- "desc" : "The x position of the click on the dragged object",
- "isOptional" : false
- },
- {
- "name" : "y",
- "type" : "Number",
- "desc" : "The y position of the click on the dragged object",
- "isOptional" : false
- }
- ],
- "returns" : [
- {
- "name" : "",
- "type" : "Boolean",
- "desc" : "true to continue the drag, false to cancel"
- }
- ]
- },
{
"name" : "onInvalidDrop",
"type" : "function",
],
"returns" : []
},
- {
- "name" : "onStartDrag",
- "type" : "function",
- "desc" : "An empty function by default, but provided so that you can perform a custom action once the initial\ndrag event has begun. The drag cannot be canceled from this function.",
- "sig" : "(x, y)",
- "static" : false,
- "memberOf" : "Roo.dd.DragSource",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "x",
- "type" : "Number",
- "desc" : "The x position of the click on the dragged object",
- "isOptional" : false
- },
- {
- "name" : "y",
- "type" : "Number",
- "desc" : "The y position of the click on the dragged object",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
{
"name" : "padding",
"type" : "function",
],
"returns" : []
},
- {
- "name" : "setDelta",
- "type" : "function",
- "desc" : "Sets the pointer offset. You can call this directly to force the\noffset to be in a particular location (e.g., pass in 0,0 to set it\nto the center of the object)",
- "sig" : "(iDeltaX, iDeltaY)",
- "static" : false,
- "memberOf" : "Roo.dd.DD",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "iDeltaX",
- "type" : "int",
- "desc" : "the distance from the left",
- "isOptional" : false
- },
- {
- "name" : "iDeltaY",
- "type" : "int",
- "desc" : "the distance from the top",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
{
"name" : "setDragElId",
"type" : "function",
],
"returns" : []
},
- {
- "name" : "setDragElPos",
- "type" : "function",
- "desc" : "Sets the drag element to the location of the mousedown or click event,\nmaintaining the cursor location relative to the location on the element\nthat was clicked. Override this if you want to place the element in a\nlocation other than where the cursor is.",
- "sig" : "(iPageX, iPageY)",
- "static" : false,
- "memberOf" : "Roo.dd.DD",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
- {
- "name" : "iPageX",
- "type" : "int",
- "desc" : "the X coordinate of the mousedown or drag event",
- "isOptional" : false
- },
- {
- "name" : "iPageY",
- "type" : "int",
- "desc" : "the Y coordinate of the mousedown or drag event",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
{
"name" : "setHandleElId",
"type" : "function",
],
"isAbstract" : false,
"isBuilderTop" : false,
- "implementations" : [],
+ "implementations" : [
+ "Roo.dd.DropZone"
+ ],
"tree_children" : [],
"tree_parent" : []
},
- "Roo.dd.DropTarget" : {
+ "Roo.dd.DropZone" : {
"props" : [
{
"name" : "ddGroup",
"type" : "String",
"desc" : "The drag drop group to handle drop events for",
- "memberOf" : ""
+ "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" : ""
+ "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" : ""
+ "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" : ""
+ "memberOf" : "Roo.dd.DropTarget",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "success",
"type" : "boolean",
"desc" : "set this after drop listener..",
- "memberOf" : ""
+ "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" : ""
+ "memberOf" : "Roo.dd.DropTarget",
+ "isOptional" : false,
+ "optvals" : []
}
],
"events" : [
"type" : "function",
"desc" : "The function a {@link Roo.dd.DragSource} calls once to notify this drop target that the dragged item has\nbeen dropped on it. This method has no default implementation and returns false, so you must provide an\nimplementation that does something to process the drop event and returns true so that the drag source's\nrepair action does not run.\n\nIMPORTANT : it should set this.success",
"sig" : "function (source, e, data)\n{\n\n}",
- "memberOf" : "",
+ "memberOf" : "Roo.dd.DropTarget",
"example" : "",
"deprecated" : "",
"since" : "",
"type" : "function",
"desc" : "The function a {@link Roo.dd.DragSource} calls once to notify this drop target that the source is now over the\ntarget. This default implementation adds the CSS class specified by overClass (if any) to the drop element\nand returns the dropAllowed config value. This method should be overridden if drop validation is required.\n\nIMPORTANT : it should set this.valid to true|false",
"sig" : "function (source, e, data)\n{\n\n}",
- "memberOf" : "",
+ "memberOf" : "Roo.dd.DropTarget",
"example" : "",
"deprecated" : "",
"since" : "",
"type" : "function",
"desc" : "The function a {@link Roo.dd.DragSource} calls once to notify this drop target that the source has been dragged\nout of the target without dropping. This default implementation simply removes the CSS class specified by\noverClass (if any) from the drop element.",
"sig" : "function (source, e, data)\n{\n\n}",
- "memberOf" : "",
+ "memberOf" : "Roo.dd.DropTarget",
"example" : "",
"deprecated" : "",
"since" : "",
"type" : "function",
"desc" : "The function a {@link Roo.dd.DragSource} calls continuously while it is being dragged over the target.\nThis method will be called on every mouse movement while the drag source is over the drop target.\nThis default implementation simply returns the dropAllowed config value.\n\nIMPORTANT : it should set this.valid to true|false",
"sig" : "function (source, e, data)\n{\n\n}",
- "memberOf" : "",
+ "memberOf" : "Roo.dd.DropTarget",
"example" : "",
"deprecated" : "",
"since" : "",
}
]
},
+ {
+ "name" : "getTargetFromEvent",
+ "type" : "function",
+ "desc" : "Returns a custom data object associated with the DOM node that is the target of the event. By default\nthis looks up the event target in the {@link Roo.dd.Registry}, although you can override this method to\nprovide your own custom lookup.",
+ "sig" : "(e)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "e",
+ "type" : "Event",
+ "desc" : "The event",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Object",
+ "desc" : "data The custom data"
+ }
+ ]
+ },
{
"name" : "hasListener",
"type" : "function",
{
"name" : "notifyDrop",
"type" : "function",
- "desc" : "",
- "sig" : "()\n{\n\n}",
+ "desc" : "The function a {@link Roo.dd.DragSource} calls once to notify this drop zone that the dragged item has\nbeen dropped on it. The drag zone will look up the target node based on the event passed in, and if there\nis a node registered for that event, it will delegate to {@link #onNodeDrop} for node-specific handling,\notherwise it will call {@link #onContainerDrop}.",
+ "sig" : "(source, e, data)",
"static" : false,
"memberOf" : "",
"isStatic" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
- "returns" : []
+ "params" : [
+ {
+ "name" : "source",
+ "type" : "Roo.dd.DragSource",
+ "desc" : "The drag source that was dragged over this drop zone",
+ "isOptional" : false
+ },
+ {
+ "name" : "e",
+ "type" : "Event",
+ "desc" : "The event",
+ "isOptional" : false
+ },
+ {
+ "name" : "data",
+ "type" : "Object",
+ "desc" : "An object containing arbitrary data supplied by the drag source",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Boolean",
+ "desc" : "True if the drop was valid, else false"
+ }
+ ]
},
{
"name" : "notifyEnter",
"type" : "function",
- "desc" : "",
- "sig" : "()\n{\n\n}",
+ "desc" : "The function a {@link Roo.dd.DragSource} calls once to notify this drop zone that the source is now over\nthe zone. The default implementation returns this.dropNotAllowed and expects that only registered drop\nnodes can process drag drop operations, so if you need the drop zone itself to be able to process drops\nyou should override this method and provide a custom implementation.",
+ "sig" : "(source, e, data)",
"static" : false,
"memberOf" : "",
"isStatic" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
- "returns" : []
+ "params" : [
+ {
+ "name" : "source",
+ "type" : "Roo.dd.DragSource",
+ "desc" : "The drag source that was dragged over this drop zone",
+ "isOptional" : false
+ },
+ {
+ "name" : "e",
+ "type" : "Event",
+ "desc" : "The event",
+ "isOptional" : false
+ },
+ {
+ "name" : "data",
+ "type" : "Object",
+ "desc" : "An object containing arbitrary data supplied by the drag source",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "String",
+ "desc" : "status The CSS class that communicates the drop status back to the source so that the\nunderlying {@link Roo.dd.StatusProxy} can be updated"
+ }
+ ]
},
{
"name" : "notifyOut",
"type" : "function",
- "desc" : "",
- "sig" : "()\n{\n\n}",
+ "desc" : "The function a {@link Roo.dd.DragSource} calls once to notify this drop zone that the source has been dragged\nout of the zone without dropping. If the drag source is currently over a registered node, the notification\nwill be delegated to {@link #onNodeOut} for node-specific handling, otherwise it will be ignored.",
+ "sig" : "(source, e, data)",
"static" : false,
"memberOf" : "",
"isStatic" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
+ "params" : [
+ {
+ "name" : "source",
+ "type" : "Roo.dd.DragSource",
+ "desc" : "The drag source that was dragged over this drop target",
+ "isOptional" : false
+ },
+ {
+ "name" : "e",
+ "type" : "Event",
+ "desc" : "The event",
+ "isOptional" : false
+ },
+ {
+ "name" : "data",
+ "type" : "Object",
+ "desc" : "An object containing arbitrary data supplied by the drag zone",
+ "isOptional" : false
+ }
+ ],
"returns" : []
},
{
"name" : "notifyOver",
"type" : "function",
- "desc" : "",
- "sig" : "()\n{\n\n}",
+ "desc" : "The function a {@link Roo.dd.DragSource} calls continuously while it is being dragged over the drop zone.\nThis method will be called on every mouse movement while the drag source is over the drop zone.\nIt will call {@link #onNodeOver} while the drag source is over a registered node, and will also automatically\ndelegate to the appropriate node-specific methods as necessary when the drag source enters and exits\nregistered nodes ({@link #onNodeEnter}, {@link #onNodeOut}). If the drag source is not currently over a\nregistered node, it will call {@link #onContainerOver}.",
+ "sig" : "(source, e, data)",
"static" : false,
"memberOf" : "",
"isStatic" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
- "returns" : []
+ "params" : [
+ {
+ "name" : "source",
+ "type" : "Roo.dd.DragSource",
+ "desc" : "The drag source that was dragged over this drop zone",
+ "isOptional" : false
+ },
+ {
+ "name" : "e",
+ "type" : "Event",
+ "desc" : "The event",
+ "isOptional" : false
+ },
+ {
+ "name" : "data",
+ "type" : "Object",
+ "desc" : "An object containing arbitrary data supplied by the drag source",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "String",
+ "desc" : "status The CSS class that communicates the drop status back to the source so that the\nunderlying {@link Roo.dd.StatusProxy} can be updated"
+ }
+ ]
},
{
"name" : "on",
"params" : [],
"returns" : []
},
+ {
+ "name" : "onContainerDrop",
+ "type" : "function",
+ "desc" : "Called internally when the DropZone determines that a {@link Roo.dd.DragSource} has been dropped on it,\nbut not on any of its registered drop nodes. The default implementation returns false, so it should be\noverridden to provide the appropriate processing of the drop event if you need the drop zone itself to\nbe able to accept drops. It should return true when valid so that the drag source's repair action does not run.",
+ "sig" : "(source, e, data)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "source",
+ "type" : "Roo.dd.DragSource",
+ "desc" : "The drag source that was dragged over this drop zone",
+ "isOptional" : false
+ },
+ {
+ "name" : "e",
+ "type" : "Event",
+ "desc" : "The event",
+ "isOptional" : false
+ },
+ {
+ "name" : "data",
+ "type" : "Object",
+ "desc" : "An object containing arbitrary data supplied by the drag source",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Boolean",
+ "desc" : "True if the drop was valid, else false"
+ }
+ ]
+ },
+ {
+ "name" : "onContainerOver",
+ "type" : "function",
+ "desc" : "Called internally while the DropZone determines that a {@link Roo.dd.DragSource} is being dragged over it,\nbut not over any of its registered drop nodes. The default implementation returns this.dropNotAllowed, so\nit should be overridden to provide the proper feedback if necessary.",
+ "sig" : "(source, e, data)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "source",
+ "type" : "Roo.dd.DragSource",
+ "desc" : "The drag source that was dragged over this drop zone",
+ "isOptional" : false
+ },
+ {
+ "name" : "e",
+ "type" : "Event",
+ "desc" : "The event",
+ "isOptional" : false
+ },
+ {
+ "name" : "data",
+ "type" : "Object",
+ "desc" : "An object containing arbitrary data supplied by the drag source",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "String",
+ "desc" : "status The CSS class that communicates the drop status back to the source so that the\nunderlying {@link Roo.dd.StatusProxy} can be updated"
+ }
+ ]
+ },
{
"name" : "onDrag",
"type" : "function",
],
"returns" : []
},
+ {
+ "name" : "onNodeDrop",
+ "type" : "function",
+ "desc" : "Called internally when the DropZone determines that a {@link Roo.dd.DragSource} has been dropped onto\nthe drop node. The default implementation returns false, so it should be overridden to provide the\nappropriate processing of the drop event and return true so that the drag source's repair action does not run.",
+ "sig" : "(nodeData, source, e, data)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "nodeData",
+ "type" : "Object",
+ "desc" : "The custom data associated with the drop node (this is the same value returned from\n{@link #getTargetFromEvent} for this node)",
+ "isOptional" : false
+ },
+ {
+ "name" : "source",
+ "type" : "Roo.dd.DragSource",
+ "desc" : "The drag source that was dragged over this drop zone",
+ "isOptional" : false
+ },
+ {
+ "name" : "e",
+ "type" : "Event",
+ "desc" : "The event",
+ "isOptional" : false
+ },
+ {
+ "name" : "data",
+ "type" : "Object",
+ "desc" : "An object containing arbitrary data supplied by the drag source",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Boolean",
+ "desc" : "True if the drop was valid, else false"
+ }
+ ]
+ },
+ {
+ "name" : "onNodeEnter",
+ "type" : "function",
+ "desc" : "Called internally when the DropZone determines that a {@link Roo.dd.DragSource} has entered a drop node\nthat it has registered. This method has no default implementation and should be overridden to provide\nnode-specific processing if necessary.",
+ "sig" : "(nodeData, source, e, data)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "nodeData",
+ "type" : "Object",
+ "desc" : "The custom data associated with the drop node (this is the same value returned from \n{@link #getTargetFromEvent} for this node)",
+ "isOptional" : false
+ },
+ {
+ "name" : "source",
+ "type" : "Roo.dd.DragSource",
+ "desc" : "The drag source that was dragged over this drop zone",
+ "isOptional" : false
+ },
+ {
+ "name" : "e",
+ "type" : "Event",
+ "desc" : "The event",
+ "isOptional" : false
+ },
+ {
+ "name" : "data",
+ "type" : "Object",
+ "desc" : "An object containing arbitrary data supplied by the drag source",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "onNodeOut",
+ "type" : "function",
+ "desc" : "Called internally when the DropZone determines that a {@link Roo.dd.DragSource} has been dragged out of\nthe drop node without dropping. This method has no default implementation and should be overridden to provide\nnode-specific processing if necessary.",
+ "sig" : "(nodeData, source, e, data)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "nodeData",
+ "type" : "Object",
+ "desc" : "The custom data associated with the drop node (this is the same value returned from\n{@link #getTargetFromEvent} for this node)",
+ "isOptional" : false
+ },
+ {
+ "name" : "source",
+ "type" : "Roo.dd.DragSource",
+ "desc" : "The drag source that was dragged over this drop zone",
+ "isOptional" : false
+ },
+ {
+ "name" : "e",
+ "type" : "Event",
+ "desc" : "The event",
+ "isOptional" : false
+ },
+ {
+ "name" : "data",
+ "type" : "Object",
+ "desc" : "An object containing arbitrary data supplied by the drag source",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "onNodeOver",
+ "type" : "function",
+ "desc" : "Called internally while the DropZone determines that a {@link Roo.dd.DragSource} is over a drop node\nthat it has registered. The default implementation returns this.dropNotAllowed, so it should be\noverridden to provide the proper feedback.",
+ "sig" : "(nodeData, source, e, data)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "nodeData",
+ "type" : "Object",
+ "desc" : "The custom data associated with the drop node (this is the same value returned from\n{@link #getTargetFromEvent} for this node)",
+ "isOptional" : false
+ },
+ {
+ "name" : "source",
+ "type" : "Roo.dd.DragSource",
+ "desc" : "The drag source that was dragged over this drop zone",
+ "isOptional" : false
+ },
+ {
+ "name" : "e",
+ "type" : "Event",
+ "desc" : "The event",
+ "isOptional" : false
+ },
+ {
+ "name" : "data",
+ "type" : "Object",
+ "desc" : "An object containing arbitrary data supplied by the drag source",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "String",
+ "desc" : "status The CSS class that communicates the drop status back to the source so that the\nunderlying {@link Roo.dd.StatusProxy} can be updated"
+ }
+ ]
+ },
{
"name" : "padding",
"type" : "function",
],
"isAbstract" : false,
"isBuilderTop" : false,
- "implementations" : [
- "Roo.dd.DropZone"
- ],
+ "implementations" : [],
"tree_children" : [],
"tree_parent" : []
},
- "Roo.dd.DropZone" : {
- "props" : [
- {
- "name" : "ddGroup",
- "type" : "String",
- "desc" : "The drag drop group to handle drop events for",
- "memberOf" : "Roo.dd.DropTarget"
- },
- {
- "name" : "dropAllowed",
- "type" : "String",
- "desc" : "The CSS class returned to the drag source when drop is allowed (defaults to \"x-dd-drop-ok\").",
- "memberOf" : "Roo.dd.DropTarget"
- },
- {
- "name" : "dropNotAllowed",
- "type" : "String",
- "desc" : "The CSS class returned to the drag source when drop is not allowed (defaults to \"x-dd-drop-nodrop\").",
- "memberOf" : "Roo.dd.DropTarget"
- },
- {
- "name" : "listeners",
- "type" : "Object",
- "desc" : "list of events and functions to call for this object, \nFor example :\n<pre><code>\n listeners : { \n 'click' : function(e) {\n ..... \n } ,\n .... \n } \n </code></pre>",
- "memberOf" : "Roo.util.Observable"
- },
- {
- "name" : "overClass",
- "type" : "String",
- "desc" : "The CSS class applied to the drop target element while the drag source is over it (defaults to \"\").",
- "memberOf" : "Roo.dd.DropTarget"
- },
- {
- "name" : "success",
- "type" : "boolean",
- "desc" : "set this after drop listener..",
- "memberOf" : "Roo.dd.DropTarget"
- },
- {
- "name" : "valid",
- "type" : "boolean|String",
- "desc" : "true/false or string (ok-add/ok-sub/ok/nodrop)\nif the drop point is valid for over/enter..",
- "memberOf" : "Roo.dd.DropTarget"
- }
- ],
- "events" : [
- {
- "name" : "drop",
- "type" : "function",
- "desc" : "The function a {@link Roo.dd.DragSource} calls once to notify this drop target that the dragged item has\nbeen dropped on it. This method has no default implementation and returns false, so you must provide an\nimplementation that does something to process the drop event and returns true so that the drag source's\nrepair action does not run.\n\nIMPORTANT : it should set this.success",
- "sig" : "function (source, e, data)\n{\n\n}",
- "memberOf" : "Roo.dd.DropTarget",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "source",
- "type" : "Roo.dd.DragSource",
- "desc" : "The drag source that was dragged over this drop target",
- "isOptional" : false
- },
- {
- "name" : "e",
- "type" : "Event",
- "desc" : "The event",
- "isOptional" : false
- },
- {
- "name" : "data",
- "type" : "Object",
- "desc" : "An object containing arbitrary data supplied by the drag source",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "enter",
- "type" : "function",
- "desc" : "The function a {@link Roo.dd.DragSource} calls once to notify this drop target that the source is now over the\ntarget. This default implementation adds the CSS class specified by overClass (if any) to the drop element\nand returns the dropAllowed config value. This method should be overridden if drop validation is required.\n\nIMPORTANT : it should set this.valid to true|false",
- "sig" : "function (source, e, data)\n{\n\n}",
- "memberOf" : "Roo.dd.DropTarget",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "source",
- "type" : "Roo.dd.DragSource",
- "desc" : "The drag source that was dragged over this drop target",
- "isOptional" : false
- },
- {
- "name" : "e",
- "type" : "Event",
- "desc" : "The event",
- "isOptional" : false
- },
- {
- "name" : "data",
- "type" : "Object",
- "desc" : "An object containing arbitrary data supplied by the drag source",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "out",
- "type" : "function",
- "desc" : "The function a {@link Roo.dd.DragSource} calls once to notify this drop target that the source has been dragged\nout of the target without dropping. This default implementation simply removes the CSS class specified by\noverClass (if any) from the drop element.",
- "sig" : "function (source, e, data)\n{\n\n}",
- "memberOf" : "Roo.dd.DropTarget",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "source",
- "type" : "Roo.dd.DragSource",
- "desc" : "The drag source that was dragged over this drop target",
- "isOptional" : false
- },
- {
- "name" : "e",
- "type" : "Event",
- "desc" : "The event",
- "isOptional" : false
- },
- {
- "name" : "data",
- "type" : "Object",
- "desc" : "An object containing arbitrary data supplied by the drag source",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "over",
- "type" : "function",
- "desc" : "The function a {@link Roo.dd.DragSource} calls continuously while it is being dragged over the target.\nThis method will be called on every mouse movement while the drag source is over the drop target.\nThis default implementation simply returns the dropAllowed config value.\n\nIMPORTANT : it should set this.valid to true|false",
- "sig" : "function (source, e, data)\n{\n\n}",
- "memberOf" : "Roo.dd.DropTarget",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "source",
- "type" : "Roo.dd.DragSource",
- "desc" : "The drag source that was dragged over this drop target",
- "isOptional" : false
- },
- {
- "name" : "e",
- "type" : "Event",
- "desc" : "The event",
- "isOptional" : false
- },
- {
- "name" : "data",
- "type" : "Object",
- "desc" : "An object containing arbitrary data supplied by the drag source",
- "isOptional" : false
- }
- ],
- "returns" : []
- }
- ],
+ "Roo.dd.Registry" : {
+ "props" : [],
+ "events" : [],
"methods" : [
{
- "name" : "addEvents",
+ "name" : "getHandle",
"type" : "function",
- "desc" : "Used to define events on this Observable",
- "sig" : "(object)",
+ "desc" : "Returns the handle registered for a DOM Node by id",
+ "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|HTMLElement",
+ "desc" : "The DOM node or id to look up",
"isOptional" : false
}
],
- "returns" : []
- },
- {
- "name" : "addInvalidHandleClass",
- "type" : "function",
- "desc" : "Lets you specify a css class of elements that will not initiate a drag",
- "sig" : "(cssClass)",
- "static" : false,
- "memberOf" : "Roo.dd.DragDrop",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
+ "returns" : [
{
- "name" : "cssClass",
- "type" : "string",
- "desc" : "the class of the elements you wish to ignore",
- "isOptional" : false
+ "name" : "",
+ "type" : "Object",
+ "desc" : "handle The custom handle data"
}
- ],
- "returns" : []
+ ]
},
{
- "name" : "addInvalidHandleId",
+ "name" : "getHandleFromEvent",
"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" : "Returns the handle that is registered for the DOM node that is the target of the event",
+ "sig" : "(e)",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "id",
- "type" : "string",
- "desc" : "the element id of the element you wish to ignore",
+ "name" : "e",
+ "type" : "Event",
+ "desc" : "The event",
"isOptional" : false
}
],
- "returns" : []
- },
- {
- "name" : "addInvalidHandleType",
- "type" : "function",
- "desc" : "Allows you to specify a tag name that should not start a drag operation\nwhen clicked. This is designed to facilitate embedding links within a\ndrag handle that do something other than start the drag.",
- "sig" : "(tagName)",
- "static" : false,
- "memberOf" : "Roo.dd.DragDrop",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
+ "returns" : [
{
- "name" : "tagName",
- "type" : "string",
- "desc" : "the type of element to exclude",
- "isOptional" : false
+ "name" : "",
+ "type" : "Object",
+ "desc" : "handle The custom handle data"
}
- ],
- "returns" : []
+ ]
},
{
- "name" : "addListener",
+ "name" : "getTarget",
"type" : "function",
- "desc" : "Appends an event handler to this component",
- "sig" : "(eventName, handler, scope, options)",
+ "desc" : "Returns a custom data object that is registered for a DOM node by id",
+ "sig" : "(id)",
"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" : "id",
+ "type" : "String|HTMLElement",
+ "desc" : "The DOM node or id to look up",
"isOptional" : false
- },
+ }
+ ],
+ "returns" : [
{
- "name" : "options",
+ "name" : "",
"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" : "data The custom data"
}
- ],
- "returns" : []
+ ]
},
{
- "name" : "addToGroup",
+ "name" : "getTargetFromEvent",
"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" : "Returns a custom data object that is registered for the DOM node that is the target of the event",
+ "sig" : "(e)",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "sGroup",
- "type" : "",
- "desc" : "{string} the name of the group",
+ "name" : "e",
+ "type" : "Event",
+ "desc" : "The event",
"isOptional" : false
}
],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Object",
+ "desc" : "data The custom data"
+ }
+ ]
},
{
- "name" : "applyConfig",
+ "name" : "register",
"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}",
+ "desc" : "Register a drag drop element",
+ "sig" : "(element, data)",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop",
+ "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",
+ "name" : "element",
+ "type" : "String|HTMLElement",
+ "desc" : "The id or DOM node to register",
"isOptional" : false
},
{
- "name" : "scope",
+ "name" : "data",
"type" : "Object",
- "desc" : "(optional) The scope (this object) for the fn",
+ "desc" : "(optional) A custom data object that will be passed between the elements that are involved\nin drag drop operations. You can populate this object with any arbitrary properties that your own code\nknows how to interpret, plus there are some specific properties known to the Registry that should be\npopulated in the data object (if applicable):\n<pre>\nValue Description<br />\n--------- ------------------------------------------<br />\nhandles Array of DOM nodes that trigger dragging<br />\n for the element being registered<br />\nisHandle True if the element passed in triggers<br />\n dragging itself, else false\n</pre>",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "clearConstraints",
+ "name" : "unregister",
"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" : "Unregister a drag drop element",
+ "sig" : "(element)",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
+ "params" : [
+ {
+ "name" : "element",
+ "type" : "String|HTMLElement",
+ "desc" : "The id or DOM node to unregister",
+ "isOptional" : false
+ }
+ ],
"returns" : []
- },
+ }
+ ],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "implementations" : [],
+ "tree_children" : [],
+ "tree_parent" : []
+ },
+ "Roo.dd.ScrollManager" : {
+ "props" : [],
+ "events" : [],
+ "methods" : [
{
- "name" : "clearTicks",
+ "name" : "refreshCache",
"type" : "function",
- "desc" : "Clears any tick interval defined for this instance",
+ "desc" : "Manually trigger a cache refresh.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"returns" : []
},
{
- "name" : "endDrag",
+ "name" : "register",
"type" : "function",
- "desc" : "Fired when we are done dragging the object",
- "sig" : "(e)",
+ "desc" : "Registers new overflow element(s) to auto scroll",
+ "sig" : "(el)",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "e",
- "type" : "Event",
- "desc" : "the mouseup event",
+ "name" : "el",
+ "type" : "String/HTMLElement/Element/Array",
+ "desc" : "The id of or the element to be scrolled or an array of either",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "fireEvent",
+ "name" : "unregister",
"type" : "function",
- "desc" : "Fires the specified event with the passed parameters (minus the event name).",
- "sig" : "(eventName, args)",
+ "desc" : "Unregisters overflow element(s) so they are no longer scrolled",
+ "sig" : "(el)",
"static" : false,
- "memberOf" : "Roo.util.Observable",
+ "memberOf" : "",
"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" : "el",
+ "type" : "String/HTMLElement/Element/Array",
+ "desc" : "The id of or the element to be removed or an array of either",
"isOptional" : false
}
],
- "returns" : [
- {
- "name" : "",
- "type" : "Boolean",
- "desc" : "returns false if any of the handlers return false otherwise it returns true"
- }
- ]
+ "returns" : []
+ }
+ ],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "implementations" : [],
+ "tree_children" : [],
+ "tree_parent" : []
+ },
+ "Roo.dd.StatusProxy" : {
+ "props" : [
+ {
+ "name" : "dropAllowed",
+ "type" : "String",
+ "desc" : "The CSS class to apply to the status element when drop is allowed (defaults to \"x-dd-drop-ok\").",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
- "name" : "getDragEl",
+ "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" : "",
+ "isOptional" : false,
+ "optvals" : []
+ }
+ ],
+ "events" : [],
+ "methods" : [
+ {
+ "name" : "getEl",
"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" : "Returns the underlying proxy {@link Roo.Layer}",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"returns" : [
{
"name" : "",
- "type" : "HTMLElement",
- "desc" : "the html element"
+ "type" : "Roo.Layer",
+ "desc" : "el"
}
]
},
{
- "name" : "getEl",
+ "name" : "getGhost",
"type" : "function",
- "desc" : "Returns a reference to the linked element",
+ "desc" : "Returns the ghost element",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"returns" : [
{
"name" : "",
- "type" : "HTMLElement",
- "desc" : "the html element"
+ "type" : "Roo.Element",
+ "desc" : "el"
}
]
},
{
- "name" : "getTargetFromEvent",
+ "name" : "hide",
"type" : "function",
- "desc" : "Returns a custom data object associated with the DOM node that is the target of the event. By default\nthis looks up the event target in the {@link Roo.dd.Registry}, although you can override this method to\nprovide your own custom lookup.",
- "sig" : "(e)",
+ "desc" : "Hides the proxy",
+ "sig" : "(clear)",
"static" : false,
"memberOf" : "",
"isStatic" : false,
"requires" : "",
"params" : [
{
- "name" : "e",
- "type" : "Event",
- "desc" : "The event",
+ "name" : "clear",
+ "type" : "Boolean",
+ "desc" : "True to reset the status and clear the ghost contents, false to preserve them",
"isOptional" : false
}
],
- "returns" : [
- {
- "name" : "",
- "type" : "Object",
- "desc" : "data The custom data"
- }
- ]
+ "returns" : []
},
{
- "name" : "hasListener",
+ "name" : "repair",
"type" : "function",
- "desc" : "Checks to see if this object has any listeners for a specified event",
- "sig" : "(eventName)",
+ "desc" : "Causes the proxy to return to its position of origin via an animation. Should be called after an\ninvalid drop operation by the item being dragged.",
+ "sig" : "(xy, callback, scope)",
"static" : false,
- "memberOf" : "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" : "xy",
+ "type" : "Array",
+ "desc" : "The XY position of the element ([x, y])",
"isOptional" : false
- }
- ],
- "returns" : [
+ },
{
- "name" : "",
- "type" : "Boolean",
- "desc" : "True if the event is being listened for, else false"
+ "name" : "callback",
+ "type" : "Function",
+ "desc" : "The function to call after the repair is complete",
+ "isOptional" : false
+ },
+ {
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "The scope in which to execute the callback",
+ "isOptional" : false
}
- ]
+ ],
+ "returns" : []
},
{
- "name" : "init",
+ "name" : "reset",
"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" : "Resets the status indicator to the default dropNotAllowed value",
+ "sig" : "(clearGhost)",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"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",
+ "name" : "clearGhost",
+ "type" : "Boolean",
+ "desc" : "True to also remove all content from the ghost, false to preserve it",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "initTarget",
+ "name" : "setStatus",
"type" : "function",
- "desc" : "Initializes Targeting functionality only... the object does not\nget a mousedown handler.",
- "sig" : "(id, sGroup, config)",
+ "desc" : "Updates the proxy's visual element to indicate the status of whether or not drop is allowed\nover the current target element.",
+ "sig" : "(cssClass)",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "id",
- "type" : "",
- "desc" : "the id of the linked element",
- "isOptional" : false
- },
- {
- "name" : "sGroup",
+ "name" : "cssClass",
"type" : "String",
- "desc" : "the group of related items",
- "isOptional" : false
- },
- {
- "name" : "config",
- "type" : "object",
- "desc" : "configuration attributes",
+ "desc" : "The css class for the new drop status indicator image",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "isLocked",
+ "name" : "show",
"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" : "Displays this proxy",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"exceptions" : "",
"requires" : "",
"params" : [],
- "returns" : [
- {
- "name" : "",
- "type" : "boolean",
- "desc" : "true if this obj or all drag/drop is locked, else\nfalse"
- }
- ]
+ "returns" : []
},
{
- "name" : "isTarget",
+ "name" : "stop",
"type" : "function",
- "desc" : "By default, all insances can be a drop target. This can be disabled by\nsetting isTarget to false.",
+ "desc" : "Stops the repair animation if it's currently running",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"returns" : []
},
{
- "name" : "isValidHandleChild",
+ "name" : "sync",
"type" : "function",
- "desc" : "Checks the tag exclusion list to see if this click should be ignored",
- "sig" : "(node)",
+ "desc" : "Force the Layer to sync its shadow and shim positions to the element",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "node",
- "type" : "HTMLElement",
- "desc" : "the HTMLElement to evaluate",
- "isOptional" : false
- }
- ],
- "returns" : [
- {
- "name" : "",
- "type" : "boolean",
- "desc" : "true if this is a valid tag type, false if not"
- }
- ]
+ "params" : [],
+ "returns" : []
},
{
- "name" : "lock",
+ "name" : "update",
"type" : "function",
- "desc" : "Lock this instance",
- "sig" : "()\n{\n\n}",
+ "desc" : "Updates the contents of the ghost element",
+ "sig" : "(html)",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
+ "params" : [
+ {
+ "name" : "html",
+ "type" : "String",
+ "desc" : "The html that will replace the current innerHTML of the ghost element",
+ "isOptional" : false
+ }
+ ],
"returns" : []
+ }
+ ],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "implementations" : [],
+ "tree_children" : [],
+ "tree_parent" : []
+ },
+ "Roo.dialog" : {
+ "props" : [],
+ "events" : [],
+ "methods" : [],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "implementations" : [],
+ "tree_children" : [],
+ "tree_parent" : []
+ },
+ "Roo.dialog.UploadCropbox" : {
+ "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" : "notifyDrop",
+ "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" : "buttons",
+ "type" : "Array",
+ "desc" : "default ['rotateLeft', 'pictureBtn', 'rotateRight']",
+ "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" : "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" : "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",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "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" : "default POST",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "minHeight",
+ "type" : "Number",
+ "desc" : "default 300",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "minWidth",
+ "type" : "Number",
+ "desc" : "default 300",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "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" : "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" : "arrange",
"type" : "function",
- "desc" : "The function a {@link Roo.dd.DragSource} calls once to notify this drop zone that the dragged item has\nbeen dropped on it. The drag zone will look up the target node based on the event passed in, and if there\nis a node registered for that event, it will delegate to {@link #onNodeDrop} for node-specific handling,\notherwise it will call {@link #onContainerDrop}.",
- "sig" : "(source, e, data)",
- "static" : false,
+ "desc" : "Fire when arrange the file data",
+ "sig" : "function (_self, formData)\n{\n\n}",
"memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
"params" : [
{
- "name" : "source",
- "type" : "Roo.dd.DragSource",
- "desc" : "The drag source that was dragged over this drop zone",
- "isOptional" : false
- },
- {
- "name" : "e",
- "type" : "Event",
- "desc" : "The event",
+ "name" : "this",
+ "type" : "Roo.dialog.UploadCropbox",
+ "desc" : "",
"isOptional" : false
},
{
- "name" : "data",
+ "name" : "formData",
"type" : "Object",
- "desc" : "An object containing arbitrary data supplied by the drag source",
+ "desc" : "",
"isOptional" : false
}
],
- "returns" : [
- {
- "name" : "",
- "type" : "Boolean",
- "desc" : "True if the drop was valid, else false"
- }
- ]
+ "returns" : []
},
{
- "name" : "notifyEnter",
+ "name" : "beforedestroy",
"type" : "function",
- "desc" : "The function a {@link Roo.dd.DragSource} calls once to notify this drop zone that the source is now over\nthe zone. The default implementation returns this.dropNotAllowed and expects that only registered drop\nnodes can process drag drop operations, so if you need the drop zone itself to be able to process drops\nyou should override this method and provide a custom implementation.",
- "sig" : "(source, e, data)",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
+ "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" : "",
- "exceptions" : "",
- "requires" : "",
"params" : [
{
- "name" : "source",
- "type" : "Roo.dd.DragSource",
- "desc" : "The drag source that was dragged over this drop zone",
- "isOptional" : false
- },
- {
- "name" : "e",
- "type" : "Event",
- "desc" : "The event",
- "isOptional" : false
- },
- {
- "name" : "data",
- "type" : "Object",
- "desc" : "An object containing arbitrary data supplied by the drag source",
+ "name" : "this",
+ "type" : "Roo.Component",
+ "desc" : "",
"isOptional" : false
}
],
- "returns" : [
- {
- "name" : "",
- "type" : "String",
- "desc" : "status The CSS class that communicates the drop status back to the source so that the\nunderlying {@link Roo.dd.StatusProxy} can be updated"
- }
- ]
+ "returns" : []
},
{
- "name" : "notifyOut",
+ "name" : "beforehide",
"type" : "function",
- "desc" : "The function a {@link Roo.dd.DragSource} calls once to notify this drop zone that the source has been dragged\nout of the zone without dropping. If the drag source is currently over a registered node, the notification\nwill be delegated to {@link #onNodeOut} for node-specific handling, otherwise it will be ignored.",
- "sig" : "(source, e, data)",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
+ "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" : "",
- "exceptions" : "",
- "requires" : "",
"params" : [
{
- "name" : "source",
- "type" : "Roo.dd.DragSource",
- "desc" : "The drag source that was dragged over this drop target",
- "isOptional" : false
- },
- {
- "name" : "e",
- "type" : "Event",
- "desc" : "The event",
- "isOptional" : false
- },
- {
- "name" : "data",
- "type" : "Object",
- "desc" : "An object containing arbitrary data supplied by the drag zone",
+ "name" : "this",
+ "type" : "Roo.Component",
+ "desc" : "",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "notifyOver",
+ "name" : "beforeloadcanvas",
"type" : "function",
- "desc" : "The function a {@link Roo.dd.DragSource} calls continuously while it is being dragged over the drop zone.\nThis method will be called on every mouse movement while the drag source is over the drop zone.\nIt will call {@link #onNodeOver} while the drag source is over a registered node, and will also automatically\ndelegate to the appropriate node-specific methods as necessary when the drag source enters and exits\nregistered nodes ({@link #onNodeEnter}, {@link #onNodeOut}). If the drag source is not currently over a\nregistered node, it will call {@link #onContainerOver}.",
- "sig" : "(source, e, data)",
- "static" : false,
+ "desc" : "Fire before load the canvas",
+ "sig" : "function (_self, src)\n{\n\n}",
"memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
"params" : [
{
- "name" : "source",
- "type" : "Roo.dd.DragSource",
- "desc" : "The drag source that was dragged over this drop zone",
- "isOptional" : false
- },
- {
- "name" : "e",
- "type" : "Event",
- "desc" : "The event",
+ "name" : "this",
+ "type" : "Roo.dialog.UploadCropbox",
+ "desc" : "",
"isOptional" : false
},
{
- "name" : "data",
- "type" : "Object",
- "desc" : "An object containing arbitrary data supplied by the drag source",
+ "name" : "src",
+ "type" : "String",
+ "desc" : "",
"isOptional" : false
}
],
- "returns" : [
- {
- "name" : "",
- "type" : "String",
- "desc" : "status The CSS class that communicates the drop status back to the source so that the\nunderlying {@link Roo.dd.StatusProxy} can be updated"
- }
- ]
+ "returns" : []
},
{
- "name" : "on",
+ "name" : "beforerender",
"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 before the component is rendered. Return false to stop the render.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
"params" : [
{
- "name" : "eventName",
- "type" : "String",
- "desc" : "The type of event to listen for",
- "isOptional" : false
- },
- {
- "name" : "handler",
- "type" : "Function",
- "desc" : "The method the event invokes",
- "isOptional" : false
- },
- {
- "name" : "scope",
- "type" : "Object",
- "desc" : "(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" : "this",
+ "type" : "Roo.Component",
+ "desc" : "",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "onAvailable",
+ "name" : "beforeselectfile",
"type" : "function",
- "desc" : "Override the onAvailable method to do what is needed after the initial\nposition was determined.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.dd.DragDrop",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
+ "desc" : "Fire before select file",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.dialog.UploadCropbox",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
"returns" : []
},
{
- "name" : "onContainerDrop",
+ "name" : "beforeshow",
"type" : "function",
- "desc" : "Called internally when the DropZone determines that a {@link Roo.dd.DragSource} has been dropped on it,\nbut not on any of its registered drop nodes. The default implementation returns false, so it should be\noverridden to provide the appropriate processing of the drop event if you need the drop zone itself to\nbe able to accept drops. It should return true when valid so that the drag source's repair action does not run.",
- "sig" : "(source, e, data)",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
+ "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" : "",
- "exceptions" : "",
- "requires" : "",
"params" : [
{
- "name" : "source",
- "type" : "Roo.dd.DragSource",
- "desc" : "The drag source that was dragged over this drop zone",
- "isOptional" : false
- },
- {
- "name" : "e",
- "type" : "Event",
- "desc" : "The event",
- "isOptional" : false
- },
- {
- "name" : "data",
- "type" : "Object",
- "desc" : "An object containing arbitrary data supplied by the drag source",
+ "name" : "this",
+ "type" : "Roo.Component",
+ "desc" : "",
"isOptional" : false
}
],
- "returns" : [
- {
- "name" : "",
- "type" : "Boolean",
- "desc" : "True if the drop was valid, else false"
- }
- ]
+ "returns" : []
},
{
- "name" : "onContainerOver",
+ "name" : "crop",
"type" : "function",
- "desc" : "Called internally while the DropZone determines that a {@link Roo.dd.DragSource} is being dragged over it,\nbut not over any of its registered drop nodes. The default implementation returns this.dropNotAllowed, so\nit should be overridden to provide the proper feedback if necessary.",
- "sig" : "(source, e, data)",
- "static" : false,
+ "desc" : "Fire after initEvent",
+ "sig" : "function (_self, data)\n{\n\n}",
"memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
"params" : [
{
- "name" : "source",
- "type" : "Roo.dd.DragSource",
- "desc" : "The drag source that was dragged over this drop zone",
- "isOptional" : false
- },
- {
- "name" : "e",
- "type" : "Event",
- "desc" : "The event",
+ "name" : "this",
+ "type" : "Roo.dialog.UploadCropbox",
+ "desc" : "",
"isOptional" : false
},
{
"name" : "data",
- "type" : "Object",
- "desc" : "An object containing arbitrary data supplied by the drag source",
+ "type" : "String",
+ "desc" : "",
"isOptional" : false
}
],
- "returns" : [
- {
- "name" : "",
- "type" : "String",
- "desc" : "status The CSS class that communicates the drop status back to the source so that the\nunderlying {@link Roo.dd.StatusProxy} can be updated"
- }
- ]
+ "returns" : []
},
{
- "name" : "onDrag",
+ "name" : "destroy",
"type" : "function",
- "desc" : "Abstract method called during the onMouseMove event while dragging an\nobject.",
- "sig" : "(e)",
- "static" : false,
- "memberOf" : "Roo.dd.DragDrop",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
+ "desc" : "Fires after the component is destroyed.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
"params" : [
{
- "name" : "e",
- "type" : "Event",
- "desc" : "the mousemove event",
+ "name" : "this",
+ "type" : "Roo.Component",
+ "desc" : "",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "onDragDrop",
+ "name" : "disable",
"type" : "function",
- "desc" : "Abstract method called when this item is dropped on another DragDrop\nobj",
- "sig" : "(e, id)",
- "static" : false,
- "memberOf" : "Roo.dd.DragDrop",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
+ "desc" : "Fires after the component is disabled.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
"params" : [
{
- "name" : "e",
- "type" : "Event",
- "desc" : "the mouseup event",
- "isOptional" : false
- },
- {
- "name" : "id",
- "type" : "String|DragDrop[]",
- "desc" : "In POINT mode, the element\nid this was dropped on. In INTERSECT mode, an array of dd items this\nwas dropped on.",
+ "name" : "this",
+ "type" : "Roo.Component",
+ "desc" : "",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "onDragEnter",
+ "name" : "download",
"type" : "function",
- "desc" : "Abstract method called when this element fist begins hovering over\nanother DragDrop obj",
- "sig" : "(e, id)",
- "static" : false,
- "memberOf" : "Roo.dd.DragDrop",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
+ "desc" : "Fire when download the image",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
"params" : [
{
- "name" : "e",
- "type" : "Event",
- "desc" : "the mousemove event",
- "isOptional" : false
- },
- {
- "name" : "id",
- "type" : "String|DragDrop[]",
- "desc" : "In POINT mode, the element\nid this is hovering over. In INTERSECT mode, an array of one or more\ndragdrop items being hovered over.",
+ "name" : "this",
+ "type" : "Roo.dialog.UploadCropbox",
+ "desc" : "",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "onDragOut",
+ "name" : "enable",
"type" : "function",
- "desc" : "Abstract method called when we are no longer hovering over an element",
- "sig" : "(e, id)",
- "static" : false,
- "memberOf" : "Roo.dd.DragDrop",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
+ "desc" : "Fires after the component is enabled.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
"params" : [
{
- "name" : "e",
- "type" : "Event",
- "desc" : "the mousemove event",
- "isOptional" : false
- },
- {
- "name" : "id",
- "type" : "String|DragDrop[]",
- "desc" : "In POINT mode, the element\nid this was hovering over. In INTERSECT mode, an array of dd items\nthat the mouse is no longer over.",
+ "name" : "this",
+ "type" : "Roo.Component",
+ "desc" : "",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "onDragOver",
+ "name" : "exception",
"type" : "function",
- "desc" : "Abstract method called when this element is hovering over another\nDragDrop obj",
- "sig" : "(e, id)",
- "static" : false,
- "memberOf" : "Roo.dd.DragDrop",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
+ "desc" : "Fire when get exception",
+ "sig" : "function (_self, xhr)\n{\n\n}",
+ "memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
"params" : [
{
- "name" : "e",
- "type" : "Event",
- "desc" : "the mousemove event",
+ "name" : "this",
+ "type" : "Roo.dialog.UploadCropbox",
+ "desc" : "",
"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.",
+ "name" : "xhr",
+ "type" : "XMLHttpRequest",
+ "desc" : "",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "onInvalidDrop",
+ "name" : "footerbuttonclick",
"type" : "function",
- "desc" : "Abstract method called when this item is dropped on an area with no\ndrop target",
- "sig" : "(e)",
- "static" : false,
- "memberOf" : "Roo.dd.DragDrop",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
+ "desc" : "Fire when footerbuttonclick",
+ "sig" : "function (_self, type)\n{\n\n}",
+ "memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
"params" : [
{
- "name" : "e",
- "type" : "Event",
- "desc" : "the mouseup event",
+ "name" : "this",
+ "type" : "Roo.dialog.UploadCropbox",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "type",
+ "type" : "String",
+ "desc" : "",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "onMouseDown",
+ "name" : "hide",
"type" : "function",
- "desc" : "Event handler that fires when a drag/drop obj gets a mousedown",
- "sig" : "(e)",
- "static" : false,
- "memberOf" : "Roo.dd.DragDrop",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
+ "desc" : "Fires after the component is hidden.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
"params" : [
{
- "name" : "e",
- "type" : "Event",
- "desc" : "the mousedown event",
+ "name" : "this",
+ "type" : "Roo.Component",
+ "desc" : "",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "onMouseUp",
+ "name" : "initial",
"type" : "function",
- "desc" : "Event handler that fires when a drag/drop obj gets a mouseup",
- "sig" : "(e)",
- "static" : false,
- "memberOf" : "Roo.dd.DragDrop",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
+ "desc" : "Fire after initEvent",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
"params" : [
{
- "name" : "e",
- "type" : "Event",
- "desc" : "the mouseup event",
+ "name" : "this",
+ "type" : "Roo.dialog.UploadCropbox",
+ "desc" : "",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "onNodeDrop",
+ "name" : "inspect",
"type" : "function",
- "desc" : "Called internally when the DropZone determines that a {@link Roo.dd.DragSource} has been dropped onto\nthe drop node. The default implementation returns false, so it should be overridden to provide the\nappropriate processing of the drop event and return true so that the drag source's repair action does not run.",
- "sig" : "(nodeData, source, e, data)",
- "static" : false,
+ "desc" : "Fire when inspect the file",
+ "sig" : "function (_self, file)\n{\n\n}",
"memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
"params" : [
{
- "name" : "nodeData",
- "type" : "Object",
- "desc" : "The custom data associated with the drop node (this is the same value returned from\n{@link #getTargetFromEvent} for this node)",
- "isOptional" : false
- },
- {
- "name" : "source",
- "type" : "Roo.dd.DragSource",
- "desc" : "The drag source that was dragged over this drop zone",
- "isOptional" : false
- },
- {
- "name" : "e",
- "type" : "Event",
- "desc" : "The event",
+ "name" : "this",
+ "type" : "Roo.dialog.UploadCropbox",
+ "desc" : "",
"isOptional" : false
},
{
- "name" : "data",
+ "name" : "file",
"type" : "Object",
- "desc" : "An object containing arbitrary data supplied by the drag source",
+ "desc" : "",
"isOptional" : false
}
],
- "returns" : [
- {
- "name" : "",
- "type" : "Boolean",
- "desc" : "True if the drop was valid, else false"
- }
- ]
+ "returns" : []
},
{
- "name" : "onNodeEnter",
+ "name" : "loadcanvas",
"type" : "function",
- "desc" : "Called internally when the DropZone determines that a {@link Roo.dd.DragSource} has entered a drop node\nthat it has registered. This method has no default implementation and should be overridden to provide\nnode-specific processing if necessary.",
- "sig" : "(nodeData, source, e, data)",
- "static" : false,
+ "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" : "nodeData",
- "type" : "Object",
- "desc" : "The custom data associated with the drop node (this is the same value returned from \n{@link #getTargetFromEvent} for this node)",
- "isOptional" : false
- },
- {
- "name" : "source",
- "type" : "Roo.dd.DragSource",
- "desc" : "The drag source that was dragged over this drop zone",
- "isOptional" : false
- },
- {
- "name" : "e",
- "type" : "Event",
- "desc" : "The event",
+ "params" : [
+ {
+ "name" : "",
+ "type" : "Roo.dialog.UploadCropbox",
+ "desc" : "",
"isOptional" : false
},
{
- "name" : "data",
+ "name" : "imgEl",
"type" : "Object",
- "desc" : "An object containing arbitrary data supplied by the drag source",
+ "desc" : "",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "onNodeOut",
+ "name" : "move",
"type" : "function",
- "desc" : "Called internally when the DropZone determines that a {@link Roo.dd.DragSource} has been dragged out of\nthe drop node without dropping. This method has no default implementation and should be overridden to provide\nnode-specific processing if necessary.",
- "sig" : "(nodeData, source, e, data)",
- "static" : false,
- "memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
+ "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" : "nodeData",
- "type" : "Object",
- "desc" : "The custom data associated with the drop node (this is the same value returned from\n{@link #getTargetFromEvent} for this node)",
- "isOptional" : false
- },
- {
- "name" : "source",
- "type" : "Roo.dd.DragSource",
- "desc" : "The drag source that was dragged over this drop zone",
+ "name" : "this",
+ "type" : "Roo.Component",
+ "desc" : "",
"isOptional" : false
},
{
- "name" : "e",
- "type" : "Event",
- "desc" : "The event",
+ "name" : "x",
+ "type" : "Number",
+ "desc" : "The new x position",
"isOptional" : false
},
{
- "name" : "data",
- "type" : "Object",
- "desc" : "An object containing arbitrary data supplied by the drag source",
+ "name" : "y",
+ "type" : "Number",
+ "desc" : "The new y position",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "onNodeOver",
+ "name" : "prepare",
"type" : "function",
- "desc" : "Called internally while the DropZone determines that a {@link Roo.dd.DragSource} is over a drop node\nthat it has registered. The default implementation returns this.dropNotAllowed, so it should be\noverridden to provide the proper feedback.",
- "sig" : "(nodeData, source, e, data)",
- "static" : false,
+ "desc" : "Fire when preparing the file data",
+ "sig" : "function (_self, file)\n{\n\n}",
"memberOf" : "",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
"params" : [
{
- "name" : "nodeData",
- "type" : "Object",
- "desc" : "The custom data associated with the drop node (this is the same value returned from\n{@link #getTargetFromEvent} for this node)",
- "isOptional" : false
- },
- {
- "name" : "source",
- "type" : "Roo.dd.DragSource",
- "desc" : "The drag source that was dragged over this drop zone",
- "isOptional" : false
- },
- {
- "name" : "e",
- "type" : "Event",
- "desc" : "The event",
+ "name" : "this",
+ "type" : "Roo.dialog.UploadCropbox",
+ "desc" : "",
"isOptional" : false
},
{
- "name" : "data",
+ "name" : "file",
"type" : "Object",
- "desc" : "An object containing arbitrary data supplied by the drag source",
+ "desc" : "",
"isOptional" : false
}
],
- "returns" : [
- {
- "name" : "",
- "type" : "String",
- "desc" : "status The CSS class that communicates the drop status back to the source so that the\nunderlying {@link Roo.dd.StatusProxy} can be updated"
- }
- ]
+ "returns" : []
},
{
- "name" : "padding",
+ "name" : "render",
"type" : "function",
- "desc" : "The padding configured for this drag and drop object for calculating\nthe drop zone intersection with this object.",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.dd.DragDrop",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
+ "desc" : "Fires after the component is rendered.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.Component",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
"returns" : []
},
{
- "name" : "purgeListeners",
+ "name" : "resize",
"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" : "Fire when resize",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
+ "params" : [
+ {
+ "name" : "this",
+ "type" : "Roo.dialog.UploadCropbox",
+ "desc" : "",
+ "isOptional" : false
+ }
+ ],
"returns" : []
},
{
- "name" : "releaseCapture",
+ "name" : "rotate",
"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" : "Fire when rotate the image",
+ "sig" : "function (_self, pos)\n{\n\n}",
+ "memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
"params" : [
{
- "name" : "o",
- "type" : "Observable",
- "desc" : "The Observable to release",
+ "name" : "this",
+ "type" : "Roo.dialog.UploadCropbox",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "pos",
+ "type" : "String",
+ "desc" : "",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "removeFromGroup",
+ "name" : "show",
"type" : "function",
- "desc" : "Remove's this instance from the supplied interaction group",
- "sig" : "(sGroup)",
- "static" : false,
- "memberOf" : "Roo.dd.DragDrop",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
+ "desc" : "Fires after the component is shown.",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "Roo.Component",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
"params" : [
{
- "name" : "sGroup",
- "type" : "string",
- "desc" : "The group to drop",
+ "name" : "this",
+ "type" : "Roo.Component",
+ "desc" : "",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "removeInvalidHandleClass",
+ "name" : "trash",
"type" : "function",
- "desc" : "Unsets an invalid css class",
- "sig" : "(cssClass)",
- "static" : false,
- "memberOf" : "Roo.dd.DragDrop",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
+ "desc" : "Fire when trash image",
+ "sig" : "function (_self)\n{\n\n}",
+ "memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
"params" : [
{
- "name" : "cssClass",
- "type" : "string",
- "desc" : "the class of the element(s) you wish to\nre-enable",
+ "name" : "this",
+ "type" : "Roo.dialog.UploadCropbox",
+ "desc" : "",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "removeInvalidHandleId",
+ "name" : "upload",
"type" : "function",
- "desc" : "Unsets an invalid handle id",
- "sig" : "(id)",
- "static" : false,
- "memberOf" : "Roo.dd.DragDrop",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
+ "desc" : "Fire when xhr upload the file",
+ "sig" : "function (_self, data)\n{\n\n}",
+ "memberOf" : "",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "exceptions" : "",
- "requires" : "",
"params" : [
{
- "name" : "id",
- "type" : "string",
- "desc" : "the id of the element to re-enable",
+ "name" : "this",
+ "type" : "Roo.dialog.UploadCropbox",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "data",
+ "type" : "Object",
+ "desc" : "",
"isOptional" : false
}
],
"returns" : []
- },
+ }
+ ],
+ "methods" : [
{
- "name" : "removeInvalidHandleType",
+ "name" : "addEvents",
"type" : "function",
- "desc" : "Unsets an excluded tag name set by addInvalidHandleType",
- "sig" : "(tagName)",
+ "desc" : "Used to define events on this Observable",
+ "sig" : "(object)",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop",
+ "memberOf" : "Roo.util.Observable",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "tagName",
- "type" : "string",
- "desc" : "the type of element to unexclude",
+ "name" : "object",
+ "type" : "Object",
+ "desc" : "The object with the events defined",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "removeListener",
+ "name" : "addListener",
"type" : "function",
- "desc" : "Removes a listener",
- "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" : "resetConstraints",
- "type" : "function",
- "desc" : "resetConstraints must be called if you manually reposition a dd element.",
- "sig" : "(maintainOffset)",
- "static" : false,
- "memberOf" : "Roo.dd.DragDrop",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [
+ },
{
- "name" : "maintainOffset",
- "type" : "boolean",
- "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" : "setDragElId",
+ "name" : "capture",
"type" : "function",
- "desc" : "Allows you to specify that an element other than the linked element\nwill be moved with the cursor during a drag",
- "sig" : "(id)",
- "static" : false,
- "memberOf" : "Roo.dd.DragDrop",
- "isStatic" : false,
+ "desc" : "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" : "id",
- "type" : "",
- "desc" : "{string} the id of the element that will be used to initiate the drag",
+ "name" : "o",
+ "type" : "Observable",
+ "desc" : "The Observable to capture",
+ "isOptional" : false
+ },
+ {
+ "name" : "fn",
+ "type" : "Function",
+ "desc" : "The function to call",
+ "isOptional" : false
+ },
+ {
+ "name" : "scope",
+ "type" : "Object",
+ "desc" : "(optional) The scope (this object) for the fn",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "setHandleElId",
+ "name" : "destroy",
"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" : "Destroys this component by purging any event listeners, removing the component's element from the DOM,\nremoving the component from its {@link Roo.Container} (if applicable) and unregistering it from {@link Roo.ComponentMgr}.",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop",
+ "memberOf" : "Roo.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [
- {
- "name" : "id",
- "type" : "",
- "desc" : "{string} the id of the element that will be used to\ninitiate the drag.",
- "isOptional" : false
- }
- ],
+ "params" : [],
"returns" : []
},
{
- "name" : "setInitPosition",
+ "name" : "disable",
"type" : "function",
- "desc" : "Stores the initial placement of the linked element.",
- "sig" : "(diffX, diffY)",
+ "desc" : "Disable this component.",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop",
+ "memberOf" : "Roo.Component",
"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" : "Roo.Component",
+ "desc" : "this"
}
- ],
- "returns" : []
+ ]
},
{
- "name" : "setOuterHandleElId",
+ "name" : "enable",
"type" : "function",
- "desc" : "Allows you to set an element outside of the linked element as a drag\nhandle",
- "sig" : "(id)",
+ "desc" : "Enable this component.",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop",
+ "memberOf" : "Roo.Component",
"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" : "Roo.Component",
+ "desc" : "this"
}
- ],
- "returns" : []
+ ]
},
{
- "name" : "setPadding",
+ "name" : "fireEvent",
"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" : "Fires the specified event with the passed parameters (minus the event name).",
+ "sig" : "(eventName, args)",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop",
+ "memberOf" : "Roo.util.Observable",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"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",
+ "name" : "eventName",
+ "type" : "String",
+ "desc" : "",
"isOptional" : false
},
{
- "name" : "iLeft",
- "type" : "int",
- "desc" : "Left pad",
+ "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" : "setXConstraint",
+ "name" : "focus",
"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" : "Try to focus this component.",
+ "sig" : "(selectText)",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop",
+ "memberOf" : "Roo.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "iLeft",
- "type" : "int",
- "desc" : "the number of pixels the element can move to the left",
- "isOptional" : false
- },
- {
- "name" : "iRight",
- "type" : "int",
- "desc" : "the number of pixels the element can move to the\nright",
- "isOptional" : false
- },
- {
- "name" : "iTickSize",
- "type" : "int",
- "desc" : "optional parameter for specifying that the\nelement\nshould move iTickSize pixels at a time.",
+ "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" : "setYConstraint",
+ "name" : "getBox",
"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" : "Gets the current box measurements of the component's underlying element.",
+ "sig" : "(local)",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop",
+ "memberOf" : "Roo.BoxComponent",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "iUp",
- "type" : "int",
- "desc" : "the number of pixels the element can move up",
- "isOptional" : false
- },
- {
- "name" : "iDown",
- "type" : "int",
- "desc" : "the number of pixels the element can move down",
- "isOptional" : false
- },
- {
- "name" : "iTickSize",
- "type" : "int",
- "desc" : "optional parameter for specifying that the\nelement should move iTickSize pixels at a time.",
+ "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" : "startDrag",
+ "name" : "getEl",
"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" : "Returns the underlying {@link Roo.Element}.",
+ "sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop",
+ "memberOf" : "Roo.Component",
"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" : "Roo.Element",
+ "desc" : "The element"
}
- ],
- "returns" : []
+ ]
},
{
- "name" : "toString",
+ "name" : "getId",
"type" : "function",
- "desc" : "toString method",
+ "desc" : "Returns the id of this component.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop",
+ "memberOf" : "Roo.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"returns" : [
{
"name" : "",
- "type" : "string",
- "desc" : "string representation of the dd obj"
+ "type" : "String",
+ "desc" : ""
}
]
},
{
- "name" : "un",
+ "name" : "getPosition",
"type" : "function",
- "desc" : "Removes a listener (shorthand for removeListener)",
- "sig" : "(eventName, handler, scope)",
+ "desc" : "Gets the current XY position of the component's underlying element.",
+ "sig" : "(local)",
"static" : false,
- "memberOf" : "Roo.util.Observable",
+ "memberOf" : "Roo.BoxComponent",
"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" : "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" : "unlock",
+ "name" : "getSize",
"type" : "function",
- "desc" : "Unlock this instace",
+ "desc" : "Gets the current size of the component's underlying element.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "Roo.dd.DragDrop",
+ "memberOf" : "Roo.BoxComponent",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"exceptions" : "",
"requires" : "",
"params" : [],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Object",
+ "desc" : "An object containing the element's size {width: (element width), height: (element height)}"
+ }
+ ]
},
{
- "name" : "unreg",
- "type" : "function",
- "desc" : "Remove all drag and drop hooks for this element",
- "sig" : "()\n{\n\n}",
- "static" : false,
- "memberOf" : "Roo.dd.DragDrop",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "exceptions" : "",
- "requires" : "",
- "params" : [],
- "returns" : []
- }
- ],
- "isAbstract" : false,
- "isBuilderTop" : false,
- "implementations" : [],
- "tree_children" : [],
- "tree_parent" : []
- },
- "Roo.dd.Registry" : {
- "props" : [],
- "events" : [],
- "methods" : [
- {
- "name" : "getHandle",
+ "name" : "hasListener",
"type" : "function",
- "desc" : "Returns the handle registered for a DOM Node by id",
- "sig" : "(id)",
+ "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" : "id",
- "type" : "String|HTMLElement",
- "desc" : "The DOM node or id to look up",
+ "name" : "eventName",
+ "type" : "String",
+ "desc" : "The name of the event to check for",
"isOptional" : false
}
],
"returns" : [
{
"name" : "",
- "type" : "Object",
- "desc" : "handle The custom handle data"
+ "type" : "Boolean",
+ "desc" : "True if the event is being listened for, else false"
}
]
},
{
- "name" : "getHandleFromEvent",
+ "name" : "hide",
"type" : "function",
- "desc" : "Returns the handle that is registered for the DOM node that is the target of the event",
- "sig" : "(e)",
+ "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" : "e",
- "type" : "Event",
- "desc" : "The event",
- "isOptional" : false
- }
- ],
+ "params" : [],
"returns" : [
{
"name" : "",
- "type" : "Object",
- "desc" : "handle The custom handle data"
+ "type" : "Roo.Component",
+ "desc" : "this"
}
]
},
{
- "name" : "getTarget",
+ "name" : "isVisible",
"type" : "function",
- "desc" : "Returns a custom data object that is registered for a DOM node by id",
- "sig" : "(id)",
+ "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" : "id",
- "type" : "String|HTMLElement",
- "desc" : "The DOM node or id to look up",
- "isOptional" : false
- }
- ],
- "returns" : [
- {
- "name" : "",
- "type" : "Object",
- "desc" : "data The custom data"
- }
- ]
+ "params" : [],
+ "returns" : []
},
{
- "name" : "getTargetFromEvent",
+ "name" : "on",
"type" : "function",
- "desc" : "Returns a custom data object that is registered for the DOM node that is the target of the event",
- "sig" : "(e)",
+ "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" : "e",
- "type" : "Event",
- "desc" : "The event",
+ "name" : "eventName",
+ "type" : "String",
+ "desc" : "The type of event to listen for",
"isOptional" : false
- }
- ],
- "returns" : [
+ },
{
- "name" : "",
+ "name" : "handler",
+ "type" : "Function",
+ "desc" : "The method the event invokes",
+ "isOptional" : false
+ },
+ {
+ "name" : "scope",
"type" : "Object",
- "desc" : "data The custom data"
+ "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
+ "isOptional" : false
+ },
+ {
+ "name" : "options",
+ "type" : "Object",
+ "desc" : "(optional)",
+ "isOptional" : false
}
- ]
+ ],
+ "returns" : []
},
{
- "name" : "register",
+ "name" : "onPosition",
"type" : "function",
- "desc" : "Register a drag drop element",
- "sig" : "(element, data)",
+ "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" : "element",
- "type" : "String|HTMLElement",
- "desc" : "The id or DOM node to register",
+ "name" : "x",
+ "type" : "Number",
+ "desc" : "The new x position",
"isOptional" : false
},
{
- "name" : "data",
- "type" : "Object",
- "desc" : "(optional) A custom data object that will be passed between the elements that are involved\nin drag drop operations. You can populate this object with any arbitrary properties that your own code\nknows how to interpret, plus there are some specific properties known to the Registry that should be\npopulated in the data object (if applicable):\n<pre>\nValue Description<br />\n--------- ------------------------------------------<br />\nhandles Array of DOM nodes that trigger dragging<br />\n for the element being registered<br />\nisHandle True if the element passed in triggers<br />\n dragging itself, else false\n</pre>",
+ "name" : "y",
+ "type" : "Number",
+ "desc" : "The new y position",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "unregister",
+ "name" : "onResize",
"type" : "function",
- "desc" : "Unregister a drag drop element",
- "sig" : "(element)",
+ "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" : "element",
- "type" : "String|HTMLElement",
- "desc" : "The id or DOM node to unregister",
+ "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" : []
- }
- ],
- "isAbstract" : false,
- "isBuilderTop" : false,
- "implementations" : [],
- "tree_children" : [],
- "tree_parent" : []
- },
- "Roo.dd.ScrollManager" : {
- "props" : [],
- "events" : [],
- "methods" : [
+ },
{
- "name" : "refreshCache",
+ "name" : "purgeListeners",
"type" : "function",
- "desc" : "Manually trigger a cache refresh.",
+ "desc" : "Removes all listeners for this object",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.util.Observable",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"returns" : []
},
{
- "name" : "register",
+ "name" : "releaseCapture",
"type" : "function",
- "desc" : "Registers new overflow element(s) to auto scroll",
- "sig" : "(el)",
- "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" : "el",
- "type" : "String/HTMLElement/Element/Array",
- "desc" : "The id of or the element to be scrolled or an array of either",
+ "name" : "o",
+ "type" : "Observable",
+ "desc" : "The Observable to release",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "unregister",
+ "name" : "removeListener",
"type" : "function",
- "desc" : "Unregisters overflow element(s) so they are no longer scrolled",
- "sig" : "(el)",
+ "desc" : "Removes a listener",
+ "sig" : "(eventName, handler, scope)",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.util.Observable",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"requires" : "",
"params" : [
{
- "name" : "el",
- "type" : "String/HTMLElement/Element/Array",
- "desc" : "The id of or the element to be removed or an array of either",
+ "name" : "eventName",
+ "type" : "String",
+ "desc" : "The type of event to listen for",
+ "isOptional" : false
+ },
+ {
+ "name" : "handler",
+ "type" : "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" : [],
- "tree_parent" : []
- },
- "Roo.dd.StatusProxy" : {
- "props" : [
- {
- "name" : "dropAllowed",
- "type" : "String",
- "desc" : "The CSS class to apply to the status element when drop is allowed (defaults to \"x-dd-drop-ok\").",
- "memberOf" : ""
},
{
- "name" : "dropNotAllowed",
- "type" : "String",
- "desc" : "The CSS class to apply to the status element when drop is not allowed (defaults to \"x-dd-drop-nodrop\").",
- "memberOf" : ""
- }
- ],
- "events" : [],
- "methods" : [
- {
- "name" : "getEl",
+ "name" : "render",
"type" : "function",
- "desc" : "Returns the underlying proxy {@link Roo.Layer}",
- "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" : "Roo.Layer",
- "desc" : "el"
+ "name" : "container",
+ "type" : "String/HTMLElement/Element",
+ "desc" : "(optional) The element this component should be rendered into. If it is being applied to existing markup, this should be left off.",
+ "isOptional" : false
}
- ]
+ ],
+ "returns" : []
},
{
- "name" : "getGhost",
+ "name" : "setDisabled",
"type" : "function",
- "desc" : "Returns the ghost element",
- "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" : "Roo.Element",
- "desc" : "el"
+ "name" : "disabled",
+ "type" : "Boolean",
+ "desc" : "",
+ "isOptional" : false
}
- ]
+ ],
+ "returns" : []
},
{
- "name" : "hide",
+ "name" : "setPagePosition",
"type" : "function",
- "desc" : "Hides the proxy",
- "sig" : "(clear)",
+ "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,
"requires" : "",
"params" : [
{
- "name" : "clear",
- "type" : "Boolean",
- "desc" : "True to reset the status and clear the ghost contents, false to preserve them",
+ "name" : "x",
+ "type" : "Number",
+ "desc" : "The new x position",
+ "isOptional" : false
+ },
+ {
+ "name" : "y",
+ "type" : "Number",
+ "desc" : "The new y position",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "repair",
+ "name" : "setPosition",
"type" : "function",
- "desc" : "Causes the proxy to return to its position of origin via an animation. Should be called after an\ninvalid drop operation by the item being dragged.",
- "sig" : "(xy, callback, scope)",
+ "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" : "xy",
- "type" : "Array",
- "desc" : "The XY position of the element ([x, y])",
- "isOptional" : false
- },
- {
- "name" : "callback",
- "type" : "Function",
- "desc" : "The function to call after the repair is complete",
+ "name" : "left",
+ "type" : "Number",
+ "desc" : "The new left",
"isOptional" : false
},
{
- "name" : "scope",
- "type" : "Object",
- "desc" : "The scope in which to execute the callback",
+ "name" : "top",
+ "type" : "Number",
+ "desc" : "The new top",
"isOptional" : false
}
],
"returns" : []
},
{
- "name" : "reset",
+ "name" : "setSize",
"type" : "function",
- "desc" : "Resets the status indicator to the default dropNotAllowed value",
- "sig" : "(clearGhost)",
+ "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,
"requires" : "",
"params" : [
{
- "name" : "clearGhost",
- "type" : "Boolean",
- "desc" : "True to also remove all content from the ghost, false to preserve it",
+ "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" : "setStatus",
+ "name" : "setVisible",
"type" : "function",
- "desc" : "Updates the proxy's visual element to indicate the status of whether or not drop is allowed\nover the current target element.",
- "sig" : "(cssClass)",
+ "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" : "cssClass",
- "type" : "String",
- "desc" : "The css class for the new drop status indicator image",
+ "name" : "visible",
+ "type" : "Boolean",
+ "desc" : "True to show, false to hide",
"isOptional" : false
}
],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.Component",
+ "desc" : "this"
+ }
+ ]
},
{
"name" : "show",
"type" : "function",
- "desc" : "Displays this proxy",
+ "desc" : "Show this component.",
"sig" : "()\n{\n\n}",
"static" : false,
- "memberOf" : "",
+ "memberOf" : "Roo.Component",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"exceptions" : "",
"requires" : "",
"params" : [],
- "returns" : []
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "Roo.Component",
+ "desc" : "this"
+ }
+ ]
},
{
- "name" : "stop",
+ "name" : "syncSize",
"type" : "function",
- "desc" : "Stops the repair animation if it's currently running",
+ "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" : "",
+ "memberOf" : "Roo.BoxComponent",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"returns" : []
},
{
- "name" : "sync",
+ "name" : "un",
"type" : "function",
- "desc" : "Force the Layer to sync its shadow and shim positions to the element",
- "sig" : "()\n{\n\n}",
+ "desc" : "Removes a listener (shorthand for removeListener)",
+ "sig" : "(eventName, handler, scope)",
"static" : false,
- "memberOf" : "",
+ "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" : "update",
+ "name" : "updateBox",
"type" : "function",
- "desc" : "Updates the contents of the ghost element",
- "sig" : "(html)",
+ "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" : "html",
- "type" : "String",
- "desc" : "The html that will replace the current innerHTML of the ghost element",
+ "name" : "box",
+ "type" : "Object",
+ "desc" : "An object in the format {x, y, width, height}",
"isOptional" : false
}
],
"name" : "baseParams",
"type" : "Object",
"desc" : "Parameters to pass with all requests. e.g. baseParams: {id: '123', foo: 'bar'}.",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "errorMask",
"type" : "Boolean",
- "desc" : "e) default false",
- "memberOf" : ""
+ "desc" : "Should the form be masked (and the active element highlighted on error - default false",
+ "memberOf" : "",
+ "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" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "fileUpload",
"type" : "Boolean",
"desc" : "Set to true if this form is a file upload.",
- "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" : "maskOffset",
"type" : "Number",
- "desc" : "Default 100",
- "memberOf" : ""
+ "desc" : "space around form element to mask if there is an error Default 100",
+ "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" : ""
+ "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" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "timeout",
"type" : "Number",
"desc" : "Timeout for form actions in seconds (default is 30 seconds).",
- "memberOf" : ""
+ "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" : ""
+ "memberOf" : "",
+ "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" : []
}
],
"events" : [
{
"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}",
+ "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" : "",
"isStatic" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
+ "params" : [
+ {
+ "name" : "with_readonly",
+ "type" : "Boolean",
+ "desc" : "return readonly field data.",
+ "isOptional" : false
+ }
+ ],
"returns" : [
{
"name" : "",
{
"name" : "asString",
"type" : "Boolean",
- "desc" : "",
+ "desc" : "(def)",
"isOptional" : false
}
],
"name" : "actionMode",
"type" : "String",
"desc" : "which property holds the 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" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "boxLabel",
"type" : "String",
"desc" : "The text that appears beside the checkbox",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "checked",
"type" : "Boolean",
"desc" : "True if the the checkbox should render already checked (defaults to false)",
- "memberOf" : ""
+ "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 checkbox (defaults to \"x-form-field\")",
- "memberOf" : ""
+ "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 checkbox receives focus (defaults to undefined)",
- "memberOf" : ""
+ "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" : "inputValue",
"type" : "String",
"desc" : "The value that should go into the generated input element's value attribute",
- "memberOf" : ""
+ "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" : "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" : "labelSeparator",
+ "type" : "String",
+ "desc" : "the ':' after a field label (default :) = set it to empty string to hide the field label.",
+ "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"
+ "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" : "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" : "value",
"type" : "Mixed",
"desc" : "A value to initialize this field with.",
- "memberOf" : "Roo.form.Field"
+ "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" : ""
+ "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" : "actionMode",
"type" : "String",
"desc" : "which property holds the 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" : ""
+ "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"
+ "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"
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "hideLabels",
"type" : "Boolean",
"desc" : "True to suppress the display of field labels in this layout (defaults to false)",
- "memberOf" : "Roo.form.Layout"
+ "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" : "labelAlign",
"type" : "String",
- "desc" : "Valid values are \"left,\" \"top\" and \"right\" (defaults to \"left\")",
- "memberOf" : "Roo.form.Layout"
+ "desc" : "t)\nValid values are \"left,\" \"top\" and \"right\" (defaults to \"left",
+ "memberOf" : "Roo.form.Layout",
+ "isOptional" : false,
+ "optvals" : [
+ "left",
+ "top",
+ "right"
+ ]
},
{
"name" : "labelSeparator",
"type" : "String",
"desc" : "The separator to use after field labels (defaults to ':')",
- "memberOf" : "Roo.form.Layout"
+ "memberOf" : "Roo.form.Layout",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "labelWidth",
"type" : "Number",
"desc" : "Fixed width in pixels of all field labels (defaults to undefined)",
- "memberOf" : "Roo.form.Layout"
+ "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"
+ "memberOf" : "Roo.util.Observable",
+ "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"
+ "memberOf" : "Roo.form.Layout",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "width",
"type" : "Number/String",
"desc" : "The fixed width of the column in pixels or CSS value (defaults to \"auto\")",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
}
],
"events" : [
"isAbstract" : false,
"isBuilderTop" : false,
"implementations" : [],
- "tree_children" : [],
+ "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" : {
"name" : "actionMode",
"type" : "String",
"desc" : "which property holds the 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" : ""
+ "memberOf" : "",
+ "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" : ""
+ "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" : ""
+ "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"
+ "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" : ""
+ "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" : "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.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" : ""
+ "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" : "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" : ""
+ "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" : "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" : ""
+ "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"
+ "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" : "labelSeparator",
+ "type" : "String",
+ "desc" : "the ':' after a field label (default :) = set it to empty string to hide the field label.",
+ "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" : ""
+ "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" : ""
+ "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.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" : ""
+ "memberOf" : "",
+ "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" : ""
+ "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" : ""
+ "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" : "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" : "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" : "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" : ""
+ "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" : "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" : ""
+ "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" : "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" : "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" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "tpl",
"type" : "String/Roo.Template",
"desc" : "The template to use to render the output",
- "memberOf" : ""
+ "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" : ""
+ "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' and triggerClass will be <b>appended</b> if specified (defaults to 'x-form-arrow-trigger'\nwhich displays a downward arrow icon).",
- "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" : "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" : ""
+ "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" : "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" : []
}
],
"events" : [
"name" : "actionMode",
"type" : "String",
"desc" : "which property holds the 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" : "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" : "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"
+ "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" : "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" : "combo",
"type" : "Roo.form.ComboBox",
- "desc" : "[required] The combo box that is wrapped",
- "memberOf" : ""
+ "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"
+ "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" : "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" : "grow",
"type" : "Boolean",
"desc" : "True if this field should automatically grow and shrink to its content",
- "memberOf" : "Roo.form.TextField"
+ "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"
+ "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"
+ "memberOf" : "Roo.form.TextField",
+ "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" : ""
+ "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",
"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" : "labelSeparator",
+ "type" : "String",
+ "desc" : "the ':' after a field label (default :) = set it to empty string to hide the field label.",
+ "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" : "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" : "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" : "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" : ""
+ "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"
+ "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" : "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" : "Roo.form.TextField",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "seperator",
"type" : "String",
"desc" : "The value seperator normally ','",
- "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" : "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" : "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"
+ "memberOf" : "Roo.form.TextField",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "width",
"type" : "Number",
"desc" : "The width of the box that displays the selected element",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
}
],
"events" : [
"name" : "actionMode",
"type" : "String",
"desc" : "which property holds the 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" : "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" : "listeners",
"type" : "Object",
"desc" : "list of events and functions to call for 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" : "Roo.BoxComponent"
+ "memberOf" : "Roo.BoxComponent",
+ "isOptional" : false,
+ "optvals" : []
}
],
"events" : [
"name" : "actionMode",
"type" : "String",
"desc" : "which property holds the 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"
+ "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"
+ "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"
+ "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"
+ "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"
+ "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"
+ "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"
+ "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"
+ "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"
+ "memberOf" : "Roo.form.ComboBox",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "grow",
"type" : "Boolean",
"desc" : "",
- "memberOf" : "Roo.form.ComboBox"
+ "memberOf" : "Roo.form.ComboBox",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "growMax",
"type" : "Number",
"desc" : "",
- "memberOf" : "Roo.form.ComboBox"
+ "memberOf" : "Roo.form.ComboBox",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "growMin",
"type" : "Number",
"desc" : "",
- "memberOf" : "Roo.form.ComboBox"
+ "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"
+ "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"
+ "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"
+ "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" : "labelSeparator",
+ "type" : "String",
+ "desc" : "the ':' after a field label (default :) = set it to empty string to hide the field label.",
+ "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"
+ "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"
+ "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"
+ "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"
+ "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"
+ "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"
+ "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"
+ "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"
+ "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"
+ "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 field's HTML name attribute.",
- "memberOf" : "Roo.form.Field"
+ "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"
+ "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"
+ "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"
+ "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"
+ "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"
+ "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"
+ "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"
+ "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"
+ "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"
+ "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"
+ "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"
+ "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"
+ "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"
+ "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"
+ "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"
+ "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"
+ "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"
+ "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" : "width (optional) size of component",
- "memberOf" : "Roo.BoxComponent"
+ "memberOf" : "Roo.BoxComponent",
+ "isOptional" : false,
+ "optvals" : []
}
],
"events" : [
"name" : "actionMode",
"type" : "String",
"desc" : "which property holds the 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"
+ "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"
+ "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"
+ "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"
+ "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"
+ "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"
+ "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"
+ "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"
+ "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"
+ "memberOf" : "Roo.form.ComboBox",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "grow",
"type" : "Boolean",
"desc" : "",
- "memberOf" : "Roo.form.ComboBox"
+ "memberOf" : "Roo.form.ComboBox",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "growMax",
"type" : "Number",
"desc" : "",
- "memberOf" : "Roo.form.ComboBox"
+ "memberOf" : "Roo.form.ComboBox",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "growMin",
"type" : "Number",
"desc" : "",
- "memberOf" : "Roo.form.ComboBox"
+ "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"
+ "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"
+ "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"
+ "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" : "labelSeparator",
+ "type" : "String",
+ "desc" : "the ':' after a field label (default :) = set it to empty string to hide the field label.",
+ "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"
+ "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"
+ "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"
+ "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"
+ "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"
+ "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"
+ "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"
+ "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"
+ "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"
+ "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 field's HTML name attribute.",
- "memberOf" : "Roo.form.Field"
+ "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"
+ "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"
+ "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"
+ "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"
+ "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"
+ "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"
+ "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"
+ "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"
+ "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"
+ "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"
+ "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"
+ "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"
+ "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"
+ "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"
+ "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"
+ "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"
+ "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"
+ "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" : "width (optional) size of component",
- "memberOf" : "Roo.BoxComponent"
+ "memberOf" : "Roo.BoxComponent",
+ "isOptional" : false,
+ "optvals" : []
}
],
"events" : [
"name" : "actionMode",
"type" : "String",
"desc" : "which property holds the 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" : "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" : "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" : "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" : ""
+ "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"
+ "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"
+ "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" : ""
+ "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" : ""
+ "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 'Disabled')",
- "memberOf" : ""
+ "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"
+ "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" : ""
+ "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" : "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 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" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "labelSeparator",
+ "type" : "String",
+ "desc" : "the ':' after a field label (default :) = set it to empty string to hide the field label.",
+ "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" : "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" : "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" : ""
+ "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" : ""
+ "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" : "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" : ""
+ "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" : ""
+ "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"
+ "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" : "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" : "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" : "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" : "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" : ""
+ "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 (false)",
- "memberOf" : ""
+ "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"
+ "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" : "actionMode",
"type" : "String",
"desc" : "which property holds the 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" : ""
+ "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 checkbox (defaults to \"x-form-field\")",
- "memberOf" : ""
+ "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 checkbox receives focus (defaults to undefined)",
- "memberOf" : ""
+ "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" : "labelSeparator",
+ "type" : "String",
+ "desc" : "the ':' after a field label (default :) = set it to empty string to hide the field label.",
+ "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"
+ "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" : "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" : "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" : "width (optional) size of component",
- "memberOf" : "Roo.BoxComponent"
+ "memberOf" : "Roo.BoxComponent",
+ "isOptional" : false,
+ "optvals" : []
}
],
"events" : [
"name" : "actionMode",
"type" : "String",
"desc" : "which property holds the 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" : ""
+ "memberOf" : "",
+ "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" : "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 checkbox (defaults to \"x-form-field\")",
- "memberOf" : ""
+ "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 checkbox receives focus (defaults to undefined)",
- "memberOf" : ""
+ "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" : "labelSeparator",
+ "type" : "String",
+ "desc" : "the ':' after a field label (default :) = set it to empty string to hide the field label.",
+ "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"
+ "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" : "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" : "value",
"type" : "Mixed",
"desc" : "A value to initialize this field with.",
- "memberOf" : "Roo.form.Field"
+ "memberOf" : "Roo.form.Field",
+ "isOptional" : false,
+ "optvals" : []
},
{
"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" : [
"name" : "actionMode",
"type" : "String",
"desc" : "which property holds the 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" : "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" : "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"
+ "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"
+ "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"
+ "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"
+ "memberOf" : "Roo.form.TextField",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "fck",
"type" : "Object",
"desc" : "BasePath",
- "memberOf" : ""
+ "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" : "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"
+ "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"
+ "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" : "labelSeparator",
+ "type" : "String",
+ "desc" : "the ':' after a field label (default :) = set it to empty string to hide the field label.",
+ "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" : "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" : "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" : "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"
+ "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"
+ "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" : "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" : "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"
+ "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"
+ "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" : "actionMode",
"type" : "String",
"desc" : "which property holds the 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: \"text\", size: \"20\", autocomplete: \"off\"})",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "cls",
"type" : "String",
"desc" : "A CSS class to apply to the field's underlying element.",
- "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" : "disabled",
"type" : "Boolean",
"desc" : "True to disable the field (defaults to false).",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "fieldClass",
"type" : "String",
"desc" : "The default CSS class for the field (defaults to \"x-form-field\")",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "fieldLabel",
"type" : "String",
"desc" : "Label to use when rendering a form.",
- "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" : "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" : ""
+ "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" : ""
+ "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" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "labelSeparator",
+ "type" : "String",
+ "desc" : "the ':' after a field label (default :) = set it to empty string to hide the field label.",
+ "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" : ""
+ "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" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "name",
"type" : "String",
"desc" : "The field's HTML name attribute.",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "qtip",
"type" : "String",
"desc" : "Mouse over tip",
- "memberOf" : ""
+ "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" : ""
+ "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" : ""
+ "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" : "value",
"type" : "Mixed",
"desc" : "A value to initialize this field with.",
- "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" : [
"name" : "actionMode",
"type" : "String",
"desc" : "which property holds the 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 fieldset (defaults to {tag: 'fieldset', cn: {tag:'legend'}})",
- "memberOf" : ""
+ "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"
+ "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"
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "hideLabels",
"type" : "Boolean",
"desc" : "True to suppress the display of field labels in this layout (defaults to false)",
- "memberOf" : "Roo.form.Layout"
+ "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" : "labelAlign",
"type" : "String",
- "desc" : "Valid values are \"left,\" \"top\" and \"right\" (defaults to \"left\")",
- "memberOf" : "Roo.form.Layout"
+ "desc" : "t)\nValid values are \"left,\" \"top\" and \"right\" (defaults to \"left",
+ "memberOf" : "Roo.form.Layout",
+ "isOptional" : false,
+ "optvals" : [
+ "left",
+ "top",
+ "right"
+ ]
},
{
"name" : "labelSeparator",
"type" : "String",
"desc" : "The separator to use after field labels (defaults to ':')",
- "memberOf" : "Roo.form.Layout"
+ "memberOf" : "Roo.form.Layout",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "labelWidth",
"type" : "Number",
"desc" : "Fixed width in pixels of all field labels (defaults to undefined)",
- "memberOf" : "Roo.form.Layout"
+ "memberOf" : "Roo.form.Layout",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "legend",
"type" : "String",
"desc" : "The text to display as the legend for the FieldSet (defaults to '')",
- "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/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"
+ "memberOf" : "Roo.form.Layout",
+ "isOptional" : false,
+ "optvals" : []
}
],
"events" : [
"name" : "baseParams",
"type" : "Object",
"desc" : "Parameters to pass with all requests. e.g. baseParams: {id: '123', foo: 'bar'}.",
- "memberOf" : "Roo.form.BasicForm"
+ "memberOf" : "Roo.form.BasicForm",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "buttonAlign",
"type" : "String",
- "desc" : "Valid values are \"left,\" \"center\" and \"right\" (defaults to \"center\")",
- "memberOf" : ""
+ "desc" : "t) Valid values are \"left,\" \"center\" and \"right\" (defaults to \"center",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : [
+ "left",
+ "center",
+ "right"
+ ]
},
{
"name" : "buttons[]",
"type" : "Roo.Button",
"desc" : "buttons at bottom of form",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "errorMask",
"type" : "Boolean",
- "desc" : "e) default false",
- "memberOf" : "Roo.form.BasicForm"
+ "desc" : "Should the form be masked (and the active element highlighted on error - default false",
+ "memberOf" : "Roo.form.BasicForm",
+ "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"
+ "memberOf" : "Roo.form.BasicForm",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "fileUpload",
"type" : "Boolean",
"desc" : "Set to true if this form is a file upload.",
- "memberOf" : "Roo.form.BasicForm"
+ "memberOf" : "Roo.form.BasicForm",
+ "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" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "itemCls",
"type" : "String",
"desc" : "A css class to apply to the x-form-item of fields. This property cascades to child containers.",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "labelAlign",
"type" : "String",
- "desc" : "Valid values are \"left,\" \"top\" and \"right\" (defaults to \"left\").\nThis property cascades to child containers if not set.",
- "memberOf" : ""
+ "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" : "labelWidth",
"type" : "Number",
"desc" : "The width of labels. This property cascades to child containers.",
- "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" : "maskOffset",
"type" : "Number",
- "desc" : "Default 100",
- "memberOf" : "Roo.form.BasicForm"
+ "desc" : "space around form element to mask if there is an error Default 100",
+ "memberOf" : "Roo.form.BasicForm",
+ "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" : "Roo.form.BasicForm"
+ "memberOf" : "Roo.form.BasicForm",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "minButtonWidth",
"type" : "Number",
"desc" : "Minimum width of all buttons in pixels (defaults to 75)",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "monitorPoll",
"type" : "Number",
"desc" : "The milliseconds to poll valid state, ignored if monitorValid is not true (defaults to 200)",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "monitorValid",
"type" : "Boolean",
"desc" : "If true the form monitors its valid state <b>client-side</b> and\nfires a looping event with that state. This is required to bind buttons to the valid\nstate using the config value formBind:true on the button.",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "progressUrl",
"type" : "String",
"desc" : "- Url to return progress data",
- "memberOf" : ""
+ "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" : "Roo.form.BasicForm"
+ "memberOf" : "Roo.form.BasicForm",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "timeout",
"type" : "Number",
"desc" : "Timeout for form actions in seconds (default is 30 seconds).",
- "memberOf" : "Roo.form.BasicForm"
+ "memberOf" : "Roo.form.BasicForm",
+ "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" : "Roo.form.BasicForm"
+ "memberOf" : "Roo.form.BasicForm",
+ "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" : "Roo.form.BasicForm"
+ "memberOf" : "Roo.form.BasicForm",
+ "isOptional" : false,
+ "optvals" : []
}
],
"events" : [
{
"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}",
+ "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.BasicForm",
"isStatic" : false,
"see" : "",
"exceptions" : "",
"requires" : "",
- "params" : [],
+ "params" : [
+ {
+ "name" : "with_readonly",
+ "type" : "Boolean",
+ "desc" : "return readonly field data.",
+ "isOptional" : false
+ }
+ ],
"returns" : [
{
"name" : "",
{
"name" : "asString",
"type" : "Boolean",
- "desc" : "",
+ "desc" : "(def)",
"isOptional" : false
}
],
"name" : "actionMode",
"type" : "String",
"desc" : "which property holds the 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" : ""
+ "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" : ""
+ "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"
+ "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" : "height",
"type" : "Number",
"desc" : "- used to restrict height of grid..",
- "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" : "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" : "labelSeparator",
+ "type" : "String",
+ "desc" : "the ':' after a field label (default :) = set it to empty string to hide the field label.",
+ "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"
+ "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" : "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" : "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" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "xgrid",
"type" : "Object",
"desc" : "(xtype'd description of grid) { xtype : 'Grid', dataSource: .... }\n\n}",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
}
],
"events" : [
"name" : "actionMode",
"type" : "String",
"desc" : "which property holds the 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" : "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" : "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"
+ "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" : "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"
+ "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"
+ "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"
+ "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"
+ "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"
+ "memberOf" : "Roo.form.TextField",
+ "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" : "labelSeparator",
+ "type" : "String",
+ "desc" : "the ':' after a field label (default :) = set it to empty string to hide the field label.",
+ "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" : "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" : "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" : "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"
+ "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" : "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" : "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"
+ "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"
+ "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" : "actionMode",
"type" : "String",
"desc" : "which property holds the 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" : ""
+ "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" : "blacklist",
"type" : "Array",
"desc" : "of html tags - in addition to standard blacklist.",
- "memberOf" : ""
+ "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" : ""
+ "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" : "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"
+ "memberOf" : "Roo.form.Field",
+ "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" : "labelSeparator",
+ "type" : "String",
+ "desc" : "the ':' after a field label (default :) = set it to empty string to hide the field label.",
+ "memberOf" : "Roo.form.Field",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "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" : "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" : ""
+ "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" : ""
+ "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" : "toolbars",
"type" : "Array",
"desc" : "Array of toolbars. - defaults to just the Standard one",
- "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" : "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" : "whitelist",
"type" : "Array",
"desc" : "of html tags - in addition to statndard whitelist",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "width",
"type" : "Number",
"desc" : "(in pixels)",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
}
],
"events" : [
],
"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",
}
]
},
+ {
+ "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",
],
"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",
"name" : "disable",
"type" : "Object",
"desc" : "List of toolbar elements to disable",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"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" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
}
],
"events" : [],
"Roo.form.HtmlEditor.ToolbarStandard" : {
"props" : [
{
- "name" : "btns",
- "type" : "Array",
+ "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" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "createLinkText",
"type" : "String",
"desc" : "The default text for the create link prompt",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "defaultFont",
"type" : "String",
"desc" : "default font to use.",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "defaultLinkValue",
"type" : "String",
"desc" : "The default value for the create link prompt (defaults to http:/ /)",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "disable",
"type" : "Object",
"desc" : "List of elements to disable..",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "fontFamilies",
"type" : "Array",
"desc" : "An array of available font families",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
}
],
"events" : [],
"name" : "actionMode",
"type" : "String",
"desc" : "which property holds the 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 layout (defaults to {tag: 'div', cls: 'x-form-ct'})",
- "memberOf" : ""
+ "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" : ""
+ "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" : "hideLabels",
"type" : "Boolean",
"desc" : "True to suppress the display of field labels in this layout (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" : "labelAlign",
"type" : "String",
- "desc" : "Valid values are \"left,\" \"top\" and \"right\" (defaults to \"left\")",
- "memberOf" : ""
+ "desc" : "t)\nValid values are \"left,\" \"top\" and \"right\" (defaults to \"left",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : [
+ "left",
+ "top",
+ "right"
+ ]
},
{
"name" : "labelSeparator",
"type" : "String",
"desc" : "The separator to use after field labels (defaults to ':')",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "labelWidth",
"type" : "Number",
"desc" : "Fixed width in pixels of all field labels (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" : "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" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
}
],
"events" : [
"Roo.SplitButton",
"Roo.Toolbar.Button",
"Roo.Toolbar.SplitButton",
- "Roo.form.TextItem"
+ "Roo.form.TextItem",
+ "Roo.form.FieldSet"
],
"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" : "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" : "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" : "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" : ""
+ "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"
+ "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"
+ "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" : ""
+ "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" : ""
+ "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 'Disabled')",
- "memberOf" : ""
+ "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"
+ "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" : ""
+ "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" : "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 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" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "labelSeparator",
+ "type" : "String",
+ "desc" : "the ':' after a field label (default :) = set it to empty string to hide the field label.",
+ "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" : "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" : "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" : ""
+ "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" : ""
+ "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" : "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" : ""
+ "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" : ""
+ "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"
+ "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" : "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" : "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" : "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" : "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" : ""
+ "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" : ""
+ "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"
+ "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" : []
}
],
"events" : [
"name" : "actionMode",
"type" : "String",
"desc" : "which property holds the 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" : "Roo.form.TextField",
+ "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" : "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" : "allowNegative",
"type" : "Boolean",
"desc" : "False to prevent entering a negative sign (defaults to true)",
- "memberOf" : ""
+ "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"
+ "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" : "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" : "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.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" : "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 x-form-num-field\")",
- "memberOf" : ""
+ "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"
+ "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" : "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"
+ "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"
+ "memberOf" : "Roo.form.TextField",
+ "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" : "labelSeparator",
+ "type" : "String",
+ "desc" : "the ':' after a field label (default :) = set it to empty string to hide the field label.",
+ "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" : "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" : "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" : "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" : "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" : "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" : "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" : "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" : "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" : "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" : "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"
+ "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"
+ "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" : "actionMode",
"type" : "String",
"desc" : "which property holds the 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" : "Roo.form.Checkbox"
+ "memberOf" : "Roo.form.Checkbox",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "boxLabel",
"type" : "String",
"desc" : "The text that appears beside the checkbox",
- "memberOf" : "Roo.form.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"
+ "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"
+ "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 checkbox (defaults to \"x-form-field\")",
- "memberOf" : "Roo.form.Checkbox"
+ "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 checkbox receives focus (defaults to undefined)",
- "memberOf" : "Roo.form.Checkbox"
+ "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"
+ "desc" : "y)\nHow this component 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"
+ "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 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" : "labelSeparator",
+ "type" : "String",
+ "desc" : "the ':' after a field label (default :) = set it to empty string to hide the field label.",
+ "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"
+ "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" : "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" : "value",
"type" : "Mixed",
"desc" : "A value to initialize this field with.",
- "memberOf" : "Roo.form.Field"
+ "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" : "Roo.form.Checkbox"
+ "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" : [
"desc" : "Sets the checked state of the checkbox.\nOn is always based on a string comparison between inputValue and the param.",
"sig" : "(value, suppressEvent)",
"static" : false,
- "memberOf" : "Roo.form.Checkbox",
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
"name" : "actionMode",
"type" : "String",
"desc" : "which property holds the 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 layout (defaults to {tag: 'div', cls: 'x-form-ct'})",
- "memberOf" : "Roo.form.Layout"
+ "memberOf" : "Roo.form.Layout",
+ "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"
+ "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"
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "height",
"type" : "Number/String",
"desc" : "The fixed height of the column in pixels or CSS value (defaults to \"auto\")",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "hideLabels",
"type" : "Boolean",
"desc" : "True to suppress the display of field labels in this layout (defaults to false)",
- "memberOf" : "Roo.form.Layout"
+ "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" : "labelAlign",
"type" : "String",
- "desc" : "Valid values are \"left,\" \"top\" and \"right\" (defaults to \"left\")",
- "memberOf" : "Roo.form.Layout"
+ "desc" : "t)\nValid values are \"left,\" \"top\" and \"right\" (defaults to \"left",
+ "memberOf" : "Roo.form.Layout",
+ "isOptional" : false,
+ "optvals" : [
+ "left",
+ "top",
+ "right"
+ ]
},
{
"name" : "labelSeparator",
"type" : "String",
"desc" : "The separator to use after field labels (defaults to ':')",
- "memberOf" : "Roo.form.Layout"
+ "memberOf" : "Roo.form.Layout",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "labelWidth",
"type" : "Number",
"desc" : "Fixed width in pixels of all field labels (defaults to undefined)",
- "memberOf" : "Roo.form.Layout"
+ "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"
+ "memberOf" : "Roo.util.Observable",
+ "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"
+ "memberOf" : "Roo.form.Layout",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "width",
"type" : "Number/String",
"desc" : "The fixed width of the column in pixels or CSS value (defaults to \"auto\")",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
}
],
"events" : [
"Roo.SplitButton",
"Roo.Toolbar.Button",
"Roo.Toolbar.SplitButton",
- "Roo.form.TextItem"
+ "Roo.form.TextItem",
+ "Roo.form.FieldSet"
],
"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" : "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.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" : ""
+ "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" : ""
+ "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"
+ "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" : ""
+ "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" : ""
+ "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" : ""
+ "memberOf" : "",
+ "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" : ""
+ "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" : "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" : ""
+ "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" : "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" : ""
+ "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"
+ "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" : "labelSeparator",
+ "type" : "String",
+ "desc" : "the ':' after a field label (default :) = set it to empty string to hide the field label.",
+ "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" : ""
+ "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" : ""
+ "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.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" : ""
+ "memberOf" : "",
+ "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" : ""
+ "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" : ""
+ "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" : "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" : "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" : "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" : ""
+ "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" : "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" : ""
+ "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" : "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" : "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" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "tpl",
"type" : "String/Roo.Template",
"desc" : "The template to use to render the output",
- "memberOf" : ""
+ "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" : ""
+ "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' and triggerClass will be <b>appended</b> if specified (defaults to 'x-form-arrow-trigger'\nwhich displays a downward arrow icon).",
- "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" : "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" : ""
+ "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" : "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" : []
}
],
"events" : [
"name" : "actionMode",
"type" : "String",
"desc" : "which property holds the 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" : ""
+ "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: \"text\", size: \"20\", autocomplete: \"off\"})",
- "memberOf" : "Roo.form.Field"
+ "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"
+ "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"
+ "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" : "height",
"type" : "Number",
"desc" : "The signature panel height (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" : "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" : "labelSeparator",
+ "type" : "String",
+ "desc" : "the ':' after a field label (default :) = set it to empty string to hide the field label.",
+ "memberOf" : "Roo.form.Field",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "labels",
"type" : "Object",
"desc" : "Label to use when rendering a form.\ndefaults to \nlabels : { \n clear : \"Clear\",\n confirm : \"Confirm\"\n }",
- "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" : "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"
+ "memberOf" : "Roo.form.Field",
+ "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" : "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" : "The signature panel width (defaults to 300)",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
}
],
"events" : [
"name" : "actionMode",
"type" : "String",
"desc" : "which property holds the 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" : "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" : "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" : ""
+ "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"
+ "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"
+ "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"
+ "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"
+ "memberOf" : "Roo.form.TextField",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "growMax",
"type" : "Number",
"desc" : "The maximum height to allow when grow = true (defaults to 1000)",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "growMin",
"type" : "Number",
"desc" : "The minimum height to allow when grow = true (defaults to 60)",
- "memberOf" : ""
+ "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" : "labelSeparator",
+ "type" : "String",
+ "desc" : "the ':' after a field label (default :) = set it to empty string to hide the field label.",
+ "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" : "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" : "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" : "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" : ""
+ "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"
+ "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" : "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" : "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"
+ "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"
+ "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" : "actionMode",
"type" : "String",
"desc" : "which property holds the 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" : ""
+ "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" : ""
+ "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"
+ "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" : ""
+ "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" : ""
+ "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" : ""
+ "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" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "growMax",
"type" : "Number",
"desc" : "The maximum width to allow when grow = true (defaults to 800)",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "growMin",
"type" : "Number",
"desc" : "The minimum width to allow when grow = true (defaults to 30)",
- "memberOf" : ""
+ "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" : "labelSeparator",
+ "type" : "String",
+ "desc" : "the ':' after a field label (default :) = set it to empty string to hide the field label.",
+ "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" : ""
+ "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" : "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" : "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"
+ "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" : ""
+ "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" : ""
+ "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" : "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" : ""
+ "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" : ""
+ "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" : "actionMode",
"type" : "String",
"desc" : "which property holds the 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" : "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" : "html",
"type" : "String",
"desc" : "the content for this 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" : "style",
+ "type" : "String",
+ "desc" : "css styles to add to component\neg. text-align:right;",
+ "memberOf" : "Roo.Component",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "tag",
"type" : "String",
"desc" : "the tag for this item (default div)",
- "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" : [
"name" : "actionMode",
"type" : "String",
"desc" : "which property holds the 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" : "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" : "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" : ""
+ "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"
+ "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"
+ "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"
+ "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" : "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" : "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" : "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" : "labelSeparator",
+ "type" : "String",
+ "desc" : "the ':' after a field label (default :) = set it to empty string to hide the field label.",
+ "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" : "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" : "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" : "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"
+ "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" : "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" : "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" : "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" : "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" : "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" : []
}
],
"events" : [
"events" : [],
"methods" : [
{
- "name" : "alpha'",
+ "name" : "alpha",
"type" : "function",
"desc" : "The function used to validate alpha values",
"sig" : "(value)",
"returns" : []
},
{
- "name" : "alphanum'",
+ "name" : "alphanum",
"type" : "function",
"desc" : "The function used to validate alphanumeric values",
"sig" : "(value)",
"returns" : []
},
{
- "name" : "email'",
+ "name" : "email",
"type" : "function",
"desc" : "The function used to validate email addresses",
"sig" : "(value)",
"returns" : []
},
{
- "name" : "url'",
+ "name" : "url",
"type" : "function",
"desc" : "The function used to validate URLs",
"sig" : "(value)",
}
],
"returns" : []
+ },
+ {
+ "name" : "urlWeb",
+ "type" : "function",
+ "desc" : "The funciton used to validate URLs (only allow schemes 'https' and 'http')",
+ "sig" : "(v)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "v",
+ "type" : "String",
+ "desc" : "The URL",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
}
],
"isAbstract" : 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" : []
}
],
"events" : [],
"name" : "listeners",
"type" : "Object",
"desc" : "list of events and functions to call for 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" : [],
"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" : "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"
+ "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"
+ "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"
+ "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"
+ "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"
+ "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"
+ "memberOf" : "Roo.grid.Grid",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "cm[]",
"type" : "Roo.grid.ColumnModel",
"desc" : "The columns of the grid",
- "memberOf" : "Roo.grid.Grid"
+ "memberOf" : "Roo.grid.Grid",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "ddGroup",
"type" : "String",
"desc" : "- drag drop group.",
- "memberOf" : "Roo.grid.Grid"
+ "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"
+ "memberOf" : "Roo.grid.Grid",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "dragGroup",
"type" : "String",
"desc" : "- drag group (?? not sure if needed.)",
- "memberOf" : "Roo.grid.Grid"
+ "memberOf" : "Roo.grid.Grid",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "dropTarget",
"type" : "Roo.dd.DropTarget",
"desc" : "An {@link Roo.dd.DropTarget} config",
- "memberOf" : "Roo.grid.Grid"
+ "memberOf" : "Roo.grid.Grid",
+ "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" : "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"
+ "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"
+ "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"
+ "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"
+ "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"
+ "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"
+ "memberOf" : "Roo.grid.Grid",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "eventStore",
"type" : "Store",
"desc" : "The store that loads events.",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "footer",
+ "type" : "Roo.PagingToolbar",
+ "desc" : "the paging toolbar",
+ "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"
+ "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" : "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"
+ "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"
+ "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"
+ "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"
+ "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"
+ "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"
+ "memberOf" : "Roo.grid.Grid",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "toolbar",
"type" : "Roo.Toolbar",
"desc" : "a toolbar for buttons etc.",
- "memberOf" : "Roo.grid.Grid"
+ "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"
+ "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"
+ "memberOf" : "Roo.grid.Grid",
+ "isOptional" : false,
+ "optvals" : []
}
],
"events" : [
"name" : "enter_is_tab",
"type" : "Boolean",
"desc" : "Enter behaves the same as tab. (eg. goes to next cell) 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" : []
}
],
"events" : [
{
"name" : "align",
"type" : "String",
- "desc" : "(Optional) Set the CSS text-align property of the column. Defaults to undefined.",
- "memberOf" : ""
+ "desc" : "t) Set the CSS text-align property of the column. Defaults to undefined (left",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : [
+ "left",
+ "right"
+ ]
},
{
"name" : "cursor",
"type" : "String",
- "desc" : "(Optional)",
- "memberOf" : ""
+ "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" : "(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" : ""
+ "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" : "(Optional) For grid editors - returns the grid editor",
- "memberOf" : ""
+ "desc" : "For grid editors - returns the grid editor",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "fixed",
"type" : "Boolean",
- "desc" : "(Optional) True if the column width cannot be changed. Defaults to false.",
- "memberOf" : ""
+ "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" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "hidden",
"type" : "Boolean",
- "desc" : "(Optional) True to hide the column. Defaults to false.",
- "memberOf" : ""
+ "desc" : "True to hide the column. Defaults to false.",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "lg",
"type" : "Number",
- "desc" : "(Optional) can be '0' for hidden at this size (number less than 12)",
- "memberOf" : ""
+ "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" : ""
+ "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" : "locked",
"type" : "Boolean",
- "desc" : "(Optional) True to lock the column in place while scrolling the Grid. Defaults to false.",
- "memberOf" : ""
+ "desc" : "True to lock the column in place while scrolling the Grid. Defaults to false.",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "md",
"type" : "Number",
- "desc" : "(Optional) can be '0' for hidden at this size (number less than 12)",
- "memberOf" : ""
+ "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" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"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" : ""
+ "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" : "(Optional) False to disable column resizing. Defaults to true.",
- "memberOf" : ""
+ "desc" : "False to disable column resizing. Defaults to true.",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "sm",
"type" : "Number",
- "desc" : "(Optional) can be '0' for hidden at this size (number less than 12)",
- "memberOf" : ""
+ "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" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"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" : ""
+ "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" : "(Optional)",
- "memberOf" : ""
+ "desc" : "mouse over tooltip text",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "valign",
"type" : "String",
- "desc" : "(Optional) Set the CSS vertical-align property of the column (eg. middle, top, bottom etc). Defaults to undefined.",
- "memberOf" : ""
+ "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" : "(Optional) The initial width in pixels of the column. Using this\ninstead of {@link Roo.grid.Grid#autoSizeColumns} is more efficient.",
- "memberOf" : ""
+ "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" : "(Optional) can be '0' for hidden at this size (number less than 12)",
- "memberOf" : ""
+ "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" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "xs",
"type" : "Number",
- "desc" : "(Optional) can be '0' for hidden at this size (number less than 12)",
- "memberOf" : ""
+ "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" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
}
],
"events" : [
"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" : "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"
+ "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"
+ "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"
+ "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"
+ "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"
+ "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"
+ "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" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "cm[]",
"type" : "Roo.grid.ColumnModel",
"desc" : "The columns of the grid",
- "memberOf" : "Roo.grid.Grid"
+ "memberOf" : "Roo.grid.Grid",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "ddGroup",
"type" : "String",
"desc" : "- drag drop group.",
- "memberOf" : "Roo.grid.Grid"
+ "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"
+ "memberOf" : "Roo.grid.Grid",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "dragGroup",
"type" : "String",
"desc" : "- drag group (?? not sure if needed.)",
- "memberOf" : "Roo.grid.Grid"
+ "memberOf" : "Roo.grid.Grid",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "dropTarget",
"type" : "Roo.dd.DropTarget",
"desc" : "An {@link Roo.dd.DropTarget} config",
- "memberOf" : "Roo.grid.Grid"
+ "memberOf" : "Roo.grid.Grid",
+ "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" : "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"
+ "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"
+ "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"
+ "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"
+ "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"
+ "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"
+ "memberOf" : "Roo.grid.Grid",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "footer",
+ "type" : "Roo.PagingToolbar",
+ "desc" : "the paging toolbar",
+ "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"
+ "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" : "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"
+ "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"
+ "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"
+ "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"
+ "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"
+ "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"
+ "memberOf" : "Roo.grid.Grid",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "toolbar",
"type" : "Roo.Toolbar",
"desc" : "a toolbar for buttons etc.",
- "memberOf" : "Roo.grid.Grid"
+ "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"
+ "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"
+ "memberOf" : "Roo.grid.Grid",
+ "isOptional" : false,
+ "optvals" : []
}
],
"events" : [
"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" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "autoExpandMax",
"type" : "Number",
"desc" : "The maximum width the autoExpandColumn can have (if enabled). Default is 1000.",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "autoExpandMin",
"type" : "Number",
"desc" : "The minimum width the autoExpandColumn can have (if enabled).\nDefault is 50.",
- "memberOf" : ""
+ "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" : ""
+ "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" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "autoSizeHeaders",
"type" : "Boolean",
"desc" : "True to measure headers with column data when auto sizing columns. Default is true.",
- "memberOf" : ""
+ "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" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "cm[]",
"type" : "Roo.grid.ColumnModel",
"desc" : "The columns of the grid",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "ddGroup",
"type" : "String",
"desc" : "- drag drop group.",
- "memberOf" : ""
+ "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" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "dragGroup",
"type" : "String",
"desc" : "- drag group (?? not sure if needed.)",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "dropTarget",
"type" : "Roo.dd.DropTarget",
"desc" : "An {@link Roo.dd.DropTarget} config",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "ds",
- "type" : "Roo.grid.Store",
+ "type" : "Roo.data.Store",
"desc" : "The data store for the grid",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "enableColumnHide",
"type" : "Boolean",
"desc" : "True to enable hiding of columns with the header context menu. Default is true.",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "enableColumnMove",
"type" : "Boolean",
"desc" : "True to enable drag and drop reorder of columns. Default is true.",
- "memberOf" : ""
+ "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" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "enableDragDrop",
"type" : "Boolean",
"desc" : "True to enable drag and drop of rows. Default is false.",
- "memberOf" : ""
+ "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" : ""
+ "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" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "footer",
+ "type" : "Roo.PagingToolbar",
+ "desc" : "the paging toolbar",
+ "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" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "maxHeight",
"type" : "Number",
"desc" : "Sets the maximum height of the grid - ignored if autoHeight is not on.",
- "memberOf" : ""
+ "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" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "minColumnWidth",
"type" : "Number",
"desc" : "The minimum width a column can be resized to. Default is 25.",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "monitorWindowResize",
"type" : "Boolean",
"desc" : "True to autoSize the grid when the window resizes. Default is true.",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "sm",
"type" : "Roo.grid.AbstractSelectionModel",
"desc" : "The selection Model (default = Roo.grid.RowSelectionModel)",
- "memberOf" : ""
+ "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" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "toolbar",
"type" : "Roo.Toolbar",
"desc" : "a toolbar for buttons etc.",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "trackMouseOver",
"type" : "Boolean",
"desc" : "True to highlight rows when the mouse is over. Default is true.",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "view",
"type" : "Roo.grid.GridView",
"desc" : "The view that renders the grid (default = Roo.grid.GridView)",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
}
],
"events" : [
"name" : "actionMode",
"type" : "String",
"desc" : "which property holds the 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" : "Roo.Editor"
+ "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"
+ "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" : "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.Field",
"desc" : "Field to wrap (or xtyped)",
- "memberOf" : ""
+ "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"
+ "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"
+ "desc" : "y)\nHow this component 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" : "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" : "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"
+ "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" : [
"name" : "listeners",
"type" : "Object",
"desc" : "list of events and functions to call for 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" : [],
"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" : "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"
+ "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"
+ "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"
+ "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"
+ "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"
+ "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"
+ "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"
+ "memberOf" : "Roo.grid.EditorGrid",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "cm[]",
"type" : "Roo.grid.ColumnModel",
"desc" : "The columns of the grid",
- "memberOf" : "Roo.grid.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" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "ddGroup",
"type" : "String",
"desc" : "- drag drop group.",
- "memberOf" : "Roo.grid.Grid"
+ "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"
+ "memberOf" : "Roo.grid.Grid",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "dragGroup",
"type" : "String",
"desc" : "- drag group (?? not sure if needed.)",
- "memberOf" : "Roo.grid.Grid"
+ "memberOf" : "Roo.grid.Grid",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "dropTarget",
"type" : "Roo.dd.DropTarget",
"desc" : "An {@link Roo.dd.DropTarget} config",
- "memberOf" : "Roo.grid.Grid"
+ "memberOf" : "Roo.grid.Grid",
+ "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" : "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"
+ "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"
+ "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"
+ "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"
+ "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"
+ "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"
+ "memberOf" : "Roo.grid.Grid",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "footer",
+ "type" : "Roo.PagingToolbar",
+ "desc" : "the paging toolbar",
+ "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"
+ "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" : "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"
+ "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"
+ "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"
+ "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"
+ "memberOf" : "Roo.grid.Grid",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "propertyNames",
"type" : "Object",
"desc" : "map of property Names to their displayed value",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "sm",
"type" : "Roo.grid.AbstractSelectionModel",
"desc" : "The selection Model (default = Roo.grid.RowSelectionModel)",
- "memberOf" : "Roo.grid.Grid"
+ "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"
+ "memberOf" : "Roo.grid.Grid",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "toolbar",
"type" : "Roo.Toolbar",
"desc" : "a toolbar for buttons etc.",
- "memberOf" : "Roo.grid.Grid"
+ "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"
+ "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"
+ "memberOf" : "Roo.grid.Grid",
+ "isOptional" : false,
+ "optvals" : []
}
],
"events" : [
"name" : "listeners",
"type" : "Object",
"desc" : "list of events and functions to call for 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" : "singleSelect",
"type" : "Boolean",
"desc" : "True to allow selection of only one row at a time (defaults to false)",
- "memberOf" : ""
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
}
],
"events" : [
"name" : "listeners",
"type" : "Object",
"desc" : "list of events and functions to call for 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" : [],
"tree_children" : [],
"tree_parent" : []
},
+ "Roo.htmleditor" : {
+ "props" : [],
+ "events" : [],
+ "methods" : [],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "implementations" : [],
+ "tree_children" : [],
+ "tree_parent" : []
+ },
+ "Roo.htmleditor.Block" : {
+ "props" : [
+ {
+ "name" : "Context",
+ "type" : "Object",
+ "desc" : "menu - see Roo.form.HtmlEditor.ToolbarContext",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "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" : [],
+ "methods" : [
+ {
+ "name" : "factory",
+ "type" : "function",
+ "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" : "the",
+ "type" : "HtmlElement",
+ "desc" : "dom element",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "getVal",
+ "type" : "function",
+ "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" : "node",
+ "type" : "DomElement",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "tag",
+ "type" : "String",
+ "desc" : "- tag to find, eg. IMG ?? might be better to use DomQuery ?",
+ "isOptional" : false
+ },
+ {
+ "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" : "style",
+ "type" : "String",
+ "desc" : "the style property - eg. text-align",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "initAll",
+ "type" : "function",
+ "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" : "the",
+ "type" : "",
+ "desc" : "body element",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "readElement",
+ "type" : "function",
+ "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" : "node",
+ "type" : "DomElement",
+ "desc" : "- the node",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "toHTML",
+ "type" : "function",
+ "desc" : "convert to plain HTML for calling insertAtCursor..",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
+ {
+ "name" : "toObject",
+ "type" : "function",
+ "desc" : "create a DomHelper friendly object - for use with \nRoo.DomHelper.markup / overwrite / etc..\n(override this)",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
+ {
+ "name" : "updateElement",
+ "type" : "function",
+ "desc" : "Update a node with values from this object",
+ "sig" : "(node)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "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" : "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" : "create a DomHelper friendly object - for use with\nRoo.DomHelper.markup / overwrite / etc..",
+ "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.htmleditor.BlockTable" : {
+ "props" : [],
+ "events" : [],
+ "methods" : [
+ {
+ "name" : "toObject",
+ "type" : "function",
+ "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,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ }
+ ],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "implementations" : [],
+ "tree_children" : [],
+ "tree_parent" : []
+ },
+ "Roo.htmleditor.BlockTd" : {
+ "props" : [],
+ "events" : [],
+ "methods" : [
+ {
+ "name" : "toObject",
+ "type" : "function",
+ "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,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ }
+ ],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "implementations" : [],
+ "tree_children" : [],
+ "tree_parent" : []
+ },
+ "Roo.htmleditor.Filter" : {
+ "props" : [
+ {
+ "name" : "node",
+ "type" : "DomElement",
+ "desc" : "The node to iterate and filter",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "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.FilterHashLink" : {
+ "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" : "Clean up MS wordisms...",
+ "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.htmleditor.KeyEnter" : {
+ "props" : [
+ {
+ "name" : "core",
+ "type" : "Roo.HtmlEditorCore",
+ "desc" : "the editor.",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ }
+ ],
+ "events" : [],
+ "methods" : [],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "implementations" : [],
+ "tree_children" : [],
+ "tree_parent" : []
+ },
+ "Roo.htmleditor.TidyEntities" : {
+ "props" : [],
+ "events" : [],
+ "methods" : [
+ {
+ "name" : "decode",
+ "type" : "function",
+ "desc" : "Decodes the specified string, this will replace entities with raw UTF characters.",
+ "sig" : "(text)",
+ "static" : true,
+ "memberOf" : "",
+ "isStatic" : true,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "text",
+ "type" : "String",
+ "desc" : "Text to entity decode.",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "String",
+ "desc" : "Entity decoded string."
+ }
+ ]
+ },
+ {
+ "name" : "encodeAllRaw",
+ "type" : "function",
+ "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" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "text",
+ "type" : "String",
+ "desc" : "Text to encode.",
+ "isOptional" : false
+ }
+ ],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "String",
+ "desc" : "Entity encoded text."
+ }
+ ]
+ },
+ {
+ "name" : "encodeNamed",
+ "type" : "function",
+ "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" : true,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "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" : "String",
+ "desc" : "Entity encoded text."
+ }
+ ]
+ },
+ {
+ "name" : "encodeNumeric",
+ "type" : "function",
+ "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" : true,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "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" : "String",
+ "desc" : "Entity encoded text."
+ }
+ ]
+ },
+ {
+ "name" : "encodeRaw",
+ "type" : "function",
+ "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" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "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" : "String",
+ "desc" : "Entity encoded text."
+ }
+ ]
+ },
+ {
+ "name" : "getEncodeFunc",
+ "type" : "function",
+ "desc" : "Returns an encode function based on the name(s) and it's optional entities.",
+ "sig" : "(name, entities)",
+ "static" : true,
+ "memberOf" : "",
+ "isStatic" : true,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "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" : "function",
+ "desc" : "Encode function to be used."
+ }
+ ]
+ },
+ {
+ "name" : "init",
+ "type" : "function",
+ "desc" : "initialize data..",
+ "sig" : "()\n{\n\n}",
+ "static" : true,
+ "memberOf" : "",
+ "isStatic" : true,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ }
+ ],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "implementations" : [],
+ "tree_children" : [],
+ "tree_parent" : []
+ },
+ "Roo.htmleditor.TidySerializer" : {
+ "props" : [],
+ "events" : [],
+ "methods" : [
+ {
+ "name" : "inner",
+ "type" : "function",
+ "desc" : "",
+ "sig" : "(inner)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "inner",
+ "type" : "boolean",
+ "desc" : "do the inner of the node.",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "serialize",
+ "type" : "function",
+ "desc" : "Serializes the specified node into a string.",
+ "sig" : "(node)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "new tinymce.html.Serializer().serialize(new tinymce.html.DomParser().parse('<p>text</p>'));",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "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" : "cdata",
+ "type" : "function",
+ "desc" : "Writes a cdata node such as <![CDATA[data]]>.",
+ "sig" : "(text)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "text",
+ "type" : "String",
+ "desc" : "String to write out inside the cdata.",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "comment",
+ "type" : "function",
+ "desc" : "Writes a comment node such as <!-- Comment -->.",
+ "sig" : "(text)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "text",
+ "type" : "String",
+ "desc" : "String to write out inside the comment.",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "doctype",
+ "type" : "function",
+ "desc" : "Writes a doctype node such as <!DOCTYPE data>.",
+ "sig" : "(text)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "text",
+ "type" : "String",
+ "desc" : "String to write out inside the doctype.",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "end",
+ "type" : "function",
+ "desc" : "Writes the a end element such as </p>.",
+ "sig" : "(name)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "name",
+ "type" : "String",
+ "desc" : "Name of the element.",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "getContent",
+ "type" : "function",
+ "desc" : "Returns the contents that got serialized.",
+ "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" : "HTML contents that got written down."
+ }
+ ]
+ },
+ {
+ "name" : "pi",
+ "type" : "function",
+ "desc" : "Writes a PI node such as <?xml attr=\"value\" ?>.",
+ "sig" : "(name, text)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "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" : "reset",
+ "type" : "function",
+ "desc" : "Resets the internal buffer if one wants to reuse the writer.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
+ },
+ {
+ "name" : "start",
+ "type" : "function",
+ "desc" : "Writes the a start element such as <p id=\"a\">.",
+ "sig" : "(name, attrs, empty)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "name",
+ "type" : "String",
+ "desc" : "Name of the element.",
+ "isOptional" : false
+ },
+ {
+ "name" : "attrs",
+ "type" : "Array",
+ "desc" : "Optional attribute array or undefined if it hasn't any.",
+ "isOptional" : false
+ },
+ {
+ "name" : "empty",
+ "type" : "Boolean",
+ "desc" : "Optional empty state if the tag should end like <br />.",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "text",
+ "type" : "function",
+ "desc" : "Writes a text node.\n\nIn pre - we should not mess with the contents.",
+ "sig" : "(text, raw)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "text",
+ "type" : "String",
+ "desc" : "String to write out.",
+ "isOptional" : false
+ },
+ {
+ "name" : "raw",
+ "type" : "Boolean",
+ "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" : [],
"tree_children" : [],
"tree_parent" : []
},
+ "Roo.lib.Range" : {
+ "props" : [],
+ "events" : [],
+ "methods" : [
+ {
+ "name" : "wrap",
+ "type" : "function",
+ "desc" : "Wrap a Dom Range object, to give it new features...",
+ "sig" : "(the)",
+ "static" : true,
+ "memberOf" : "",
+ "isStatic" : true,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "the",
+ "type" : "Range",
+ "desc" : "range to wrap",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ }
+ ],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "implementations" : [],
+ "tree_children" : [],
+ "tree_parent" : []
+ },
+ "Roo.lib.Selection" : {
+ "props" : [],
+ "events" : [],
+ "methods" : [
+ {
+ "name" : "insertNode",
+ "type" : "function",
+ "desc" : "insert node at selection",
+ "sig" : "(node, cursor)",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "name" : "node",
+ "type" : "DomElement|string",
+ "desc" : "",
+ "isOptional" : false
+ },
+ {
+ "name" : "cursor",
+ "type" : "string",
+ "desc" : "(after|in|none) where to place the cursor after inserting.",
+ "isOptional" : false
+ }
+ ],
+ "returns" : []
+ },
+ {
+ "name" : "wrap",
+ "type" : "function",
+ "desc" : "Wrap a Dom Range object, to give it new features...",
+ "sig" : "(the)",
+ "static" : true,
+ "memberOf" : "",
+ "isStatic" : true,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [
+ {
+ "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" : "String",
+ "desc" : "The HTML fragment"
+ }
+ ]
+ }
+ ],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "implementations" : [],
+ "tree_children" : [],
+ "tree_parent" : []
+ },
"Roo.menu" : {
"props" : [],
"events" : [],
"name" : "actionMode",
"type" : "String",
"desc" : "which property holds the 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" : [
"name" : "actionMode",
"type" : "String",
"desc" : "which property holds the 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" : [
},
"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" : [
"name" : "actionMode",
"type" : "String",
"desc" : "which property holds the 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" : [
"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" : [
"name" : "actionMode",
"type" : "String",
"desc" : "which property holds the 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" : [
"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" : [
},
"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" : [
"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" : [
"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"
],
"name" : "actionMode",
"type" : "String",
"desc" : "which property holds the 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" : [
"name" : "actionMode",
"type" : "String",
"desc" : "which property holds the 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" : [
"tree_children" : [],
"tree_parent" : []
},
+ "Roo.rtf" : {
+ "props" : [],
+ "events" : [],
+ "methods" : [],
+ "isAbstract" : false,
+ "isBuilderTop" : false,
+ "implementations" : [],
+ "tree_children" : [],
+ "tree_parent" : []
+ },
"Roo.state" : {
"props" : [],
"events" : [],
"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" : [
"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" : [
"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" : [
"name" : "listeners",
"type" : "Object",
"desc" : "list of events and functions to call for 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" : [
"name" : "listeners",
"type" : "Object",
"desc" : "list of events and functions to call for 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" : [
"name" : "actionMode",
"type" : "String",
"desc" : "which property holds the 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" : [
"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" : [
"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" : [
"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" : [
"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" : [],
"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" : [
"name" : "listeners",
"type" : "Object",
"desc" : "list of events and functions to call for 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" : [
"name" : "listeners",
"type" : "Object",
"desc" : "list of events and functions 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" : [],
"Roo.bootstrap.form.FieldLabel",
"Roo.bootstrap.form.Form",
"Roo.bootstrap.form.HtmlEditor",
- "Roo.bootstrap.form.HtmlEditorToolbarStandard",
+ "Roo.bootstrap.form.HtmlEditorToolbar.Standard",
"Roo.bootstrap.form.Input",
"Roo.bootstrap.form.Markdown",
"Roo.bootstrap.form.MoneyField",
"Roo.bootstrap.form.MonthField",
"Roo.bootstrap.form.NumberField",
+ "Roo.bootstrap.form.Password",
"Roo.bootstrap.form.PhoneInput",
"Roo.bootstrap.form.Radio",
"Roo.bootstrap.form.RadioSet",
"Roo.data.DataProxy",
"Roo.data.HttpProxy",
"Roo.data.JsonStore",
+ "Roo.data.MemoryProxy",
"Roo.data.Node",
"Roo.data.SimpleStore",
"Roo.data.Store",
"Roo.dd.DragZone",
"Roo.dd.DropTarget",
"Roo.dd.DropZone",
+ "Roo.dialog.UploadCropbox",
"Roo.form.BasicForm",
"Roo.form.Checkbox",
"Roo.form.Column",
}
]
},
+ {
+ "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",
projects / roojs1 / blobdiff