Fix #6893 - fix roo docs
[roojs1] / docs / symbols / Roo.form.ComboNested.json
index 4559c8f..c87f1f1 100644 (file)
       "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",
-      "values" : []
+      "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",
-      "values" : []
+      "optvals" : []
     },
     {
       "name" : "hideMode",
       "type" : "String",
-      "desc" : "How this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".",
+      "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".",
       "memberOf" : "Roo.Component",
-      "values" : [
-        "(display",
-        "visibility)"
+      "optvals" : [
+        "display",
+        "visibility"
       ]
     },
     {
       "type" : "Boolean",
       "desc" : "True to disable input keystroke filtering (defaults to false)",
       "memberOf" : "Roo.form.TextField",
-      "values" : []
+      "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",
-      "values" : []
+      "optvals" : []
     },
     {
       "name" : "disabled",
       "type" : "Boolean",
       "desc" : "True to disable the field (defaults to false).",
       "memberOf" : "Roo.form.Field",
-      "values" : []
+      "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",
-      "values" : []
+      "optvals" : []
     },
     {
       "name" : "name",
       "type" : "String",
       "desc" : "The field's HTML name attribute.",
       "memberOf" : "Roo.form.Field",
-      "values" : []
+      "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",
-      "values" : []
+      "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",
-      "values" : []
+      "optvals" : []
     },
     {
       "name" : "width",
       "type" : "Number",
       "desc" : "width (optional) size of component",
       "memberOf" : "Roo.BoxComponent",
-      "values" : []
+      "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",
-      "values" : []
+      "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",
-      "values" : []
+      "optvals" : []
     },
     {
       "name" : "allowDomMove",
       "type" : "Boolean",
       "desc" : "Whether the component can move the Dom node when rendering (defaults to true).",
       "memberOf" : "Roo.Component",
-      "values" : []
+      "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",
-      "values" : []
+      "optvals" : []
     },
     {
       "name" : "height",
       "type" : "Number",
       "desc" : "height (optional) size of component",
       "memberOf" : "Roo.BoxComponent",
-      "values" : []
+      "optvals" : []
     },
     {
       "name" : "tpl",
       "type" : "String/Roo.Template",
       "desc" : "The template to use to render the output",
       "memberOf" : "Roo.form.ComboBox",
-      "values" : []
+      "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",
-      "values" : []
+      "optvals" : []
     },
     {
       "name" : "disableClear",
       "type" : "Boolean",
       "desc" : "Disable showing of clear button.",
       "memberOf" : "Roo.form.ComboBox",
-      "values" : []
+      "optvals" : []
     },
     {
       "name" : "value",
       "type" : "Mixed",
       "desc" : "A value to initialize this field with.",
       "memberOf" : "Roo.form.Field",
-      "values" : []
+      "optvals" : []
     },
     {
       "name" : "emptyText",
       "type" : "String",
       "desc" : "The default text to display in an empty field - placeholder... (defaults to null).",
       "memberOf" : "Roo.form.TextField",
-      "values" : []
+      "optvals" : []
     },
     {
       "name" : "store",
       "type" : "Roo.data.Store",
       "desc" : "The data store to which this combo is bound (defaults to undefined)",
       "memberOf" : "Roo.form.ComboBox",
-      "values" : []
+      "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",
-      "values" : []
+      "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",
-      "values" : []
+      "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",
-      "values" : []
+      "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",
-      "values" : []
+      "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",
-      "values" : []
+      "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",
-      "values" : []
+      "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",
-      "values" : []
+      "optvals" : []
     },
     {
       "name" : "listeners",
       "type" : "Object",
       "desc" : "list of events and functions to call for this object, \nFor example :\n<pre><code>\n    listeners :  { \n       'click' : function(e) {\n           ..... \n        } ,\n        .... \n    } \n  </code></pre>",
       "memberOf" : "Roo.util.Observable",
-      "values" : []
+      "optvals" : []
     },
     {
       "name" : "alwaysQuery",
       "type" : "Boolean",
       "desc" : "Disable caching of results, and always send query",
       "memberOf" : "Roo.form.ComboBox",
-      "values" : []
+      "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",
-      "values" : []
+      "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",
-      "values" : []
+      "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",
-      "values" : []
+      "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",
-      "values" : []
+      "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",
-      "values" : []
+      "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",
-      "values" : []
+      "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",
-      "values" : []
+      "optvals" : []
     },
     {
       "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",
-      "values" : []
+      "optvals" : []
     },
     {
       "name" : "cls",
       "type" : "String",
       "desc" : "A CSS class to apply to the field's underlying element.",
       "memberOf" : "Roo.form.Field",
-      "values" : []
+      "optvals" : []
     },
     {
       "name" : "validateOnBlur",
       "type" : "Boolean",
       "desc" : "Whether the field should validate when it loses focus (defaults to true).",
       "memberOf" : "Roo.form.Field",
-      "values" : []
+      "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",
-      "values" : []
+      "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",
-      "values" : []
+      "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",
-      "values" : []
+      "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",
-      "values" : []
+      "optvals" : []
     },
     {
       "name" : "inputType",
       "type" : "String",
       "desc" : "The type attribute for input fields -- e.g. radio, text, password (defaults to \"text\").",
       "memberOf" : "Roo.form.Field",
-      "values" : []
+      "optvals" : []
     },
     {
       "name" : "fieldClass",
       "type" : "String",
       "desc" : "The default CSS class for the field (defaults to \"x-form-field\")",
       "memberOf" : "Roo.form.Field",
-      "values" : []
+      "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",
-      "values" : []
+      "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",
-      "values" : []
+      "optvals" : []
     },
     {
       "name" : "growMin",
       "type" : "Number",
       "desc" : "",
       "memberOf" : "Roo.form.ComboBox",
-      "values" : []
+      "optvals" : []
     },
     {
       "name" : "vtype",
       "type" : "String",
       "desc" : "A validation type name as defined in {@link Roo.form.VTypes} (defaults to null)",
       "memberOf" : "Roo.form.TextField",
-      "values" : []
+      "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",
-      "values" : []
+      "optvals" : []
     },
     {
       "name" : "allowLeadingSpace",
       "type" : "Boolean",
       "desc" : "True to prevent the stripping of leading white space",
       "memberOf" : "Roo.form.TextField",
-      "values" : []
+      "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",
-      "values" : []
+      "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",
-      "values" : []
+      "optvals" : []
     },
     {
       "name" : "blockFocus",
       "type" : "Boolean",
       "desc" : "Prevents all focus calls, so it can work with things like HTML edtor bar",
       "memberOf" : "Roo.form.ComboBox",
-      "values" : []
+      "optvals" : []
     },
     {
       "name" : "fieldLabel",
       "type" : "String",
       "desc" : "Label to use when rendering a form.",
       "memberOf" : "Roo.form.Field",
-      "values" : []
+      "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",
-      "values" : []
+      "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",
-      "values" : []
+      "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",
-      "values" : []
+      "optvals" : []
     },
     {
       "name" : "disableClass",
       "type" : "String",
       "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").",
       "memberOf" : "Roo.Component",
-      "values" : []
+      "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",
-      "values" : []
+      "optvals" : []
     },
     {
       "name" : "growMax",
       "type" : "Number",
       "desc" : "",
       "memberOf" : "Roo.form.ComboBox",
-      "values" : []
+      "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",
-      "values" : []
+      "optvals" : []
     },
     {
       "name" : "listClass",
       "type" : "String",
       "desc" : "CSS class to apply to the dropdown list element (defaults to '')",
       "memberOf" : "Roo.form.ComboBox",
-      "values" : []
+      "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",
-      "values" : []
+      "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",
-      "values" : []
+      "optvals" : []
     },
     {
       "name" : "grow",
       "type" : "Boolean",
       "desc" : "",
       "memberOf" : "Roo.form.ComboBox",
-      "values" : []
+      "optvals" : []
     },
     {
       "name" : "minLength",
       "type" : "Number",
       "desc" : "Minimum input field length required (defaults to 0)",
       "memberOf" : "Roo.form.TextField",
-      "values" : []
+      "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",
-      "values" : []
+      "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",
-      "values" : []
+      "optvals" : []
     },
     {
       "name" : "allowBlank",
       "type" : "Boolean",
       "desc" : "False to validate that the value length > 0 (defaults to true)",
       "memberOf" : "Roo.form.TextField",
-      "values" : []
+      "optvals" : []
     },
     {
       "name" : "qtip",
       "type" : "String",
       "desc" : "Mouse over tip",
       "memberOf" : "Roo.form.Field",
-      "values" : []
+      "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",
-      "values" : []
+      "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",
-      "values" : []
+      "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",
-      "values" : []
+      "optvals" : []
     },
     {
       "name" : "maxLength",
       "type" : "Number",
       "desc" : "Maximum input field length allowed (defaults to Number.MAX_VALUE)",
       "memberOf" : "Roo.form.TextField",
-      "values" : []
+      "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",
-      "values" : []
+      "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",
-      "values" : []
+      "optvals" : []
     }
   ],
   "methods" : [