Palete/rooprops.json
authorAlan Knowles <alan@roojs.com>
Wed, 2 May 2012 06:22:37 +0000 (14:22 +0800)
committerAlan Knowles <alan@roojs.com>
Wed, 2 May 2012 06:22:37 +0000 (14:22 +0800)
Palete/rooprops.json

index 25f6c7f..b8b8382 100644 (file)
      "name": "removeMask",
      "type": "Boolean",
      "desc": "True to create a single-use mask that is automatically destroyed after loading (useful for page loads),\nFalse to persist the mask element reference for multiple uses (e.g., for paged data widgets).  Defaults to false.",
-     "memberOf": "Roo"
+     "memberOf": ""
     },
     {
      "name": "msg",
      "name": "items",
      "type": "Array",
      "desc": "array of button configs or elements to add (will be converted to a MixedCollection)",
-     "memberOf": "Roo"
+     "memberOf": "Roo.Toolbar"
     }
    ],
    "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": "Roo"
+     "memberOf": ""
     },
     {
      "name": "offset",
      "name": "items",
      "type": "Array",
      "desc": "array of button configs or elements to add (will be converted to a MixedCollection)",
-     "memberOf": "Roo"
+     "memberOf": ""
     },
     {
      "name": "container",
      "name": "tree",
      "type": "Roo.tree.TreePanel",
      "desc": "The tree TreePanel, with config etc.",
-     "memberOf": "Roo"
+     "memberOf": ""
     },
     {
      "name": "fitToFrame",
   "Roo.form.ComboBoxArray": {
    "props": [
     {
-     "name": "boxWidth",
-     "type": "Number",
-     "desc": "The width of the box that displays the selected element",
+     "name": "combo",
+     "type": "Roo.form.Combo",
+     "desc": "The combo box that is wrapped",
      "memberOf": ""
     },
     {
-     "name": "transform",
-     "type": "String/HTMLElement/Element",
-     "desc": "The id, DOM node or element of an existing select to convert to a ComboBox",
-     "memberOf": "Roo.form.ComboBox"
-    },
-    {
-     "name": "lazyRender",
-     "type": "Boolean",
-     "desc": "True to prevent the ComboBox from rendering until requested (should always be used when\nrendering into an Roo.Editor, defaults to false)",
-     "memberOf": "Roo.form.ComboBox"
-    },
-    {
-     "name": "autoCreate",
-     "type": "Boolean/Object",
-     "desc": "A DomHelper element spec, or true for a default element spec (defaults to:\n{tag: \"input\", type: \"text\", size: \"24\", autocomplete: \"off\"})",
-     "memberOf": "Roo.form.ComboBox"
-    },
-    {
-     "name": "store",
-     "type": "Roo.data.Store",
-     "desc": "The data store to which this combo is bound (defaults to undefined)",
-     "memberOf": "Roo.form.ComboBox"
+     "name": "width",
+     "type": "Number",
+     "desc": "The width of the box that displays the selected element",
+     "memberOf": ""
     },
     {
-     "name": "title",
+     "name": "name",
      "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"
+     "desc": "The name of the visable items on this form (eg. titles not ids)",
+     "memberOf": ""
     },
     {
      "name": "grow",
      "type": "Boolean",
-     "desc": "",
-     "memberOf": "Roo.form.ComboBox"
+     "desc": "True if this field should automatically grow and shrink to its content",
+     "memberOf": "Roo.form.TextField"
     },
     {
      "name": "growMin",
      "type": "Number",
-     "desc": "",
-     "memberOf": "Roo.form.ComboBox"
+     "desc": "The minimum width to allow when grow = true (defaults to 30)",
+     "memberOf": "Roo.form.TextField"
     },
     {
      "name": "growMax",
      "type": "Number",
-     "desc": "",
-     "memberOf": "Roo.form.ComboBox"
-    },
-    {
-     "name": "tpl",
-     "type": "String/Roo.Template",
-     "desc": "The template to use to render the output",
-     "memberOf": "Roo.form.ComboBox"
-    },
-    {
-     "name": "listWidth",
-     "type": "Number",
-     "desc": "The width in pixels of the dropdown list (defaults to the width of the ComboBox field)",
-     "memberOf": "Roo.form.ComboBox"
-    },
-    {
-     "name": "displayField",
-     "type": "String",
-     "desc": "The underlying data field name to bind to this CombBox (defaults to undefined if\nmode = 'remote' or 'text' if mode = 'local')",
-     "memberOf": "Roo.form.ComboBox"
-    },
-    {
-     "name": "valueField",
-     "type": "String",
-     "desc": "The underlying data value name to bind to this CombBox (defaults to undefined if\nmode = 'remote' or 'value' if mode = 'local'). \nNote: use of a valueField requires the user make a selection\nin order for a value to be mapped.",
-     "memberOf": "Roo.form.ComboBox"
-    },
-    {
-     "name": "hiddenName",
-     "type": "String",
-     "desc": "If specified, a hidden form field with this name is dynamically generated to store the\nfield's data value (defaults to the underlying DOM element's name)",
-     "memberOf": "Roo.form.ComboBox"
-    },
-    {
-     "name": "listClass",
-     "type": "String",
-     "desc": "CSS class to apply to the dropdown list element (defaults to '')",
-     "memberOf": "Roo.form.ComboBox"
-    },
-    {
-     "name": "selectedClass",
-     "type": "String",
-     "desc": "CSS class to apply to the selected item in the dropdown list (defaults to 'x-combo-selected')",
-     "memberOf": "Roo.form.ComboBox"
-    },
-    {
-     "name": "triggerClass",
-     "type": "String",
-     "desc": "An additional CSS class used to style the trigger button.  The trigger will always get the\nclass 'x-form-trigger' and triggerClass will be <b>appended</b> if specified (defaults to 'x-form-arrow-trigger'\nwhich displays a downward arrow icon).",
-     "memberOf": "Roo.form.ComboBox"
-    },
-    {
-     "name": "shadow",
-     "type": "Boolean/String",
-     "desc": "True or \"sides\" for the default effect, \"frame\" for 4-way shadow, and \"drop\" for bottom-right",
-     "memberOf": "Roo.form.ComboBox"
-    },
-    {
-     "name": "listAlign",
-     "type": "String",
-     "desc": "A valid anchor position value. See {@link Roo.Element#alignTo} for details on supported\nanchor positions (defaults to 'tl-bl')",
-     "memberOf": "Roo.form.ComboBox"
-    },
-    {
-     "name": "maxHeight",
-     "type": "Number",
-     "desc": "The maximum height in pixels of the dropdown list before scrollbars are shown (defaults to 300)",
-     "memberOf": "Roo.form.ComboBox"
-    },
-    {
-     "name": "triggerAction",
-     "type": "String",
-     "desc": "The action to execute when the trigger field is activated.  Use 'all' to run the\nquery specified by the allQuery config option (defaults to 'query')",
-     "memberOf": "Roo.form.ComboBox"
-    },
-    {
-     "name": "minChars",
-     "type": "Number",
-     "desc": "The minimum number of characters the user must type before autocomplete and typeahead activate\n(defaults to 4, does not apply if editable = false)",
-     "memberOf": "Roo.form.ComboBox"
-    },
-    {
-     "name": "typeAhead",
-     "type": "Boolean",
-     "desc": "True to populate and autoselect the remainder of the text being typed after a configurable\ndelay (typeAheadDelay) if it matches a known value (defaults to false)",
-     "memberOf": "Roo.form.ComboBox"
-    },
-    {
-     "name": "queryDelay",
-     "type": "Number",
-     "desc": "The length of time in milliseconds to delay between the start of typing and sending the\nquery to filter the dropdown list (defaults to 500 if mode = 'remote' or 10 if mode = 'local')",
-     "memberOf": "Roo.form.ComboBox"
-    },
-    {
-     "name": "pageSize",
-     "type": "Number",
-     "desc": "If greater than 0, a paging toolbar is displayed in the footer of the dropdown list and the\nfilter queries will execute with page start and limit parameters.  Only applies when mode = 'remote' (defaults to 0)",
-     "memberOf": "Roo.form.ComboBox"
-    },
-    {
-     "name": "selectOnFocus",
-     "type": "Boolean",
-     "desc": "True to select any existing text in the field immediately on focus.  Only applies\nwhen editable = true (defaults to false)",
-     "memberOf": "Roo.form.ComboBox"
-    },
-    {
-     "name": "queryParam",
-     "type": "String",
-     "desc": "Name of the query as it will be passed on the querystring (defaults to 'query')",
-     "memberOf": "Roo.form.ComboBox"
-    },
-    {
-     "name": "loadingText",
-     "type": "String",
-     "desc": "The text to display in the dropdown list while data is loading.  Only applies\nwhen mode = 'remote' (defaults to 'Loading...')",
-     "memberOf": "Roo.form.ComboBox"
-    },
-    {
-     "name": "resizable",
-     "type": "Boolean",
-     "desc": "True to add a resize handle to the bottom of the dropdown list (defaults to false)",
-     "memberOf": "Roo.form.ComboBox"
-    },
-    {
-     "name": "handleHeight",
-     "type": "Number",
-     "desc": "The height in pixels of the dropdown list resize handle if resizable = true (defaults to 8)",
-     "memberOf": "Roo.form.ComboBox"
-    },
-    {
-     "name": "editable",
-     "type": "Boolean",
-     "desc": "False to prevent the user from typing text directly into the field, just like a\ntraditional select (defaults to true)",
-     "memberOf": "Roo.form.ComboBox"
-    },
-    {
-     "name": "allQuery",
-     "type": "String",
-     "desc": "The text query to send to the server to return all records for the list with no filtering (defaults to '')",
-     "memberOf": "Roo.form.ComboBox"
-    },
-    {
-     "name": "mode",
-     "type": "String",
-     "desc": "Set to 'local' if the ComboBox loads local data (defaults to 'remote' which loads from the server)",
-     "memberOf": "Roo.form.ComboBox"
-    },
-    {
-     "name": "minListWidth",
-     "type": "Number",
-     "desc": "The minimum width of the dropdown list in pixels (defaults to 70, will be ignored if\nlistWidth has a higher value)",
-     "memberOf": "Roo.form.ComboBox"
-    },
-    {
-     "name": "forceSelection",
-     "type": "Boolean",
-     "desc": "True to restrict the selected value to one of the values in the list, false to\nallow the user to set arbitrary text into the field (defaults to false)",
-     "memberOf": "Roo.form.ComboBox"
-    },
-    {
-     "name": "typeAheadDelay",
-     "type": "Number",
-     "desc": "The length of time in milliseconds to wait until the typeahead text is displayed\nif typeAhead = true (defaults to 250)",
-     "memberOf": "Roo.form.ComboBox"
-    },
-    {
-     "name": "valueNotFoundText",
-     "type": "String",
-     "desc": "When using a name/value combo, if the value passed to setValue is not found in\nthe store, valueNotFoundText will be displayed as the field text if defined (defaults to undefined)",
-     "memberOf": "Roo.form.ComboBox"
-    },
-    {
-     "name": "blockFocus",
-     "type": "Boolean",
-     "desc": "Prevents all focus calls, so it can work with things like HTML edtor bar",
-     "memberOf": "Roo.form.ComboBox"
-    },
-    {
-     "name": "disableClear",
-     "type": "Boolean",
-     "desc": "Disable showing of clear button.",
-     "memberOf": "Roo.form.ComboBox"
-    },
-    {
-     "name": "alwaysQuery",
-     "type": "Boolean",
-     "desc": "Disable caching of results, and always send query",
-     "memberOf": "Roo.form.ComboBox"
-    },
-    {
-     "name": "hideTrigger",
-     "type": "Boolean",
-     "desc": "True to hide the trigger element and display only the base text field (defaults to false)",
-     "memberOf": "Roo.form.TriggerField"
+     "desc": "The maximum width to allow when grow = true (defaults to 800)",
+     "memberOf": "Roo.form.TextField"
     },
     {
      "name": "vtype",
      "desc": "Error text to display if the maximum length validation fails (defaults to \"The maximum length for this field is {maxLength}\")",
      "memberOf": "Roo.form.TextField"
     },
+    {
+     "name": "selectOnFocus",
+     "type": "Boolean",
+     "desc": "True to automatically select any existing field text when the field receives input focus (defaults to false)",
+     "memberOf": "Roo.form.TextField"
+    },
     {
      "name": "blankText",
      "type": "String",
      "desc": "Mouse over tip",
      "memberOf": "Roo.form.Field"
     },
-    {
-     "name": "name",
-     "type": "String",
-     "desc": "The field's HTML name attribute.",
-     "memberOf": "Roo.form.Field"
-    },
     {
      "name": "invalidClass",
      "type": "String",
      "desc": "The length of time in milliseconds after user input begins until validation is initiated (defaults to 250)",
      "memberOf": "Roo.form.Field"
     },
+    {
+     "name": "autoCreate",
+     "type": "String/Object",
+     "desc": "A DomHelper element spec, or true for a default element spec (defaults to\n{tag: \"input\", type: \"text\", size: \"20\", autocomplete: \"off\"})",
+     "memberOf": "Roo.form.Field"
+    },
     {
      "name": "fieldClass",
      "type": "String",
      "desc": "A CSS class to apply to the field's underlying element.",
      "memberOf": "Roo.form.Field"
     },
-    {
-     "name": "width",
-     "type": "Number",
-     "desc": "width (optional) size of component",
-     "memberOf": "Roo.BoxComponent"
-    },
     {
      "name": "height",
      "type": "Number",
     }
    ],
    "events": [
-    {
-     "name": "add",
-     "sig": "function (combo)\n{\n\n}",
-     "type": "function",
-     "desc": "Fires when the 'add' icon is pressed (add a listener to enable add button)"
-    },
     {
      "name": "autosize",
      "sig": "function (_self, width)\n{\n\n}",
      "type": "function",
      "desc": "Fires before the component is hidden. Return false to stop the hide."
     },
-    {
-     "name": "beforequery",
-     "sig": "function (combo, query, forceAll, cancel, e)\n{\n\n}",
-     "type": "function",
-     "desc": "Fires before all queries are processed. Return false to cancel the query or set cancel to true.\nThe event object passed has these properties:"
-    },
     {
      "name": "beforerender",
      "sig": "function (_self)\n{\n\n}",
      "type": "function",
      "desc": "Fires before the component is rendered. Return false to stop the render."
     },
-    {
-     "name": "beforeselect",
-     "sig": "function (combo, record, index)\n{\n\n}",
-     "type": "function",
-     "desc": "Fires before a list item is selected. Return false to cancel the selection."
-    },
     {
      "name": "beforeshow",
      "sig": "function (_self)\n{\n\n}",
      "type": "function",
      "desc": "Fires just before the field blurs if the field value has changed."
     },
-    {
-     "name": "collapse",
-     "sig": "function (combo)\n{\n\n}",
-     "type": "function",
-     "desc": "Fires when the dropdown list is collapsed"
-    },
     {
      "name": "destroy",
      "sig": "function (_self)\n{\n\n}",
      "type": "function",
      "desc": "Fires after the component is disabled."
     },
-    {
-     "name": "edit",
-     "sig": "function (combo, record)\n{\n\n}",
-     "type": "function",
-     "desc": "Fires when the 'edit' icon is pressed (add a listener to enable add button)"
-    },
     {
      "name": "enable",
      "sig": "function (_self)\n{\n\n}",
      "type": "function",
      "desc": "Fires after the component is enabled."
     },
-    {
-     "name": "expand",
-     "sig": "function (combo)\n{\n\n}",
-     "type": "function",
-     "desc": "Fires when the dropdown list is expanded"
-    },
     {
      "name": "focus",
      "sig": "function (_self)\n{\n\n}",
      "type": "function",
      "desc": "Fires after the component is resized."
     },
-    {
-     "name": "select",
-     "sig": "function (combo, record, index)\n{\n\n}",
-     "type": "function",
-     "desc": "Fires when a list item is selected"
-    },
     {
      "name": "show",
      "sig": "function (_self)\n{\n\n}",