Fix #6893 - fix roo docs
[roojs1] / docs / symbols / Roo.bootstrap.CheckBox.json
index b38d412..8b2c08b 100644 (file)
       "type" : "String",
       "desc" : "The CSS class to use when create feedback icon (defaults to \"x-form-invalid\")",
       "memberOf" : "Roo.bootstrap.Input",
-      "values" : []
+      "optvals" : []
     },
     {
       "name" : "lg",
       "type" : "Number",
       "desc" : "colspan out of 12 for large computer-sized screens",
       "memberOf" : "Roo.bootstrap.Input",
-      "values" : []
+      "optvals" : []
     },
     {
       "name" : "accept",
       "type" : "String",
-      "desc" : "use for file input only. (default empty)",
+      "desc" : "o) use for file input only. (default empty)",
       "memberOf" : "Roo.bootstrap.Input",
-      "values" : [
-        "(image",
+      "optvals" : [
+        "image",
         "video",
-        "audio)"
+        "audio"
       ]
     },
     {
       "type" : "String",
       "desc" : "inputType",
       "memberOf" : "Roo.bootstrap.Input",
-      "values" : []
+      "optvals" : []
     },
     {
       "name" : "xs",
       "type" : "Number",
       "desc" : "colspan out of 12 for mobile-sized screens",
       "memberOf" : "Roo.bootstrap.Input",
-      "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.bootstrap.Input",
-      "values" : []
+      "optvals" : []
     },
     {
       "name" : "disabled",
       "type" : "Boolean",
       "desc" : "is it disabled",
       "memberOf" : "Roo.bootstrap.Input",
-      "values" : []
+      "optvals" : []
     },
     {
       "name" : "xattr",
       "type" : "Object",
       "desc" : "extra attributes to add to 'element' (used by builder to store stuff.)",
       "memberOf" : "Roo.bootstrap.Component",
-      "values" : []
+      "optvals" : []
     },
     {
       "name" : "name",
       "type" : "String",
       "desc" : "name of the input",
       "memberOf" : "Roo.bootstrap.Input",
-      "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.bootstrap.Input",
-      "values" : []
+      "optvals" : []
     },
     {
       "name" : "inputValue",
       "type" : "String",
       "desc" : "The value that should go into the generated input element's value when checked.",
       "memberOf" : "Roo.bootstrap.CheckBox",
-      "values" : []
+      "optvals" : []
     },
     {
       "name" : "weight",
       "type" : "String",
-      "desc" : "The text that appears beside the checkbox",
+      "desc" : "s) The text that appears beside the checkbox",
       "memberOf" : "Roo.bootstrap.CheckBox",
-      "values" : [
-        "(primary",
+      "optvals" : [
+        "primary",
         "warning",
         "info",
         "danger",
-        "success)"
+        "success"
       ]
     },
     {
       "type" : "String",
       "desc" : "- default is new-password see: https://developers.google.com/web/fundamentals/input/form/label-and-name-inputs?hl=en",
       "memberOf" : "Roo.bootstrap.Input",
-      "values" : []
+      "optvals" : []
     },
     {
       "name" : "tooltip",
       "type" : "String",
       "desc" : "label tooltip",
       "memberOf" : "Roo.bootstrap.CheckBox",
-      "values" : []
+      "optvals" : []
     },
     {
       "name" : "labelAlign",
       "type" : "String",
-      "desc" : "",
+      "desc" : "t)",
       "memberOf" : "Roo.bootstrap.Input",
-      "values" : [
-        "(top",
-        "left)"
+      "optvals" : [
+        "top",
+        "left"
       ]
     },
     {
       "type" : "String",
       "desc" : "-- Depricated - use Invalid Text",
       "memberOf" : "Roo.bootstrap.Input",
-      "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" : "boxLabel",
       "type" : "String",
       "desc" : "The text that appears beside the checkbox",
       "memberOf" : "Roo.bootstrap.CheckBox",
-      "values" : []
+      "optvals" : []
     },
     {
       "name" : "style",
       "type" : "String",
       "desc" : "any extra css",
       "memberOf" : "Roo.bootstrap.Component",
-      "values" : []
+      "optvals" : []
     },
     {
       "name" : "labelmd",
       "type" : "Number",
       "desc" : "set the width of label (1-12)",
       "memberOf" : "Roo.bootstrap.Input",
-      "values" : []
+      "optvals" : []
     },
     {
       "name" : "value",
       "type" : "string",
       "desc" : "default value of the input",
       "memberOf" : "Roo.bootstrap.Input",
-      "values" : []
+      "optvals" : []
     },
     {
       "name" : "hasFeedback",
       "type" : "Boolean",
-      "desc" : "default true",
+      "desc" : "e) default true",
       "memberOf" : "Roo.bootstrap.Input",
-      "values" : [
-        "(true",
-        "false)"
+      "optvals" : [
+        "true",
+        "false"
       ]
     },
     {
       "type" : "String",
       "desc" : "which property holds the 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" : "sm",
       "type" : "Number",
       "desc" : "colspan out of 12 for tablet-sized screens",
       "memberOf" : "Roo.bootstrap.Input",
-      "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.bootstrap.Input",
-      "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.bootstrap.Input",
-      "values" : []
+      "optvals" : []
     },
     {
       "name" : "groupId",
       "type" : "String",
       "desc" : "the checkbox group id // normal just use for checkbox",
       "memberOf" : "Roo.bootstrap.CheckBox",
-      "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" : "container_method",
       "type" : "string",
       "desc" : "method to fetch parents container element (used by NavHeaderbar -  getHeaderChildContainer)",
       "memberOf" : "Roo.bootstrap.Component",
-      "values" : []
+      "optvals" : []
     },
     {
       "name" : "readOnly",
       "type" : "Boolean",
       "desc" : "Specifies that the field should be read-only",
       "memberOf" : "Roo.bootstrap.Input",
-      "values" : []
+      "optvals" : []
     },
     {
       "name" : "indicatorpos",
       "type" : "String",
-      "desc" : "default left",
+      "desc" : "t) default left",
       "memberOf" : "Roo.bootstrap.Input",
-      "values" : [
-        "(left",
-        "right)"
+      "optvals" : [
+        "left",
+        "right"
       ]
     },
     {
       "name" : "align",
       "type" : "String",
-      "desc" : "Default left",
+      "desc" : "t) Default left",
       "memberOf" : "Roo.bootstrap.Input",
-      "values" : [
-        "(left",
+      "optvals" : [
+        "left",
         "center",
-        "right)"
+        "right"
       ]
     },
     {
       "type" : "Boolean",
       "desc" : "initnal the element",
       "memberOf" : "Roo.bootstrap.CheckBox",
-      "values" : []
+      "optvals" : []
     },
     {
       "name" : "inline",
       "type" : "Boolean",
       "desc" : "inline the element (default false)",
       "memberOf" : "Roo.bootstrap.CheckBox",
-      "values" : []
+      "optvals" : []
     },
     {
       "name" : "size",
       "type" : "string",
       "desc" : "- (lg|sm) or leave empty..",
       "memberOf" : "Roo.bootstrap.Input",
-      "values" : []
+      "optvals" : []
     },
     {
       "name" : "focusClass",
       "type" : "String",
       "desc" : "The CSS class to use when the field receives focus (defaults to \"x-form-focus\")",
       "memberOf" : "Roo.bootstrap.Input",
-      "values" : []
+      "optvals" : []
     },
     {
       "name" : "labellg",
       "type" : "Number",
       "desc" : "set the width of label (1-12)",
       "memberOf" : "Roo.bootstrap.Input",
-      "values" : []
+      "optvals" : []
     },
     {
       "name" : "labelxs",
       "type" : "Number",
       "desc" : "set the width of label (1-12)",
       "memberOf" : "Roo.bootstrap.Input",
-      "values" : []
+      "optvals" : []
     },
     {
       "name" : "validateOnBlur",
       "type" : "Boolean",
       "desc" : "Whether the field should validate when it loses focus (defaults to true).",
       "memberOf" : "Roo.bootstrap.Input",
-      "values" : []
+      "optvals" : []
     },
     {
       "name" : "cls",
       "type" : "String",
       "desc" : "css class",
       "memberOf" : "Roo.bootstrap.Component",
-      "values" : []
+      "optvals" : []
     },
     {
       "name" : "invalidClass",
       "type" : "String",
       "desc" : "DEPRICATED - code uses BS4 - is-valid / is-invalid",
       "memberOf" : "Roo.bootstrap.Input",
-      "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.bootstrap.Input",
-      "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.bootstrap.Input",
-      "values" : []
+      "optvals" : []
     },
     {
       "name" : "vtype",
       "type" : "String",
       "desc" : "A validation type name as defined in {@link Roo.form.VTypes} (defaults to null)",
       "memberOf" : "Roo.bootstrap.Input",
-      "values" : []
+      "optvals" : []
     },
     {
       "name" : "fieldLabel",
       "type" : "string",
       "desc" : "- the label associated",
       "memberOf" : "Roo.bootstrap.Input",
-      "values" : []
+      "optvals" : []
     },
     {
       "name" : "can_build_overlaid",
       "type" : "Boolean",
       "desc" : "True if element can be rebuild from a HTML page",
       "memberOf" : "Roo.bootstrap.Component",
-      "values" : []
+      "optvals" : []
     },
     {
       "name" : "before",
       "type" : "string",
       "desc" : "- input group add on before",
       "memberOf" : "Roo.bootstrap.Input",
-      "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.bootstrap.Input",
-      "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.bootstrap.Input",
-      "values" : []
+      "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.Input",
-      "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" : "invalidFeedbackIcon",
       "type" : "String",
       "desc" : "The CSS class to use when create feedback icon (defaults to \"x-form-invalid\")",
       "memberOf" : "Roo.bootstrap.Input",
-      "values" : []
+      "optvals" : []
     },
     {
       "name" : "visibilityEl",
       "type" : "string|object",
-      "desc" : "What element to use for visibility (@see getVisibilityEl())",
+      "desc" : "t) What element to use for visibility (@see getVisibilityEl())",
       "memberOf" : "Roo.bootstrap.Component",
-      "values" : [
-        "(el",
-        "parent)"
+      "optvals" : [
+        "el",
+        "parent"
       ]
     },
     {
       "type" : "string",
       "desc" : "- placeholder to put in text.",
       "memberOf" : "Roo.bootstrap.Input",
-      "values" : []
+      "optvals" : []
     },
     {
       "name" : "dataId",
       "type" : "string",
       "desc" : "cutomer id",
       "memberOf" : "Roo.bootstrap.Component",
-      "values" : []
+      "optvals" : []
     },
     {
       "name" : "md",
       "type" : "Number",
       "desc" : "colspan out of 12 for computer-sized screens",
       "memberOf" : "Roo.bootstrap.Input",
-      "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.bootstrap.Input",
-      "values" : []
+      "optvals" : []
     },
     {
       "name" : "labelWidth",
       "type" : "Number",
       "desc" : "set the width of label",
       "memberOf" : "Roo.bootstrap.Input",
-      "values" : []
+      "optvals" : []
     },
     {
       "name" : "minLength",
       "type" : "Number",
       "desc" : "Minimum input field length required (defaults to 0)",
       "memberOf" : "Roo.bootstrap.Input",
-      "values" : []
+      "optvals" : []
     },
     {
       "name" : "capture",
       "type" : "String",
-      "desc" : "use for file input only. (default empty)",
+      "desc" : "a) use for file input only. (default empty)",
       "memberOf" : "Roo.bootstrap.Input",
-      "values" : [
-        "(user",
-        "camera)"
+      "optvals" : [
+        "user",
+        "camera"
       ]
     },
     {
       "type" : "String",
       "desc" : "DEPRICATED - code uses BS4 - is-valid / is-invalid",
       "memberOf" : "Roo.bootstrap.Input",
-      "values" : []
+      "optvals" : []
     },
     {
       "name" : "allowBlank",
       "type" : "Boolean",
       "desc" : "False to validate that the value length > 0 (defaults to true)",
       "memberOf" : "Roo.bootstrap.Input",
-      "values" : []
+      "optvals" : []
     },
     {
       "name" : "valueOff",
       "type" : "String",
       "desc" : "The value that should go into the generated input element's value when unchecked.",
       "memberOf" : "Roo.bootstrap.CheckBox",
-      "values" : []
+      "optvals" : []
     },
     {
       "name" : "preventMark",
       "type" : "Boolean",
       "desc" : "Do not show tick or cross if error/success",
       "memberOf" : "Roo.bootstrap.Input",
-      "values" : []
+      "optvals" : []
     },
     {
       "name" : "forceFeedback",
       "type" : "Boolean",
-      "desc" : "Default false",
+      "desc" : "e) Default false",
       "memberOf" : "Roo.bootstrap.Input",
-      "values" : [
-        "(true",
-        "false)"
+      "optvals" : [
+        "true",
+        "false"
       ]
     },
     {
       "type" : "Number",
       "desc" : "set the width of label (1-12)",
       "memberOf" : "Roo.bootstrap.Input",
-      "values" : []
+      "optvals" : []
     },
     {
       "name" : "after",
       "type" : "string",
       "desc" : "- input group add on after",
       "memberOf" : "Roo.bootstrap.Input",
-      "values" : []
+      "optvals" : []
     },
     {
       "name" : "maxLength",
       "type" : "Number",
       "desc" : "Maximum input field length allowed (defaults to Number.MAX_VALUE)",
       "memberOf" : "Roo.bootstrap.Input",
-      "values" : []
+      "optvals" : []
     },
     {
       "name" : "invalidText",
       "type" : "String",
       "desc" : "The error text to display if {@link #validator} test fails during validation (defaults to \"\")",
       "memberOf" : "Roo.bootstrap.Input",
-      "values" : []
+      "optvals" : []
     }
   ],
   "methods" : [