{
"name": "panel",
"type": "String",
- "desc": "render as a panel.",
+ "desc": "render as panel - type - primary/success.....",
"memberOf": "",
"optvals": [
"primary",
"desc": "contet on the right of header",
"memberOf": ""
},
+ {
+ "name": "clickable",
+ "type": "Boolean",
+ "desc": "default false",
+ "memberOf": "",
+ "optvals": [
+ "true",
+ "false"
+ ]
+ },
{
"name": "cls",
"type": "String",
"type": "function",
"desc": "Fires when the children have been rendered.."
},
+ {
+ "name": "click",
+ "sig": "function (_self, e)\n{\n\n}",
+ "type": "function",
+ "desc": "When a element is chick"
+ },
{
"name": "collapse",
"sig": "function (_self)\n{\n\n}",
}
]
},
- "Roo.form": {
- "props": [],
- "events": [],
- "methods": []
- },
- "Roo.form.Action": {
+ "Roo.doc": {
"props": [],
"events": [],
"methods": []
},
- "Roo.form.BasicForm": {
+ "Roo.doc.Entry": {
"props": [
{
- "name": "method",
+ "name": "cls",
"type": "String",
- "desc": "The request method to use (GET or POST) for form actions if one isn't supplied in the action options.",
- "memberOf": ""
- },
- {
- "name": "reader",
- "type": "DataReader",
- "desc": "An Roo.data.DataReader (e.g. {@link Roo.data.XmlReader}) to be used to read data when executing \"load\" actions.\nThis is optional as there is built-in support for processing JSON.",
- "memberOf": ""
- },
- {
- "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": ""
+ "desc": "css class",
+ "memberOf": "Roo.bootstrap.Component"
},
{
- "name": "url",
+ "name": "style",
"type": "String",
- "desc": "The URL to use for form actions if one isn't supplied in the action options.",
- "memberOf": ""
- },
- {
- "name": "fileUpload",
- "type": "Boolean",
- "desc": "Set to true if this form is a file upload.",
- "memberOf": ""
- },
- {
- "name": "baseParams",
- "type": "Object",
- "desc": "Parameters to pass with all requests. e.g. baseParams: {id: '123', foo: 'bar'}.",
- "memberOf": ""
- },
- {
- "name": "timeout",
- "type": "Number",
- "desc": "Timeout for form actions in seconds (default is 30 seconds).",
- "memberOf": ""
- },
- {
- "name": "trackResetOnLoad",
- "type": "Boolean",
- "desc": "If set to true, form.reset() resets to the last loaded\nor setValues() data instead of when the form was first created.",
- "memberOf": ""
+ "desc": "any extra css",
+ "memberOf": "Roo.bootstrap.Component"
},
{
- "name": "listeners",
+ "name": "xattr",
"type": "Object",
- "desc": "list of events and functions to call for 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": "actioncomplete",
- "sig": "function (_self, action)\n{\n\n}",
- "type": "function",
- "desc": "Fires when an action is completed."
- },
- {
- "name": "actionfailed",
- "sig": "function (_self, action)\n{\n\n}",
- "type": "function",
- "desc": "Fires when an action fails."
- },
- {
- "name": "beforeaction",
- "sig": "function (_self, action)\n{\n\n}",
- "type": "function",
- "desc": "Fires before any action is performed. Return false to cancel the action."
- }
- ],
- "methods": [
- {
- "name": "add",
- "sig": "(Field field1, Field field2, Field etc)",
- "type": "function",
- "desc": "Add Roo.form components to this form."
- },
- {
- "name": "addEvents",
- "sig": "(Object object)",
- "type": "function",
- "desc": "Used to define events on this Observable"
- },
- {
- "name": "addForm",
- "sig": "(Roo.form.Form form)",
- "type": "function",
- "desc": "Add a secondary form to this one, \nUsed to provide tabbed forms. One form is primary, with hidden values \nwhich mirror the elements from the other forms."
- },
- {
- "name": "addListener",
- "sig": "(String eventName, Function handler, Object scope, Object options)",
- "type": "function",
- "desc": "Appends an event handler to this component"
- },
- {
- "name": "applyIfToFields",
- "sig": "(Object values)",
- "type": "function",
- "desc": "Calls {@link Ext#applyIf} for all field in this form with the passed object."
- },
- {
- "name": "applyToFields",
- "sig": "(Object values)",
- "type": "function",
- "desc": "Calls {@link Ext#apply} for all fields in this form with the passed object."
- },
- {
- "name": "capture",
- "sig": "(Observable o, Function fn, Object scope)",
- "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."
- },
- {
- "name": "clearInvalid",
- "sig": "()",
- "type": "function",
- "desc": "Clears all invalid messages in this form."
- },
- {
- "name": "doAction",
- "sig": "(String actionName, Object options)",
- "type": "function",
- "desc": "Performs a predefined action (submit or load) or custom actions you define on this form."
- },
- {
- "name": "findField",
- "sig": "(String id)",
- "type": "function",
- "desc": "Find a Roo.form.Field in this form by id, dataIndex, name or hiddenName"
- },
- {
- "name": "fireEvent",
- "sig": "(String eventName, Object... args)",
- "type": "function",
- "desc": "Fires the specified event with the passed parameters (minus the event name)."
- },
- {
- "name": "getFieldValues",
- "sig": "()",
- "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."
- },
- {
- "name": "getValues",
- "sig": "(Boolean asString)",
- "type": "function",
- "desc": "Returns the fields in this form as an object with key/value pairs. If multiple fields exist with the same name\nthey are returned as an array."
- },
- {
- "name": "hasListener",
- "sig": "(String eventName)",
- "type": "function",
- "desc": "Checks to see if this object has any listeners for a specified event"
- },
- {
- "name": "isDirty",
- "sig": "()",
- "type": "function",
- "desc": "Returns true if any fields in this form have changed since their original load."
- },
- {
- "name": "isValid",
- "sig": "()",
- "type": "function",
- "desc": "Returns true if client-side validation on the form is successful."
- },
- {
- "name": "load",
- "sig": "(Object options)",
- "type": "function",
- "desc": "Shortcut to do a load action."
- },
- {
- "name": "loadRecord",
- "sig": "(Record record)",
- "type": "function",
- "desc": "Loads an Roo.data.Record into this form."
- },
- {
- "name": "markInvalid",
- "sig": "(Array/Object errors)",
- "type": "function",
- "desc": "Mark fields in this form invalid in bulk."
- },
- {
- "name": "on",
- "sig": "(String eventName, Function handler, Object scope, Object options)",
- "type": "function",
- "desc": "Appends an event handler to this element (shorthand for addListener)"
- },
- {
- "name": "purgeListeners",
- "sig": "()",
- "type": "function",
- "desc": "Removes all listeners for this object"
- },
- {
- "name": "releaseCapture",
- "sig": "(Observable o)",
- "type": "function",
- "desc": "Removes <b>all</b> added captures from the Observable."
- },
- {
- "name": "remove",
- "sig": "(Field field)",
- "type": "function",
- "desc": "Removes a field from the items collection (does NOT remove its markup)."
- },
- {
- "name": "removeListener",
- "sig": "(String eventName, Function handler, Object scope)",
- "type": "function",
- "desc": "Removes a listener"
- },
- {
- "name": "render",
- "sig": "()",
- "type": "function",
- "desc": "Looks at the fields in this form, checks them for an id attribute,\nand calls applyTo on the existing dom element with that id."
- },
- {
- "name": "reset",
- "sig": "()",
- "type": "function",
- "desc": "Resets this form."
- },
- {
- "name": "setValues",
- "sig": "(Array/Object values)",
- "type": "function",
- "desc": "Set values for fields in this form in bulk."
- },
- {
- "name": "submit",
- "sig": "(Object options)",
- "type": "function",
- "desc": "Shortcut to do a submit action."
- },
- {
- "name": "un",
- "sig": "(String eventName, Function handler, Object scope)",
- "type": "function",
- "desc": "Removes a listener (shorthand for removeListener)"
- },
- {
- "name": "updateRecord",
- "sig": "(Record record)",
- "type": "function",
- "desc": "Persists the values in this form into the passed Roo.data.Record object in a beginEdit/endEdit block."
- }
- ]
- },
- "Roo.form.Checkbox": {
- "props": [
- {
- "name": "focusClass",
- "type": "String",
- "desc": "The CSS class to use when the checkbox receives focus (defaults to undefined)",
- "memberOf": ""
- },
- {
- "name": "fieldClass",
- "type": "String",
- "desc": "The default CSS class for the checkbox (defaults to \"x-form-field\")",
- "memberOf": ""
+ "desc": "extra attributes to add to 'element' (used by builder to store stuff.)",
+ "memberOf": "Roo.bootstrap.Component"
},
{
- "name": "checked",
+ "name": "can_build_overlaid",
"type": "Boolean",
- "desc": "True if the the checkbox should render already checked (defaults to false)",
- "memberOf": ""
- },
- {
- "name": "autoCreate",
- "type": "String/Object",
- "desc": "A DomHelper element spec, or true for a default element spec (defaults to\n{tag: \"input\", type: \"checkbox\", autocomplete: \"off\"})",
- "memberOf": ""
- },
- {
- "name": "boxLabel",
- "type": "String",
- "desc": "The text that appears beside the checkbox",
- "memberOf": ""
- },
- {
- "name": "inputValue",
- "type": "String",
- "desc": "The value that should go into the generated input element's value attribute",
- "memberOf": ""
- },
- {
- "name": "valueOff",
- "type": "String",
- "desc": "The value that should go into the generated input element's value when unchecked.",
- "memberOf": ""
- },
- {
- "name": "fieldLabel",
- "type": "String",
- "desc": "Label to use when rendering a form.",
- "memberOf": "Roo.form.Field"
+ "desc": "True if element can be rebuild from a HTML page",
+ "memberOf": "Roo.bootstrap.Component"
},
{
- "name": "qtip",
- "type": "String",
- "desc": "Mouse over tip",
- "memberOf": "Roo.form.Field"
+ "name": "dataId",
+ "type": "string",
+ "desc": "cutomer id",
+ "memberOf": "Roo.bootstrap.Component"
},
{
"name": "name",
- "type": "String",
- "desc": "The field's HTML name attribute.",
- "memberOf": "Roo.form.Field"
- },
- {
- "name": "invalidClass",
- "type": "String",
- "desc": "The CSS class to use when marking a field invalid (defaults to \"x-form-invalid\")",
- "memberOf": "Roo.form.Field"
- },
- {
- "name": "invalidText",
- "type": "String",
- "desc": "The error text to use when marking a field invalid and no message is provided (defaults to \"The value in this field is invalid\")",
- "memberOf": "Roo.form.Field"
- },
- {
- "name": "validationEvent",
- "type": "String/Boolean",
- "desc": "The event that should initiate field validation. Set to false to disable\n automatic validation (defaults to \"keyup\").",
- "memberOf": "Roo.form.Field"
- },
- {
- "name": "validateOnBlur",
- "type": "Boolean",
- "desc": "Whether the field should validate when it loses focus (defaults to true).",
- "memberOf": "Roo.form.Field"
- },
- {
- "name": "validationDelay",
- "type": "Number",
- "desc": "The length of time in milliseconds after user input begins until validation is initiated (defaults to 250)",
- "memberOf": "Roo.form.Field"
- },
- {
- "name": "msgTarget",
- "type": "String",
- "desc": "The location where error text should display. Should be one of the following values (defaults to 'qtip'):\n<pre>\nValue Description\n----------- ----------------------------------------------------------------------\nqtip Display a quick tip when the user hovers over the field\ntitle Display a default browser title attribute popup\nunder Add a block div beneath the field containing the error text\nside Add an error icon to the right of the field with a popup on hover\n[element id] Add the error text directly to the innerHTML of the specified element\n</pre>",
- "memberOf": "Roo.form.Field"
- },
- {
- "name": "msgFx",
- "type": "String",
- "desc": "<b>Experimental</b> The effect used when displaying a validation message under the field (defaults to 'normal').",
- "memberOf": "Roo.form.Field"
- },
- {
- "name": "readOnly",
- "type": "Boolean",
- "desc": "True to mark the field as readOnly in HTML (defaults to false) -- Note: this only sets the element's readOnly DOM attribute.",
- "memberOf": "Roo.form.Field"
- },
- {
- "name": "disabled",
- "type": "Boolean",
- "desc": "True to disable the field (defaults to false).",
- "memberOf": "Roo.form.Field"
- },
- {
- "name": "inputType",
- "type": "String",
- "desc": "The type attribute for input fields -- e.g. radio, text, password (defaults to \"text\").",
- "memberOf": "Roo.form.Field"
- },
- {
- "name": "tabIndex",
- "type": "Number",
- "desc": "The tabIndex for this field. Note this only applies to fields that are rendered, not those which are built via applyTo (defaults to undefined).",
- "memberOf": "Roo.form.Field"
- },
- {
- "name": "value",
- "type": "Mixed",
- "desc": "A value to initialize this field with.",
- "memberOf": "Roo.form.Field"
- },
- {
- "name": "cls",
- "type": "String",
- "desc": "A CSS class to apply to the field's underlying element.",
- "memberOf": "Roo.form.Field"
+ "type": "string",
+ "desc": "Specifies name attribute",
+ "memberOf": "Roo.bootstrap.Component"
},
{
- "name": "width",
- "type": "Number",
- "desc": "width (optional) size of component",
- "memberOf": "Roo.BoxComponent"
+ "name": "tooltip",
+ "type": "string",
+ "desc": "Text for the tooltip",
+ "memberOf": "Roo.bootstrap.Component"
},
{
- "name": "height",
- "type": "Number",
- "desc": "height (optional) size of component",
- "memberOf": "Roo.BoxComponent"
+ "name": "container_method",
+ "type": "string",
+ "desc": "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)",
+ "memberOf": "Roo.bootstrap.Component"
},
{
"name": "disableClass",
"desc": "Fires before the component is shown. Return false to stop the show."
},
{
- "name": "blur",
+ "name": "childrenrendered",
"sig": "function (_self)\n{\n\n}",
"type": "function",
- "desc": "Fires when this field loses input focus."
- },
- {
- "name": "change",
- "sig": "function (_self, newValue, oldValue)\n{\n\n}",
- "type": "function",
- "desc": "Fires just before the field blurs if the field value has changed."
- },
- {
- "name": "check",
- "sig": "function (_self, checked)\n{\n\n}",
- "type": "function",
- "desc": "Fires when the checkbox is checked or unchecked."
+ "desc": "Fires when the children have been rendered.."
},
{
"name": "destroy",
"type": "function",
"desc": "Fires after the component is enabled."
},
- {
- "name": "focus",
- "sig": "function (_self)\n{\n\n}",
- "type": "function",
- "desc": "Fires when this field receives input focus."
- },
{
"name": "hide",
"sig": "function (_self)\n{\n\n}",
"type": "function",
"desc": "Fires after the component is hidden."
},
- {
- "name": "invalid",
- "sig": "function (_self, msg)\n{\n\n}",
- "type": "function",
- "desc": "Fires after the field has been marked as invalid."
- },
- {
- "name": "keyup",
- "sig": "function (_self, e)\n{\n\n}",
- "type": "function",
- "desc": "Fires after the key up"
- },
- {
- "name": "move",
- "sig": "function (_self, x, y)\n{\n\n}",
- "type": "function",
- "desc": "Fires after the component is moved."
- },
{
"name": "render",
"sig": "function (_self)\n{\n\n}",
"type": "function",
"desc": "Fires after the component is rendered."
},
- {
- "name": "resize",
- "sig": "function (_self, adjWidth, adjHeight, rawWidth, rawHeight)\n{\n\n}",
- "type": "function",
- "desc": "Fires after the component is resized."
- },
{
"name": "show",
"sig": "function (_self)\n{\n\n}",
"type": "function",
"desc": "Fires after the component is shown."
- },
- {
- "name": "specialkey",
- "sig": "function (_self, e)\n{\n\n}",
- "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."
- },
- {
- "name": "valid",
- "sig": "function (_self)\n{\n\n}",
- "type": "function",
- "desc": "Fires after the field has been validated with no errors."
}
],
"methods": [
"type": "function",
"desc": "Appends an event handler to this component"
},
- {
- "name": "applyTo",
- "sig": "(String/HTMLElement/Element el)",
- "type": "function",
- "desc": "Apply the behaviors of this component to an existing element. <b>This is used instead of render().</b>"
- },
{
"name": "capture",
"sig": "(Observable o, Function fn, Object scope)",
"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."
},
- {
- "name": "clearInvalid",
- "sig": "()",
- "type": "function",
- "desc": "Clear any invalid styles/messages for this field"
- },
{
"name": "destroy",
"sig": "()",
"desc": "Try to focus this component."
},
{
- "name": "getBox",
- "sig": "(Boolean local)",
+ "name": "getChildContainer",
+ "sig": "()",
"type": "function",
- "desc": "Gets the current box measurements of the component's underlying element."
+ "desc": "Fetch the element to add children to"
},
{
"name": "getEl",
"type": "function",
"desc": "Returns the id of this component."
},
- {
- "name": "getName",
- "sig": "()",
- "type": "function",
- "desc": "Returns the name attribute of the field if available"
- },
- {
- "name": "getPosition",
- "sig": "(Boolean local)",
- "type": "function",
- "desc": "Gets the current XY position of the component's underlying element."
- },
- {
- "name": "getRawValue",
- "sig": "()",
- "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}."
- },
- {
- "name": "getSize",
- "sig": "()",
- "type": "function",
- "desc": "Gets the current size of the component's underlying element."
- },
- {
- "name": "getValue",
- "sig": "()",
- "type": "function",
- "desc": "Returns the checked state of the checkbox."
- },
{
"name": "hasListener",
"sig": "(String eventName)",
"name": "hide",
"sig": "()",
"type": "function",
- "desc": "Hide this component."
+ "desc": "Hide a component - adds 'hidden' class"
},
{
- "name": "isDirty",
+ "name": "initEvents",
"sig": "()",
"type": "function",
- "desc": "Returns true if this field has been changed since it was originally loaded and is not disabled."
- },
- {
- "name": "isValid",
- "sig": "(Boolean preventMark)",
- "type": "function",
- "desc": "Returns whether or not the field value is currently valid"
+ "desc": "Initialize Events for the element"
},
{
"name": "isVisible",
"type": "function",
"desc": "Returns true if this component is visible."
},
- {
- "name": "markInvalid",
- "sig": "(String msg)",
- "type": "function",
- "desc": "Mark this field as invalid"
- },
{
"name": "on",
"sig": "(String eventName, Function handler, Object scope, Object options)",
"type": "function",
"desc": "Appends an event handler to this element (shorthand for addListener)"
},
- {
- "name": "onPosition",
- "sig": "(Number x, Number y)",
- "type": "function",
- "desc": "Called after the component is moved, this method is empty by default but can be implemented by any\nsubclass that needs to perform custom logic after a move occurs."
- },
- {
- "name": "onResize",
- "sig": "(Number adjWidth, Number adjHeight, Number rawWidth, Number rawHeight)",
- "type": "function",
- "desc": "Called after the component is resized, this method is empty by default but can be implemented by any\nsubclass that needs to perform custom logic after a resize occurs."
- },
{
"name": "purgeListeners",
"sig": "()",
"type": "function",
"desc": "If this is a lazy rendering component, render it to its container element."
},
- {
- "name": "reset",
- "sig": "()",
- "type": "function",
- "desc": "Resets the current field value to the originally loaded value and clears any validation messages"
- },
{
"name": "setDisabled",
"sig": "(Boolean disabled)",
"type": "function",
"desc": "Convenience function for setting disabled/enabled by boolean."
},
- {
- "name": "setPagePosition",
- "sig": "(Number x, Number y)",
- "type": "function",
- "desc": "Sets the page XY position of the component. To set the left and top instead, use {@link #setPosition}.\nThis method fires the move event."
- },
- {
- "name": "setPosition",
- "sig": "(Number left, Number top)",
- "type": "function",
- "desc": "Sets the left and top of the component. To set the page XY position instead, use {@link #setPagePosition}.\nThis method fires the move event."
- },
- {
- "name": "setRawValue",
- "sig": "(Mixed value)",
- "type": "function",
- "desc": "Sets the underlying DOM field's value directly, bypassing validation. To set the value with validation see {@link #setValue}."
- },
- {
- "name": "setSize",
- "sig": "(Number/Object width, Number height)",
- "type": "function",
- "desc": "Sets the width and height of the component. This method fires the resize event. This method can accept\neither width and height as separate numeric arguments, or you can pass a size object like {width:10, height:20}."
- },
- {
- "name": "setValue",
- "sig": "(Boolean/String value, Boolean/String suppressEvent)",
- "type": "function",
- "desc": "Sets the checked state of the checkbox.\nOn is always based on a string comparison between inputValue and the param."
- },
{
"name": "setVisible",
"sig": "(Boolean visible)",
"name": "show",
"sig": "()",
"type": "function",
- "desc": "Show this component."
+ "desc": "Show a component - removes 'hidden' class"
},
{
- "name": "syncSize",
+ "name": "tooltipEl",
"sig": "()",
"type": "function",
- "desc": "Force the component's size to recalculate based on the underlying element's current height and width."
+ "desc": "Fetch the element to display the tooltip on."
},
{
"name": "un",
"sig": "(String eventName, Function handler, Object scope)",
"type": "function",
"desc": "Removes a listener (shorthand for removeListener)"
- },
+ }
+ ]
+ },
+ "Roo.doc.Example": {
+ "props": [
{
- "name": "updateBox",
- "sig": "(Object box)",
- "type": "function",
- "desc": "Sets the current box measurements of the component's underlying element."
+ "name": "lang",
+ "type": "String",
+ "desc": "section type.",
+ "memberOf": "",
+ "optvals": [
+ "phpcode",
+ "programlisting"
+ ]
},
{
- "name": "validate",
- "sig": "()",
- "type": "function",
- "desc": "Validates the field value"
+ "name": "code",
+ "type": "String",
+ "desc": "",
+ "memberOf": ""
}
- ]
+ ],
+ "events": [],
+ "methods": []
},
- "Roo.form.Column": {
+ "Roo.doc.Para": {
"props": [
{
- "name": "width",
- "type": "Number/String",
- "desc": "The fixed width of the column in pixels or CSS value (defaults to \"auto\")",
+ "name": "html",
+ "type": "String",
+ "desc": "",
"memberOf": ""
},
{
- "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": ""
+ "name": "cls",
+ "type": "String",
+ "desc": "css class",
+ "memberOf": "Roo.bootstrap.Component"
},
{
"name": "style",
- "type": "String/Object/Function",
- "desc": "A style specification string, e.g. \"width:100px\", or object in the form {width:\"100px\"}, or\na function which returns such a specification.",
- "memberOf": "Roo.form.Layout"
- },
- {
- "name": "labelAlign",
"type": "String",
- "desc": "Valid values are \"left,\" \"top\" and \"right\" (defaults to \"left\")",
- "memberOf": "Roo.form.Layout"
+ "desc": "any extra css",
+ "memberOf": "Roo.bootstrap.Component"
},
{
- "name": "labelWidth",
- "type": "Number",
- "desc": "Fixed width in pixels of all field labels (defaults to undefined)",
- "memberOf": "Roo.form.Layout"
+ "name": "xattr",
+ "type": "Object",
+ "desc": "extra attributes to add to 'element' (used by builder to store stuff.)",
+ "memberOf": "Roo.bootstrap.Component"
},
{
- "name": "clear",
+ "name": "can_build_overlaid",
"type": "Boolean",
- "desc": "True to add a clearing element at the end of this layout, equivalent to CSS clear: both (defaults to true)",
- "memberOf": "Roo.form.Layout"
+ "desc": "True if element can be rebuild from a HTML page",
+ "memberOf": "Roo.bootstrap.Component"
},
{
- "name": "labelSeparator",
- "type": "String",
- "desc": "The separator to use after field labels (defaults to ':')",
- "memberOf": "Roo.form.Layout"
+ "name": "dataId",
+ "type": "string",
+ "desc": "cutomer id",
+ "memberOf": "Roo.bootstrap.Component"
},
{
- "name": "hideLabels",
- "type": "Boolean",
- "desc": "True to suppress the display of field labels in this layout (defaults to false)",
- "memberOf": "Roo.form.Layout"
+ "name": "name",
+ "type": "string",
+ "desc": "Specifies name attribute",
+ "memberOf": "Roo.bootstrap.Component"
+ },
+ {
+ "name": "tooltip",
+ "type": "string",
+ "desc": "Text for the tooltip",
+ "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": "disableClass",
"type": "function",
"desc": "Fires before the component is shown. Return false to stop the show."
},
+ {
+ "name": "childrenrendered",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires when the children have been rendered.."
+ },
{
"name": "destroy",
"sig": "function (_self)\n{\n\n}",
"type": "function",
"desc": "Appends an event handler to this component"
},
- {
- "name": "addxtype",
- "sig": "(Object config)",
- "type": "function",
- "desc": "Adds a object form elements (using the xtype property as the factory method.)\nValid xtypes are: TextField, TextArea .... Button, Layout, FieldSet, Column"
- },
{
"name": "capture",
"sig": "(Observable o, Function fn, Object scope)",
"type": "function",
"desc": "Try to focus this component."
},
+ {
+ "name": "getChildContainer",
+ "sig": "()",
+ "type": "function",
+ "desc": "Fetch the element to add children to"
+ },
{
"name": "getEl",
"sig": "()",
"name": "hide",
"sig": "()",
"type": "function",
- "desc": "Hide this component."
+ "desc": "Hide a component - adds 'hidden' class"
+ },
+ {
+ "name": "initEvents",
+ "sig": "()",
+ "type": "function",
+ "desc": "Initialize Events for the element"
},
{
"name": "isVisible",
"name": "show",
"sig": "()",
"type": "function",
- "desc": "Show this component."
+ "desc": "Show a component - removes 'hidden' class"
+ },
+ {
+ "name": "tooltipEl",
+ "sig": "()",
+ "type": "function",
+ "desc": "Fetch the element to display the tooltip on."
},
{
"name": "un",
}
]
},
- "Roo.form.ComboBox": {
+ "Roo.doc.Param": {
"props": [
{
- "name": "transform",
- "type": "String/HTMLElement/Element",
- "desc": "The id, DOM node or element of an existing select to convert to a ComboBox",
+ "name": "is_optional",
+ "type": "bool",
+ "desc": "",
"memberOf": ""
},
{
- "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)",
+ "name": "type",
+ "type": "String",
+ "desc": "argument type",
"memberOf": ""
},
{
- "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\"})",
+ "name": "name",
+ "type": "String",
+ "desc": "",
"memberOf": ""
},
{
- "name": "store",
- "type": "Roo.data.Store",
- "desc": "The data store to which this combo is bound (defaults to undefined)",
+ "name": "desc",
+ "type": "String",
+ "desc": "short description",
"memberOf": ""
},
{
- "name": "title",
+ "name": "defaultvalue",
"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)",
+ "desc": "default value",
"memberOf": ""
},
{
- "name": "grow",
- "type": "Boolean",
- "desc": "",
- "memberOf": ""
+ "name": "cls",
+ "type": "String",
+ "desc": "css class",
+ "memberOf": "Roo.bootstrap.Component"
},
{
- "name": "growMin",
- "type": "Number",
- "desc": "",
- "memberOf": ""
+ "name": "style",
+ "type": "String",
+ "desc": "any extra css",
+ "memberOf": "Roo.bootstrap.Component"
},
{
- "name": "growMax",
- "type": "Number",
- "desc": "",
- "memberOf": ""
+ "name": "xattr",
+ "type": "Object",
+ "desc": "extra attributes to add to 'element' (used by builder to store stuff.)",
+ "memberOf": "Roo.bootstrap.Component"
},
{
- "name": "tpl",
- "type": "String/Roo.Template",
- "desc": "The template to use to render the output",
- "memberOf": ""
+ "name": "can_build_overlaid",
+ "type": "Boolean",
+ "desc": "True if element can be rebuild from a HTML page",
+ "memberOf": "Roo.bootstrap.Component"
},
{
- "name": "listWidth",
- "type": "Number",
- "desc": "The width in pixels of the dropdown list (defaults to the width of the ComboBox field)",
- "memberOf": ""
+ "name": "dataId",
+ "type": "string",
+ "desc": "cutomer id",
+ "memberOf": "Roo.bootstrap.Component"
},
{
- "name": "displayField",
- "type": "String",
- "desc": "The underlying data field name to bind to this CombBox (defaults to undefined if\nmode = 'remote' or 'text' if mode = 'local')",
- "memberOf": ""
+ "name": "tooltip",
+ "type": "string",
+ "desc": "Text for the tooltip",
+ "memberOf": "Roo.bootstrap.Component"
},
{
- "name": "valueField",
- "type": "String",
- "desc": "The underlying data value name to bind to this CombBox (defaults to undefined if\nmode = 'remote' or 'value' if mode = 'local'). \nNote: use of a valueField requires the user make a selection\nin order for a value to be mapped.",
- "memberOf": ""
+ "name": "container_method",
+ "type": "string",
+ "desc": "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)",
+ "memberOf": "Roo.bootstrap.Component"
},
{
- "name": "hiddenName",
+ "name": "disableClass",
"type": "String",
- "desc": "If specified, a hidden form field with this name is dynamically generated to store the\nfield's data value (defaults to the underlying DOM element's name)",
- "memberOf": ""
+ "desc": "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").",
+ "memberOf": "Roo.Component"
},
{
- "name": "listClass",
- "type": "String",
- "desc": "CSS class to apply to the dropdown list element (defaults to '')",
- "memberOf": ""
+ "name": "allowDomMove",
+ "type": "Boolean",
+ "desc": "Whether the component can move the Dom node when rendering (defaults to true).",
+ "memberOf": "Roo.Component"
},
{
- "name": "selectedClass",
+ "name": "hideMode",
"type": "String",
- "desc": "CSS class to apply to the selected item in the dropdown list (defaults to 'x-combo-selected')",
- "memberOf": ""
+ "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\".",
+ "memberOf": "Roo.Component",
+ "optvals": [
+ "display",
+ "visibility"
+ ]
},
{
- "name": "triggerClass",
+ "name": "actionMode",
"type": "String",
- "desc": "An additional CSS class used to style the trigger button. The trigger will always get the\nclass 'x-form-trigger' and triggerClass will be <b>appended</b> if specified (defaults to 'x-form-arrow-trigger'\nwhich displays a downward arrow icon).",
- "memberOf": ""
- },
- {
- "name": "shadow",
- "type": "Boolean/String",
- "desc": "True or \"sides\" for the default effect, \"frame\" for 4-way shadow, and \"drop\" for bottom-right",
- "memberOf": ""
+ "desc": "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el'",
+ "memberOf": "Roo.Component"
},
{
- "name": "listAlign",
- "type": "String",
- "desc": "A valid anchor position value. See {@link Roo.Element#alignTo} for details on supported\nanchor positions (defaults to 'tl-bl')",
- "memberOf": ""
- },
+ "name": "listeners",
+ "type": "Object",
+ "desc": "list of events and functions to call for 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": "maxHeight",
- "type": "Number",
- "desc": "The maximum height in pixels of the dropdown list before scrollbars are shown (defaults to 300)",
- "memberOf": ""
+ "name": "beforedestroy",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires before the component is destroyed. Return false to stop the destroy."
},
{
- "name": "triggerAction",
- "type": "String",
- "desc": "The action to execute when the trigger field is activated. Use 'all' to run the\nquery specified by the allQuery config option (defaults to 'query')",
- "memberOf": ""
+ "name": "beforehide",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires before the component is hidden. Return false to stop the hide."
},
{
- "name": "minChars",
- "type": "Number",
- "desc": "The minimum number of characters the user must type before autocomplete and typeahead activate\n(defaults to 4, does not apply if editable = false)",
- "memberOf": ""
+ "name": "beforerender",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires before the component is rendered. Return false to stop the render."
},
{
- "name": "typeAhead",
- "type": "Boolean",
- "desc": "True to populate and autoselect the remainder of the text being typed after a configurable\ndelay (typeAheadDelay) if it matches a known value (defaults to false)",
- "memberOf": ""
+ "name": "beforeshow",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires before the component is shown. Return false to stop the show."
},
{
- "name": "queryDelay",
- "type": "Number",
- "desc": "The length of time in milliseconds to delay between the start of typing and sending the\nquery to filter the dropdown list (defaults to 500 if mode = 'remote' or 10 if mode = 'local')",
- "memberOf": ""
+ "name": "childrenrendered",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires when the children have been rendered.."
},
{
- "name": "pageSize",
- "type": "Number",
- "desc": "If greater than 0, a paging toolbar is displayed in the footer of the dropdown list and the\nfilter queries will execute with page start and limit parameters. Only applies when mode = 'remote' (defaults to 0)",
- "memberOf": ""
+ "name": "destroy",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires after the component is destroyed."
},
{
- "name": "selectOnFocus",
- "type": "Boolean",
- "desc": "True to select any existing text in the field immediately on focus. Only applies\nwhen editable = true (defaults to false)",
- "memberOf": ""
+ "name": "disable",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires after the component is disabled."
},
{
- "name": "queryParam",
- "type": "String",
- "desc": "Name of the query as it will be passed on the querystring (defaults to 'query')",
- "memberOf": ""
+ "name": "enable",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires after the component is enabled."
},
{
- "name": "loadingText",
- "type": "String",
- "desc": "The text to display in the dropdown list while data is loading. Only applies\nwhen mode = 'remote' (defaults to 'Loading...')",
- "memberOf": ""
+ "name": "hide",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires after the component is hidden."
},
{
- "name": "resizable",
- "type": "Boolean",
- "desc": "True to add a resize handle to the bottom of the dropdown list (defaults to false)",
- "memberOf": ""
+ "name": "render",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires after the component is rendered."
},
{
- "name": "handleHeight",
- "type": "Number",
- "desc": "The height in pixels of the dropdown list resize handle if resizable = true (defaults to 8)",
- "memberOf": ""
- },
- {
- "name": "editable",
- "type": "Boolean",
- "desc": "False to prevent the user from typing text directly into the field, just like a\ntraditional select (defaults to true)",
- "memberOf": ""
- },
- {
- "name": "allQuery",
- "type": "String",
- "desc": "The text query to send to the server to return all records for the list with no filtering (defaults to '')",
- "memberOf": ""
- },
- {
- "name": "mode",
- "type": "String",
- "desc": "Set to 'local' if the ComboBox loads local data (defaults to 'remote' which loads from the server)",
- "memberOf": ""
- },
- {
- "name": "minListWidth",
- "type": "Number",
- "desc": "The minimum width of the dropdown list in pixels (defaults to 70, will be ignored if\nlistWidth has a higher value)",
- "memberOf": ""
- },
- {
- "name": "forceSelection",
- "type": "Boolean",
- "desc": "True to restrict the selected value to one of the values in the list, false to\nallow the user to set arbitrary text into the field (defaults to false)",
- "memberOf": ""
- },
- {
- "name": "typeAheadDelay",
- "type": "Number",
- "desc": "The length of time in milliseconds to wait until the typeahead text is displayed\nif typeAhead = true (defaults to 250)",
- "memberOf": ""
- },
- {
- "name": "valueNotFoundText",
- "type": "String",
- "desc": "When using a name/value combo, if the value passed to setValue is not found in\nthe store, valueNotFoundText will be displayed as the field text if defined (defaults to undefined)",
- "memberOf": ""
- },
- {
- "name": "blockFocus",
- "type": "Boolean",
- "desc": "Prevents all focus calls, so it can work with things like HTML edtor bar",
- "memberOf": ""
- },
+ "name": "show",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires after the component is shown."
+ }
+ ],
+ "methods": [
{
- "name": "disableClear",
- "type": "Boolean",
- "desc": "Disable showing of clear button.",
- "memberOf": ""
+ "name": "addEvents",
+ "sig": "(Object object)",
+ "type": "function",
+ "desc": "Used to define events on this Observable"
},
{
- "name": "alwaysQuery",
- "type": "Boolean",
- "desc": "Disable caching of results, and always send query",
- "memberOf": ""
+ "name": "addListener",
+ "sig": "(String eventName, Function handler, Object scope, Object options)",
+ "type": "function",
+ "desc": "Appends an event handler to this component"
},
{
- "name": "hideTrigger",
- "type": "Boolean",
- "desc": "True to hide the trigger element and display only the base text field (defaults to false)",
- "memberOf": "Roo.form.TriggerField"
+ "name": "capture",
+ "sig": "(Observable o, Function fn, Object scope)",
+ "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."
},
{
- "name": "vtype",
- "type": "String",
- "desc": "A validation type name as defined in {@link Roo.form.VTypes} (defaults to null)",
- "memberOf": "Roo.form.TextField"
+ "name": "destroy",
+ "sig": "()",
+ "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}."
},
{
- "name": "maskRe",
- "type": "String",
- "desc": "An input mask regular expression that will be used to filter keystrokes that don't match (defaults to null)",
- "memberOf": "Roo.form.TextField"
+ "name": "disable",
+ "sig": "()",
+ "type": "function",
+ "desc": "Disable this component."
},
{
- "name": "disableKeyFilter",
- "type": "Boolean",
- "desc": "True to disable input keystroke filtering (defaults to false)",
- "memberOf": "Roo.form.TextField"
+ "name": "enable",
+ "sig": "()",
+ "type": "function",
+ "desc": "Enable this component."
},
{
- "name": "allowBlank",
- "type": "Boolean",
- "desc": "False to validate that the value length > 0 (defaults to true)",
- "memberOf": "Roo.form.TextField"
+ "name": "fireEvent",
+ "sig": "(String eventName, Object... args)",
+ "type": "function",
+ "desc": "Fires the specified event with the passed parameters (minus the event name)."
},
{
- "name": "minLength",
- "type": "Number",
- "desc": "Minimum input field length required (defaults to 0)",
- "memberOf": "Roo.form.TextField"
+ "name": "focus",
+ "sig": "(Boolean selectText)",
+ "type": "function",
+ "desc": "Try to focus this component."
},
{
- "name": "maxLength",
- "type": "Number",
- "desc": "Maximum input field length allowed (defaults to Number.MAX_VALUE)",
- "memberOf": "Roo.form.TextField"
+ "name": "getChildContainer",
+ "sig": "()",
+ "type": "function",
+ "desc": "Fetch the element to add children to"
},
{
- "name": "minLengthText",
- "type": "String",
- "desc": "Error text to display if the minimum length validation fails (defaults to \"The minimum length for this field is {minLength}\")",
- "memberOf": "Roo.form.TextField"
+ "name": "getEl",
+ "sig": "()",
+ "type": "function",
+ "desc": "Returns the underlying {@link Roo.Element}."
},
{
- "name": "maxLengthText",
- "type": "String",
- "desc": "Error text to display if the maximum length validation fails (defaults to \"The maximum length for this field is {maxLength}\")",
- "memberOf": "Roo.form.TextField"
+ "name": "getId",
+ "sig": "()",
+ "type": "function",
+ "desc": "Returns the id of this component."
},
{
- "name": "blankText",
- "type": "String",
- "desc": "Error text to display if the allow blank validation fails (defaults to \"This field is required\")",
- "memberOf": "Roo.form.TextField"
+ "name": "hasListener",
+ "sig": "(String eventName)",
+ "type": "function",
+ "desc": "Checks to see if this object has any listeners for a specified event"
},
{
- "name": "validator",
- "type": "Function",
- "desc": "A custom validation function to be called during field validation (defaults to null).\nIf available, this function will be called only after the basic validators all return true, and will be passed the\ncurrent field value and expected to return boolean true if the value is valid or a string error message if invalid.",
- "memberOf": "Roo.form.TextField"
+ "name": "hide",
+ "sig": "()",
+ "type": "function",
+ "desc": "Hide a component - adds 'hidden' class"
},
{
- "name": "regex",
- "type": "RegExp",
- "desc": "A JavaScript RegExp object to be tested against the field value during validation (defaults to null).\nIf available, this regex will be evaluated only after the basic validators all return true, and will be passed the\ncurrent field value. If the test fails, the field will be marked invalid using {@link #regexText}.",
- "memberOf": "Roo.form.TextField"
+ "name": "initEvents",
+ "sig": "()",
+ "type": "function",
+ "desc": "Initialize Events for the element"
},
{
- "name": "regexText",
- "type": "String",
- "desc": "The error text to display if {@link #regex} is used and the test fails during validation (defaults to \"\")",
- "memberOf": "Roo.form.TextField"
+ "name": "isVisible",
+ "sig": "()",
+ "type": "function",
+ "desc": "Returns true if this component is visible."
},
{
- "name": "emptyText",
- "type": "String",
- "desc": "The default text to display in an empty field - placeholder... (defaults to null).",
- "memberOf": "Roo.form.TextField"
+ "name": "on",
+ "sig": "(String eventName, Function handler, Object scope, Object options)",
+ "type": "function",
+ "desc": "Appends an event handler to this element (shorthand for addListener)"
},
{
- "name": "fieldLabel",
- "type": "String",
- "desc": "Label to use when rendering a form.",
- "memberOf": "Roo.form.Field"
+ "name": "purgeListeners",
+ "sig": "()",
+ "type": "function",
+ "desc": "Removes all listeners for this object"
},
{
- "name": "qtip",
- "type": "String",
- "desc": "Mouse over tip",
- "memberOf": "Roo.form.Field"
+ "name": "releaseCapture",
+ "sig": "(Observable o)",
+ "type": "function",
+ "desc": "Removes <b>all</b> added captures from the Observable."
},
{
- "name": "name",
- "type": "String",
- "desc": "The field's HTML name attribute.",
- "memberOf": "Roo.form.Field"
+ "name": "removeListener",
+ "sig": "(String eventName, Function handler, Object scope)",
+ "type": "function",
+ "desc": "Removes a listener"
},
{
- "name": "invalidClass",
- "type": "String",
- "desc": "The CSS class to use when marking a field invalid (defaults to \"x-form-invalid\")",
- "memberOf": "Roo.form.Field"
+ "name": "render",
+ "sig": "(String/HTMLElement/Element container)",
+ "type": "function",
+ "desc": "If this is a lazy rendering component, render it to its container element."
},
{
- "name": "invalidText",
- "type": "String",
- "desc": "The error text to use when marking a field invalid and no message is provided (defaults to \"The value in this field is invalid\")",
- "memberOf": "Roo.form.Field"
+ "name": "setDisabled",
+ "sig": "(Boolean disabled)",
+ "type": "function",
+ "desc": "Convenience function for setting disabled/enabled by boolean."
},
{
- "name": "focusClass",
- "type": "String",
- "desc": "The CSS class to use when the field receives focus (defaults to \"x-form-focus\")",
- "memberOf": "Roo.form.Field"
+ "name": "setVisible",
+ "sig": "(Boolean visible)",
+ "type": "function",
+ "desc": "Convenience function to hide or show this component by boolean."
},
{
- "name": "validationEvent",
- "type": "String/Boolean",
- "desc": "The event that should initiate field validation. Set to false to disable\n automatic validation (defaults to \"keyup\").",
- "memberOf": "Roo.form.Field"
+ "name": "show",
+ "sig": "()",
+ "type": "function",
+ "desc": "Show a component - removes 'hidden' class"
},
{
- "name": "validateOnBlur",
- "type": "Boolean",
- "desc": "Whether the field should validate when it loses focus (defaults to true).",
- "memberOf": "Roo.form.Field"
+ "name": "tooltipEl",
+ "sig": "()",
+ "type": "function",
+ "desc": "Fetch the element to display the tooltip on."
},
{
- "name": "validationDelay",
- "type": "Number",
- "desc": "The length of time in milliseconds after user input begins until validation is initiated (defaults to 250)",
- "memberOf": "Roo.form.Field"
- },
+ "name": "un",
+ "sig": "(String eventName, Function handler, Object scope)",
+ "type": "function",
+ "desc": "Removes a listener (shorthand for removeListener)"
+ }
+ ]
+ },
+ "Roo.doc.Section": {
+ "props": [
{
- "name": "fieldClass",
+ "name": "stype",
"type": "String",
- "desc": "The default CSS class for the field (defaults to \"x-form-field\")",
- "memberOf": "Roo.form.Field"
+ "desc": "section type.",
+ "memberOf": "",
+ "optvals": [
+ "desc",
+ "parameter",
+ "return",
+ "note",
+ "example"
+ ]
},
{
- "name": "msgTarget",
+ "name": "cls",
"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"
+ "desc": "css class",
+ "memberOf": "Roo.bootstrap.Component"
},
{
- "name": "msgFx",
+ "name": "style",
"type": "String",
- "desc": "<b>Experimental</b> The effect used when displaying a validation message under the field (defaults to 'normal').",
- "memberOf": "Roo.form.Field"
+ "desc": "any extra css",
+ "memberOf": "Roo.bootstrap.Component"
},
{
- "name": "readOnly",
- "type": "Boolean",
- "desc": "True to mark the field as readOnly in HTML (defaults to false) -- Note: this only sets the element's readOnly DOM attribute.",
- "memberOf": "Roo.form.Field"
+ "name": "xattr",
+ "type": "Object",
+ "desc": "extra attributes to add to 'element' (used by builder to store stuff.)",
+ "memberOf": "Roo.bootstrap.Component"
},
{
- "name": "disabled",
+ "name": "can_build_overlaid",
"type": "Boolean",
- "desc": "True to disable the field (defaults to false).",
- "memberOf": "Roo.form.Field"
- },
- {
- "name": "inputType",
- "type": "String",
- "desc": "The type attribute for input fields -- e.g. radio, text, password (defaults to \"text\").",
- "memberOf": "Roo.form.Field"
- },
- {
- "name": "tabIndex",
- "type": "Number",
- "desc": "The tabIndex for this field. Note this only applies to fields that are rendered, not those which are built via applyTo (defaults to undefined).",
- "memberOf": "Roo.form.Field"
+ "desc": "True if element can be rebuild from a HTML page",
+ "memberOf": "Roo.bootstrap.Component"
},
{
- "name": "value",
- "type": "Mixed",
- "desc": "A value to initialize this field with.",
- "memberOf": "Roo.form.Field"
+ "name": "dataId",
+ "type": "string",
+ "desc": "cutomer id",
+ "memberOf": "Roo.bootstrap.Component"
},
{
- "name": "cls",
- "type": "String",
- "desc": "A CSS class to apply to the field's underlying element.",
- "memberOf": "Roo.form.Field"
+ "name": "name",
+ "type": "string",
+ "desc": "Specifies name attribute",
+ "memberOf": "Roo.bootstrap.Component"
},
{
- "name": "width",
- "type": "Number",
- "desc": "width (optional) size of component",
- "memberOf": "Roo.BoxComponent"
+ "name": "tooltip",
+ "type": "string",
+ "desc": "Text for the tooltip",
+ "memberOf": "Roo.bootstrap.Component"
},
{
- "name": "height",
- "type": "Number",
- "desc": "height (optional) size of component",
- "memberOf": "Roo.BoxComponent"
+ "name": "container_method",
+ "type": "string",
+ "desc": "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)",
+ "memberOf": "Roo.bootstrap.Component"
},
{
"name": "disableClass",
}
],
"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 when the autosize function is triggered. The field may or may not have actually changed size\naccording to the default logic, but this event provides a hook for the developer to apply additional\nlogic at runtime to resize the field if needed."
- },
{
"name": "beforedestroy",
"sig": "function (_self)\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}",
"desc": "Fires before the component is shown. Return false to stop the show."
},
{
- "name": "blur",
+ "name": "childrenrendered",
"sig": "function (_self)\n{\n\n}",
"type": "function",
- "desc": "Fires when this field loses input focus."
- },
- {
- "name": "change",
- "sig": "function (_self, newValue, oldValue)\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"
+ "desc": "Fires when the children have been rendered.."
},
{
"name": "destroy",
"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 when this field receives input focus."
- },
{
"name": "hide",
"sig": "function (_self)\n{\n\n}",
"type": "function",
"desc": "Fires after the component is hidden."
},
- {
- "name": "invalid",
- "sig": "function (_self, msg)\n{\n\n}",
- "type": "function",
- "desc": "Fires after the field has been marked as invalid."
- },
- {
- "name": "keyup",
- "sig": "function (_self, e)\n{\n\n}",
- "type": "function",
- "desc": "Fires after the key up"
- },
- {
- "name": "move",
- "sig": "function (_self, x, y)\n{\n\n}",
- "type": "function",
- "desc": "Fires after the component is moved."
- },
{
"name": "render",
"sig": "function (_self)\n{\n\n}",
"type": "function",
"desc": "Fires after the component is rendered."
},
- {
- "name": "resize",
- "sig": "function (_self, adjWidth, adjHeight, rawWidth, rawHeight)\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}",
"type": "function",
"desc": "Fires after the component is shown."
- },
- {
- "name": "specialkey",
- "sig": "function (_self, e)\n{\n\n}",
- "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."
- },
- {
- "name": "valid",
- "sig": "function (_self)\n{\n\n}",
- "type": "function",
- "desc": "Fires after the field has been validated with no errors."
}
],
"methods": [
"type": "function",
"desc": "Appends an event handler to this component"
},
- {
- "name": "applyTo",
- "sig": "(String/HTMLElement/Element el)",
- "type": "function",
- "desc": "Apply the behaviors of this component to an existing element. <b>This is used instead of render().</b>"
- },
{
"name": "capture",
"sig": "(Observable o, Function fn, Object scope)",
"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."
},
- {
- "name": "clearInvalid",
- "sig": "()",
- "type": "function",
- "desc": "Clear any invalid styles/messages for this field"
- },
- {
- "name": "clearValue",
- "sig": "()",
- "type": "function",
- "desc": "Clears any text/value currently set in the field"
- },
- {
- "name": "collapse",
- "sig": "()",
- "type": "function",
- "desc": "Hides the dropdown list if it is currently expanded. Fires the 'collapse' event on completion."
- },
{
"name": "destroy",
"sig": "()",
"type": "function",
"desc": "Disable this component."
},
- {
- "name": "doQuery",
- "sig": "(String query, Boolean forceAll)",
- "type": "function",
- "desc": "Execute a query to filter the dropdown list. Fires the beforequery event prior to performing the\nquery allowing the query action to be canceled if needed."
- },
{
"name": "enable",
"sig": "()",
"type": "function",
"desc": "Enable this component."
},
- {
- "name": "expand",
- "sig": "()",
- "type": "function",
- "desc": "Expands the dropdown list if it is currently hidden. Fires the 'expand' event on completion."
- },
{
"name": "fireEvent",
"sig": "(String eventName, Object... args)",
"desc": "Try to focus this component."
},
{
- "name": "getBox",
- "sig": "(Boolean local)",
+ "name": "getChildContainer",
+ "sig": "()",
"type": "function",
- "desc": "Gets the current box measurements of the component's underlying element."
+ "desc": "Fetch the element to add children to"
},
{
"name": "getEl",
"desc": "Returns the id of this component."
},
{
- "name": "getName",
- "sig": "()",
- "type": "function",
- "desc": "Returns the name attribute of the field if available"
- },
- {
- "name": "getPosition",
- "sig": "(Boolean local)",
+ "name": "hasListener",
+ "sig": "(String eventName)",
"type": "function",
- "desc": "Gets the current XY position of the component's underlying element."
+ "desc": "Checks to see if this object has any listeners for a specified event"
},
{
- "name": "getRawValue",
+ "name": "hide",
"sig": "()",
"type": "function",
- "desc": "Returns the raw data value which may or may not be a valid, defined value. To return a normalized value see {@link #getValue}."
+ "desc": "Hide a component - adds 'hidden' class"
},
{
- "name": "getSize",
+ "name": "initEvents",
"sig": "()",
"type": "function",
- "desc": "Gets the current size of the component's underlying element."
+ "desc": "Initialize Events for the element"
},
{
- "name": "getValue",
+ "name": "isVisible",
"sig": "()",
"type": "function",
- "desc": "Returns the currently selected field value or empty string if no value is set."
+ "desc": "Returns true if this component is visible."
},
{
- "name": "hasListener",
- "sig": "(String eventName)",
+ "name": "on",
+ "sig": "(String eventName, Function handler, Object scope, Object options)",
"type": "function",
- "desc": "Checks to see if this object has any listeners for a specified event"
+ "desc": "Appends an event handler to this element (shorthand for addListener)"
},
{
- "name": "hide",
- "sig": "()",
- "type": "function",
- "desc": "Hide this component."
- },
- {
- "name": "isDirty",
- "sig": "()",
- "type": "function",
- "desc": "Returns true if this field has been changed since it was originally loaded and is not disabled."
- },
- {
- "name": "isExpanded",
- "sig": "()",
- "type": "function",
- "desc": "Returns true if the dropdown list is expanded, else false."
- },
- {
- "name": "isValid",
- "sig": "(Boolean preventMark)",
- "type": "function",
- "desc": "Returns whether or not the field value is currently valid"
- },
- {
- "name": "isVisible",
- "sig": "()",
- "type": "function",
- "desc": "Returns true if this component is visible."
- },
- {
- "name": "markInvalid",
- "sig": "(String msg)",
- "type": "function",
- "desc": "Mark this field as invalid"
- },
- {
- "name": "on",
- "sig": "(String eventName, Function handler, Object scope, Object options)",
- "type": "function",
- "desc": "Appends an event handler to this element (shorthand for addListener)"
- },
- {
- "name": "onPosition",
- "sig": "(Number x, Number y)",
- "type": "function",
- "desc": "Called after the component is moved, this method is empty by default but can be implemented by any\nsubclass that needs to perform custom logic after a move occurs."
- },
- {
- "name": "onResize",
- "sig": "(Number adjWidth, Number adjHeight, Number rawWidth, Number rawHeight)",
- "type": "function",
- "desc": "Called after the component is resized, this method is empty by default but can be implemented by any\nsubclass that needs to perform custom logic after a resize occurs."
- },
- {
- "name": "onTriggerClick",
- "sig": "(EventObject e)",
- "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."
- },
- {
- "name": "purgeListeners",
+ "name": "purgeListeners",
"sig": "()",
"type": "function",
"desc": "Removes all listeners for this object"
"type": "function",
"desc": "If this is a lazy rendering component, render it to its container element."
},
- {
- "name": "reset",
- "sig": "()",
- "type": "function",
- "desc": "Resets the current field value to the originally-loaded value and clears any validation messages."
- },
- {
- "name": "select",
- "sig": "(Number index, Boolean scrollIntoView)",
- "type": "function",
- "desc": "Select an item in the dropdown list by its numeric index in the list. This function does NOT cause the select event to fire.\nThe store must be loaded and the list expanded for this function to work, otherwise use setValue."
- },
- {
- "name": "selectByValue",
- "sig": "(String value, Boolean scrollIntoView)",
- "type": "function",
- "desc": "Select an item in the dropdown list by its data value. This function does NOT cause the select event to fire.\nThe store must be loaded and the list expanded for this function to work, otherwise use setValue."
- },
- {
- "name": "selectText",
- "sig": "(Number start, Number end)",
- "type": "function",
- "desc": "Selects text in this field"
- },
{
"name": "setDisabled",
"sig": "(Boolean disabled)",
"type": "function",
"desc": "Convenience function for setting disabled/enabled by boolean."
},
- {
- "name": "setEditable",
- "sig": "(Boolean value)",
- "type": "function",
- "desc": "Allow or prevent the user from directly editing the field text. If false is passed,\nthe user will only be able to select from the items defined in the dropdown list. This method\nis the runtime equivalent of setting the 'editable' config option at config time."
- },
- {
- "name": "setFromData",
- "sig": "(Object value)",
- "type": "function",
- "desc": "Sets the value of the field based on a object which is related to the record format for the store."
- },
- {
- "name": "setPagePosition",
- "sig": "(Number x, Number y)",
- "type": "function",
- "desc": "Sets the page XY position of the component. To set the left and top instead, use {@link #setPosition}.\nThis method fires the move event."
- },
- {
- "name": "setPosition",
- "sig": "(Number left, Number top)",
- "type": "function",
- "desc": "Sets the left and top of the component. To set the page XY position instead, use {@link #setPagePosition}.\nThis method fires the move event."
- },
- {
- "name": "setRawValue",
- "sig": "(Mixed value)",
- "type": "function",
- "desc": "Sets the underlying DOM field's value directly, bypassing validation. To set the value with validation see {@link #setValue}."
- },
- {
- "name": "setSize",
- "sig": "(Number/Object width, Number height)",
- "type": "function",
- "desc": "Sets the width and height of the component. This method fires the resize event. This method can accept\neither width and height as separate numeric arguments, or you can pass a size object like {width:10, height:20}."
- },
- {
- "name": "setValue",
- "sig": "(String value)",
- "type": "function",
- "desc": "Sets the specified value into the field. If the value finds a match, the corresponding record text\nwill be displayed in the field. If the value does not match the data value of an existing item,\nand the valueNotFoundText config option is defined, it will be displayed as the default field text.\nOtherwise the field will be blank (although the value will still be set)."
- },
{
"name": "setVisible",
"sig": "(Boolean visible)",
"name": "show",
"sig": "()",
"type": "function",
- "desc": "Show this component."
+ "desc": "Show a component - removes 'hidden' class"
},
{
- "name": "syncSize",
+ "name": "tooltipEl",
"sig": "()",
"type": "function",
- "desc": "Force the component's size to recalculate based on the underlying element's current height and width."
+ "desc": "Fetch the element to display the tooltip on."
},
{
"name": "un",
"sig": "(String eventName, Function handler, Object scope)",
"type": "function",
"desc": "Removes a listener (shorthand for removeListener)"
- },
- {
- "name": "updateBox",
- "sig": "(Object box)",
- "type": "function",
- "desc": "Sets the current box measurements of the component's underlying element."
- },
- {
- "name": "validate",
- "sig": "()",
- "type": "function",
- "desc": "Validates the field value"
- },
- {
- "name": "validateValue",
- "sig": "(Mixed value)",
- "type": "function",
- "desc": "Validates a value according to the field's validation rules and marks the field as invalid\nif the validation fails"
}
]
},
- "Roo.form.ComboBoxArray": {
+ "Roo.doc.Synopsis": {
"props": [
{
- "name": "combo",
- "type": "Roo.form.Combo",
- "desc": "The combo box that is wrapped",
- "memberOf": ""
- },
- {
- "name": "width",
- "type": "Number",
- "desc": "The width of the box that displays the selected element",
- "memberOf": ""
- },
- {
- "name": "name",
+ "name": "returntype",
"type": "String",
- "desc": "The name of the visable items on this form (eg. titles not ids)",
+ "desc": "return value",
"memberOf": ""
},
{
- "name": "hiddenName",
+ "name": "name",
"type": "String",
- "desc": "The hidden name of the field, often contains an comma seperated list of names",
+ "desc": "title really..",
"memberOf": ""
},
{
- "name": "grow",
- "type": "Boolean",
- "desc": "True if this field should automatically grow and shrink to its content",
- "memberOf": "Roo.form.TextField"
- },
- {
- "name": "growMin",
- "type": "Number",
- "desc": "The minimum width to allow when grow = true (defaults to 30)",
- "memberOf": "Roo.form.TextField"
- },
- {
- "name": "growMax",
- "type": "Number",
- "desc": "The maximum width to allow when grow = true (defaults to 800)",
- "memberOf": "Roo.form.TextField"
- },
- {
- "name": "vtype",
- "type": "String",
- "desc": "A validation type name as defined in {@link Roo.form.VTypes} (defaults to null)",
- "memberOf": "Roo.form.TextField"
- },
- {
- "name": "maskRe",
- "type": "String",
- "desc": "An input mask regular expression that will be used to filter keystrokes that don't match (defaults to null)",
- "memberOf": "Roo.form.TextField"
- },
- {
- "name": "disableKeyFilter",
- "type": "Boolean",
- "desc": "True to disable input keystroke filtering (defaults to false)",
- "memberOf": "Roo.form.TextField"
- },
- {
- "name": "allowBlank",
- "type": "Boolean",
- "desc": "False to validate that the value length > 0 (defaults to true)",
- "memberOf": "Roo.form.TextField"
- },
- {
- "name": "minLength",
- "type": "Number",
- "desc": "Minimum input field length required (defaults to 0)",
- "memberOf": "Roo.form.TextField"
- },
- {
- "name": "maxLength",
- "type": "Number",
- "desc": "Maximum input field length allowed (defaults to Number.MAX_VALUE)",
- "memberOf": "Roo.form.TextField"
- },
- {
- "name": "minLengthText",
- "type": "String",
- "desc": "Error text to display if the minimum length validation fails (defaults to \"The minimum length for this field is {minLength}\")",
- "memberOf": "Roo.form.TextField"
- },
- {
- "name": "maxLengthText",
- "type": "String",
- "desc": "Error text to display if the maximum length validation fails (defaults to \"The maximum length for this field is {maxLength}\")",
- "memberOf": "Roo.form.TextField"
- },
- {
- "name": "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": "Error text to display if the allow blank validation fails (defaults to \"This field is required\")",
- "memberOf": "Roo.form.TextField"
- },
- {
- "name": "validator",
- "type": "Function",
- "desc": "A custom validation function to be called during field validation (defaults to null).\nIf available, this function will be called only after the basic validators all return true, and will be passed the\ncurrent field value and expected to return boolean true if the value is valid or a string error message if invalid.",
- "memberOf": "Roo.form.TextField"
- },
- {
- "name": "regex",
- "type": "RegExp",
- "desc": "A JavaScript RegExp object to be tested against the field value during validation (defaults to null).\nIf available, this regex will be evaluated only after the basic validators all return true, and will be passed the\ncurrent field value. If the test fails, the field will be marked invalid using {@link #regexText}.",
- "memberOf": "Roo.form.TextField"
- },
- {
- "name": "regexText",
- "type": "String",
- "desc": "The error text to display if {@link #regex} is used and the test fails during validation (defaults to \"\")",
- "memberOf": "Roo.form.TextField"
- },
- {
- "name": "emptyText",
- "type": "String",
- "desc": "The default text to display in an empty field - placeholder... (defaults to null).",
- "memberOf": "Roo.form.TextField"
- },
- {
- "name": "fieldLabel",
- "type": "String",
- "desc": "Label to use when rendering a form.",
- "memberOf": "Roo.form.Field"
- },
- {
- "name": "qtip",
- "type": "String",
- "desc": "Mouse over tip",
- "memberOf": "Roo.form.Field"
- },
- {
- "name": "invalidClass",
- "type": "String",
- "desc": "The CSS class to use when marking a field invalid (defaults to \"x-form-invalid\")",
- "memberOf": "Roo.form.Field"
- },
- {
- "name": "invalidText",
- "type": "String",
- "desc": "The error text to use when marking a field invalid and no message is provided (defaults to \"The value in this field is invalid\")",
- "memberOf": "Roo.form.Field"
- },
- {
- "name": "focusClass",
- "type": "String",
- "desc": "The CSS class to use when the field receives focus (defaults to \"x-form-focus\")",
- "memberOf": "Roo.form.Field"
- },
- {
- "name": "validationEvent",
- "type": "String/Boolean",
- "desc": "The event that should initiate field validation. Set to false to disable\n automatic validation (defaults to \"keyup\").",
- "memberOf": "Roo.form.Field"
- },
- {
- "name": "validateOnBlur",
- "type": "Boolean",
- "desc": "Whether the field should validate when it loses focus (defaults to true).",
- "memberOf": "Roo.form.Field"
- },
- {
- "name": "validationDelay",
- "type": "Number",
- "desc": "The length of time in milliseconds after user input begins until validation is initiated (defaults to 250)",
- "memberOf": "Roo.form.Field"
- },
- {
- "name": "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",
+ "name": "stype",
"type": "String",
- "desc": "The default CSS class for the field (defaults to \"x-form-field\")",
- "memberOf": "Roo.form.Field"
+ "desc": "",
+ "memberOf": "",
+ "optvals": [
+ "function",
+ "constant"
+ ]
},
{
- "name": "msgTarget",
+ "name": "cls",
"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"
+ "desc": "css class",
+ "memberOf": "Roo.bootstrap.Component"
},
{
- "name": "msgFx",
+ "name": "style",
"type": "String",
- "desc": "<b>Experimental</b> The effect used when displaying a validation message under the field (defaults to 'normal').",
- "memberOf": "Roo.form.Field"
+ "desc": "any extra css",
+ "memberOf": "Roo.bootstrap.Component"
},
{
- "name": "readOnly",
- "type": "Boolean",
- "desc": "True to mark the field as readOnly in HTML (defaults to false) -- Note: this only sets the element's readOnly DOM attribute.",
- "memberOf": "Roo.form.Field"
+ "name": "xattr",
+ "type": "Object",
+ "desc": "extra attributes to add to 'element' (used by builder to store stuff.)",
+ "memberOf": "Roo.bootstrap.Component"
},
{
- "name": "disabled",
+ "name": "can_build_overlaid",
"type": "Boolean",
- "desc": "True to disable the field (defaults to false).",
- "memberOf": "Roo.form.Field"
- },
- {
- "name": "inputType",
- "type": "String",
- "desc": "The type attribute for input fields -- e.g. radio, text, password (defaults to \"text\").",
- "memberOf": "Roo.form.Field"
- },
- {
- "name": "tabIndex",
- "type": "Number",
- "desc": "The tabIndex for this field. Note this only applies to fields that are rendered, not those which are built via applyTo (defaults to undefined).",
- "memberOf": "Roo.form.Field"
+ "desc": "True if element can be rebuild from a HTML page",
+ "memberOf": "Roo.bootstrap.Component"
},
{
- "name": "value",
- "type": "Mixed",
- "desc": "A value to initialize this field with.",
- "memberOf": "Roo.form.Field"
+ "name": "dataId",
+ "type": "string",
+ "desc": "cutomer id",
+ "memberOf": "Roo.bootstrap.Component"
},
{
- "name": "cls",
- "type": "String",
- "desc": "A CSS class to apply to the field's underlying element.",
- "memberOf": "Roo.form.Field"
+ "name": "tooltip",
+ "type": "string",
+ "desc": "Text for the tooltip",
+ "memberOf": "Roo.bootstrap.Component"
},
{
- "name": "height",
- "type": "Number",
- "desc": "height (optional) size of component",
- "memberOf": "Roo.BoxComponent"
+ "name": "container_method",
+ "type": "string",
+ "desc": "method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)",
+ "memberOf": "Roo.bootstrap.Component"
},
{
"name": "disableClass",
}
],
"events": [
- {
- "name": "autosize",
- "sig": "function (_self, width)\n{\n\n}",
- "type": "function",
- "desc": "Fires when the autosize function is triggered. The field may or may not have actually changed size\naccording to the default logic, but this event provides a hook for the developer to apply additional\nlogic at runtime to resize the field if needed."
- },
{
"name": "beforedestroy",
"sig": "function (_self)\n{\n\n}",
"type": "function",
"desc": "Fires before the component is hidden. Return false to stop the hide."
},
- {
- "name": "beforeremove",
- "sig": "function (_self, item)\n{\n\n}",
- "type": "function",
- "desc": "Fires before remove the value from the list"
- },
{
"name": "beforerender",
"sig": "function (_self)\n{\n\n}",
"desc": "Fires before the component is shown. Return false to stop the show."
},
{
- "name": "blur",
+ "name": "childrenrendered",
"sig": "function (_self)\n{\n\n}",
"type": "function",
- "desc": "Fires when this field loses input focus."
- },
- {
- "name": "change",
- "sig": "function (_self, newValue, oldValue)\n{\n\n}",
- "type": "function",
- "desc": "Fires just before the field blurs if the field value has changed."
+ "desc": "Fires when the children have been rendered.."
},
{
"name": "destroy",
"type": "function",
"desc": "Fires after the component is enabled."
},
- {
- "name": "focus",
- "sig": "function (_self)\n{\n\n}",
- "type": "function",
- "desc": "Fires when this field receives input focus."
- },
{
"name": "hide",
"sig": "function (_self)\n{\n\n}",
"type": "function",
"desc": "Fires after the component is hidden."
},
- {
- "name": "invalid",
- "sig": "function (_self, msg)\n{\n\n}",
- "type": "function",
- "desc": "Fires after the field has been marked as invalid."
- },
- {
- "name": "keyup",
- "sig": "function (_self, e)\n{\n\n}",
- "type": "function",
- "desc": "Fires after the key up"
- },
- {
- "name": "move",
- "sig": "function (_self, x, y)\n{\n\n}",
- "type": "function",
- "desc": "Fires after the component is moved."
- },
- {
- "name": "remove",
- "sig": "function (_self, item)\n{\n\n}",
- "type": "function",
- "desc": "Fires when remove the value from the list"
- },
{
"name": "render",
"sig": "function (_self)\n{\n\n}",
"type": "function",
"desc": "Fires after the component is rendered."
},
- {
- "name": "resize",
- "sig": "function (_self, adjWidth, adjHeight, rawWidth, rawHeight)\n{\n\n}",
- "type": "function",
- "desc": "Fires after the component is resized."
- },
{
"name": "show",
"sig": "function (_self)\n{\n\n}",
"type": "function",
"desc": "Fires after the component is shown."
- },
- {
- "name": "specialkey",
- "sig": "function (_self, e)\n{\n\n}",
- "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."
- },
- {
- "name": "valid",
- "sig": "function (_self)\n{\n\n}",
- "type": "function",
- "desc": "Fires after the field has been validated with no errors."
}
],
"methods": [
"type": "function",
"desc": "Appends an event handler to this component"
},
- {
- "name": "applyTo",
- "sig": "(String/HTMLElement/Element el)",
- "type": "function",
- "desc": "Apply the behaviors of this component to an existing element. <b>This is used instead of render().</b>"
- },
- {
- "name": "autoSize",
- "sig": "()",
- "type": "function",
- "desc": "Automatically grows the field to accomodate the width of the text up to the maximum field width allowed.\nThis only takes effect if grow = true, and fires the autosize event."
- },
{
"name": "capture",
"sig": "(Observable o, Function fn, Object scope)",
"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."
},
- {
- "name": "clearInvalid",
- "sig": "()",
- "type": "function",
- "desc": "Clear any invalid styles/messages for this field"
- },
{
"name": "destroy",
"sig": "()",
"desc": "Try to focus this component."
},
{
- "name": "getBox",
- "sig": "(Boolean local)",
+ "name": "getChildContainer",
+ "sig": "()",
"type": "function",
- "desc": "Gets the current box measurements of the component's underlying element."
+ "desc": "Fetch the element to add children to"
},
{
"name": "getEl",
"desc": "Returns the id of this component."
},
{
- "name": "getName",
- "sig": "()",
+ "name": "hasListener",
+ "sig": "(String eventName)",
"type": "function",
- "desc": "Returns the name attribute of the field if available"
+ "desc": "Checks to see if this object has any listeners for a specified event"
},
{
- "name": "getPosition",
- "sig": "(Boolean local)",
+ "name": "hide",
+ "sig": "()",
"type": "function",
- "desc": "Gets the current XY position of the component's underlying element."
+ "desc": "Hide a component - adds 'hidden' class"
},
{
- "name": "getRawValue",
+ "name": "initEvents",
"sig": "()",
"type": "function",
- "desc": "Returns the raw data value which may or may not be a valid, defined value. To return a normalized value see {@link #getValue}."
+ "desc": "Initialize Events for the element"
},
{
- "name": "getSize",
+ "name": "isVisible",
"sig": "()",
"type": "function",
- "desc": "Gets the current size of the component's underlying element."
+ "desc": "Returns true if this component is visible."
},
{
- "name": "getValue",
- "sig": "()",
+ "name": "on",
+ "sig": "(String eventName, Function handler, Object scope, Object options)",
"type": "function",
- "desc": "Returns the normalized data value (undefined or emptyText will be returned as ''). To return the raw value see {@link #getRawValue}."
+ "desc": "Appends an event handler to this element (shorthand for addListener)"
},
{
- "name": "hasListener",
- "sig": "(String eventName)",
+ "name": "purgeListeners",
+ "sig": "()",
"type": "function",
- "desc": "Checks to see if this object has any listeners for a specified event"
+ "desc": "Removes all listeners for this object"
},
{
- "name": "hide",
+ "name": "releaseCapture",
+ "sig": "(Observable o)",
+ "type": "function",
+ "desc": "Removes <b>all</b> added captures from the Observable."
+ },
+ {
+ "name": "removeListener",
+ "sig": "(String eventName, Function handler, Object scope)",
+ "type": "function",
+ "desc": "Removes a listener"
+ },
+ {
+ "name": "render",
+ "sig": "(String/HTMLElement/Element container)",
+ "type": "function",
+ "desc": "If this is a lazy rendering component, render it to its container element."
+ },
+ {
+ "name": "setDisabled",
+ "sig": "(Boolean disabled)",
+ "type": "function",
+ "desc": "Convenience function for setting disabled/enabled by boolean."
+ },
+ {
+ "name": "setVisible",
+ "sig": "(Boolean visible)",
+ "type": "function",
+ "desc": "Convenience function to hide or show this component by boolean."
+ },
+ {
+ "name": "show",
"sig": "()",
"type": "function",
- "desc": "Hide this component."
+ "desc": "Show a component - removes 'hidden' class"
},
{
- "name": "isDirty",
+ "name": "tooltipEl",
"sig": "()",
"type": "function",
- "desc": "Returns true if this field has been changed since it was originally loaded and is not disabled."
+ "desc": "Fetch the element to display the tooltip on."
},
{
- "name": "isValid",
- "sig": "(Boolean preventMark)",
+ "name": "un",
+ "sig": "(String eventName, Function handler, Object scope)",
"type": "function",
- "desc": "Returns whether or not the field value is currently valid"
+ "desc": "Removes a listener (shorthand for removeListener)"
+ }
+ ]
+ },
+ "Roo.form": {
+ "props": [],
+ "events": [],
+ "methods": []
+ },
+ "Roo.form.Action": {
+ "props": [],
+ "events": [],
+ "methods": []
+ },
+ "Roo.form.BasicForm": {
+ "props": [
+ {
+ "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": ""
},
{
- "name": "isVisible",
- "sig": "()",
+ "name": "reader",
+ "type": "DataReader",
+ "desc": "An Roo.data.DataReader (e.g. {@link Roo.data.XmlReader}) to be used to read data when executing \"load\" actions.\nThis is optional as there is built-in support for processing JSON.",
+ "memberOf": ""
+ },
+ {
+ "name": "errorReader",
+ "type": "DataReader",
+ "desc": "An Roo.data.DataReader (e.g. {@link Roo.data.XmlReader}) to be used to read data when reading validation errors on \"submit\" actions.\nThis is completely optional as there is built-in support for processing JSON.",
+ "memberOf": ""
+ },
+ {
+ "name": "url",
+ "type": "String",
+ "desc": "The URL to use for form actions if one isn't supplied in the action options.",
+ "memberOf": ""
+ },
+ {
+ "name": "fileUpload",
+ "type": "Boolean",
+ "desc": "Set to true if this form is a file upload.",
+ "memberOf": ""
+ },
+ {
+ "name": "baseParams",
+ "type": "Object",
+ "desc": "Parameters to pass with all requests. e.g. baseParams: {id: '123', foo: 'bar'}.",
+ "memberOf": ""
+ },
+ {
+ "name": "timeout",
+ "type": "Number",
+ "desc": "Timeout for form actions in seconds (default is 30 seconds).",
+ "memberOf": ""
+ },
+ {
+ "name": "trackResetOnLoad",
+ "type": "Boolean",
+ "desc": "If set to true, form.reset() resets to the last loaded\nor setValues() data instead of when the form was first created.",
+ "memberOf": ""
+ },
+ {
+ "name": "listeners",
+ "type": "Object",
+ "desc": "list of events and functions to call for 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": "actioncomplete",
+ "sig": "function (_self, action)\n{\n\n}",
"type": "function",
- "desc": "Returns true if this component is visible."
+ "desc": "Fires when an action is completed."
},
{
- "name": "markInvalid",
- "sig": "(String msg)",
+ "name": "actionfailed",
+ "sig": "function (_self, action)\n{\n\n}",
"type": "function",
- "desc": "Mark this field as invalid"
+ "desc": "Fires when an action fails."
},
{
- "name": "on",
+ "name": "beforeaction",
+ "sig": "function (_self, action)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires before any action is performed. Return false to cancel the action."
+ }
+ ],
+ "methods": [
+ {
+ "name": "add",
+ "sig": "(Field field1, Field field2, Field etc)",
+ "type": "function",
+ "desc": "Add Roo.form components to this form."
+ },
+ {
+ "name": "addEvents",
+ "sig": "(Object object)",
+ "type": "function",
+ "desc": "Used to define events on this Observable"
+ },
+ {
+ "name": "addForm",
+ "sig": "(Roo.form.Form form)",
+ "type": "function",
+ "desc": "Add a secondary form to this one, \nUsed to provide tabbed forms. One form is primary, with hidden values \nwhich mirror the elements from the other forms."
+ },
+ {
+ "name": "addListener",
"sig": "(String eventName, Function handler, Object scope, Object options)",
"type": "function",
- "desc": "Appends an event handler to this element (shorthand for addListener)"
+ "desc": "Appends an event handler to this component"
},
{
- "name": "onPosition",
- "sig": "(Number x, Number y)",
+ "name": "applyIfToFields",
+ "sig": "(Object values)",
"type": "function",
- "desc": "Called after the component is moved, this method is empty by default but can be implemented by any\nsubclass that needs to perform custom logic after a move occurs."
+ "desc": "Calls {@link Ext#applyIf} for all field in this form with the passed object."
},
{
- "name": "onResize",
- "sig": "(Number adjWidth, Number adjHeight, Number rawWidth, Number rawHeight)",
+ "name": "applyToFields",
+ "sig": "(Object values)",
"type": "function",
- "desc": "Called after the component is resized, this method is empty by default but can be implemented by any\nsubclass that needs to perform custom logic after a resize occurs."
+ "desc": "Calls {@link Ext#apply} for all fields in this form with the passed object."
},
{
- "name": "purgeListeners",
+ "name": "capture",
+ "sig": "(Observable o, Function fn, Object scope)",
+ "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."
+ },
+ {
+ "name": "clearInvalid",
"sig": "()",
"type": "function",
- "desc": "Removes all listeners for this object"
+ "desc": "Clears all invalid messages in this form."
},
{
- "name": "releaseCapture",
- "sig": "(Observable o)",
+ "name": "doAction",
+ "sig": "(String actionName, Object options)",
"type": "function",
- "desc": "Removes <b>all</b> added captures from the Observable."
+ "desc": "Performs a predefined action (submit or load) or custom actions you define on this form."
},
{
- "name": "removeListener",
- "sig": "(String eventName, Function handler, Object scope)",
+ "name": "findField",
+ "sig": "(String id)",
"type": "function",
- "desc": "Removes a listener"
+ "desc": "Find a Roo.form.Field in this form by id, dataIndex, name or hiddenName"
},
{
- "name": "render",
- "sig": "(String/HTMLElement/Element container)",
+ "name": "fireEvent",
+ "sig": "(String eventName, Object... args)",
"type": "function",
- "desc": "If this is a lazy rendering component, render it to its container element."
+ "desc": "Fires the specified event with the passed parameters (minus the event name)."
},
{
- "name": "reset",
+ "name": "getFieldValues",
"sig": "()",
"type": "function",
- "desc": "Resets the current field value to the originally-loaded value and clears any validation messages."
+ "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."
},
{
- "name": "selectText",
- "sig": "(Number start, Number end)",
+ "name": "getValues",
+ "sig": "(Boolean asString)",
"type": "function",
- "desc": "Selects text in this field"
+ "desc": "Returns the fields in this form as an object with key/value pairs. If multiple fields exist with the same name\nthey are returned as an array."
},
{
- "name": "setDisabled",
- "sig": "(Boolean disabled)",
+ "name": "hasChanged",
+ "sig": "()",
"type": "function",
- "desc": "Convenience function for setting disabled/enabled by boolean."
+ "desc": "Returns true if any fields in this form have changed since their original load. (New version)"
},
{
- "name": "setPagePosition",
- "sig": "(Number x, Number y)",
+ "name": "hasListener",
+ "sig": "(String eventName)",
"type": "function",
- "desc": "Sets the page XY position of the component. To set the left and top instead, use {@link #setPosition}.\nThis method fires the move event."
+ "desc": "Checks to see if this object has any listeners for a specified event"
},
{
- "name": "setPosition",
- "sig": "(Number left, Number top)",
+ "name": "isDirty",
+ "sig": "()",
"type": "function",
- "desc": "Sets the left and top of the component. To set the page XY position instead, use {@link #setPagePosition}.\nThis method fires the move event."
+ "desc": "DEPRICATED Returns true if any fields in this form have changed since their original load."
},
{
- "name": "setRawValue",
- "sig": "(Mixed value)",
+ "name": "isValid",
+ "sig": "()",
"type": "function",
- "desc": "Sets the underlying DOM field's value directly, bypassing validation. To set the value with validation see {@link #setValue}."
+ "desc": "Returns true if client-side validation on the form is successful."
},
{
- "name": "setSize",
- "sig": "(Number/Object width, Number height)",
+ "name": "load",
+ "sig": "(Object options)",
"type": "function",
- "desc": "Sets the width and height of the component. This method fires the resize event. This method can accept\neither width and height as separate numeric arguments, or you can pass a size object like {width:10, height:20}."
+ "desc": "Shortcut to do a load action."
},
{
- "name": "setValue",
- "sig": "(Mixed value)",
+ "name": "loadRecord",
+ "sig": "(Record record)",
"type": "function",
- "desc": "Sets a data value into the field and validates it. To set the value directly without validation see {@link #setRawValue}."
+ "desc": "Loads an Roo.data.Record into this form."
},
{
- "name": "setVisible",
- "sig": "(Boolean visible)",
+ "name": "markInvalid",
+ "sig": "(Array/Object errors)",
"type": "function",
- "desc": "Convenience function to hide or show this component by boolean."
+ "desc": "Mark fields in this form invalid in bulk."
},
{
- "name": "show",
- "sig": "()",
+ "name": "on",
+ "sig": "(String eventName, Function handler, Object scope, Object options)",
"type": "function",
- "desc": "Show this component."
+ "desc": "Appends an event handler to this element (shorthand for addListener)"
},
{
- "name": "syncSize",
+ "name": "purgeListeners",
"sig": "()",
"type": "function",
- "desc": "Force the component's size to recalculate based on the underlying element's current height and width."
+ "desc": "Removes all listeners for this object"
},
{
- "name": "un",
+ "name": "releaseCapture",
+ "sig": "(Observable o)",
+ "type": "function",
+ "desc": "Removes <b>all</b> added captures from the Observable."
+ },
+ {
+ "name": "remove",
+ "sig": "(Field field)",
+ "type": "function",
+ "desc": "Removes a field from the items collection (does NOT remove its markup)."
+ },
+ {
+ "name": "removeListener",
"sig": "(String eventName, Function handler, Object scope)",
"type": "function",
- "desc": "Removes a listener (shorthand for removeListener)"
+ "desc": "Removes a listener"
},
{
- "name": "updateBox",
- "sig": "(Object box)",
+ "name": "render",
+ "sig": "()",
"type": "function",
- "desc": "Sets the current box measurements of the component's underlying element."
+ "desc": "Looks at the fields in this form, checks them for an id attribute,\nand calls applyTo on the existing dom element with that id."
},
{
- "name": "validate",
+ "name": "reset",
"sig": "()",
"type": "function",
- "desc": "Validates the combox array value"
+ "desc": "Resets this form."
},
{
- "name": "validateValue",
- "sig": "(Mixed value)",
+ "name": "resetHasChanged",
+ "sig": "()",
"type": "function",
- "desc": "Validates a value according to the field's validation rules and marks the field as invalid\nif the validation fails"
+ "desc": "Resets all hasChanged to 'false' -\nThe old 'isDirty' used 'original value..' however this breaks reset() and a few other things.\nSo hasChanged storage is only to be used for this purpose"
+ },
+ {
+ "name": "setValues",
+ "sig": "(Array/Object values)",
+ "type": "function",
+ "desc": "Set values for fields in this form in bulk."
+ },
+ {
+ "name": "submit",
+ "sig": "(Object options)",
+ "type": "function",
+ "desc": "Shortcut to do a submit action."
+ },
+ {
+ "name": "un",
+ "sig": "(String eventName, Function handler, Object scope)",
+ "type": "function",
+ "desc": "Removes a listener (shorthand for removeListener)"
+ },
+ {
+ "name": "updateRecord",
+ "sig": "(Record record)",
+ "type": "function",
+ "desc": "Persists the values in this form into the passed Roo.data.Record object in a beginEdit/endEdit block."
}
]
},
- "Roo.form.ComboBoxArray.Item": {
+ "Roo.form.Checkbox": {
"props": [
+ {
+ "name": "focusClass",
+ "type": "String",
+ "desc": "The CSS class to use when the checkbox receives focus (defaults to undefined)",
+ "memberOf": ""
+ },
+ {
+ "name": "fieldClass",
+ "type": "String",
+ "desc": "The default CSS class for the checkbox (defaults to \"x-form-field\")",
+ "memberOf": ""
+ },
+ {
+ "name": "checked",
+ "type": "Boolean",
+ "desc": "True if the the checkbox should render already checked (defaults to false)",
+ "memberOf": ""
+ },
+ {
+ "name": "autoCreate",
+ "type": "String/Object",
+ "desc": "A DomHelper element spec, or true for a default element spec (defaults to\n{tag: \"input\", type: \"checkbox\", autocomplete: \"off\"})",
+ "memberOf": ""
+ },
+ {
+ "name": "boxLabel",
+ "type": "String",
+ "desc": "The text that appears beside the checkbox",
+ "memberOf": ""
+ },
+ {
+ "name": "inputValue",
+ "type": "String",
+ "desc": "The value that should go into the generated input element's value attribute",
+ "memberOf": ""
+ },
+ {
+ "name": "valueOff",
+ "type": "String",
+ "desc": "The value that should go into the generated input element's value when unchecked.",
+ "memberOf": ""
+ },
+ {
+ "name": "fieldLabel",
+ "type": "String",
+ "desc": "Label to use when rendering a form.",
+ "memberOf": "Roo.form.Field"
+ },
+ {
+ "name": "qtip",
+ "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 CSS class to use when marking a field invalid (defaults to \"x-form-invalid\")",
+ "memberOf": "Roo.form.Field"
+ },
+ {
+ "name": "invalidText",
+ "type": "String",
+ "desc": "The error text to use when marking a field invalid and no message is provided (defaults to \"The value in this field is invalid\")",
+ "memberOf": "Roo.form.Field"
+ },
+ {
+ "name": "validationEvent",
+ "type": "String/Boolean",
+ "desc": "The event that should initiate field validation. Set to false to disable\n automatic validation (defaults to \"keyup\").",
+ "memberOf": "Roo.form.Field"
+ },
+ {
+ "name": "validateOnBlur",
+ "type": "Boolean",
+ "desc": "Whether the field should validate when it loses focus (defaults to true).",
+ "memberOf": "Roo.form.Field"
+ },
+ {
+ "name": "validationDelay",
+ "type": "Number",
+ "desc": "The length of time in milliseconds after user input begins until validation is initiated (defaults to 250)",
+ "memberOf": "Roo.form.Field"
+ },
+ {
+ "name": "msgTarget",
+ "type": "String",
+ "desc": "The location where error text should display. Should be one of the following values (defaults to 'qtip'):\n<pre>\nValue Description\n----------- ----------------------------------------------------------------------\nqtip Display a quick tip when the user hovers over the field\ntitle Display a default browser title attribute popup\nunder Add a block div beneath the field containing the error text\nside Add an error icon to the right of the field with a popup on hover\n[element id] Add the error text directly to the innerHTML of the specified element\n</pre>",
+ "memberOf": "Roo.form.Field"
+ },
+ {
+ "name": "msgFx",
+ "type": "String",
+ "desc": "<b>Experimental</b> The effect used when displaying a validation message under the field (defaults to 'normal').",
+ "memberOf": "Roo.form.Field"
+ },
+ {
+ "name": "readOnly",
+ "type": "Boolean",
+ "desc": "True to mark the field as readOnly in HTML (defaults to false) -- Note: this only sets the element's readOnly DOM attribute.",
+ "memberOf": "Roo.form.Field"
+ },
+ {
+ "name": "disabled",
+ "type": "Boolean",
+ "desc": "True to disable the field (defaults to false).",
+ "memberOf": "Roo.form.Field"
+ },
+ {
+ "name": "inputType",
+ "type": "String",
+ "desc": "The type attribute for input fields -- e.g. radio, text, password (defaults to \"text\").",
+ "memberOf": "Roo.form.Field"
+ },
+ {
+ "name": "tabIndex",
+ "type": "Number",
+ "desc": "The tabIndex for this field. Note this only applies to fields that are rendered, not those which are built via applyTo (defaults to undefined).",
+ "memberOf": "Roo.form.Field"
+ },
+ {
+ "name": "value",
+ "type": "Mixed",
+ "desc": "A value to initialize this field with.",
+ "memberOf": "Roo.form.Field"
+ },
+ {
+ "name": "cls",
+ "type": "String",
+ "desc": "A CSS class to apply to the field's underlying element.",
+ "memberOf": "Roo.form.Field"
+ },
{
"name": "width",
"type": "Number",
"type": "function",
"desc": "Fires before the component is shown. Return false to stop the show."
},
+ {
+ "name": "blur",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires when this field loses input focus."
+ },
+ {
+ "name": "change",
+ "sig": "function (_self, newValue, oldValue)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires just before the field blurs if the field value has changed."
+ },
+ {
+ "name": "check",
+ "sig": "function (_self, checked)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires when the checkbox is checked or unchecked."
+ },
{
"name": "destroy",
"sig": "function (_self)\n{\n\n}",
"type": "function",
"desc": "Fires after the component is enabled."
},
+ {
+ "name": "focus",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires when this field receives input focus."
+ },
{
"name": "hide",
"sig": "function (_self)\n{\n\n}",
"type": "function",
"desc": "Fires after the component is hidden."
},
+ {
+ "name": "invalid",
+ "sig": "function (_self, msg)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires after the field has been marked as invalid."
+ },
+ {
+ "name": "keyup",
+ "sig": "function (_self, e)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires after the key up"
+ },
{
"name": "move",
"sig": "function (_self, x, y)\n{\n\n}",
"sig": "function (_self)\n{\n\n}",
"type": "function",
"desc": "Fires after the component is shown."
+ },
+ {
+ "name": "specialkey",
+ "sig": "function (_self, e)\n{\n\n}",
+ "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."
+ },
+ {
+ "name": "valid",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires after the field has been validated with no errors."
}
],
"methods": [
"type": "function",
"desc": "Appends an event handler to this component"
},
+ {
+ "name": "applyTo",
+ "sig": "(String/HTMLElement/Element el)",
+ "type": "function",
+ "desc": "Apply the behaviors of this component to an existing element. <b>This is used instead of render().</b>"
+ },
{
"name": "capture",
"sig": "(Observable o, Function fn, Object scope)",
"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."
},
{
- "name": "destroy",
+ "name": "clearInvalid",
"sig": "()",
"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": "Clear any invalid styles/messages for this field"
},
{
- "name": "disable",
+ "name": "destroy",
+ "sig": "()",
+ "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}."
+ },
+ {
+ "name": "disable",
"sig": "()",
"type": "function",
"desc": "Disable this component."
"type": "function",
"desc": "Returns the id of this component."
},
+ {
+ "name": "getName",
+ "sig": "()",
+ "type": "function",
+ "desc": "Returns the name attribute of the field if available"
+ },
{
"name": "getPosition",
"sig": "(Boolean local)",
"type": "function",
"desc": "Gets the current XY position of the component's underlying element."
},
+ {
+ "name": "getRawValue",
+ "sig": "()",
+ "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}."
+ },
{
"name": "getSize",
"sig": "()",
"type": "function",
"desc": "Gets the current size of the component's underlying element."
},
+ {
+ "name": "getValue",
+ "sig": "()",
+ "type": "function",
+ "desc": "Returns the checked state of the checkbox."
+ },
+ {
+ "name": "hasChanged",
+ "sig": "()",
+ "type": "function",
+ "desc": "checks the current value against the 'loaded' value.\nNote - will return false if 'resetHasChanged' has not been called first."
+ },
{
"name": "hasListener",
"sig": "(String eventName)",
"type": "function",
"desc": "Hide this component."
},
+ {
+ "name": "isDirty",
+ "sig": "()",
+ "type": "function",
+ "desc": "Returns true if this field has been changed since it was originally loaded and is not disabled.\nDEPRICATED - it never worked well - use hasChanged/resetHasChanged."
+ },
+ {
+ "name": "isValid",
+ "sig": "(Boolean preventMark)",
+ "type": "function",
+ "desc": "Returns whether or not the field value is currently valid"
+ },
{
"name": "isVisible",
"sig": "()",
"type": "function",
"desc": "Returns true if this component is visible."
},
+ {
+ "name": "markInvalid",
+ "sig": "(String msg)",
+ "type": "function",
+ "desc": "Mark this field as invalid"
+ },
{
"name": "on",
"sig": "(String eventName, Function handler, Object scope, Object options)",
"type": "function",
"desc": "If this is a lazy rendering component, render it to its container element."
},
+ {
+ "name": "reset",
+ "sig": "()",
+ "type": "function",
+ "desc": "Resets the current field value to the originally loaded value and clears any validation messages"
+ },
+ {
+ "name": "resetHasChanged",
+ "sig": "()",
+ "type": "function",
+ "desc": "stores the current value in loadedValue"
+ },
{
"name": "setDisabled",
"sig": "(Boolean disabled)",
"type": "function",
"desc": "Sets the left and top of the component. To set the page XY position instead, use {@link #setPagePosition}.\nThis method fires the move event."
},
+ {
+ "name": "setRawValue",
+ "sig": "(Mixed value)",
+ "type": "function",
+ "desc": "Sets the underlying DOM field's value directly, bypassing validation. To set the value with validation see {@link #setValue}."
+ },
{
"name": "setSize",
"sig": "(Number/Object width, Number height)",
"type": "function",
"desc": "Sets the width and height of the component. This method fires the resize event. This method can accept\neither width and height as separate numeric arguments, or you can pass a size object like {width:10, height:20}."
},
+ {
+ "name": "setValue",
+ "sig": "(Boolean/String value, Boolean/String suppressEvent)",
+ "type": "function",
+ "desc": "Sets the checked state of the checkbox.\nOn is always based on a string comparison between inputValue and the param."
+ },
{
"name": "setVisible",
"sig": "(Boolean visible)",
"sig": "(Object box)",
"type": "function",
"desc": "Sets the current box measurements of the component's underlying element."
+ },
+ {
+ "name": "validate",
+ "sig": "()",
+ "type": "function",
+ "desc": "Validates the field value"
}
]
},
- "Roo.form.ComboCheck": {
+ "Roo.form.Column": {
+ "props": [
+ {
+ "name": "width",
+ "type": "Number/String",
+ "desc": "The fixed width of the column in pixels or CSS value (defaults to \"auto\")",
+ "memberOf": ""
+ },
+ {
+ "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": ""
+ },
+ {
+ "name": "style",
+ "type": "String/Object/Function",
+ "desc": "A style specification string, e.g. \"width:100px\", or object in the form {width:\"100px\"}, or\na function which returns such a specification.",
+ "memberOf": "Roo.form.Layout"
+ },
+ {
+ "name": "labelAlign",
+ "type": "String",
+ "desc": "Valid values are \"left,\" \"top\" and \"right\" (defaults to \"left\")",
+ "memberOf": "Roo.form.Layout"
+ },
+ {
+ "name": "labelWidth",
+ "type": "Number",
+ "desc": "Fixed width in pixels of all field labels (defaults to undefined)",
+ "memberOf": "Roo.form.Layout"
+ },
+ {
+ "name": "clear",
+ "type": "Boolean",
+ "desc": "True to add a clearing element at the end of this layout, equivalent to CSS clear: both (defaults to true)",
+ "memberOf": "Roo.form.Layout"
+ },
+ {
+ "name": "labelSeparator",
+ "type": "String",
+ "desc": "The separator to use after field labels (defaults to ':')",
+ "memberOf": "Roo.form.Layout"
+ },
+ {
+ "name": "hideLabels",
+ "type": "Boolean",
+ "desc": "True to suppress the display of field labels in this layout (defaults to false)",
+ "memberOf": "Roo.form.Layout"
+ },
+ {
+ "name": "disableClass",
+ "type": "String",
+ "desc": "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").",
+ "memberOf": "Roo.Component"
+ },
+ {
+ "name": "allowDomMove",
+ "type": "Boolean",
+ "desc": "Whether the component can move the Dom node when rendering (defaults to true).",
+ "memberOf": "Roo.Component"
+ },
+ {
+ "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\".",
+ "memberOf": "Roo.Component",
+ "optvals": [
+ "display",
+ "visibility"
+ ]
+ },
+ {
+ "name": "actionMode",
+ "type": "String",
+ "desc": "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el'",
+ "memberOf": "Roo.Component"
+ },
+ {
+ "name": "listeners",
+ "type": "Object",
+ "desc": "list of events and functions to call for 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": "beforedestroy",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires before the component is destroyed. Return false to stop the destroy."
+ },
+ {
+ "name": "beforehide",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires before the component is hidden. Return false to stop the hide."
+ },
+ {
+ "name": "beforerender",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires before the component is rendered. Return false to stop the render."
+ },
+ {
+ "name": "beforeshow",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires before the component is shown. Return false to stop the show."
+ },
+ {
+ "name": "destroy",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires after the component is destroyed."
+ },
+ {
+ "name": "disable",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires after the component is disabled."
+ },
+ {
+ "name": "enable",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires after the component is enabled."
+ },
+ {
+ "name": "hide",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires after the component is hidden."
+ },
+ {
+ "name": "render",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires after the component is rendered."
+ },
+ {
+ "name": "show",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires after the component is shown."
+ }
+ ],
+ "methods": [
+ {
+ "name": "addEvents",
+ "sig": "(Object object)",
+ "type": "function",
+ "desc": "Used to define events on this Observable"
+ },
+ {
+ "name": "addListener",
+ "sig": "(String eventName, Function handler, Object scope, Object options)",
+ "type": "function",
+ "desc": "Appends an event handler to this component"
+ },
+ {
+ "name": "addxtype",
+ "sig": "(Object config)",
+ "type": "function",
+ "desc": "Adds a object form elements (using the xtype property as the factory method.)\nValid xtypes are: TextField, TextArea .... Button, Layout, FieldSet, Column"
+ },
+ {
+ "name": "capture",
+ "sig": "(Observable o, Function fn, Object scope)",
+ "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."
+ },
+ {
+ "name": "destroy",
+ "sig": "()",
+ "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}."
+ },
+ {
+ "name": "disable",
+ "sig": "()",
+ "type": "function",
+ "desc": "Disable this component."
+ },
+ {
+ "name": "enable",
+ "sig": "()",
+ "type": "function",
+ "desc": "Enable this component."
+ },
+ {
+ "name": "fireEvent",
+ "sig": "(String eventName, Object... args)",
+ "type": "function",
+ "desc": "Fires the specified event with the passed parameters (minus the event name)."
+ },
+ {
+ "name": "focus",
+ "sig": "(Boolean selectText)",
+ "type": "function",
+ "desc": "Try to focus this component."
+ },
+ {
+ "name": "getEl",
+ "sig": "()",
+ "type": "function",
+ "desc": "Returns the underlying {@link Roo.Element}."
+ },
+ {
+ "name": "getId",
+ "sig": "()",
+ "type": "function",
+ "desc": "Returns the id of this component."
+ },
+ {
+ "name": "hasListener",
+ "sig": "(String eventName)",
+ "type": "function",
+ "desc": "Checks to see if this object has any listeners for a specified event"
+ },
+ {
+ "name": "hide",
+ "sig": "()",
+ "type": "function",
+ "desc": "Hide this component."
+ },
+ {
+ "name": "isVisible",
+ "sig": "()",
+ "type": "function",
+ "desc": "Returns true if this component is visible."
+ },
+ {
+ "name": "on",
+ "sig": "(String eventName, Function handler, Object scope, Object options)",
+ "type": "function",
+ "desc": "Appends an event handler to this element (shorthand for addListener)"
+ },
+ {
+ "name": "purgeListeners",
+ "sig": "()",
+ "type": "function",
+ "desc": "Removes all listeners for this object"
+ },
+ {
+ "name": "releaseCapture",
+ "sig": "(Observable o)",
+ "type": "function",
+ "desc": "Removes <b>all</b> added captures from the Observable."
+ },
+ {
+ "name": "removeListener",
+ "sig": "(String eventName, Function handler, Object scope)",
+ "type": "function",
+ "desc": "Removes a listener"
+ },
+ {
+ "name": "render",
+ "sig": "(String/HTMLElement/Element container)",
+ "type": "function",
+ "desc": "If this is a lazy rendering component, render it to its container element."
+ },
+ {
+ "name": "setDisabled",
+ "sig": "(Boolean disabled)",
+ "type": "function",
+ "desc": "Convenience function for setting disabled/enabled by boolean."
+ },
+ {
+ "name": "setVisible",
+ "sig": "(Boolean visible)",
+ "type": "function",
+ "desc": "Convenience function to hide or show this component by boolean."
+ },
+ {
+ "name": "show",
+ "sig": "()",
+ "type": "function",
+ "desc": "Show this component."
+ },
+ {
+ "name": "un",
+ "sig": "(String eventName, Function handler, Object scope)",
+ "type": "function",
+ "desc": "Removes a listener (shorthand for removeListener)"
+ }
+ ]
+ },
+ "Roo.form.ComboBox": {
"props": [
{
"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": ""
},
{
"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": ""
},
{
"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": ""
},
{
"name": "store",
"type": "Roo.data.Store",
"desc": "The data store to which this combo is bound (defaults to undefined)",
- "memberOf": "Roo.form.ComboBox"
+ "memberOf": ""
},
{
"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": ""
},
{
"name": "grow",
"type": "Boolean",
"desc": "",
- "memberOf": "Roo.form.ComboBox"
+ "memberOf": ""
},
{
"name": "growMin",
"type": "Number",
"desc": "",
- "memberOf": "Roo.form.ComboBox"
+ "memberOf": ""
},
{
"name": "growMax",
"type": "Number",
"desc": "",
- "memberOf": "Roo.form.ComboBox"
+ "memberOf": ""
},
{
"name": "tpl",
"type": "String/Roo.Template",
"desc": "The template to use to render the output",
- "memberOf": "Roo.form.ComboBox"
+ "memberOf": ""
},
{
"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": ""
},
{
"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": ""
},
{
"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": ""
},
{
"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": ""
},
{
"name": "listClass",
"type": "String",
"desc": "CSS class to apply to the dropdown list element (defaults to '')",
- "memberOf": "Roo.form.ComboBox"
+ "memberOf": ""
},
{
"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": ""
},
{
"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": ""
},
{
"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": ""
},
{
"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": ""
},
{
"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": ""
},
{
"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": ""
},
{
"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": ""
},
{
"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": ""
},
{
"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": ""
},
{
"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": ""
},
{
"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": ""
},
{
"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": ""
},
{
"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": ""
},
{
"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": ""
},
{
"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": ""
},
{
"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": ""
},
{
"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": ""
},
{
"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": ""
},
{
"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": ""
},
{
"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": ""
},
{
"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": ""
},
{
"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": ""
},
{
"name": "blockFocus",
"type": "Boolean",
"desc": "Prevents all focus calls, so it can work with things like HTML edtor bar",
- "memberOf": "Roo.form.ComboBox"
+ "memberOf": ""
},
{
"name": "disableClear",
"type": "Boolean",
"desc": "Disable showing of clear button.",
- "memberOf": "Roo.form.ComboBox"
+ "memberOf": ""
},
{
"name": "alwaysQuery",
"type": "Boolean",
"desc": "Disable caching of results, and always send query",
- "memberOf": "Roo.form.ComboBox"
+ "memberOf": ""
},
{
"name": "hideTrigger",
"type": "function",
"desc": "Returns the currently selected field value or empty string if no value is set."
},
+ {
+ "name": "hasChanged",
+ "sig": "()",
+ "type": "function",
+ "desc": "checks the current value against the 'loaded' value.\nNote - will return false if 'resetHasChanged' has not been called first."
+ },
{
"name": "hasListener",
"sig": "(String eventName)",
"name": "isDirty",
"sig": "()",
"type": "function",
- "desc": "Returns true if this field has been changed since it was originally loaded and is not disabled."
+ "desc": "Returns true if this field has been changed since it was originally loaded and is not disabled.\nDEPRICATED - it never worked well - use hasChanged/resetHasChanged."
},
{
"name": "isExpanded",
"type": "function",
"desc": "Resets the current field value to the originally-loaded value and clears any validation messages."
},
+ {
+ "name": "resetHasChanged",
+ "sig": "()",
+ "type": "function",
+ "desc": "stores the current value in loadedValue"
+ },
{
"name": "select",
"sig": "(Number index, Boolean scrollIntoView)",
}
]
},
- "Roo.form.DateField": {
+ "Roo.form.ComboBoxArray": {
"props": [
{
- "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": ""
- },
- {
- "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": ""
- },
- {
- "name": "disabledDays",
- "type": "Array",
- "desc": "An array of days to disable, 0 based. For example, [0, 6] disables Sunday and Saturday (defaults to null).",
- "memberOf": ""
- },
- {
- "name": "disabledDaysText",
- "type": "String",
- "desc": "The tooltip to display when the date falls on a disabled day (defaults to 'Disabled')",
- "memberOf": ""
- },
- {
- "name": "disabledDates",
- "type": "Array",
- "desc": "An array of \"dates\" to disable, as strings. These strings will be used to build a dynamic regular\nexpression so they are very powerful. Some examples:\n<ul>\n<li>[\"03/08/2003\", \"09/16/2003\"] would disable those exact dates</li>\n<li>[\"03/08\", \"09/16\"] would disable those days for every year</li>\n<li>[\"^03/08\"] would only match the beginning (useful if you are using short years)</li>\n<li>[\"03/../2006\"] would disable every day in March 2006</li>\n<li>[\"^03\"] would disable every day in every March</li>\n</ul>\nIn order to support regular expressions, if you are using a date format that has \".\" in it, you will have to\nescape the dot when restricting dates. For example: [\"03\\\\.08\\\\.03\"].",
- "memberOf": ""
- },
- {
- "name": "disabledDatesText",
- "type": "String",
- "desc": "The tooltip text to display when the date falls on a disabled date (defaults to 'Disabled')",
- "memberOf": ""
- },
- {
- "name": "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": ""
- },
- {
- "name": "maxValue",
- "type": "Date/String",
- "desc": "The maximum allowed date. Can be either a Javascript date object or a string date in a\nvalid format (defaults to null).",
- "memberOf": ""
- },
- {
- "name": "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}').",
+ "name": "combo",
+ "type": "Roo.form.Combo",
+ "desc": "The combo box that is wrapped",
"memberOf": ""
},
{
- "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}').",
+ "name": "width",
+ "type": "Number",
+ "desc": "The width of the box that displays the selected element",
"memberOf": ""
},
{
- "name": "invalidText",
+ "name": "name",
"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}').",
+ "desc": "The name of the visable items on this form (eg. titles not ids)",
"memberOf": ""
},
{
- "name": "triggerClass",
+ "name": "hiddenName",
"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).",
+ "desc": "The hidden name of the field, often contains an comma seperated list of names",
"memberOf": ""
},
{
- "name": "useIso",
+ "name": "grow",
"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": ""
+ "desc": "True if this field should automatically grow and shrink to its content",
+ "memberOf": "Roo.form.TextField"
},
{
- "name": "autoCreate",
- "type": "String/Object",
- "desc": "A DomHelper element spec, or true for a default element spec (defaults to\n{tag: \"input\", type: \"text\", size: \"10\", autocomplete: \"off\"})",
- "memberOf": ""
+ "name": "growMin",
+ "type": "Number",
+ "desc": "The minimum width to allow when grow = true (defaults to 30)",
+ "memberOf": "Roo.form.TextField"
},
{
- "name": "hideTrigger",
- "type": "Boolean",
- "desc": "True to hide the trigger element and display only the base text field (defaults to false)",
- "memberOf": "Roo.form.TriggerField"
+ "name": "growMax",
+ "type": "Number",
+ "desc": "The maximum width to allow when grow = true (defaults to 800)",
+ "memberOf": "Roo.form.TextField"
},
{
"name": "vtype",
"memberOf": "Roo.form.Field"
},
{
- "name": "name",
+ "name": "invalidClass",
"type": "String",
- "desc": "The field's HTML name attribute.",
+ "desc": "The CSS class to use when marking a field invalid (defaults to \"x-form-invalid\")",
"memberOf": "Roo.form.Field"
},
{
- "name": "invalidClass",
+ "name": "invalidText",
"type": "String",
- "desc": "The CSS class to use when marking a field invalid (defaults to \"x-form-invalid\")",
+ "desc": "The error text to use when marking a field invalid and no message is provided (defaults to \"The value in this field is invalid\")",
"memberOf": "Roo.form.Field"
},
{
"desc": "The 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",
"type": "function",
"desc": "Fires before the component is hidden. Return false to stop the hide."
},
+ {
+ "name": "beforeremove",
+ "sig": "function (_self, item)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires before remove the value from the list"
+ },
{
"name": "beforerender",
"sig": "function (_self)\n{\n\n}",
"type": "function",
"desc": "Fires after the component is moved."
},
+ {
+ "name": "remove",
+ "sig": "function (_self, item)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires when remove the value from the list"
+ },
{
"name": "render",
"sig": "function (_self)\n{\n\n}",
"type": "function",
"desc": "Fires after the component is resized."
},
- {
- "name": "select",
- "sig": "function (combo, date)\n{\n\n}",
- "type": "function",
- "desc": "Fires when a date is selected"
- },
{
"name": "show",
"sig": "function (_self)\n{\n\n}",
"type": "function",
"desc": "Apply the behaviors of this component to an existing element. <b>This is used instead of render().</b>"
},
+ {
+ "name": "autoSize",
+ "sig": "()",
+ "type": "function",
+ "desc": "Automatically grows the field to accomodate the width of the text up to the maximum field width allowed.\nThis only takes effect if grow = true, and fires the autosize event."
+ },
{
"name": "capture",
"sig": "(Observable o, Function fn, Object scope)",
"name": "getValue",
"sig": "()",
"type": "function",
- "desc": "Returns the current date value of the date field."
+ "desc": "Returns the normalized data value (undefined or emptyText will be returned as ''). To return the raw value see {@link #getRawValue}."
+ },
+ {
+ "name": "hasChanged",
+ "sig": "()",
+ "type": "function",
+ "desc": "checks the current value against the 'loaded' value.\nNote - will return false if 'resetHasChanged' has not been called first."
},
{
"name": "hasListener",
"name": "isDirty",
"sig": "()",
"type": "function",
- "desc": "Returns true if this field has been changed since it was originally loaded and is not disabled."
+ "desc": "Returns true if this field has been changed since it was originally loaded and is not disabled.\nDEPRICATED - it never worked well - use hasChanged/resetHasChanged."
},
{
"name": "isValid",
"type": "function",
"desc": "Called after the component is resized, this method is empty by default but can be implemented by any\nsubclass that needs to perform custom logic after a resize occurs."
},
- {
- "name": "onTriggerClick",
- "sig": "(EventObject e)",
- "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."
- },
{
"name": "purgeListeners",
"sig": "()",
"type": "function",
"desc": "Resets the current field value to the originally-loaded value and clears any validation messages."
},
+ {
+ "name": "resetHasChanged",
+ "sig": "()",
+ "type": "function",
+ "desc": "stores the current value in loadedValue"
+ },
{
"name": "selectText",
"sig": "(Number start, Number end)",
},
{
"name": "setValue",
- "sig": "(String/Date date)",
+ "sig": "(Mixed value)",
"type": "function",
- "desc": "Sets the value of the date field. You can pass a date object or any string that can be parsed into a valid\ndate, using DateField.format as the date format, according to the same rules as {@link Date#parseDate}\n(the default format used is \"m/d/y\").\n<br />Usage:\n<pre><code>\n//All of these calls set the same date value (May 4, 2006)\n\n//Pass a date object:\nvar dt = new Date('5/4/06');\ndateField.setValue(dt);\n\n//Pass a date string (default format):\ndateField.setValue('5/4/06');\n\n//Pass a date string (custom format):\ndateField.format = 'Y-m-d';\ndateField.setValue('2006-5-4');\n</code></pre>"
+ "desc": "Sets a data value into the field and validates it. To set the value directly without validation see {@link #setRawValue}."
},
{
"name": "setVisible",
"name": "validate",
"sig": "()",
"type": "function",
- "desc": "Validates the field value"
+ "desc": "Validates the combox array value"
},
{
"name": "validateValue",
}
]
},
- "Roo.form.DayPicker": {
+ "Roo.form.ComboBoxArray.Item": {
"props": [
- {
- "name": "focusClass",
- "type": "String",
- "desc": "The CSS class to use when the checkbox receives focus (defaults to undefined)",
- "memberOf": ""
- },
- {
- "name": "fieldClass",
- "type": "String",
- "desc": "The default CSS class for the checkbox (defaults to \"x-form-field\")",
- "memberOf": ""
- },
- {
- "name": "autoCreate",
- "type": "String/Object",
- "desc": "A DomHelper element spec, or true for a default element spec (defaults to\n{tag: \"input\", type: \"checkbox\", autocomplete: \"off\"})",
- "memberOf": ""
- },
- {
- "name": "fieldLabel",
- "type": "String",
- "desc": "Label to use when rendering a form.",
- "memberOf": "Roo.form.Field"
- },
- {
- "name": "qtip",
- "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 CSS class to use when marking a field invalid (defaults to \"x-form-invalid\")",
- "memberOf": "Roo.form.Field"
- },
- {
- "name": "invalidText",
- "type": "String",
- "desc": "The error text to use when marking a field invalid and no message is provided (defaults to \"The value in this field is invalid\")",
- "memberOf": "Roo.form.Field"
- },
- {
- "name": "validationEvent",
- "type": "String/Boolean",
- "desc": "The event that should initiate field validation. Set to false to disable\n automatic validation (defaults to \"keyup\").",
- "memberOf": "Roo.form.Field"
- },
- {
- "name": "validateOnBlur",
- "type": "Boolean",
- "desc": "Whether the field should validate when it loses focus (defaults to true).",
- "memberOf": "Roo.form.Field"
- },
- {
- "name": "validationDelay",
- "type": "Number",
- "desc": "The length of time in milliseconds after user input begins until validation is initiated (defaults to 250)",
- "memberOf": "Roo.form.Field"
- },
- {
- "name": "msgTarget",
- "type": "String",
- "desc": "The location where error text should display. Should be one of the following values (defaults to 'qtip'):\n<pre>\nValue Description\n----------- ----------------------------------------------------------------------\nqtip Display a quick tip when the user hovers over the field\ntitle Display a default browser title attribute popup\nunder Add a block div beneath the field containing the error text\nside Add an error icon to the right of the field with a popup on hover\n[element id] Add the error text directly to the innerHTML of the specified element\n</pre>",
- "memberOf": "Roo.form.Field"
- },
- {
- "name": "msgFx",
- "type": "String",
- "desc": "<b>Experimental</b> The effect used when displaying a validation message under the field (defaults to 'normal').",
- "memberOf": "Roo.form.Field"
- },
- {
- "name": "readOnly",
- "type": "Boolean",
- "desc": "True to mark the field as readOnly in HTML (defaults to false) -- Note: this only sets the element's readOnly DOM attribute.",
- "memberOf": "Roo.form.Field"
- },
- {
- "name": "disabled",
- "type": "Boolean",
- "desc": "True to disable the field (defaults to false).",
- "memberOf": "Roo.form.Field"
- },
- {
- "name": "inputType",
- "type": "String",
- "desc": "The type attribute for input fields -- e.g. radio, text, password (defaults to \"text\").",
- "memberOf": "Roo.form.Field"
- },
- {
- "name": "tabIndex",
- "type": "Number",
- "desc": "The tabIndex for this field. Note this only applies to fields that are rendered, not those which are built via applyTo (defaults to undefined).",
- "memberOf": "Roo.form.Field"
- },
- {
- "name": "value",
- "type": "Mixed",
- "desc": "A value to initialize this field with.",
- "memberOf": "Roo.form.Field"
- },
- {
- "name": "cls",
- "type": "String",
- "desc": "A CSS class to apply to the field's underlying element.",
- "memberOf": "Roo.form.Field"
- },
{
"name": "width",
"type": "Number",
"type": "function",
"desc": "Fires before the component is shown. Return false to stop the show."
},
- {
- "name": "blur",
- "sig": "function (_self)\n{\n\n}",
- "type": "function",
- "desc": "Fires when this field loses input focus."
- },
- {
- "name": "change",
- "sig": "function (_self, newValue, oldValue)\n{\n\n}",
- "type": "function",
- "desc": "Fires just before the field blurs if the field value has changed."
- },
{
"name": "destroy",
"sig": "function (_self)\n{\n\n}",
"type": "function",
"desc": "Fires after the component is enabled."
},
- {
- "name": "focus",
- "sig": "function (_self)\n{\n\n}",
- "type": "function",
- "desc": "Fires when this field receives input focus."
- },
{
"name": "hide",
"sig": "function (_self)\n{\n\n}",
"type": "function",
"desc": "Fires after the component is hidden."
},
- {
- "name": "invalid",
- "sig": "function (_self, msg)\n{\n\n}",
- "type": "function",
- "desc": "Fires after the field has been marked as invalid."
- },
- {
- "name": "keyup",
- "sig": "function (_self, e)\n{\n\n}",
- "type": "function",
- "desc": "Fires after the key up"
- },
{
"name": "move",
"sig": "function (_self, x, y)\n{\n\n}",
"sig": "function (_self)\n{\n\n}",
"type": "function",
"desc": "Fires after the component is shown."
- },
- {
- "name": "specialkey",
- "sig": "function (_self, e)\n{\n\n}",
- "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."
- },
- {
- "name": "valid",
- "sig": "function (_self)\n{\n\n}",
- "type": "function",
- "desc": "Fires after the field has been validated with no errors."
}
],
"methods": [
"type": "function",
"desc": "Appends an event handler to this component"
},
- {
- "name": "applyTo",
- "sig": "(String/HTMLElement/Element el)",
- "type": "function",
- "desc": "Apply the behaviors of this component to an existing element. <b>This is used instead of render().</b>"
- },
{
"name": "capture",
"sig": "(Observable o, Function fn, Object scope)",
"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."
},
- {
- "name": "clearInvalid",
- "sig": "()",
- "type": "function",
- "desc": "Clear any invalid styles/messages for this field"
- },
{
"name": "destroy",
"sig": "()",
"type": "function",
"desc": "Returns the id of this component."
},
- {
- "name": "getName",
- "sig": "()",
- "type": "function",
- "desc": "Returns the name attribute of the field if available"
- },
{
"name": "getPosition",
"sig": "(Boolean local)",
"type": "function",
"desc": "Gets the current XY position of the component's underlying element."
},
- {
- "name": "getRawValue",
- "sig": "()",
- "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}."
- },
{
"name": "getSize",
"sig": "()",
"type": "function",
"desc": "Gets the current size of the component's underlying element."
},
- {
- "name": "getValue",
- "sig": "()",
- "type": "function",
- "desc": "Returns the checked state of the checkbox."
- },
{
"name": "hasListener",
"sig": "(String eventName)",
"type": "function",
"desc": "Hide this component."
},
- {
- "name": "isDirty",
- "sig": "()",
- "type": "function",
- "desc": "Returns true if this field has been changed since it was originally loaded and is not disabled."
- },
- {
- "name": "isValid",
- "sig": "(Boolean preventMark)",
- "type": "function",
- "desc": "Returns whether or not the field value is currently valid"
- },
{
"name": "isVisible",
"sig": "()",
"type": "function",
"desc": "Returns true if this component is visible."
},
- {
- "name": "markInvalid",
- "sig": "(String msg)",
- "type": "function",
- "desc": "Mark this field as invalid"
- },
{
"name": "on",
"sig": "(String eventName, Function handler, Object scope, Object options)",
"type": "function",
"desc": "If this is a lazy rendering component, render it to its container element."
},
- {
- "name": "reset",
- "sig": "()",
- "type": "function",
- "desc": "Resets the current field value to the originally loaded value and clears any validation messages"
- },
{
"name": "setDisabled",
"sig": "(Boolean disabled)",
"type": "function",
"desc": "Sets the left and top of the component. To set the page XY position instead, use {@link #setPagePosition}.\nThis method fires the move event."
},
- {
- "name": "setRawValue",
- "sig": "(Mixed value)",
- "type": "function",
- "desc": "Sets the underlying DOM field's value directly, bypassing validation. To set the value with validation see {@link #setValue}."
- },
{
"name": "setSize",
"sig": "(Number/Object width, Number height)",
"type": "function",
"desc": "Sets the width and height of the component. This method fires the resize event. This method can accept\neither width and height as separate numeric arguments, or you can pass a size object like {width:10, height:20}."
},
- {
- "name": "setValue",
- "sig": "(Boolean/String value, Boolean/String suppressEvent)",
- "type": "function",
- "desc": "Sets the checked state of the checkbox.\nOn is always based on a string comparison between inputValue and the param."
- },
{
"name": "setVisible",
"sig": "(Boolean visible)",
"sig": "(Object box)",
"type": "function",
"desc": "Sets the current box measurements of the component's underlying element."
- },
- {
- "name": "validate",
- "sig": "()",
- "type": "function",
- "desc": "Validates the field value"
}
]
},
- "Roo.form.DisplayField": {
+ "Roo.form.ComboCheck": {
"props": [
{
- "name": "focusClass",
+ "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": "title",
"type": "String",
- "desc": "The CSS class to use when the checkbox receives focus (defaults to undefined)",
- "memberOf": ""
+ "desc": "If supplied, a header element is created containing this text and added into the top of\nthe dropdown list (defaults to undefined, with no header element)",
+ "memberOf": "Roo.form.ComboBox"
},
{
- "name": "fieldClass",
+ "name": "grow",
+ "type": "Boolean",
+ "desc": "",
+ "memberOf": "Roo.form.ComboBox"
+ },
+ {
+ "name": "growMin",
+ "type": "Number",
+ "desc": "",
+ "memberOf": "Roo.form.ComboBox"
+ },
+ {
+ "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 default CSS class for the checkbox (defaults to \"x-form-field\")",
- "memberOf": ""
+ "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": "valueRenderer",
+ "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"
+ },
+ {
+ "name": "vtype",
+ "type": "String",
+ "desc": "A validation type name as defined in {@link Roo.form.VTypes} (defaults to null)",
+ "memberOf": "Roo.form.TextField"
+ },
+ {
+ "name": "maskRe",
+ "type": "String",
+ "desc": "An input mask regular expression that will be used to filter keystrokes that don't match (defaults to null)",
+ "memberOf": "Roo.form.TextField"
+ },
+ {
+ "name": "disableKeyFilter",
+ "type": "Boolean",
+ "desc": "True to disable input keystroke filtering (defaults to false)",
+ "memberOf": "Roo.form.TextField"
+ },
+ {
+ "name": "allowBlank",
+ "type": "Boolean",
+ "desc": "False to validate that the value length > 0 (defaults to true)",
+ "memberOf": "Roo.form.TextField"
+ },
+ {
+ "name": "minLength",
+ "type": "Number",
+ "desc": "Minimum input field length required (defaults to 0)",
+ "memberOf": "Roo.form.TextField"
+ },
+ {
+ "name": "maxLength",
+ "type": "Number",
+ "desc": "Maximum input field length allowed (defaults to Number.MAX_VALUE)",
+ "memberOf": "Roo.form.TextField"
+ },
+ {
+ "name": "minLengthText",
+ "type": "String",
+ "desc": "Error text to display if the minimum length validation fails (defaults to \"The minimum length for this field is {minLength}\")",
+ "memberOf": "Roo.form.TextField"
+ },
+ {
+ "name": "maxLengthText",
+ "type": "String",
+ "desc": "Error text to display if the maximum length validation fails (defaults to \"The maximum length for this field is {maxLength}\")",
+ "memberOf": "Roo.form.TextField"
+ },
+ {
+ "name": "blankText",
+ "type": "String",
+ "desc": "Error text to display if the allow blank validation fails (defaults to \"This field is required\")",
+ "memberOf": "Roo.form.TextField"
+ },
+ {
+ "name": "validator",
"type": "Function",
- "desc": "The renderer for the field (so you can reformat output). should return raw HTML",
- "memberOf": ""
+ "desc": "A custom validation function to be called during field validation (defaults to null).\nIf available, this function will be called only after the basic validators all return true, and will be passed the\ncurrent field value and expected to return boolean true if the value is valid or a string error message if invalid.",
+ "memberOf": "Roo.form.TextField"
},
{
- "name": "autoCreate",
- "type": "String/Object",
- "desc": "A DomHelper element spec, or true for a default element spec (defaults to\n{tag: \"input\", type: \"checkbox\", autocomplete: \"off\"})",
- "memberOf": ""
+ "name": "regex",
+ "type": "RegExp",
+ "desc": "A JavaScript RegExp object to be tested against the field value during validation (defaults to null).\nIf available, this regex will be evaluated only after the basic validators all return true, and will be passed the\ncurrent field value. If the test fails, the field will be marked invalid using {@link #regexText}.",
+ "memberOf": "Roo.form.TextField"
+ },
+ {
+ "name": "regexText",
+ "type": "String",
+ "desc": "The error text to display if {@link #regex} is used and the test fails during validation (defaults to \"\")",
+ "memberOf": "Roo.form.TextField"
+ },
+ {
+ "name": "emptyText",
+ "type": "String",
+ "desc": "The default text to display in an empty field - placeholder... (defaults to null).",
+ "memberOf": "Roo.form.TextField"
},
{
"name": "fieldLabel",
"desc": "The error text to use when marking a field invalid and no message is provided (defaults to \"The value in this field is invalid\")",
"memberOf": "Roo.form.Field"
},
+ {
+ "name": "focusClass",
+ "type": "String",
+ "desc": "The CSS class to use when the field receives focus (defaults to \"x-form-focus\")",
+ "memberOf": "Roo.form.Field"
+ },
{
"name": "validationEvent",
"type": "String/Boolean",
"desc": "The length of time in milliseconds after user input begins until validation is initiated (defaults to 250)",
"memberOf": "Roo.form.Field"
},
+ {
+ "name": "fieldClass",
+ "type": "String",
+ "desc": "The default CSS class for the field (defaults to \"x-form-field\")",
+ "memberOf": "Roo.form.Field"
+ },
{
"name": "msgTarget",
"type": "String",
}
],
"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 when the autosize function is triggered. The field may or may not have actually changed size\naccording to the default logic, but this event provides a hook for the developer to apply additional\nlogic at runtime to resize the field if needed."
+ },
{
"name": "beforedestroy",
"sig": "function (_self)\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}",
"desc": "Clear any invalid styles/messages for this field"
},
{
- "name": "destroy",
+ "name": "clearValue",
"sig": "()",
"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": "Clears any text/value currently set in the field"
},
{
- "name": "disable",
+ "name": "collapse",
"sig": "()",
"type": "function",
- "desc": "Disable this component."
+ "desc": "Hides the dropdown list if it is currently expanded. Fires the 'collapse' event on completion."
},
{
- "name": "enable",
+ "name": "destroy",
"sig": "()",
"type": "function",
- "desc": "Enable this component."
+ "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}."
},
{
- "name": "fireEvent",
- "sig": "(String eventName, Object... args)",
+ "name": "disable",
+ "sig": "()",
"type": "function",
- "desc": "Fires the specified event with the passed parameters (minus the event name)."
+ "desc": "Disable this component."
+ },
+ {
+ "name": "doQuery",
+ "sig": "(String query, Boolean forceAll)",
+ "type": "function",
+ "desc": "Execute a query to filter the dropdown list. Fires the beforequery event prior to performing the\nquery allowing the query action to be canceled if needed."
+ },
+ {
+ "name": "enable",
+ "sig": "()",
+ "type": "function",
+ "desc": "Enable this component."
+ },
+ {
+ "name": "expand",
+ "sig": "()",
+ "type": "function",
+ "desc": "Expands the dropdown list if it is currently hidden. Fires the 'expand' event on completion."
+ },
+ {
+ "name": "fireEvent",
+ "sig": "(String eventName, Object... args)",
+ "type": "function",
+ "desc": "Fires the specified event with the passed parameters (minus the event name)."
},
{
"name": "focus",
"name": "getValue",
"sig": "()",
"type": "function",
- "desc": "Returns the normalized data value (undefined or emptyText will be returned as ''). To return the raw value see {@link #getRawValue}."
+ "desc": "Returns the currently selected field value or empty string if no value is set."
+ },
+ {
+ "name": "hasChanged",
+ "sig": "()",
+ "type": "function",
+ "desc": "checks the current value against the 'loaded' value.\nNote - will return false if 'resetHasChanged' has not been called first."
},
{
"name": "hasListener",
"name": "isDirty",
"sig": "()",
"type": "function",
- "desc": "Returns true if this field has been changed since it was originally loaded and is not disabled."
+ "desc": "Returns true if this field has been changed since it was originally loaded and is not disabled.\nDEPRICATED - it never worked well - use hasChanged/resetHasChanged."
+ },
+ {
+ "name": "isExpanded",
+ "sig": "()",
+ "type": "function",
+ "desc": "Returns true if the dropdown list is expanded, else false."
},
{
"name": "isValid",
"type": "function",
"desc": "Called after the component is resized, this method is empty by default but can be implemented by any\nsubclass that needs to perform custom logic after a resize occurs."
},
+ {
+ "name": "onTriggerClick",
+ "sig": "(EventObject e)",
+ "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."
+ },
{
"name": "purgeListeners",
"sig": "()",
"name": "reset",
"sig": "()",
"type": "function",
- "desc": "Resets the current field value to the originally loaded value and clears any validation messages"
+ "desc": "Resets the current field value to the originally-loaded value and clears any validation messages."
+ },
+ {
+ "name": "resetHasChanged",
+ "sig": "()",
+ "type": "function",
+ "desc": "stores the current value in loadedValue"
+ },
+ {
+ "name": "select",
+ "sig": "(Number index, Boolean scrollIntoView)",
+ "type": "function",
+ "desc": "Select an item in the dropdown list by its numeric index in the list. This function does NOT cause the select event to fire.\nThe store must be loaded and the list expanded for this function to work, otherwise use setValue."
+ },
+ {
+ "name": "selectByValue",
+ "sig": "(String value, Boolean scrollIntoView)",
+ "type": "function",
+ "desc": "Select an item in the dropdown list by its data value. This function does NOT cause the select event to fire.\nThe store must be loaded and the list expanded for this function to work, otherwise use setValue."
+ },
+ {
+ "name": "selectText",
+ "sig": "(Number start, Number end)",
+ "type": "function",
+ "desc": "Selects text in this field"
},
{
"name": "setDisabled",
"type": "function",
"desc": "Convenience function for setting disabled/enabled by boolean."
},
+ {
+ "name": "setEditable",
+ "sig": "(Boolean value)",
+ "type": "function",
+ "desc": "Allow or prevent the user from directly editing the field text. If false is passed,\nthe user will only be able to select from the items defined in the dropdown list. This method\nis the runtime equivalent of setting the 'editable' config option at config time."
+ },
+ {
+ "name": "setFromData",
+ "sig": "(Object value)",
+ "type": "function",
+ "desc": "Sets the value of the field based on a object which is related to the record format for the store."
+ },
{
"name": "setPagePosition",
"sig": "(Number x, Number y)",
},
{
"name": "setValue",
- "sig": "(Boolean/String checked)",
+ "sig": "(String value)",
"type": "function",
- "desc": "Sets the checked state of the checkbox."
+ "desc": "Sets the specified value into the field. If the value finds a match, the corresponding record text\nwill be displayed in the field. If the value does not match the data value of an existing item,\nand the valueNotFoundText config option is defined, it will be displayed as the default field text.\nOtherwise the field will be blank (although the value will still be set)."
},
{
"name": "setVisible",
"sig": "()",
"type": "function",
"desc": "Validates the field value"
+ },
+ {
+ "name": "validateValue",
+ "sig": "(Mixed value)",
+ "type": "function",
+ "desc": "Validates a value according to the field's validation rules and marks the field as invalid\nif the validation fails"
}
]
},
- "Roo.form.FCKeditor": {
+ "Roo.form.DateField": {
"props": [
{
- "name": "fck",
- "type": "Object",
- "desc": "options - see fck manual for details.",
+ "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": ""
},
{
- "name": "growMin",
- "type": "Number",
- "desc": "The minimum height to allow when grow = true (defaults to 60)",
- "memberOf": "Roo.form.TextArea"
+ "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": ""
},
{
- "name": "growMax",
- "type": "Number",
- "desc": "The maximum height to allow when grow = true (defaults to 1000)",
- "memberOf": "Roo.form.TextArea"
+ "name": "disabledDays",
+ "type": "Array",
+ "desc": "An array of days to disable, 0 based. For example, [0, 6] disables Sunday and Saturday (defaults to null).",
+ "memberOf": ""
},
{
- "name": "preventScrollbars",
+ "name": "disabledDaysText",
+ "type": "String",
+ "desc": "The tooltip to display when the date falls on a disabled day (defaults to 'Disabled')",
+ "memberOf": ""
+ },
+ {
+ "name": "disabledDates",
+ "type": "Array",
+ "desc": "An array of \"dates\" to disable, as strings. These strings will be used to build a dynamic regular\nexpression so they are very powerful. Some examples:\n<ul>\n<li>[\"03/08/2003\", \"09/16/2003\"] would disable those exact dates</li>\n<li>[\"03/08\", \"09/16\"] would disable those days for every year</li>\n<li>[\"^03/08\"] would only match the beginning (useful if you are using short years)</li>\n<li>[\"03/../2006\"] would disable every day in March 2006</li>\n<li>[\"^03\"] would disable every day in every March</li>\n</ul>\nIn order to support regular expressions, if you are using a date format that has \".\" in it, you will have to\nescape the dot when restricting dates. For example: [\"03\\\\.08\\\\.03\"].",
+ "memberOf": ""
+ },
+ {
+ "name": "disabledDatesText",
+ "type": "String",
+ "desc": "The tooltip text to display when the date falls on a disabled date (defaults to 'Disabled')",
+ "memberOf": ""
+ },
+ {
+ "name": "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": ""
+ },
+ {
+ "name": "maxValue",
+ "type": "Date/String",
+ "desc": "The maximum allowed date. Can be either a Javascript date object or a string date in a\nvalid format (defaults to null).",
+ "memberOf": ""
+ },
+ {
+ "name": "minText",
+ "type": "String",
+ "desc": "The error text to display when the date in the cell is before minValue (defaults to\n'The date in this field must be after {minValue}').",
+ "memberOf": ""
+ },
+ {
+ "name": "maxText",
+ "type": "String",
+ "desc": "The error text to display when the date in the cell is after maxValue (defaults to\n'The date in this field must be before {maxValue}').",
+ "memberOf": ""
+ },
+ {
+ "name": "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": ""
+ },
+ {
+ "name": "triggerClass",
+ "type": "String",
+ "desc": "An additional CSS class used to style the trigger button. The trigger will always get the\nclass 'x-form-trigger' and triggerClass will be <b>appended</b> if specified (defaults to 'x-form-date-trigger'\nwhich displays a calendar icon).",
+ "memberOf": ""
+ },
+ {
+ "name": "useIso",
"type": "Boolean",
- "desc": "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"
+ "desc": "if enabled, then the date field will use a hidden field to store the \nreal value as iso formated date. default (false)",
+ "memberOf": ""
},
{
"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"
+ "desc": "A DomHelper element spec, or true for a default element spec (defaults to\n{tag: \"input\", type: \"text\", size: \"10\", autocomplete: \"off\"})",
+ "memberOf": ""
},
{
- "name": "grow",
+ "name": "hideTrigger",
"type": "Boolean",
- "desc": "True if this field should automatically grow and shrink to its content",
- "memberOf": "Roo.form.TextField"
+ "desc": "True to hide the trigger element and display only the base text field (defaults to false)",
+ "memberOf": "Roo.form.TriggerField"
},
{
"name": "vtype",
"desc": "The CSS class to use when marking a field invalid (defaults to \"x-form-invalid\")",
"memberOf": "Roo.form.Field"
},
- {
- "name": "invalidText",
- "type": "String",
- "desc": "The error text to use when marking a field invalid and no message is provided (defaults to \"The value in this field is invalid\")",
- "memberOf": "Roo.form.Field"
- },
{
"name": "focusClass",
"type": "String",
"type": "function",
"desc": "Fires after the component is disabled."
},
- {
- "name": "editorinit",
- "sig": "function (_self, the)\n{\n\n}",
- "type": "function",
- "desc": "Fired when the editor is initialized - you can add extra handlers here.."
- },
{
"name": "enable",
"sig": "function (_self)\n{\n\n}",
"type": "function",
"desc": "Fires after the component is resized."
},
+ {
+ "name": "select",
+ "sig": "function (combo, date)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires when a date is selected"
+ },
{
"name": "show",
"sig": "function (_self)\n{\n\n}",
"type": "function",
"desc": "Apply the behaviors of this component to an existing element. <b>This is used instead of render().</b>"
},
- {
- "name": "autoSize",
- "sig": "()",
- "type": "function",
- "desc": "Automatically grows the field to accomodate the height of the text up to the maximum field height allowed.\nThis only takes effect if grow = true, and fires the autosize event if the height changes."
- },
{
"name": "capture",
"sig": "(Observable o, Function fn, Object scope)",
"name": "getValue",
"sig": "()",
"type": "function",
- "desc": "Returns the normalized data value (undefined or emptyText will be returned as ''). To return the raw value see {@link #getRawValue}."
+ "desc": "Returns the current date value of the date field."
+ },
+ {
+ "name": "hasChanged",
+ "sig": "()",
+ "type": "function",
+ "desc": "checks the current value against the 'loaded' value.\nNote - will return false if 'resetHasChanged' has not been called first."
},
{
"name": "hasListener",
"name": "isDirty",
"sig": "()",
"type": "function",
- "desc": "Returns true if this field has been changed since it was originally loaded and is not disabled."
+ "desc": "Returns true if this field has been changed since it was originally loaded and is not disabled.\nDEPRICATED - it never worked well - use hasChanged/resetHasChanged."
},
{
"name": "isValid",
"type": "function",
"desc": "Called after the component is resized, this method is empty by default but can be implemented by any\nsubclass that needs to perform custom logic after a resize occurs."
},
+ {
+ "name": "onTriggerClick",
+ "sig": "(EventObject e)",
+ "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."
+ },
{
"name": "purgeListeners",
"sig": "()",
"type": "function",
"desc": "Resets the current field value to the originally-loaded value and clears any validation messages."
},
+ {
+ "name": "resetHasChanged",
+ "sig": "()",
+ "type": "function",
+ "desc": "stores the current value in loadedValue"
+ },
{
"name": "selectText",
"sig": "(Number start, Number end)",
},
{
"name": "setValue",
- "sig": "(Mixed value)",
+ "sig": "(String/Date date)",
"type": "function",
- "desc": "Sets a data value into the field and validates it. To set the value directly without validation see {@link #setRawValue}."
+ "desc": "Sets the value of the date field. You can pass a date object or any string that can be parsed into a valid\ndate, using DateField.format as the date format, according to the same rules as {@link Date#parseDate}\n(the default format used is \"m/d/y\").\n<br />Usage:\n<pre><code>\n//All of these calls set the same date value (May 4, 2006)\n\n//Pass a date object:\nvar dt = new Date('5/4/06');\ndateField.setValue(dt);\n\n//Pass a date string (default format):\ndateField.setValue('5/4/06');\n\n//Pass a date string (custom format):\ndateField.format = 'Y-m-d';\ndateField.setValue('2006-5-4');\n</code></pre>"
},
{
"name": "setVisible",
}
]
},
- "Roo.form.Field": {
+ "Roo.form.DayPicker": {
"props": [
+ {
+ "name": "focusClass",
+ "type": "String",
+ "desc": "The CSS class to use when the checkbox receives focus (defaults to undefined)",
+ "memberOf": ""
+ },
+ {
+ "name": "fieldClass",
+ "type": "String",
+ "desc": "The default CSS class for the checkbox (defaults to \"x-form-field\")",
+ "memberOf": ""
+ },
+ {
+ "name": "autoCreate",
+ "type": "String/Object",
+ "desc": "A DomHelper element spec, or true for a default element spec (defaults to\n{tag: \"input\", type: \"checkbox\", autocomplete: \"off\"})",
+ "memberOf": ""
+ },
{
"name": "fieldLabel",
"type": "String",
"desc": "Label to use when rendering a form.",
- "memberOf": ""
+ "memberOf": "Roo.form.Field"
},
{
"name": "qtip",
"type": "String",
"desc": "Mouse over tip",
- "memberOf": ""
+ "memberOf": "Roo.form.Field"
},
{
"name": "name",
"type": "String",
"desc": "The field's HTML name attribute.",
- "memberOf": ""
+ "memberOf": "Roo.form.Field"
},
{
"name": "invalidClass",
"type": "String",
"desc": "The CSS class to use when marking a field invalid (defaults to \"x-form-invalid\")",
- "memberOf": ""
+ "memberOf": "Roo.form.Field"
},
{
"name": "invalidText",
"type": "String",
"desc": "The error text to use when marking a field invalid and no message is provided (defaults to \"The value in this field is invalid\")",
- "memberOf": ""
- },
- {
- "name": "focusClass",
- "type": "String",
- "desc": "The CSS class to use when the field receives focus (defaults to \"x-form-focus\")",
- "memberOf": ""
+ "memberOf": "Roo.form.Field"
},
{
"name": "validationEvent",
"type": "String/Boolean",
"desc": "The event that should initiate field validation. Set to false to disable\n automatic validation (defaults to \"keyup\").",
- "memberOf": ""
+ "memberOf": "Roo.form.Field"
},
{
"name": "validateOnBlur",
"type": "Boolean",
"desc": "Whether the field should validate when it loses focus (defaults to true).",
- "memberOf": ""
+ "memberOf": "Roo.form.Field"
},
{
"name": "validationDelay",
"type": "Number",
"desc": "The length of time in milliseconds after user input begins until validation is initiated (defaults to 250)",
- "memberOf": ""
- },
- {
- "name": "autoCreate",
- "type": "String/Object",
- "desc": "A DomHelper element spec, or true for a default element spec (defaults to\n{tag: \"input\", type: \"text\", size: \"20\", autocomplete: \"off\"})",
- "memberOf": ""
- },
- {
- "name": "fieldClass",
- "type": "String",
- "desc": "The default CSS class for the field (defaults to \"x-form-field\")",
- "memberOf": ""
+ "memberOf": "Roo.form.Field"
},
{
"name": "msgTarget",
"type": "String",
"desc": "The location where error text should display. Should be one of the following values (defaults to 'qtip'):\n<pre>\nValue Description\n----------- ----------------------------------------------------------------------\nqtip Display a quick tip when the user hovers over the field\ntitle Display a default browser title attribute popup\nunder Add a block div beneath the field containing the error text\nside Add an error icon to the right of the field with a popup on hover\n[element id] Add the error text directly to the innerHTML of the specified element\n</pre>",
- "memberOf": ""
+ "memberOf": "Roo.form.Field"
},
{
"name": "msgFx",
"type": "String",
"desc": "<b>Experimental</b> The effect used when displaying a validation message under the field (defaults to 'normal').",
- "memberOf": ""
+ "memberOf": "Roo.form.Field"
},
{
"name": "readOnly",
"type": "Boolean",
"desc": "True to mark the field as readOnly in HTML (defaults to false) -- Note: this only sets the element's readOnly DOM attribute.",
- "memberOf": ""
+ "memberOf": "Roo.form.Field"
},
{
"name": "disabled",
"type": "Boolean",
"desc": "True to disable the field (defaults to false).",
- "memberOf": ""
+ "memberOf": "Roo.form.Field"
},
{
"name": "inputType",
"type": "String",
"desc": "The type attribute for input fields -- e.g. radio, text, password (defaults to \"text\").",
- "memberOf": ""
+ "memberOf": "Roo.form.Field"
},
{
"name": "tabIndex",
"type": "Number",
"desc": "The tabIndex for this field. Note this only applies to fields that are rendered, not those which are built via applyTo (defaults to undefined).",
- "memberOf": ""
+ "memberOf": "Roo.form.Field"
},
{
"name": "value",
"type": "Mixed",
"desc": "A value to initialize this field with.",
- "memberOf": ""
+ "memberOf": "Roo.form.Field"
},
{
"name": "cls",
"type": "String",
"desc": "A CSS class to apply to the field's underlying element.",
- "memberOf": ""
+ "memberOf": "Roo.form.Field"
},
{
"name": "width",
"name": "getValue",
"sig": "()",
"type": "function",
- "desc": "Returns the normalized data value (undefined or emptyText will be returned as ''). To return the raw value see {@link #getRawValue}."
+ "desc": "Returns the checked state of the checkbox."
+ },
+ {
+ "name": "hasChanged",
+ "sig": "()",
+ "type": "function",
+ "desc": "checks the current value against the 'loaded' value.\nNote - will return false if 'resetHasChanged' has not been called first."
},
{
"name": "hasListener",
"name": "isDirty",
"sig": "()",
"type": "function",
- "desc": "Returns true if this field has been changed since it was originally loaded and is not disabled."
+ "desc": "Returns true if this field has been changed since it was originally loaded and is not disabled.\nDEPRICATED - it never worked well - use hasChanged/resetHasChanged."
},
{
"name": "isValid",
"type": "function",
"desc": "Resets the current field value to the originally loaded value and clears any validation messages"
},
+ {
+ "name": "resetHasChanged",
+ "sig": "()",
+ "type": "function",
+ "desc": "stores the current value in loadedValue"
+ },
{
"name": "setDisabled",
"sig": "(Boolean disabled)",
},
{
"name": "setValue",
- "sig": "(Mixed value)",
+ "sig": "(Boolean/String value, Boolean/String suppressEvent)",
"type": "function",
- "desc": "Sets a data value into the field and validates it. To set the value directly without validation see {@link #setRawValue}."
+ "desc": "Sets the checked state of the checkbox.\nOn is always based on a string comparison between inputValue and the param."
},
{
"name": "setVisible",
}
]
},
- "Roo.form.FieldSet": {
+ "Roo.form.DisplayField": {
"props": [
{
- "name": "legend",
+ "name": "closable",
+ "type": "Boolean",
+ "desc": "default false",
+ "memberOf": "",
+ "optvals": [
+ "true",
+ "false"
+ ]
+ },
+ {
+ "name": "focusClass",
"type": "String",
- "desc": "The text to display as the legend for the FieldSet (defaults to '')",
+ "desc": "The CSS class to use when the checkbox receives focus (defaults to undefined)",
+ "memberOf": ""
+ },
+ {
+ "name": "fieldClass",
+ "type": "String",
+ "desc": "The default CSS class for the checkbox (defaults to \"x-form-field\")",
+ "memberOf": ""
+ },
+ {
+ "name": "valueRenderer",
+ "type": "Function",
+ "desc": "The renderer for the field (so you can reformat output). should return raw HTML",
"memberOf": ""
},
{
"name": "autoCreate",
"type": "String/Object",
- "desc": "A DomHelper element spec used to autocreate the fieldset (defaults to {tag: 'fieldset', cn: {tag:'legend'}})",
+ "desc": "A DomHelper element spec, or true for a default element spec (defaults to\n{tag: \"input\", type: \"checkbox\", autocomplete: \"off\"})",
"memberOf": ""
},
{
- "name": "style",
- "type": "String/Object/Function",
- "desc": "A style specification string, e.g. \"width:100px\", or object in the form {width:\"100px\"}, or\na function which returns such a specification.",
- "memberOf": "Roo.form.Layout"
+ "name": "fieldLabel",
+ "type": "String",
+ "desc": "Label to use when rendering a form.",
+ "memberOf": "Roo.form.Field"
},
{
- "name": "labelAlign",
+ "name": "qtip",
"type": "String",
- "desc": "Valid values are \"left,\" \"top\" and \"right\" (defaults to \"left\")",
- "memberOf": "Roo.form.Layout"
+ "desc": "Mouse over tip",
+ "memberOf": "Roo.form.Field"
},
{
- "name": "labelWidth",
- "type": "Number",
- "desc": "Fixed width in pixels of all field labels (defaults to undefined)",
- "memberOf": "Roo.form.Layout"
+ "name": "name",
+ "type": "String",
+ "desc": "The field's HTML name attribute.",
+ "memberOf": "Roo.form.Field"
},
{
- "name": "clear",
+ "name": "invalidClass",
+ "type": "String",
+ "desc": "The CSS class to use when marking a field invalid (defaults to \"x-form-invalid\")",
+ "memberOf": "Roo.form.Field"
+ },
+ {
+ "name": "invalidText",
+ "type": "String",
+ "desc": "The error text to use when marking a field invalid and no message is provided (defaults to \"The value in this field is invalid\")",
+ "memberOf": "Roo.form.Field"
+ },
+ {
+ "name": "validationEvent",
+ "type": "String/Boolean",
+ "desc": "The event that should initiate field validation. Set to false to disable\n automatic validation (defaults to \"keyup\").",
+ "memberOf": "Roo.form.Field"
+ },
+ {
+ "name": "validateOnBlur",
"type": "Boolean",
- "desc": "True to add a clearing element at the end of this layout, equivalent to CSS clear: both (defaults to true)",
- "memberOf": "Roo.form.Layout"
+ "desc": "Whether the field should validate when it loses focus (defaults to true).",
+ "memberOf": "Roo.form.Field"
},
{
- "name": "labelSeparator",
+ "name": "validationDelay",
+ "type": "Number",
+ "desc": "The length of time in milliseconds after user input begins until validation is initiated (defaults to 250)",
+ "memberOf": "Roo.form.Field"
+ },
+ {
+ "name": "msgTarget",
"type": "String",
- "desc": "The separator to use after field labels (defaults to ':')",
- "memberOf": "Roo.form.Layout"
+ "desc": "The location where error text should display. Should be one of the following values (defaults to 'qtip'):\n<pre>\nValue Description\n----------- ----------------------------------------------------------------------\nqtip Display a quick tip when the user hovers over the field\ntitle Display a default browser title attribute popup\nunder Add a block div beneath the field containing the error text\nside Add an error icon to the right of the field with a popup on hover\n[element id] Add the error text directly to the innerHTML of the specified element\n</pre>",
+ "memberOf": "Roo.form.Field"
},
{
- "name": "hideLabels",
+ "name": "msgFx",
+ "type": "String",
+ "desc": "<b>Experimental</b> The effect used when displaying a validation message under the field (defaults to 'normal').",
+ "memberOf": "Roo.form.Field"
+ },
+ {
+ "name": "readOnly",
"type": "Boolean",
- "desc": "True to suppress the display of field labels in this layout (defaults to false)",
- "memberOf": "Roo.form.Layout"
+ "desc": "True to mark the field as readOnly in HTML (defaults to false) -- Note: this only sets the element's readOnly DOM attribute.",
+ "memberOf": "Roo.form.Field"
+ },
+ {
+ "name": "disabled",
+ "type": "Boolean",
+ "desc": "True to disable the field (defaults to false).",
+ "memberOf": "Roo.form.Field"
+ },
+ {
+ "name": "inputType",
+ "type": "String",
+ "desc": "The type attribute for input fields -- e.g. radio, text, password (defaults to \"text\").",
+ "memberOf": "Roo.form.Field"
+ },
+ {
+ "name": "tabIndex",
+ "type": "Number",
+ "desc": "The tabIndex for this field. Note this only applies to fields that are rendered, not those which are built via applyTo (defaults to undefined).",
+ "memberOf": "Roo.form.Field"
+ },
+ {
+ "name": "value",
+ "type": "Mixed",
+ "desc": "A value to initialize this field with.",
+ "memberOf": "Roo.form.Field"
+ },
+ {
+ "name": "cls",
+ "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",
+ "desc": "height (optional) size of component",
+ "memberOf": "Roo.BoxComponent"
},
{
"name": "disableClass",
"type": "function",
"desc": "Fires before the component is shown. Return false to stop the show."
},
+ {
+ "name": "blur",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires when this field loses input focus."
+ },
+ {
+ "name": "change",
+ "sig": "function (_self, newValue, oldValue)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires just before the field blurs if the field value has changed."
+ },
+ {
+ "name": "close",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires after the click the close btn"
+ },
{
"name": "destroy",
"sig": "function (_self)\n{\n\n}",
"type": "function",
"desc": "Fires after the component is enabled."
},
+ {
+ "name": "focus",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires when this field receives input focus."
+ },
{
"name": "hide",
"sig": "function (_self)\n{\n\n}",
"type": "function",
"desc": "Fires after the component is hidden."
},
+ {
+ "name": "invalid",
+ "sig": "function (_self, msg)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires after the field has been marked as invalid."
+ },
+ {
+ "name": "keyup",
+ "sig": "function (_self, e)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires after the key up"
+ },
+ {
+ "name": "move",
+ "sig": "function (_self, x, y)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires after the component is moved."
+ },
{
"name": "render",
"sig": "function (_self)\n{\n\n}",
"type": "function",
"desc": "Fires after the component is rendered."
},
+ {
+ "name": "resize",
+ "sig": "function (_self, adjWidth, adjHeight, rawWidth, rawHeight)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires after the component is resized."
+ },
{
"name": "show",
"sig": "function (_self)\n{\n\n}",
"type": "function",
"desc": "Fires after the component is shown."
+ },
+ {
+ "name": "specialkey",
+ "sig": "function (_self, e)\n{\n\n}",
+ "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."
+ },
+ {
+ "name": "valid",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires after the field has been validated with no errors."
}
],
"methods": [
"desc": "Appends an event handler to this component"
},
{
- "name": "addxtype",
- "sig": "(Object config)",
+ "name": "applyTo",
+ "sig": "(String/HTMLElement/Element el)",
"type": "function",
- "desc": "Adds a object form elements (using the xtype property as the factory method.)\nValid xtypes are: TextField, TextArea .... Button, Layout, FieldSet, Column"
+ "desc": "Apply the behaviors of this component to an existing element. <b>This is used instead of render().</b>"
},
{
"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."
},
+ {
+ "name": "clearInvalid",
+ "sig": "()",
+ "type": "function",
+ "desc": "Clear any invalid styles/messages for this field"
+ },
{
"name": "destroy",
"sig": "()",
"type": "function",
"desc": "Try to focus this component."
},
+ {
+ "name": "getBox",
+ "sig": "(Boolean local)",
+ "type": "function",
+ "desc": "Gets the current box measurements of the component's underlying element."
+ },
{
"name": "getEl",
"sig": "()",
"type": "function",
"desc": "Returns the id of this component."
},
+ {
+ "name": "getName",
+ "sig": "()",
+ "type": "function",
+ "desc": "Returns the name attribute of the field if available"
+ },
+ {
+ "name": "getPosition",
+ "sig": "(Boolean local)",
+ "type": "function",
+ "desc": "Gets the current XY position of the component's underlying element."
+ },
+ {
+ "name": "getRawValue",
+ "sig": "()",
+ "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}."
+ },
+ {
+ "name": "getSize",
+ "sig": "()",
+ "type": "function",
+ "desc": "Gets the current size of the component's underlying element."
+ },
+ {
+ "name": "getValue",
+ "sig": "()",
+ "type": "function",
+ "desc": "Returns the normalized data value (undefined or emptyText will be returned as ''). To return the raw value see {@link #getRawValue}."
+ },
+ {
+ "name": "hasChanged",
+ "sig": "()",
+ "type": "function",
+ "desc": "checks the current value against the 'loaded' value.\nNote - will return false if 'resetHasChanged' has not been called first."
+ },
{
"name": "hasListener",
"sig": "(String eventName)",
"type": "function",
"desc": "Hide this component."
},
+ {
+ "name": "isDirty",
+ "sig": "()",
+ "type": "function",
+ "desc": "Returns true if this field has been changed since it was originally loaded and is not disabled.\nDEPRICATED - it never worked well - use hasChanged/resetHasChanged."
+ },
+ {
+ "name": "isValid",
+ "sig": "(Boolean preventMark)",
+ "type": "function",
+ "desc": "Returns whether or not the field value is currently valid"
+ },
{
"name": "isVisible",
"sig": "()",
"type": "function",
"desc": "Returns true if this component is visible."
},
+ {
+ "name": "markInvalid",
+ "sig": "(String msg)",
+ "type": "function",
+ "desc": "Mark this field as invalid"
+ },
{
"name": "on",
"sig": "(String eventName, Function handler, Object scope, Object options)",
"type": "function",
"desc": "Appends an event handler to this element (shorthand for addListener)"
},
+ {
+ "name": "onPosition",
+ "sig": "(Number x, Number y)",
+ "type": "function",
+ "desc": "Called after the component is moved, this method is empty by default but can be implemented by any\nsubclass that needs to perform custom logic after a move occurs."
+ },
+ {
+ "name": "onResize",
+ "sig": "(Number adjWidth, Number adjHeight, Number rawWidth, Number rawHeight)",
+ "type": "function",
+ "desc": "Called after the component is resized, this method is empty by default but can be implemented by any\nsubclass that needs to perform custom logic after a resize occurs."
+ },
{
"name": "purgeListeners",
"sig": "()",
"type": "function",
"desc": "If this is a lazy rendering component, render it to its container element."
},
+ {
+ "name": "reset",
+ "sig": "()",
+ "type": "function",
+ "desc": "Resets the current field value to the originally loaded value and clears any validation messages"
+ },
+ {
+ "name": "resetHasChanged",
+ "sig": "()",
+ "type": "function",
+ "desc": "stores the current value in loadedValue"
+ },
{
"name": "setDisabled",
"sig": "(Boolean disabled)",
"type": "function",
"desc": "Convenience function for setting disabled/enabled by boolean."
},
+ {
+ "name": "setPagePosition",
+ "sig": "(Number x, Number y)",
+ "type": "function",
+ "desc": "Sets the page XY position of the component. To set the left and top instead, use {@link #setPosition}.\nThis method fires the move event."
+ },
+ {
+ "name": "setPosition",
+ "sig": "(Number left, Number top)",
+ "type": "function",
+ "desc": "Sets the left and top of the component. To set the page XY position instead, use {@link #setPagePosition}.\nThis method fires the move event."
+ },
+ {
+ "name": "setRawValue",
+ "sig": "(Mixed value)",
+ "type": "function",
+ "desc": "Sets the underlying DOM field's value directly, bypassing validation. To set the value with validation see {@link #setValue}."
+ },
+ {
+ "name": "setSize",
+ "sig": "(Number/Object width, Number height)",
+ "type": "function",
+ "desc": "Sets the width and height of the component. This method fires the resize event. This method can accept\neither width and height as separate numeric arguments, or you can pass a size object like {width:10, height:20}."
+ },
+ {
+ "name": "setValue",
+ "sig": "(Boolean/String checked)",
+ "type": "function",
+ "desc": "Sets the checked state of the checkbox."
+ },
{
"name": "setVisible",
"sig": "(Boolean visible)",
"type": "function",
"desc": "Show this component."
},
+ {
+ "name": "syncSize",
+ "sig": "()",
+ "type": "function",
+ "desc": "Force the component's size to recalculate based on the underlying element's current height and width."
+ },
{
"name": "un",
"sig": "(String eventName, Function handler, Object scope)",
"type": "function",
"desc": "Removes a listener (shorthand for removeListener)"
+ },
+ {
+ "name": "updateBox",
+ "sig": "(Object box)",
+ "type": "function",
+ "desc": "Sets the current box measurements of the component's underlying element."
+ },
+ {
+ "name": "validate",
+ "sig": "()",
+ "type": "function",
+ "desc": "Validates the field value"
}
]
},
- "Roo.form.Form": {
+ "Roo.form.FCKeditor": {
"props": [
{
- "name": "labelWidth",
- "type": "Number",
- "desc": "The width of labels. This property cascades to child containers.",
- "memberOf": ""
- },
- {
- "name": "itemCls",
- "type": "String",
- "desc": "A css class to apply to the x-form-item of fields. This property cascades to child containers.",
+ "name": "fck",
+ "type": "Object",
+ "desc": "options - see fck manual for details.",
"memberOf": ""
},
{
- "name": "buttonAlign",
- "type": "String",
- "desc": "Valid values are \"left,\" \"center\" and \"right\" (defaults to \"center\")",
- "memberOf": ""
+ "name": "growMin",
+ "type": "Number",
+ "desc": "The minimum height to allow when grow = true (defaults to 60)",
+ "memberOf": "Roo.form.TextArea"
},
{
- "name": "minButtonWidth",
+ "name": "growMax",
"type": "Number",
- "desc": "Minimum width of all buttons in pixels (defaults to 75)",
- "memberOf": ""
+ "desc": "The maximum height to allow when grow = true (defaults to 1000)",
+ "memberOf": "Roo.form.TextArea"
},
{
- "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": ""
+ "name": "preventScrollbars",
+ "type": "Boolean",
+ "desc": "True to prevent scrollbars from appearing regardless of how much text is\nin the field (equivalent to setting overflow: hidden, defaults to false)",
+ "memberOf": "Roo.form.TextArea"
},
{
- "name": "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": ""
+ "name": "autoCreate",
+ "type": "String/Object",
+ "desc": "A DomHelper element spec, or true for a default element spec (defaults to\n{tag: \"textarea\", style: \"width:300px;height:60px;\", autocomplete: \"off\"})",
+ "memberOf": "Roo.form.TextArea"
},
{
- "name": "monitorPoll",
- "type": "Number",
- "desc": "The milliseconds to poll valid state, ignored if monitorValid is not true (defaults to 200)",
- "memberOf": ""
+ "name": "grow",
+ "type": "Boolean",
+ "desc": "True if this field should automatically grow and shrink to its content",
+ "memberOf": "Roo.form.TextField"
},
{
- "name": "progressUrl",
+ "name": "vtype",
"type": "String",
- "desc": "- Url to return progress data",
- "memberOf": ""
+ "desc": "A validation type name as defined in {@link Roo.form.VTypes} (defaults to null)",
+ "memberOf": "Roo.form.TextField"
},
{
- "name": "method",
+ "name": "maskRe",
"type": "String",
- "desc": "The request method to use (GET or POST) for form actions if one isn't supplied in the action options.",
- "memberOf": "Roo.form.BasicForm"
+ "desc": "An input mask regular expression that will be used to filter keystrokes that don't match (defaults to null)",
+ "memberOf": "Roo.form.TextField"
},
{
- "name": "reader",
- "type": "DataReader",
- "desc": "An Roo.data.DataReader (e.g. {@link Roo.data.XmlReader}) to be used to read data when executing \"load\" actions.\nThis is optional as there is built-in support for processing JSON.",
- "memberOf": "Roo.form.BasicForm"
+ "name": "disableKeyFilter",
+ "type": "Boolean",
+ "desc": "True to disable input keystroke filtering (defaults to false)",
+ "memberOf": "Roo.form.TextField"
},
{
- "name": "errorReader",
- "type": "DataReader",
- "desc": "An Roo.data.DataReader (e.g. {@link Roo.data.XmlReader}) to be used to read data when reading validation errors on \"submit\" actions.\nThis is completely optional as there is built-in support for processing JSON.",
- "memberOf": "Roo.form.BasicForm"
+ "name": "allowBlank",
+ "type": "Boolean",
+ "desc": "False to validate that the value length > 0 (defaults to true)",
+ "memberOf": "Roo.form.TextField"
},
{
- "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"
+ "name": "minLength",
+ "type": "Number",
+ "desc": "Minimum input field length required (defaults to 0)",
+ "memberOf": "Roo.form.TextField"
},
{
- "name": "fileUpload",
- "type": "Boolean",
- "desc": "Set to true if this form is a file upload.",
- "memberOf": "Roo.form.BasicForm"
+ "name": "maxLength",
+ "type": "Number",
+ "desc": "Maximum input field length allowed (defaults to Number.MAX_VALUE)",
+ "memberOf": "Roo.form.TextField"
},
{
- "name": "baseParams",
- "type": "Object",
- "desc": "Parameters to pass with all requests. e.g. baseParams: {id: '123', foo: 'bar'}.",
- "memberOf": "Roo.form.BasicForm"
+ "name": "minLengthText",
+ "type": "String",
+ "desc": "Error text to display if the minimum length validation fails (defaults to \"The minimum length for this field is {minLength}\")",
+ "memberOf": "Roo.form.TextField"
},
{
- "name": "timeout",
- "type": "Number",
- "desc": "Timeout for form actions in seconds (default is 30 seconds).",
- "memberOf": "Roo.form.BasicForm"
+ "name": "maxLengthText",
+ "type": "String",
+ "desc": "Error text to display if the maximum length validation fails (defaults to \"The maximum length for this field is {maxLength}\")",
+ "memberOf": "Roo.form.TextField"
},
{
- "name": "trackResetOnLoad",
+ "name": "selectOnFocus",
"type": "Boolean",
- "desc": "If set to true, form.reset() resets to the last loaded\nor setValues() data instead of when the form was first created.",
- "memberOf": "Roo.form.BasicForm"
+ "desc": "True to automatically select any existing field text when the field receives input focus (defaults to false)",
+ "memberOf": "Roo.form.TextField"
},
{
- "name": "listeners",
- "type": "Object",
- "desc": "list of events and functions to call for 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": "actioncomplete",
- "sig": "function (_self, action)\n{\n\n}",
- "type": "function",
- "desc": "Fires when an action is completed."
+ "name": "blankText",
+ "type": "String",
+ "desc": "Error text to display if the allow blank validation fails (defaults to \"This field is required\")",
+ "memberOf": "Roo.form.TextField"
},
{
- "name": "actionfailed",
- "sig": "function (_self, action)\n{\n\n}",
- "type": "function",
- "desc": "Fires when an action fails."
+ "name": "validator",
+ "type": "Function",
+ "desc": "A custom validation function to be called during field validation (defaults to null).\nIf available, this function will be called only after the basic validators all return true, and will be passed the\ncurrent field value and expected to return boolean true if the value is valid or a string error message if invalid.",
+ "memberOf": "Roo.form.TextField"
},
{
- "name": "beforeaction",
- "sig": "function (_self, action)\n{\n\n}",
- "type": "function",
- "desc": "Fires before any action is performed. Return false to cancel the action."
+ "name": "regex",
+ "type": "RegExp",
+ "desc": "A JavaScript RegExp object to be tested against the field value during validation (defaults to null).\nIf available, this regex will be evaluated only after the basic validators all return true, and will be passed the\ncurrent field value. If the test fails, the field will be marked invalid using {@link #regexText}.",
+ "memberOf": "Roo.form.TextField"
},
{
- "name": "clientvalidation",
- "sig": "function (_self, valid)\n{\n\n}",
- "type": "function",
- "desc": "If the monitorValid config option is true, this event fires repetitively to notify of valid state"
+ "name": "regexText",
+ "type": "String",
+ "desc": "The error text to display if {@link #regex} is used and the test fails during validation (defaults to \"\")",
+ "memberOf": "Roo.form.TextField"
},
{
- "name": "rendered",
- "sig": "function (form)\n{\n\n}",
- "type": "function",
- "desc": "Fires when the form is rendered"
- }
- ],
- "methods": [
- {
- "name": "add",
- "sig": "(Field field1, Field field2)",
- "type": "function",
- "desc": "Add Roo.form components to the current open container (e.g. column, fieldset, etc.). Fields added via this method\ncan also be passed with an additional property of fieldLabel, which if supplied, will provide the text to display\nas the label of the field."
- },
- {
- "name": "addButton",
- "sig": "(String/Object config, Function handler, Object scope)",
- "type": "function",
- "desc": "Adds a button to the footer of the form - this <b>must</b> be called before the form is rendered."
- },
- {
- "name": "addEvents",
- "sig": "(Object object)",
- "type": "function",
- "desc": "Used to define events on this Observable"
- },
- {
- "name": "addForm",
- "sig": "(Roo.form.Form form)",
- "type": "function",
- "desc": "Add a secondary form to this one, \nUsed to provide tabbed forms. One form is primary, with hidden values \nwhich mirror the elements from the other forms."
- },
- {
- "name": "addListener",
- "sig": "(String eventName, Function handler, Object scope, Object options)",
- "type": "function",
- "desc": "Appends an event handler to this component"
- },
- {
- "name": "addxtype",
- "sig": "(Object config)",
- "type": "function",
- "desc": "Adds a series of form elements (using the xtype property as the factory method.\nValid xtypes are: TextField, TextArea .... Button, Layout, FieldSet, Column, (and 'end' to close a block)"
- },
- {
- "name": "applyIfToFields",
- "sig": "(Object values)",
- "type": "function",
- "desc": "Calls {@link Ext#applyIf} for all field in this form with the passed object."
- },
- {
- "name": "applyToFields",
- "sig": "(Object values)",
- "type": "function",
- "desc": "Calls {@link Ext#apply} for all fields in this form with the passed object."
- },
- {
- "name": "capture",
- "sig": "(Observable o, Function fn, Object scope)",
- "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."
- },
- {
- "name": "clearInvalid",
- "sig": "()",
- "type": "function",
- "desc": "Clears all invalid messages in this form."
- },
- {
- "name": "column",
- "sig": "(Object config, Field field1, Field field2, Field etc)",
- "type": "function",
- "desc": "Opens a new {@link Roo.form.Column} container in the layout stack. If fields are passed after the config, the\nfields are added and the column is closed. If no fields are passed the column remains open\nuntil end() is called."
- },
- {
- "name": "container",
- "sig": "(Object config, Field field1, Field field2, Field etc)",
- "type": "function",
- "desc": "Opens a new {@link Roo.form.Layout} container in the layout stack. If fields are passed after the config, the\nfields are added and the container is closed. If no fields are passed the container remains open\nuntil end() is called."
- },
- {
- "name": "doAction",
- "sig": "(String actionName, Object options)",
- "type": "function",
- "desc": "Performs a predefined action (submit or load) or custom actions you define on this form."
- },
- {
- "name": "end",
- "sig": "()",
- "type": "function",
- "desc": "Closes the current open container"
- },
- {
- "name": "fieldset",
- "sig": "(Object config, Field field1, Field field2, Field etc)",
- "type": "function",
- "desc": "Opens a new {@link Roo.form.FieldSet} container in the layout stack. If fields are passed after the config, the\nfields are added and the fieldset is closed. If no fields are passed the fieldset remains open\nuntil end() is called."
- },
- {
- "name": "findField",
- "sig": "(String id)",
- "type": "function",
- "desc": "Find a Roo.form.Field in this form by id, dataIndex, name or hiddenName"
- },
- {
- "name": "findbyId",
- "sig": "(String id)",
- "type": "function",
- "desc": "Find any element that has been added to a form, using it's ID or name\nThis can include framesets, columns etc. along with regular fields.."
- },
- {
- "name": "fireEvent",
- "sig": "(String eventName, Object... args)",
- "type": "function",
- "desc": "Fires the specified event with the passed parameters (minus the event name)."
- },
- {
- "name": "getFieldValues",
- "sig": "()",
- "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."
- },
- {
- "name": "getValues",
- "sig": "(Boolean asString)",
- "type": "function",
- "desc": "Returns the fields in this form as an object with key/value pairs. If multiple fields exist with the same name\nthey are returned as an array."
- },
- {
- "name": "hasListener",
- "sig": "(String eventName)",
- "type": "function",
- "desc": "Checks to see if this object has any listeners for a specified event"
- },
- {
- "name": "isDirty",
- "sig": "()",
- "type": "function",
- "desc": "Returns true if any fields in this form have changed since their original load."
- },
- {
- "name": "isValid",
- "sig": "()",
- "type": "function",
- "desc": "Returns true if client-side validation on the form is successful."
- },
- {
- "name": "load",
- "sig": "(Object options)",
- "type": "function",
- "desc": "Shortcut to do a load action."
- },
- {
- "name": "loadRecord",
- "sig": "(Record record)",
- "type": "function",
- "desc": "Loads an Roo.data.Record into this form."
- },
- {
- "name": "markInvalid",
- "sig": "(Array/Object errors)",
- "type": "function",
- "desc": "Mark fields in this form invalid in bulk."
- },
- {
- "name": "on",
- "sig": "(String eventName, Function handler, Object scope, Object options)",
- "type": "function",
- "desc": "Appends an event handler to this element (shorthand for addListener)"
- },
- {
- "name": "purgeListeners",
- "sig": "()",
- "type": "function",
- "desc": "Removes all listeners for this object"
- },
- {
- "name": "releaseCapture",
- "sig": "(Observable o)",
- "type": "function",
- "desc": "Removes <b>all</b> added captures from the Observable."
- },
- {
- "name": "remove",
- "sig": "(Field field)",
- "type": "function",
- "desc": "Removes a field from the items collection (does NOT remove its markup)."
- },
- {
- "name": "removeListener",
- "sig": "(String eventName, Function handler, Object scope)",
- "type": "function",
- "desc": "Removes a listener"
- },
- {
- "name": "render",
- "sig": "(String/HTMLElement/Element container)",
- "type": "function",
- "desc": "Render this form into the passed container. This should only be called once!"
- },
- {
- "name": "reset",
- "sig": "()",
- "type": "function",
- "desc": "Resets this form."
- },
- {
- "name": "setValues",
- "sig": "(Array/Object values)",
- "type": "function",
- "desc": "Set values for fields in this form in bulk."
- },
- {
- "name": "start",
- "sig": "(Object container)",
- "type": "function",
- "desc": "Opens the passed container in the layout stack. The container can be any {@link Roo.form.Layout} or subclass."
- },
- {
- "name": "startMonitoring",
- "sig": "()",
- "type": "function",
- "desc": "Starts monitoring of the valid state of this form. Usually this is done by passing the config\noption \"monitorValid\""
- },
- {
- "name": "stopMonitoring",
- "sig": "()",
- "type": "function",
- "desc": "Stops monitoring of the valid state of this form"
- },
- {
- "name": "submit",
- "sig": "(Object options)",
- "type": "function",
- "desc": "Shortcut to do a submit action."
- },
- {
- "name": "un",
- "sig": "(String eventName, Function handler, Object scope)",
- "type": "function",
- "desc": "Removes a listener (shorthand for removeListener)"
- },
- {
- "name": "updateRecord",
- "sig": "(Record record)",
- "type": "function",
- "desc": "Persists the values in this form into the passed Roo.data.Record object in a beginEdit/endEdit block."
- }
- ]
- },
- "Roo.form.GridField": {
- "props": [
- {
- "name": "width",
- "type": "Number",
- "desc": "- used to restrict width of grid..",
- "memberOf": ""
- },
- {
- "name": "height",
- "type": "Number",
- "desc": "- used to restrict height of grid..",
- "memberOf": ""
- },
- {
- "name": "xgrid",
- "type": "Object",
- "desc": "(xtype'd description of grid) { xtype : 'Grid', dataSource: .... }\n\n}",
- "memberOf": ""
- },
- {
- "name": "autoCreate",
- "type": "String/Object",
- "desc": "A DomHelper element spec, or true for a default element spec (defaults to\n{tag: \"input\", type: \"checkbox\", autocomplete: \"off\"})",
- "memberOf": ""
- },
- {
- "name": "addTitle",
+ "name": "emptyText",
"type": "String",
- "desc": "Text to include for adding a title.",
- "memberOf": ""
+ "desc": "The default text to display in an empty field - placeholder... (defaults to null).",
+ "memberOf": "Roo.form.TextField"
},
{
"name": "fieldLabel",
"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",
+ "desc": "height (optional) size of component",
+ "memberOf": "Roo.BoxComponent"
+ },
{
"name": "disableClass",
"type": "String",
}
],
"events": [
+ {
+ "name": "autosize",
+ "sig": "function (_self, width)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires when the autosize function is triggered. The field may or may not have actually changed size\naccording to the default logic, but this event provides a hook for the developer to apply additional\nlogic at runtime to resize the field if needed."
+ },
{
"name": "beforedestroy",
"sig": "function (_self)\n{\n\n}",
"type": "function",
"desc": "Fires after the component is disabled."
},
+ {
+ "name": "editorinit",
+ "sig": "function (_self, the)\n{\n\n}",
+ "type": "function",
+ "desc": "Fired when the editor is initialized - you can add extra handlers here.."
+ },
{
"name": "enable",
"sig": "function (_self)\n{\n\n}",
"type": "function",
"desc": "Apply the behaviors of this component to an existing element. <b>This is used instead of render().</b>"
},
+ {
+ "name": "autoSize",
+ "sig": "()",
+ "type": "function",
+ "desc": "Automatically grows the field to accomodate the height of the text up to the maximum field height allowed.\nThis only takes effect if grow = true, and fires the autosize event if the height changes."
+ },
{
"name": "capture",
"sig": "(Observable o, Function fn, Object scope)",
"type": "function",
"desc": "Returns the normalized data value (undefined or emptyText will be returned as ''). To return the raw value see {@link #getRawValue}."
},
+ {
+ "name": "hasChanged",
+ "sig": "()",
+ "type": "function",
+ "desc": "checks the current value against the 'loaded' value.\nNote - will return false if 'resetHasChanged' has not been called first."
+ },
{
"name": "hasListener",
"sig": "(String eventName)",
"name": "isDirty",
"sig": "()",
"type": "function",
- "desc": "Returns true if this field has been changed since it was originally loaded and is not disabled."
+ "desc": "Returns true if this field has been changed since it was originally loaded and is not disabled.\nDEPRICATED - it never worked well - use hasChanged/resetHasChanged."
},
{
"name": "isValid",
"name": "reset",
"sig": "()",
"type": "function",
- "desc": "Resets the current field value to the originally loaded value and clears any validation messages"
+ "desc": "Resets the current field value to the originally-loaded value and clears any validation messages."
+ },
+ {
+ "name": "resetHasChanged",
+ "sig": "()",
+ "type": "function",
+ "desc": "stores the current value in loadedValue"
+ },
+ {
+ "name": "selectText",
+ "sig": "(Number start, Number end)",
+ "type": "function",
+ "desc": "Selects text in this field"
},
{
"name": "setDisabled",
},
{
"name": "setValue",
- "sig": "(String either)",
+ "sig": "(Mixed value)",
"type": "function",
- "desc": "Sets the value of the item."
+ "desc": "Sets a data value into the field and validates it. To set the value directly without validation see {@link #setRawValue}."
},
{
"name": "setVisible",
"sig": "()",
"type": "function",
"desc": "Validates the field value"
+ },
+ {
+ "name": "validateValue",
+ "sig": "(Mixed value)",
+ "type": "function",
+ "desc": "Validates a value according to the field's validation rules and marks the field as invalid\nif the validation fails"
}
]
},
- "Roo.form.Hidden": {
+ "Roo.form.Field": {
"props": [
- {
- "name": "grow",
- "type": "Boolean",
- "desc": "True if this field should automatically grow and shrink to its content",
- "memberOf": "Roo.form.TextField"
- },
- {
- "name": "growMin",
- "type": "Number",
- "desc": "The minimum width to allow when grow = true (defaults to 30)",
- "memberOf": "Roo.form.TextField"
- },
- {
- "name": "growMax",
- "type": "Number",
- "desc": "The maximum width to allow when grow = true (defaults to 800)",
- "memberOf": "Roo.form.TextField"
- },
- {
- "name": "vtype",
- "type": "String",
- "desc": "A validation type name as defined in {@link Roo.form.VTypes} (defaults to null)",
- "memberOf": "Roo.form.TextField"
- },
- {
- "name": "maskRe",
- "type": "String",
- "desc": "An input mask regular expression that will be used to filter keystrokes that don't match (defaults to null)",
- "memberOf": "Roo.form.TextField"
- },
- {
- "name": "disableKeyFilter",
- "type": "Boolean",
- "desc": "True to disable input keystroke filtering (defaults to false)",
- "memberOf": "Roo.form.TextField"
- },
- {
- "name": "allowBlank",
- "type": "Boolean",
- "desc": "False to validate that the value length > 0 (defaults to true)",
- "memberOf": "Roo.form.TextField"
- },
- {
- "name": "minLength",
- "type": "Number",
- "desc": "Minimum input field length required (defaults to 0)",
- "memberOf": "Roo.form.TextField"
- },
- {
- "name": "maxLength",
- "type": "Number",
- "desc": "Maximum input field length allowed (defaults to Number.MAX_VALUE)",
- "memberOf": "Roo.form.TextField"
- },
- {
- "name": "minLengthText",
- "type": "String",
- "desc": "Error text to display if the minimum length validation fails (defaults to \"The minimum length for this field is {minLength}\")",
- "memberOf": "Roo.form.TextField"
- },
- {
- "name": "maxLengthText",
- "type": "String",
- "desc": "Error text to display if the maximum length validation fails (defaults to \"The maximum length for this field is {maxLength}\")",
- "memberOf": "Roo.form.TextField"
- },
- {
- "name": "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": "Error text to display if the allow blank validation fails (defaults to \"This field is required\")",
- "memberOf": "Roo.form.TextField"
- },
- {
- "name": "validator",
- "type": "Function",
- "desc": "A custom validation function to be called during field validation (defaults to null).\nIf available, this function will be called only after the basic validators all return true, and will be passed the\ncurrent field value and expected to return boolean true if the value is valid or a string error message if invalid.",
- "memberOf": "Roo.form.TextField"
- },
- {
- "name": "regex",
- "type": "RegExp",
- "desc": "A JavaScript RegExp object to be tested against the field value during validation (defaults to null).\nIf available, this regex will be evaluated only after the basic validators all return true, and will be passed the\ncurrent field value. If the test fails, the field will be marked invalid using {@link #regexText}.",
- "memberOf": "Roo.form.TextField"
- },
- {
- "name": "regexText",
- "type": "String",
- "desc": "The error text to display if {@link #regex} is used and the test fails during validation (defaults to \"\")",
- "memberOf": "Roo.form.TextField"
- },
- {
- "name": "emptyText",
- "type": "String",
- "desc": "The default text to display in an empty field - placeholder... (defaults to null).",
- "memberOf": "Roo.form.TextField"
- },
{
"name": "fieldLabel",
"type": "String",
"desc": "Label to use when rendering a form.",
- "memberOf": "Roo.form.Field"
+ "memberOf": ""
},
{
"name": "qtip",
"type": "String",
"desc": "Mouse over tip",
- "memberOf": "Roo.form.Field"
+ "memberOf": ""
},
{
"name": "name",
"type": "String",
"desc": "The field's HTML name attribute.",
- "memberOf": "Roo.form.Field"
+ "memberOf": ""
},
{
"name": "invalidClass",
"type": "String",
"desc": "The CSS class to use when marking a field invalid (defaults to \"x-form-invalid\")",
- "memberOf": "Roo.form.Field"
+ "memberOf": ""
},
{
"name": "invalidText",
"type": "String",
"desc": "The error text to use when marking a field invalid and no message is provided (defaults to \"The value in this field is invalid\")",
- "memberOf": "Roo.form.Field"
+ "memberOf": ""
},
{
"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": ""
},
{
"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": ""
},
{
"name": "validateOnBlur",
"type": "Boolean",
"desc": "Whether the field should validate when it loses focus (defaults to true).",
- "memberOf": "Roo.form.Field"
+ "memberOf": ""
},
{
"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": ""
},
{
"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": ""
},
{
"name": "fieldClass",
"type": "String",
"desc": "The default CSS class for the field (defaults to \"x-form-field\")",
- "memberOf": "Roo.form.Field"
+ "memberOf": ""
},
{
"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": ""
},
{
"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": ""
},
{
"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": ""
},
{
"name": "disabled",
"type": "Boolean",
"desc": "True to disable the field (defaults to false).",
- "memberOf": "Roo.form.Field"
+ "memberOf": ""
},
{
"name": "inputType",
"type": "String",
"desc": "The type attribute for input fields -- e.g. radio, text, password (defaults to \"text\").",
- "memberOf": "Roo.form.Field"
+ "memberOf": ""
},
{
"name": "tabIndex",
"type": "Number",
"desc": "The tabIndex for this field. Note this only applies to fields that are rendered, not those which are built via applyTo (defaults to undefined).",
- "memberOf": "Roo.form.Field"
+ "memberOf": ""
},
{
"name": "value",
"type": "Mixed",
"desc": "A value to initialize this field with.",
- "memberOf": "Roo.form.Field"
+ "memberOf": ""
},
{
"name": "cls",
"type": "String",
"desc": "A CSS class to apply to the field's underlying element.",
- "memberOf": "Roo.form.Field"
+ "memberOf": ""
},
{
"name": "width",
}
],
"events": [
- {
- "name": "autosize",
- "sig": "function (_self, width)\n{\n\n}",
- "type": "function",
- "desc": "Fires when the autosize function is triggered. The field may or may not have actually changed size\naccording to the default logic, but this event provides a hook for the developer to apply additional\nlogic at runtime to resize the field if needed."
- },
{
"name": "beforedestroy",
"sig": "function (_self)\n{\n\n}",
"type": "function",
"desc": "Apply the behaviors of this component to an existing element. <b>This is used instead of render().</b>"
},
- {
- "name": "autoSize",
- "sig": "()",
- "type": "function",
- "desc": "Automatically grows the field to accomodate the width of the text up to the maximum field width allowed.\nThis only takes effect if grow = true, and fires the autosize event."
- },
{
"name": "capture",
"sig": "(Observable o, Function fn, Object scope)",
"type": "function",
"desc": "Returns the normalized data value (undefined or emptyText will be returned as ''). To return the raw value see {@link #getRawValue}."
},
+ {
+ "name": "hasChanged",
+ "sig": "()",
+ "type": "function",
+ "desc": "checks the current value against the 'loaded' value.\nNote - will return false if 'resetHasChanged' has not been called first."
+ },
{
"name": "hasListener",
"sig": "(String eventName)",
"name": "isDirty",
"sig": "()",
"type": "function",
- "desc": "Returns true if this field has been changed since it was originally loaded and is not disabled."
+ "desc": "Returns true if this field has been changed since it was originally loaded and is not disabled.\nDEPRICATED - it never worked well - use hasChanged/resetHasChanged."
},
{
"name": "isValid",
"name": "reset",
"sig": "()",
"type": "function",
- "desc": "Resets the current field value to the originally-loaded value and clears any validation messages."
+ "desc": "Resets the current field value to the originally loaded value and clears any validation messages"
},
{
- "name": "selectText",
- "sig": "(Number start, Number end)",
+ "name": "resetHasChanged",
+ "sig": "()",
"type": "function",
- "desc": "Selects text in this field"
+ "desc": "stores the current value in loadedValue"
},
{
"name": "setDisabled",
"sig": "()",
"type": "function",
"desc": "Validates the field value"
- },
- {
- "name": "validateValue",
- "sig": "(Mixed value)",
- "type": "function",
- "desc": "Validates a value according to the field's validation rules and marks the field as invalid\nif the validation fails"
}
]
},
- "Roo.form.HtmlEditor": {
+ "Roo.form.FieldSet": {
"props": [
{
- "name": "clearUp",
- "type": "Boolean",
- "desc": "",
- "memberOf": ""
- },
- {
- "name": "toolbars",
- "type": "Array",
- "desc": "Array of toolbars. - defaults to just the Standard one",
- "memberOf": ""
- },
- {
- "name": "resizable",
+ "name": "legend",
"type": "String",
- "desc": "'s' or 'se' or 'e' - wrapps the element in a\n Roo.resizable.",
- "memberOf": ""
- },
- {
- "name": "height",
- "type": "Number",
- "desc": "(in pixels)",
- "memberOf": ""
- },
- {
- "name": "width",
- "type": "Number",
- "desc": "(in pixels)",
- "memberOf": ""
- },
- {
- "name": "stylesheets",
- "type": "Array",
- "desc": "url of stylesheets. set to [] to disable stylesheets.",
- "memberOf": ""
- },
- {
- "name": "blacklist",
- "type": "Array",
- "desc": "of css styles style attributes (blacklist overrides whitelist)",
+ "desc": "The text to display as the legend for the FieldSet (defaults to '')",
"memberOf": ""
},
{
- "name": "whitelist",
- "type": "Array",
- "desc": "of css styles style attributes (blacklist overrides whitelist)",
+ "name": "autoCreate",
+ "type": "String/Object",
+ "desc": "A DomHelper element spec used to autocreate the fieldset (defaults to {tag: 'fieldset', cn: {tag:'legend'}})",
"memberOf": ""
},
{
- "name": "fieldLabel",
- "type": "String",
- "desc": "Label to use when rendering a form.",
- "memberOf": "Roo.form.Field"
- },
- {
- "name": "qtip",
- "type": "String",
- "desc": "Mouse over tip",
- "memberOf": "Roo.form.Field"
+ "name": "style",
+ "type": "String/Object/Function",
+ "desc": "A style specification string, e.g. \"width:100px\", or object in the form {width:\"100px\"}, or\na function which returns such a specification.",
+ "memberOf": "Roo.form.Layout"
},
{
- "name": "name",
+ "name": "labelAlign",
"type": "String",
- "desc": "The field's HTML name attribute.",
- "memberOf": "Roo.form.Field"
- },
- {
- "name": "validationEvent",
- "type": "String/Boolean",
- "desc": "The event that should initiate field validation. Set to false to disable\n automatic validation (defaults to \"keyup\").",
- "memberOf": "Roo.form.Field"
+ "desc": "Valid values are \"left,\" \"top\" and \"right\" (defaults to \"left\")",
+ "memberOf": "Roo.form.Layout"
},
{
- "name": "validationDelay",
+ "name": "labelWidth",
"type": "Number",
- "desc": "The length of time in milliseconds after user input begins until validation is initiated (defaults to 250)",
- "memberOf": "Roo.form.Field"
- },
- {
- "name": "msgTarget",
- "type": "String",
- "desc": "The location where error text should display. Should be one of the following values (defaults to 'qtip'):\n<pre>\nValue Description\n----------- ----------------------------------------------------------------------\nqtip Display a quick tip when the user hovers over the field\ntitle Display a default browser title attribute popup\nunder Add a block div beneath the field containing the error text\nside Add an error icon to the right of the field with a popup on hover\n[element id] Add the error text directly to the innerHTML of the specified element\n</pre>",
- "memberOf": "Roo.form.Field"
- },
- {
- "name": "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"
+ "desc": "Fixed width in pixels of all field labels (defaults to undefined)",
+ "memberOf": "Roo.form.Layout"
},
{
- "name": "disabled",
+ "name": "clear",
"type": "Boolean",
- "desc": "True to disable the field (defaults to false).",
- "memberOf": "Roo.form.Field"
- },
- {
- "name": "tabIndex",
- "type": "Number",
- "desc": "The tabIndex for this field. Note this only applies to fields that are rendered, not those which are built via applyTo (defaults to undefined).",
- "memberOf": "Roo.form.Field"
+ "desc": "True to add a clearing element at the end of this layout, equivalent to CSS clear: both (defaults to true)",
+ "memberOf": "Roo.form.Layout"
},
{
- "name": "value",
- "type": "Mixed",
- "desc": "A value to initialize this field with.",
- "memberOf": "Roo.form.Field"
+ "name": "labelSeparator",
+ "type": "String",
+ "desc": "The separator to use after field labels (defaults to ':')",
+ "memberOf": "Roo.form.Layout"
},
{
- "name": "cls",
- "type": "String",
- "desc": "A CSS class to apply to the field's underlying element.",
- "memberOf": "Roo.form.Field"
+ "name": "hideLabels",
+ "type": "Boolean",
+ "desc": "True to suppress the display of field labels in this layout (defaults to false)",
+ "memberOf": "Roo.form.Layout"
},
{
"name": "disableClass",
}
],
"events": [
- {
- "name": "activate",
- "sig": "function (_self)\n{\n\n}",
- "type": "function",
- "desc": "Fires when the editor is first receives the focus. Any insertion must wait\nuntil after this event."
- },
- {
- "name": "autosave",
- "sig": "function (_self)\n{\n\n}",
- "type": "function",
- "desc": "Auto save the htmlEditor value as a file into Events"
- },
{
"name": "beforedestroy",
"sig": "function (_self)\n{\n\n}",
"type": "function",
"desc": "Fires before the component is hidden. Return false to stop the hide."
},
- {
- "name": "beforepush",
- "sig": "function (_self, html)\n{\n\n}",
- "type": "function",
- "desc": "Fires before the iframe editor is updated with content from the textarea. Return false\nto cancel the push."
- },
{
"name": "beforerender",
"sig": "function (_self)\n{\n\n}",
"type": "function",
"desc": "Fires before the component is shown. Return false to stop the show."
},
- {
- "name": "beforesync",
- "sig": "function (_self, html)\n{\n\n}",
- "type": "function",
- "desc": "Fires before the textarea is updated with content from the editor iframe. Return false\nto cancel the sync."
- },
{
"name": "destroy",
"sig": "function (_self)\n{\n\n}",
"type": "function",
"desc": "Fires after the component is disabled."
},
- {
- "name": "editmodechange",
- "sig": "function (_self, sourceEdit)\n{\n\n}",
- "type": "function",
- "desc": "Fires when the editor switches edit modes"
- },
- {
- "name": "editorevent",
- "sig": "function (_self)\n{\n\n}",
- "type": "function",
- "desc": "Fires when on any editor (mouse up/down cursor movement etc.) - used for toolbar hooks."
- },
{
"name": "enable",
"sig": "function (_self)\n{\n\n}",
"type": "function",
"desc": "Fires after the component is enabled."
},
- {
- "name": "firstfocus",
- "sig": "function (_self)\n{\n\n}",
- "type": "function",
- "desc": "Fires when on first focus - needed by toolbars.."
- },
{
"name": "hide",
"sig": "function (_self)\n{\n\n}",
"type": "function",
"desc": "Fires after the component is hidden."
},
- {
- "name": "initialize",
- "sig": "function (_self)\n{\n\n}",
- "type": "function",
- "desc": "Fires when the editor is fully initialized (including the iframe)"
- },
- {
- "name": "invalid",
- "sig": "function (_self, msg)\n{\n\n}",
- "type": "function",
- "desc": "Fires after the field has been marked as invalid."
- },
- {
- "name": "keyup",
- "sig": "function (_self, e)\n{\n\n}",
- "type": "function",
- "desc": "Fires after the key up"
- },
- {
- "name": "move",
- "sig": "function (_self, x, y)\n{\n\n}",
- "type": "function",
- "desc": "Fires after the component is moved."
- },
- {
- "name": "push",
- "sig": "function (_self, html)\n{\n\n}",
- "type": "function",
- "desc": "Fires when the iframe editor is updated with content from the textarea."
- },
{
"name": "render",
"sig": "function (_self)\n{\n\n}",
"type": "function",
"desc": "Fires after the component is rendered."
},
- {
- "name": "resize",
- "sig": "function (_self, adjWidth, adjHeight, rawWidth, rawHeight)\n{\n\n}",
- "type": "function",
- "desc": "Fires after the component is resized."
- },
- {
- "name": "savedpreview",
- "sig": "function (_self)\n{\n\n}",
- "type": "function",
- "desc": "preview the saved version of htmlEditor"
- },
{
"name": "show",
"sig": "function (_self)\n{\n\n}",
"type": "function",
"desc": "Fires after the component is shown."
- },
- {
- "name": "stylesheetsclick",
- "sig": "function (_self)\n{\n\n}",
- "type": "function",
- "desc": "Fires when press the Sytlesheets button"
- },
- {
- "name": "sync",
- "sig": "function (_self, html)\n{\n\n}",
- "type": "function",
- "desc": "Fires when the textarea is updated with content from the editor iframe."
- },
- {
- "name": "valid",
- "sig": "function (_self)\n{\n\n}",
- "type": "function",
- "desc": "Fires after the field has been validated with no errors."
}
],
"methods": [
"desc": "Appends an event handler to this component"
},
{
- "name": "applyTo",
- "sig": "(String/HTMLElement/Element el)",
+ "name": "addxtype",
+ "sig": "(Object config)",
"type": "function",
- "desc": "Apply the behaviors of this component to an existing element. <b>This is used instead of render().</b>"
+ "desc": "Adds a object form elements (using the xtype property as the factory method.)\nValid xtypes are: TextField, TextArea .... Button, Layout, FieldSet, Column"
},
{
"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."
},
- {
- "name": "clearInvalid",
- "sig": "()",
- "type": "function",
- "desc": "Overridden and disabled. The editor element does not support standard valid/invalid marking. @hide"
- },
- {
- "name": "createToolbar",
- "sig": "(HtmlEditor editor)",
- "type": "function",
- "desc": "Protected method that will not generally be called directly. It\nis called when the editor creates its toolbar. Override this method if you need to\nadd custom toolbar buttons."
- },
{
"name": "destroy",
"sig": "()",
"type": "function",
"desc": "Try to focus this component."
},
- {
- "name": "getBox",
- "sig": "(Boolean local)",
- "type": "function",
- "desc": "Gets the current box measurements of the component's underlying element."
- },
{
"name": "getEl",
"sig": "()",
"type": "function",
"desc": "Returns the id of this component."
},
- {
- "name": "getName",
- "sig": "()",
- "type": "function",
- "desc": "Returns the name attribute of the field if available"
- },
- {
- "name": "getPosition",
- "sig": "(Boolean local)",
- "type": "function",
- "desc": "Gets the current XY position of the component's underlying element."
- },
- {
- "name": "getRawValue",
- "sig": "()",
- "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}."
- },
- {
- "name": "getSize",
- "sig": "()",
- "type": "function",
- "desc": "Gets the current size of the component's underlying element."
- },
- {
- "name": "getValue",
- "sig": "()",
- "type": "function",
- "desc": "Returns the normalized data value (undefined or emptyText will be returned as ''). To return the raw value see {@link #getRawValue}."
- },
{
"name": "hasListener",
"sig": "(String eventName)",
"type": "function",
"desc": "Hide this component."
},
- {
- "name": "isDirty",
- "sig": "()",
- "type": "function",
- "desc": "Returns true if this field has been changed since it was originally loaded and is not disabled."
- },
- {
- "name": "isValid",
- "sig": "(Boolean preventMark)",
- "type": "function",
- "desc": "Returns whether or not the field value is currently valid"
- },
{
"name": "isVisible",
"sig": "()",
"type": "function",
"desc": "Returns true if this component is visible."
},
- {
- "name": "markInvalid",
- "sig": "()",
- "type": "function",
- "desc": "Overridden and disabled. The editor element does not support standard valid/invalid marking. @hide"
- },
{
"name": "on",
"sig": "(String eventName, Function handler, Object scope, Object options)",
"type": "function",
"desc": "Appends an event handler to this element (shorthand for addListener)"
},
- {
- "name": "onPosition",
- "sig": "(Number x, Number y)",
- "type": "function",
- "desc": "Called after the component is moved, this method is empty by default but can be implemented by any\nsubclass that needs to perform custom logic after a move occurs."
- },
- {
- "name": "onResize",
- "sig": "(Number adjWidth, Number adjHeight, Number rawWidth, Number rawHeight)",
- "type": "function",
- "desc": "Called after the component is resized, this method is empty by default but can be implemented by any\nsubclass that needs to perform custom logic after a resize occurs."
- },
{
"name": "purgeListeners",
"sig": "()",
"type": "function",
"desc": "If this is a lazy rendering component, render it to its container element."
},
- {
- "name": "reset",
- "sig": "()",
- "type": "function",
- "desc": "Resets the current field value to the originally loaded value and clears any validation messages"
- },
{
"name": "setDisabled",
"sig": "(Boolean disabled)",
"type": "function",
"desc": "Convenience function for setting disabled/enabled by boolean."
},
- {
- "name": "setPagePosition",
- "sig": "(Number x, Number y)",
- "type": "function",
- "desc": "Sets the page XY position of the component. To set the left and top instead, use {@link #setPosition}.\nThis method fires the move event."
- },
- {
- "name": "setPosition",
- "sig": "(Number left, Number top)",
- "type": "function",
- "desc": "Sets the left and top of the component. To set the page XY position instead, use {@link #setPagePosition}.\nThis method fires the move event."
- },
- {
- "name": "setRawValue",
- "sig": "(Mixed value)",
- "type": "function",
- "desc": "Sets the underlying DOM field's value directly, bypassing validation. To set the value with validation see {@link #setValue}."
- },
- {
- "name": "setSize",
- "sig": "(Number/Object width, Number height)",
- "type": "function",
- "desc": "Sets the width and height of the component. This method fires the resize event. This method can accept\neither width and height as separate numeric arguments, or you can pass a size object like {width:10, height:20}."
- },
- {
- "name": "setValue",
- "sig": "(Mixed value)",
- "type": "function",
- "desc": "Sets a data value into the field and validates it. To set the value directly without validation see {@link #setRawValue}."
- },
{
"name": "setVisible",
"sig": "(Boolean visible)",
"type": "function",
"desc": "Show this component."
},
- {
- "name": "syncSize",
- "sig": "()",
- "type": "function",
- "desc": "Force the component's size to recalculate based on the underlying element's current height and width."
- },
- {
- "name": "toggleSourceEdit",
- "sig": "(Boolean sourceEdit)",
- "type": "function",
- "desc": "Toggles the editor between standard and source edit mode."
- },
{
"name": "un",
"sig": "(String eventName, Function handler, Object scope)",
"type": "function",
"desc": "Removes a listener (shorthand for removeListener)"
- },
- {
- "name": "updateBox",
- "sig": "(Object box)",
- "type": "function",
- "desc": "Sets the current box measurements of the component's underlying element."
- },
- {
- "name": "validate",
- "sig": "()",
- "type": "function",
- "desc": "Validates the field value"
}
]
},
- "Roo.form.HtmlEditor.ToolbarContext": {
+ "Roo.form.Form": {
"props": [
{
- "name": "disable",
- "type": "Object",
- "desc": "List of toolbar elements to disable",
+ "name": "labelWidth",
+ "type": "Number",
+ "desc": "The width of labels. This property cascades to child containers.",
"memberOf": ""
},
{
- "name": "styles",
- "type": "Object",
- "desc": "List of styles \n eg. { '*' : [ 'headline' ] , 'TD' : [ 'underline', 'double-underline' ] } \n\nThese must be defined in the page, so they get rendered correctly..\n.headline { }\nTD.underline { }",
+ "name": "itemCls",
+ "type": "String",
+ "desc": "A css class to apply to the x-form-item of fields. This property cascades to child containers.",
"memberOf": ""
- }
- ],
- "events": [],
- "methods": [
- {
- "name": "updateToolbar",
- "sig": "()",
- "type": "function",
- "desc": "Protected method that will not generally be called directly. It triggers\na toolbar update by reading the markup state of the current selection in the editor.\n\nNote you can force an update by calling on('editorevent', scope, false)"
- }
- ]
- },
- "Roo.form.HtmlEditor.ToolbarStandard": {
- "props": [
+ },
{
- "name": "disable",
- "type": "Object",
- "desc": "List of elements to disable..",
+ "name": "buttonAlign",
+ "type": "String",
+ "desc": "Valid values are \"left,\" \"center\" and \"right\" (defaults to \"center\")",
"memberOf": ""
},
{
- "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; }",
+ "name": "minButtonWidth",
+ "type": "Number",
+ "desc": "Minimum width of all buttons in pixels (defaults to 75)",
"memberOf": ""
},
{
- "name": "createLinkText",
+ "name": "labelAlign",
"type": "String",
- "desc": "The default text for the create link prompt",
+ "desc": "Valid values are \"left,\" \"top\" and \"right\" (defaults to \"left\").\nThis property cascades to child containers if not set.",
"memberOf": ""
},
{
- "name": "defaultLinkValue",
- "type": "String",
- "desc": "The default value for the create link prompt (defaults to http:/ /)",
+ "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": ""
},
{
- "name": "fontFamilies",
- "type": "Array",
- "desc": "An array of available font families",
+ "name": "monitorPoll",
+ "type": "Number",
+ "desc": "The milliseconds to poll valid state, ignored if monitorValid is not true (defaults to 200)",
"memberOf": ""
},
{
- "name": "defaultFont",
+ "name": "progressUrl",
"type": "String",
- "desc": "default font to use.",
+ "desc": "- Url to return progress data",
"memberOf": ""
- }
- ],
- "events": [],
- "methods": [
+ },
{
- "name": "updateToolbar",
- "sig": "()",
- "type": "function",
- "desc": "Protected method that will not generally be called directly. It triggers\na toolbar update by reading the markup state of the current selection in the editor."
- }
- ]
- },
- "Roo.form.Layout": {
- "props": [
+ "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"
+ },
{
- "name": "autoCreate",
- "type": "String/Object",
- "desc": "A DomHelper element spec used to autocreate the layout (defaults to {tag: 'div', cls: 'x-form-ct'})",
- "memberOf": ""
+ "name": "reader",
+ "type": "DataReader",
+ "desc": "An Roo.data.DataReader (e.g. {@link Roo.data.XmlReader}) to be used to read data when executing \"load\" actions.\nThis is optional as there is built-in support for processing JSON.",
+ "memberOf": "Roo.form.BasicForm"
},
{
- "name": "style",
- "type": "String/Object/Function",
- "desc": "A style specification string, e.g. \"width:100px\", or object in the form {width:\"100px\"}, or\na function which returns such a specification.",
- "memberOf": ""
+ "name": "errorReader",
+ "type": "DataReader",
+ "desc": "An Roo.data.DataReader (e.g. {@link Roo.data.XmlReader}) to be used to read data when reading validation errors on \"submit\" actions.\nThis is completely optional as there is built-in support for processing JSON.",
+ "memberOf": "Roo.form.BasicForm"
},
{
- "name": "labelAlign",
+ "name": "url",
"type": "String",
- "desc": "Valid values are \"left,\" \"top\" and \"right\" (defaults to \"left\")",
- "memberOf": ""
+ "desc": "The URL to use for form actions if one isn't supplied in the action options.",
+ "memberOf": "Roo.form.BasicForm"
},
{
- "name": "labelWidth",
- "type": "Number",
- "desc": "Fixed width in pixels of all field labels (defaults to undefined)",
- "memberOf": ""
+ "name": "fileUpload",
+ "type": "Boolean",
+ "desc": "Set to true if this form is a file upload.",
+ "memberOf": "Roo.form.BasicForm"
},
{
- "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": ""
+ "name": "baseParams",
+ "type": "Object",
+ "desc": "Parameters to pass with all requests. e.g. baseParams: {id: '123', foo: 'bar'}.",
+ "memberOf": "Roo.form.BasicForm"
},
{
- "name": "labelSeparator",
- "type": "String",
- "desc": "The separator to use after field labels (defaults to ':')",
- "memberOf": ""
+ "name": "timeout",
+ "type": "Number",
+ "desc": "Timeout for form actions in seconds (default is 30 seconds).",
+ "memberOf": "Roo.form.BasicForm"
},
{
- "name": "hideLabels",
+ "name": "trackResetOnLoad",
"type": "Boolean",
- "desc": "True to suppress the display of field labels in this layout (defaults to false)",
- "memberOf": ""
- },
- {
- "name": "disableClass",
- "type": "String",
- "desc": "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").",
- "memberOf": "Roo.Component"
- },
- {
- "name": "allowDomMove",
- "type": "Boolean",
- "desc": "Whether the component can move the Dom node when rendering (defaults to true).",
- "memberOf": "Roo.Component"
- },
- {
- "name": "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\".",
- "memberOf": "Roo.Component",
- "optvals": [
- "display",
- "visibility"
- ]
- },
- {
- "name": "actionMode",
- "type": "String",
- "desc": "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el'",
- "memberOf": "Roo.Component"
+ "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"
},
{
"name": "listeners",
],
"events": [
{
- "name": "beforedestroy",
- "sig": "function (_self)\n{\n\n}",
- "type": "function",
- "desc": "Fires before the component is destroyed. Return false to stop the destroy."
- },
- {
- "name": "beforehide",
- "sig": "function (_self)\n{\n\n}",
- "type": "function",
- "desc": "Fires before the component is hidden. Return false to stop the hide."
- },
- {
- "name": "beforerender",
- "sig": "function (_self)\n{\n\n}",
+ "name": "actioncomplete",
+ "sig": "function (_self, action)\n{\n\n}",
"type": "function",
- "desc": "Fires before the component is rendered. Return false to stop the render."
+ "desc": "Fires when an action is completed."
},
{
- "name": "beforeshow",
- "sig": "function (_self)\n{\n\n}",
+ "name": "actionfailed",
+ "sig": "function (_self, action)\n{\n\n}",
"type": "function",
- "desc": "Fires before the component is shown. Return false to stop the show."
+ "desc": "Fires when an action fails."
},
{
- "name": "destroy",
- "sig": "function (_self)\n{\n\n}",
+ "name": "beforeaction",
+ "sig": "function (_self, action)\n{\n\n}",
"type": "function",
- "desc": "Fires after the component is destroyed."
+ "desc": "Fires before any action is performed. Return false to cancel the action."
},
{
- "name": "disable",
- "sig": "function (_self)\n{\n\n}",
+ "name": "clientvalidation",
+ "sig": "function (_self, valid)\n{\n\n}",
"type": "function",
- "desc": "Fires after the component is disabled."
+ "desc": "If the monitorValid config option is true, this event fires repetitively to notify of valid state"
},
{
- "name": "enable",
- "sig": "function (_self)\n{\n\n}",
+ "name": "rendered",
+ "sig": "function (form)\n{\n\n}",
"type": "function",
- "desc": "Fires after the component is enabled."
- },
+ "desc": "Fires when the form is rendered"
+ }
+ ],
+ "methods": [
{
- "name": "hide",
- "sig": "function (_self)\n{\n\n}",
+ "name": "add",
+ "sig": "(Field field1, Field field2)",
"type": "function",
- "desc": "Fires after the component is hidden."
+ "desc": "Add Roo.form components to the current open container (e.g. column, fieldset, etc.). Fields added via this method\ncan also be passed with an additional property of fieldLabel, which if supplied, will provide the text to display\nas the label of the field."
},
{
- "name": "render",
- "sig": "function (_self)\n{\n\n}",
+ "name": "addButton",
+ "sig": "(String/Object config, Function handler, Object scope)",
"type": "function",
- "desc": "Fires after the component is rendered."
+ "desc": "Adds a button to the footer of the form - this <b>must</b> be called before the form is rendered."
},
- {
- "name": "show",
- "sig": "function (_self)\n{\n\n}",
- "type": "function",
- "desc": "Fires after the component is shown."
- }
- ],
- "methods": [
{
"name": "addEvents",
"sig": "(Object object)",
"type": "function",
"desc": "Used to define events on this Observable"
},
+ {
+ "name": "addForm",
+ "sig": "(Roo.form.Form form)",
+ "type": "function",
+ "desc": "Add a secondary form to this one, \nUsed to provide tabbed forms. One form is primary, with hidden values \nwhich mirror the elements from the other forms."
+ },
{
"name": "addListener",
"sig": "(String eventName, Function handler, Object scope, Object options)",
"name": "addxtype",
"sig": "(Object config)",
"type": "function",
- "desc": "Adds a object form elements (using the xtype property as the factory method.)\nValid xtypes are: TextField, TextArea .... Button, Layout, FieldSet, Column"
+ "desc": "Adds a series of form elements (using the xtype property as the factory method.\nValid xtypes are: TextField, TextArea .... Button, Layout, FieldSet, Column, (and 'end' to close a block)"
+ },
+ {
+ "name": "applyIfToFields",
+ "sig": "(Object values)",
+ "type": "function",
+ "desc": "Calls {@link Ext#applyIf} for all field in this form with the passed object."
+ },
+ {
+ "name": "applyToFields",
+ "sig": "(Object values)",
+ "type": "function",
+ "desc": "Calls {@link Ext#apply} for all fields in this form with the passed object."
},
{
"name": "capture",
"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."
},
{
- "name": "destroy",
+ "name": "clearInvalid",
"sig": "()",
"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": "Clears all invalid messages in this form."
},
{
- "name": "disable",
- "sig": "()",
+ "name": "column",
+ "sig": "(Object config, Field field1, Field field2, Field etc)",
"type": "function",
- "desc": "Disable this component."
+ "desc": "Opens a new {@link Roo.form.Column} container in the layout stack. If fields are passed after the config, the\nfields are added and the column is closed. If no fields are passed the column remains open\nuntil end() is called."
},
{
- "name": "enable",
+ "name": "container",
+ "sig": "(Object config, Field field1, Field field2, Field etc)",
+ "type": "function",
+ "desc": "Opens a new {@link Roo.form.Layout} container in the layout stack. If fields are passed after the config, the\nfields are added and the container is closed. If no fields are passed the container remains open\nuntil end() is called."
+ },
+ {
+ "name": "doAction",
+ "sig": "(String actionName, Object options)",
+ "type": "function",
+ "desc": "Performs a predefined action (submit or load) or custom actions you define on this form."
+ },
+ {
+ "name": "end",
"sig": "()",
"type": "function",
- "desc": "Enable this component."
+ "desc": "Closes the current open container"
+ },
+ {
+ "name": "fieldset",
+ "sig": "(Object config, Field field1, Field field2, Field etc)",
+ "type": "function",
+ "desc": "Opens a new {@link Roo.form.FieldSet} container in the layout stack. If fields are passed after the config, the\nfields are added and the fieldset is closed. If no fields are passed the fieldset remains open\nuntil end() is called."
+ },
+ {
+ "name": "findField",
+ "sig": "(String id)",
+ "type": "function",
+ "desc": "Find a Roo.form.Field in this form by id, dataIndex, name or hiddenName"
+ },
+ {
+ "name": "findbyId",
+ "sig": "(String id)",
+ "type": "function",
+ "desc": "Find any element that has been added to a form, using it's ID or name\nThis can include framesets, columns etc. along with regular fields.."
},
{
"name": "fireEvent",
"desc": "Fires the specified event with the passed parameters (minus the event name)."
},
{
- "name": "focus",
- "sig": "(Boolean selectText)",
+ "name": "getFieldValues",
+ "sig": "()",
"type": "function",
- "desc": "Try to focus this component."
+ "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."
},
{
- "name": "getEl",
- "sig": "()",
+ "name": "getValues",
+ "sig": "(Boolean asString)",
"type": "function",
- "desc": "Returns the underlying {@link Roo.Element}."
+ "desc": "Returns the fields in this form as an object with key/value pairs. If multiple fields exist with the same name\nthey are returned as an array."
},
{
- "name": "getId",
+ "name": "hasChanged",
"sig": "()",
"type": "function",
- "desc": "Returns the id of this component."
+ "desc": "Returns true if any fields in this form have changed since their original load. (New version)"
},
{
"name": "hasListener",
"desc": "Checks to see if this object has any listeners for a specified event"
},
{
- "name": "hide",
+ "name": "isDirty",
"sig": "()",
"type": "function",
- "desc": "Hide this component."
+ "desc": "DEPRICATED Returns true if any fields in this form have changed since their original load."
},
{
- "name": "isVisible",
+ "name": "isValid",
"sig": "()",
"type": "function",
- "desc": "Returns true if this component is visible."
+ "desc": "Returns true if client-side validation on the form is successful."
+ },
+ {
+ "name": "load",
+ "sig": "(Object options)",
+ "type": "function",
+ "desc": "Shortcut to do a load action."
+ },
+ {
+ "name": "loadRecord",
+ "sig": "(Record record)",
+ "type": "function",
+ "desc": "Loads an Roo.data.Record into this form."
+ },
+ {
+ "name": "markInvalid",
+ "sig": "(Array/Object errors)",
+ "type": "function",
+ "desc": "Mark fields in this form invalid in bulk."
},
{
"name": "on",
"type": "function",
"desc": "Removes <b>all</b> added captures from the Observable."
},
+ {
+ "name": "remove",
+ "sig": "(Field field)",
+ "type": "function",
+ "desc": "Removes a field from the items collection (does NOT remove its markup)."
+ },
{
"name": "removeListener",
"sig": "(String eventName, Function handler, Object scope)",
"name": "render",
"sig": "(String/HTMLElement/Element container)",
"type": "function",
- "desc": "If this is a lazy rendering component, render it to its container element."
- },
- {
- "name": "setDisabled",
- "sig": "(Boolean disabled)",
- "type": "function",
- "desc": "Convenience function for setting disabled/enabled by boolean."
+ "desc": "Render this form into the passed container. This should only be called once!"
},
{
- "name": "setVisible",
- "sig": "(Boolean visible)",
+ "name": "reset",
+ "sig": "()",
"type": "function",
- "desc": "Convenience function to hide or show this component by boolean."
+ "desc": "Resets this form."
},
{
- "name": "show",
+ "name": "resetHasChanged",
"sig": "()",
"type": "function",
- "desc": "Show this component."
+ "desc": "Resets all hasChanged to 'false' -\nThe old 'isDirty' used 'original value..' however this breaks reset() and a few other things.\nSo hasChanged storage is only to be used for this purpose"
},
{
- "name": "un",
- "sig": "(String eventName, Function handler, Object scope)",
+ "name": "setValues",
+ "sig": "(Array/Object values)",
"type": "function",
- "desc": "Removes a listener (shorthand for removeListener)"
- }
- ]
- },
- "Roo.form.MonthField": {
- "props": [
- {
- "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": ""
- },
- {
- "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": ""
- },
- {
- "name": "disabledDays",
- "type": "Array",
- "desc": "An array of days to disable, 0 based. For example, [0, 6] disables Sunday and Saturday (defaults to null).",
- "memberOf": ""
- },
- {
- "name": "disabledDaysText",
- "type": "String",
- "desc": "The tooltip to display when the date falls on a disabled day (defaults to 'Disabled')",
- "memberOf": ""
+ "desc": "Set values for fields in this form in bulk."
},
{
- "name": "disabledDates",
- "type": "Array",
- "desc": "An array of \"dates\" to disable, as strings. These strings will be used to build a dynamic regular\nexpression so they are very powerful. Some examples:\n<ul>\n<li>[\"03/08/2003\", \"09/16/2003\"] would disable those exact dates</li>\n<li>[\"03/08\", \"09/16\"] would disable those days for every year</li>\n<li>[\"^03/08\"] would only match the beginning (useful if you are using short years)</li>\n<li>[\"03/../2006\"] would disable every day in March 2006</li>\n<li>[\"^03\"] would disable every day in every March</li>\n</ul>\nIn order to support regular expressions, if you are using a date format that has \".\" in it, you will have to\nescape the dot when restricting dates. For example: [\"03\\\\.08\\\\.03\"].",
- "memberOf": ""
+ "name": "start",
+ "sig": "(Object container)",
+ "type": "function",
+ "desc": "Opens the passed container in the layout stack. The container can be any {@link Roo.form.Layout} or subclass."
},
{
- "name": "disabledDatesText",
- "type": "String",
- "desc": "The tooltip text to display when the date falls on a disabled date (defaults to 'Disabled')",
- "memberOf": ""
+ "name": "startMonitoring",
+ "sig": "()",
+ "type": "function",
+ "desc": "Starts monitoring of the valid state of this form. Usually this is done by passing the config\noption \"monitorValid\""
},
{
- "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": ""
+ "name": "stopMonitoring",
+ "sig": "()",
+ "type": "function",
+ "desc": "Stops monitoring of the valid state of this form"
},
{
- "name": "maxValue",
- "type": "Date/String",
- "desc": "The maximum allowed date. Can be either a Javascript date object or a string date in a\nvalid format (defaults to null).",
- "memberOf": ""
+ "name": "submit",
+ "sig": "(Object options)",
+ "type": "function",
+ "desc": "Shortcut to do a submit action."
},
{
- "name": "minText",
- "type": "String",
- "desc": "The error text to display when the date in the cell is before minValue (defaults to\n'The date in this field must be after {minValue}').",
- "memberOf": ""
+ "name": "un",
+ "sig": "(String eventName, Function handler, Object scope)",
+ "type": "function",
+ "desc": "Removes a listener (shorthand for removeListener)"
},
{
- "name": "maxTextf",
- "type": "String",
- "desc": "The error text to display when the date in the cell is after maxValue (defaults to\n'The date in this field must be before {maxValue}').",
- "memberOf": ""
- },
+ "name": "updateRecord",
+ "sig": "(Record record)",
+ "type": "function",
+ "desc": "Persists the values in this form into the passed Roo.data.Record object in a beginEdit/endEdit block."
+ }
+ ]
+ },
+ "Roo.form.GridField": {
+ "props": [
{
- "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}').",
+ "name": "width",
+ "type": "Number",
+ "desc": "- used to restrict width of grid..",
"memberOf": ""
},
{
- "name": "triggerClass",
- "type": "String",
- "desc": "An additional CSS class used to style the trigger button. The trigger will always get the\nclass 'x-form-trigger' and triggerClass will be <b>appended</b> if specified (defaults to 'x-form-date-trigger'\nwhich displays a calendar icon).",
+ "name": "height",
+ "type": "Number",
+ "desc": "- used to restrict height of grid..",
"memberOf": ""
},
{
- "name": "useIso",
- "type": "Boolean",
- "desc": "if enabled, then the date field will use a hidden field to store the \nreal value as iso formated date. default (true)",
+ "name": "xgrid",
+ "type": "Object",
+ "desc": "(xtype'd description of grid) { xtype : 'Grid', dataSource: .... }\n\n}",
"memberOf": ""
},
{
"name": "autoCreate",
"type": "String/Object",
- "desc": "A DomHelper element spec, or true for a default element spec (defaults to\n{tag: \"input\", type: \"text\", size: \"10\", autocomplete: \"off\"})",
+ "desc": "A DomHelper element spec, or true for a default element spec (defaults to\n{tag: \"input\", type: \"checkbox\", autocomplete: \"off\"})",
"memberOf": ""
},
{
- "name": "hideTrigger",
- "type": "Boolean",
- "desc": "True to hide the trigger element and display only the base text field (defaults to false)",
- "memberOf": "Roo.form.TriggerField"
- },
- {
- "name": "vtype",
- "type": "String",
- "desc": "A validation type name as defined in {@link Roo.form.VTypes} (defaults to null)",
- "memberOf": "Roo.form.TextField"
- },
- {
- "name": "maskRe",
- "type": "String",
- "desc": "An input mask regular expression that will be used to filter keystrokes that don't match (defaults to null)",
- "memberOf": "Roo.form.TextField"
- },
- {
- "name": "disableKeyFilter",
- "type": "Boolean",
- "desc": "True to disable input keystroke filtering (defaults to false)",
- "memberOf": "Roo.form.TextField"
- },
- {
- "name": "allowBlank",
- "type": "Boolean",
- "desc": "False to validate that the value length > 0 (defaults to true)",
- "memberOf": "Roo.form.TextField"
- },
- {
- "name": "minLength",
- "type": "Number",
- "desc": "Minimum input field length required (defaults to 0)",
- "memberOf": "Roo.form.TextField"
- },
- {
- "name": "maxLength",
- "type": "Number",
- "desc": "Maximum input field length allowed (defaults to Number.MAX_VALUE)",
- "memberOf": "Roo.form.TextField"
- },
- {
- "name": "minLengthText",
- "type": "String",
- "desc": "Error text to display if the minimum length validation fails (defaults to \"The minimum length for this field is {minLength}\")",
- "memberOf": "Roo.form.TextField"
- },
- {
- "name": "maxLengthText",
- "type": "String",
- "desc": "Error text to display if the maximum length validation fails (defaults to \"The maximum length for this field is {maxLength}\")",
- "memberOf": "Roo.form.TextField"
- },
- {
- "name": "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": "Error text to display if the allow blank validation fails (defaults to \"This field is required\")",
- "memberOf": "Roo.form.TextField"
- },
- {
- "name": "validator",
- "type": "Function",
- "desc": "A custom validation function to be called during field validation (defaults to null).\nIf available, this function will be called only after the basic validators all return true, and will be passed the\ncurrent field value and expected to return boolean true if the value is valid or a string error message if invalid.",
- "memberOf": "Roo.form.TextField"
- },
- {
- "name": "regex",
- "type": "RegExp",
- "desc": "A JavaScript RegExp object to be tested against the field value during validation (defaults to null).\nIf available, this regex will be evaluated only after the basic validators all return true, and will be passed the\ncurrent field value. If the test fails, the field will be marked invalid using {@link #regexText}.",
- "memberOf": "Roo.form.TextField"
- },
- {
- "name": "regexText",
- "type": "String",
- "desc": "The error text to display if {@link #regex} is used and the test fails during validation (defaults to \"\")",
- "memberOf": "Roo.form.TextField"
- },
- {
- "name": "emptyText",
+ "name": "addTitle",
"type": "String",
- "desc": "The default text to display in an empty field - placeholder... (defaults to null).",
- "memberOf": "Roo.form.TextField"
+ "desc": "Text to include for adding a title.",
+ "memberOf": ""
},
{
"name": "fieldLabel",
"desc": "The CSS class to use when marking a field invalid (defaults to \"x-form-invalid\")",
"memberOf": "Roo.form.Field"
},
+ {
+ "name": "invalidText",
+ "type": "String",
+ "desc": "The error text to use when marking a field invalid and no message is provided (defaults to \"The value in this field is invalid\")",
+ "memberOf": "Roo.form.Field"
+ },
{
"name": "focusClass",
"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",
- "desc": "height (optional) size of component",
- "memberOf": "Roo.BoxComponent"
- },
{
"name": "disableClass",
"type": "String",
}
],
"events": [
- {
- "name": "autosize",
- "sig": "function (_self, width)\n{\n\n}",
- "type": "function",
- "desc": "Fires when the autosize function is triggered. The field may or may not have actually changed size\naccording to the default logic, but this event provides a hook for the developer to apply additional\nlogic at runtime to resize the field if needed."
- },
{
"name": "beforedestroy",
"sig": "function (_self)\n{\n\n}",
"type": "function",
"desc": "Fires after the component is resized."
},
- {
- "name": "select",
- "sig": "function (combo, date)\n{\n\n}",
- "type": "function",
- "desc": "Fires when a date is selected"
- },
{
"name": "show",
"sig": "function (_self)\n{\n\n}",
"name": "getValue",
"sig": "()",
"type": "function",
- "desc": "Returns the current date value of the date field."
+ "desc": "Returns the normalized data value (undefined or emptyText will be returned as ''). To return the raw value see {@link #getRawValue}."
+ },
+ {
+ "name": "hasChanged",
+ "sig": "()",
+ "type": "function",
+ "desc": "checks the current value against the 'loaded' value.\nNote - will return false if 'resetHasChanged' has not been called first."
},
{
"name": "hasListener",
"name": "isDirty",
"sig": "()",
"type": "function",
- "desc": "Returns true if this field has been changed since it was originally loaded and is not disabled."
+ "desc": "Returns true if this field has been changed since it was originally loaded and is not disabled.\nDEPRICATED - it never worked well - use hasChanged/resetHasChanged."
},
{
"name": "isValid",
"type": "function",
"desc": "Called after the component is resized, this method is empty by default but can be implemented by any\nsubclass that needs to perform custom logic after a resize occurs."
},
- {
- "name": "onTriggerClick",
- "sig": "(EventObject e)",
- "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."
- },
{
"name": "purgeListeners",
"sig": "()",
"name": "reset",
"sig": "()",
"type": "function",
- "desc": "Resets the current field value to the originally-loaded value and clears any validation messages."
+ "desc": "Resets the current field value to the originally loaded value and clears any validation messages"
},
{
- "name": "selectText",
- "sig": "(Number start, Number end)",
+ "name": "resetHasChanged",
+ "sig": "()",
"type": "function",
- "desc": "Selects text in this field"
+ "desc": "stores the current value in loadedValue"
},
{
"name": "setDisabled",
},
{
"name": "setValue",
- "sig": "(String/Date date)",
+ "sig": "(String either)",
"type": "function",
- "desc": "Sets the value of the date field. You can pass a date object or any string that can be parsed into a valid\ndate, using MonthField.format as the date format, according to the same rules as {@link Date#parseDate}\n(the default format used is \"m/d/y\").\n<br />Usage:\n<pre><code>\n//All of these calls set the same date value (May 4, 2006)\n\n//Pass a date object:\nvar dt = new Date('5/4/06');\nmonthField.setValue(dt);\n\n//Pass a date string (default format):\nmonthField.setValue('5/4/06');\n\n//Pass a date string (custom format):\nmonthField.format = 'Y-m-d';\nmonthField.setValue('2006-5-4');\n</code></pre>"
+ "desc": "Sets the value of the item."
},
{
"name": "setVisible",
"sig": "()",
"type": "function",
"desc": "Validates the field value"
- },
- {
- "name": "validateValue",
- "sig": "(Mixed value)",
- "type": "function",
- "desc": "Validates a value according to the field's validation rules and marks the field as invalid\nif the validation fails"
}
]
},
- "Roo.form.NumberField": {
+ "Roo.form.Hidden": {
"props": [
{
- "name": "fieldClass",
- "type": "String",
- "desc": "The default CSS class for the field (defaults to \"x-form-field x-form-num-field\")",
- "memberOf": ""
- },
- {
- "name": "allowDecimals",
+ "name": "grow",
"type": "Boolean",
- "desc": "False to disallow decimal values (defaults to true)",
- "memberOf": ""
+ "desc": "True if this field should automatically grow and shrink to its content",
+ "memberOf": "Roo.form.TextField"
},
{
- "name": "decimalSeparator",
- "type": "String",
- "desc": "Character(s) to allow as the decimal separator (defaults to '.')",
- "memberOf": ""
+ "name": "growMin",
+ "type": "Number",
+ "desc": "The minimum width to allow when grow = true (defaults to 30)",
+ "memberOf": "Roo.form.TextField"
},
{
- "name": "decimalPrecision",
+ "name": "growMax",
"type": "Number",
- "desc": "The maximum precision to display after the decimal separator (defaults to 2)",
- "memberOf": ""
+ "desc": "The maximum width to allow when grow = true (defaults to 800)",
+ "memberOf": "Roo.form.TextField"
},
{
- "name": "allowNegative",
- "type": "Boolean",
- "desc": "False to prevent entering a negative sign (defaults to true)",
- "memberOf": ""
- },
- {
- "name": "minValue",
- "type": "Number",
- "desc": "The minimum allowed value (defaults to Number.NEGATIVE_INFINITY)",
- "memberOf": ""
- },
- {
- "name": "maxValue",
- "type": "Number",
- "desc": "The maximum allowed value (defaults to Number.MAX_VALUE)",
- "memberOf": ""
- },
- {
- "name": "minText",
- "type": "String",
- "desc": "Error text to display if the minimum value validation fails (defaults to \"The minimum value for this field is {minValue}\")",
- "memberOf": ""
- },
- {
- "name": "maxText",
- "type": "String",
- "desc": "Error text to display if the maximum value validation fails (defaults to \"The maximum value for this field is {maxValue}\")",
- "memberOf": ""
- },
- {
- "name": "nanText",
- "type": "String",
- "desc": "Error text to display if the value is not a valid number. For example, this can happen\nif a valid character like '.' or '-' is left in the field with no number (defaults to \"{value} is not a valid number\")",
- "memberOf": ""
- },
- {
- "name": "grow",
- "type": "Boolean",
- "desc": "True if this field should automatically grow and shrink to its content",
- "memberOf": "Roo.form.TextField"
- },
- {
- "name": "growMin",
- "type": "Number",
- "desc": "The minimum width to allow when grow = true (defaults to 30)",
- "memberOf": "Roo.form.TextField"
- },
- {
- "name": "growMax",
- "type": "Number",
- "desc": "The maximum width to allow when grow = true (defaults to 800)",
- "memberOf": "Roo.form.TextField"
- },
- {
- "name": "vtype",
- "type": "String",
- "desc": "A validation type name as defined in {@link Roo.form.VTypes} (defaults to null)",
- "memberOf": "Roo.form.TextField"
+ "name": "vtype",
+ "type": "String",
+ "desc": "A validation type name as defined in {@link Roo.form.VTypes} (defaults to null)",
+ "memberOf": "Roo.form.TextField"
},
{
"name": "maskRe",
"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": "The default CSS class for the field (defaults to \"x-form-field\")",
+ "memberOf": "Roo.form.Field"
+ },
{
"name": "msgTarget",
"type": "String",
"type": "function",
"desc": "Returns the normalized data value (undefined or emptyText will be returned as ''). To return the raw value see {@link #getRawValue}."
},
+ {
+ "name": "hasChanged",
+ "sig": "()",
+ "type": "function",
+ "desc": "checks the current value against the 'loaded' value.\nNote - will return false if 'resetHasChanged' has not been called first."
+ },
{
"name": "hasListener",
"sig": "(String eventName)",
"name": "isDirty",
"sig": "()",
"type": "function",
- "desc": "Returns true if this field has been changed since it was originally loaded and is not disabled."
+ "desc": "Returns true if this field has been changed since it was originally loaded and is not disabled.\nDEPRICATED - it never worked well - use hasChanged/resetHasChanged."
},
{
"name": "isValid",
"type": "function",
"desc": "Resets the current field value to the originally-loaded value and clears any validation messages."
},
+ {
+ "name": "resetHasChanged",
+ "sig": "()",
+ "type": "function",
+ "desc": "stores the current value in loadedValue"
+ },
{
"name": "selectText",
"sig": "(Number start, Number end)",
}
]
},
- "Roo.form.Radio": {
+ "Roo.form.HtmlEditor": {
"props": [
{
- "name": "focusClass",
- "type": "String",
- "desc": "The CSS class to use when the checkbox receives focus (defaults to undefined)",
- "memberOf": "Roo.form.Checkbox"
+ "name": "clearUp",
+ "type": "Boolean",
+ "desc": "",
+ "memberOf": ""
},
{
- "name": "fieldClass",
+ "name": "toolbars",
+ "type": "Array",
+ "desc": "Array of toolbars. - defaults to just the Standard one",
+ "memberOf": ""
+ },
+ {
+ "name": "resizable",
"type": "String",
- "desc": "The default CSS class for the checkbox (defaults to \"x-form-field\")",
- "memberOf": "Roo.form.Checkbox"
+ "desc": "'s' or 'se' or 'e' - wrapps the element in a\n Roo.resizable.",
+ "memberOf": ""
},
{
- "name": "checked",
- "type": "Boolean",
- "desc": "True if the the checkbox should render already checked (defaults to false)",
- "memberOf": "Roo.form.Checkbox"
+ "name": "height",
+ "type": "Number",
+ "desc": "(in pixels)",
+ "memberOf": ""
},
{
- "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"
+ "name": "width",
+ "type": "Number",
+ "desc": "(in pixels)",
+ "memberOf": ""
},
{
- "name": "boxLabel",
- "type": "String",
- "desc": "The text that appears beside the checkbox",
- "memberOf": "Roo.form.Checkbox"
+ "name": "stylesheets",
+ "type": "Array",
+ "desc": "url of stylesheets. set to [] to disable stylesheets.",
+ "memberOf": ""
},
{
- "name": "inputValue",
- "type": "String",
- "desc": "The value that should go into the generated input element's value attribute",
- "memberOf": "Roo.form.Checkbox"
+ "name": "blacklist",
+ "type": "Array",
+ "desc": "of css styles style attributes (blacklist overrides whitelist)",
+ "memberOf": ""
},
{
- "name": "valueOff",
- "type": "String",
- "desc": "The value that should go into the generated input element's value when unchecked.",
- "memberOf": "Roo.form.Checkbox"
+ "name": "whitelist",
+ "type": "Array",
+ "desc": "of css styles style attributes (blacklist overrides whitelist)",
+ "memberOf": ""
},
{
"name": "fieldLabel",
"desc": "The field's HTML name attribute.",
"memberOf": "Roo.form.Field"
},
- {
- "name": "invalidClass",
- "type": "String",
- "desc": "The CSS class to use when marking a field invalid (defaults to \"x-form-invalid\")",
- "memberOf": "Roo.form.Field"
- },
- {
- "name": "invalidText",
- "type": "String",
- "desc": "The error text to use when marking a field invalid and no message is provided (defaults to \"The value in this field is invalid\")",
- "memberOf": "Roo.form.Field"
- },
{
"name": "validationEvent",
"type": "String/Boolean",
"desc": "The event that should initiate field validation. Set to false to disable\n automatic validation (defaults to \"keyup\").",
"memberOf": "Roo.form.Field"
},
- {
- "name": "validateOnBlur",
- "type": "Boolean",
- "desc": "Whether the field should validate when it loses focus (defaults to true).",
- "memberOf": "Roo.form.Field"
- },
{
"name": "validationDelay",
"type": "Number",
"desc": "The location where error text should display. Should be one of the following values (defaults to 'qtip'):\n<pre>\nValue Description\n----------- ----------------------------------------------------------------------\nqtip Display a quick tip when the user hovers over the field\ntitle Display a default browser title attribute popup\nunder Add a block div beneath the field containing the error text\nside Add an error icon to the right of the field with a popup on hover\n[element id] Add the error text directly to the innerHTML of the specified element\n</pre>",
"memberOf": "Roo.form.Field"
},
- {
- "name": "msgFx",
- "type": "String",
- "desc": "<b>Experimental</b> The effect used when displaying a validation message under the field (defaults to 'normal').",
- "memberOf": "Roo.form.Field"
- },
{
"name": "readOnly",
"type": "Boolean",
"desc": "True to disable the field (defaults to false).",
"memberOf": "Roo.form.Field"
},
- {
- "name": "inputType",
- "type": "String",
- "desc": "The type attribute for input fields -- e.g. radio, text, password (defaults to \"text\").",
- "memberOf": "Roo.form.Field"
- },
{
"name": "tabIndex",
"type": "Number",
"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",
- "desc": "height (optional) size of component",
- "memberOf": "Roo.BoxComponent"
- },
{
"name": "disableClass",
"type": "String",
}
],
"events": [
+ {
+ "name": "activate",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires when the editor is first receives the focus. Any insertion must wait\nuntil after this event."
+ },
+ {
+ "name": "autosave",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Auto save the htmlEditor value as a file into Events"
+ },
{
"name": "beforedestroy",
"sig": "function (_self)\n{\n\n}",
"type": "function",
"desc": "Fires before the component is hidden. Return false to stop the hide."
},
+ {
+ "name": "beforepush",
+ "sig": "function (_self, html)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires before the iframe editor is updated with content from the textarea. Return false\nto cancel the push."
+ },
{
"name": "beforerender",
"sig": "function (_self)\n{\n\n}",
"desc": "Fires before the component is shown. Return false to stop the show."
},
{
- "name": "blur",
- "sig": "function (_self)\n{\n\n}",
+ "name": "beforesync",
+ "sig": "function (_self, html)\n{\n\n}",
"type": "function",
- "desc": "Fires when this field loses input focus."
+ "desc": "Fires before the textarea is updated with content from the editor iframe. Return false\nto cancel the sync."
},
{
- "name": "change",
- "sig": "function (_self, newValue, oldValue)\n{\n\n}",
+ "name": "destroy",
+ "sig": "function (_self)\n{\n\n}",
"type": "function",
- "desc": "Fires just before the field blurs if the field value has changed."
+ "desc": "Fires after the component is destroyed."
},
{
- "name": "check",
- "sig": "function (_self, checked)\n{\n\n}",
+ "name": "disable",
+ "sig": "function (_self)\n{\n\n}",
"type": "function",
- "desc": "Fires when the checkbox is checked or unchecked."
+ "desc": "Fires after the component is disabled."
},
{
- "name": "destroy",
- "sig": "function (_self)\n{\n\n}",
+ "name": "editmodechange",
+ "sig": "function (_self, sourceEdit)\n{\n\n}",
"type": "function",
- "desc": "Fires after the component is destroyed."
+ "desc": "Fires when the editor switches edit modes"
},
{
- "name": "disable",
+ "name": "editorevent",
"sig": "function (_self)\n{\n\n}",
"type": "function",
- "desc": "Fires after the component is disabled."
+ "desc": "Fires when on any editor (mouse up/down cursor movement etc.) - used for toolbar hooks."
},
{
"name": "enable",
"desc": "Fires after the component is enabled."
},
{
- "name": "focus",
+ "name": "firstfocus",
"sig": "function (_self)\n{\n\n}",
"type": "function",
- "desc": "Fires when this field receives input focus."
+ "desc": "Fires when on first focus - needed by toolbars.."
},
{
"name": "hide",
"type": "function",
"desc": "Fires after the component is hidden."
},
+ {
+ "name": "initialize",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires when the editor is fully initialized (including the iframe)"
+ },
{
"name": "invalid",
"sig": "function (_self, msg)\n{\n\n}",
"type": "function",
"desc": "Fires after the component is moved."
},
+ {
+ "name": "push",
+ "sig": "function (_self, html)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires when the iframe editor is updated with content from the textarea."
+ },
{
"name": "render",
"sig": "function (_self)\n{\n\n}",
"type": "function",
"desc": "Fires after the component is resized."
},
+ {
+ "name": "savedpreview",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "preview the saved version of htmlEditor"
+ },
{
"name": "show",
"sig": "function (_self)\n{\n\n}",
"desc": "Fires after the component is shown."
},
{
- "name": "specialkey",
- "sig": "function (_self, e)\n{\n\n}",
+ "name": "stylesheetsclick",
+ "sig": "function (_self)\n{\n\n}",
"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."
+ "desc": "Fires when press the Sytlesheets button"
+ },
+ {
+ "name": "sync",
+ "sig": "function (_self, html)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires when the textarea is updated with content from the editor iframe."
},
{
"name": "valid",
"name": "clearInvalid",
"sig": "()",
"type": "function",
- "desc": "Clear any invalid styles/messages for this field"
+ "desc": "Overridden and disabled. The editor element does not support standard valid/invalid marking. @hide"
+ },
+ {
+ "name": "createToolbar",
+ "sig": "(HtmlEditor editor)",
+ "type": "function",
+ "desc": "Protected method that will not generally be called directly. It\nis called when the editor creates its toolbar. Override this method if you need to\nadd custom toolbar buttons."
},
{
"name": "destroy",
"type": "function",
"desc": "Returns the underlying {@link Roo.Element}."
},
- {
- "name": "getGroupValue",
- "sig": "()",
- "type": "function",
- "desc": "If this radio is part of a group, it will return the selected value"
- },
{
"name": "getId",
"sig": "()",
"name": "getValue",
"sig": "()",
"type": "function",
- "desc": "Returns the checked state of the checkbox."
+ "desc": "Returns the normalized data value (undefined or emptyText will be returned as ''). To return the raw value see {@link #getRawValue}."
+ },
+ {
+ "name": "hasChanged",
+ "sig": "()",
+ "type": "function",
+ "desc": "checks the current value against the 'loaded' value.\nNote - will return false if 'resetHasChanged' has not been called first."
},
{
"name": "hasListener",
"name": "isDirty",
"sig": "()",
"type": "function",
- "desc": "Returns true if this field has been changed since it was originally loaded and is not disabled."
+ "desc": "Returns true if this field has been changed since it was originally loaded and is not disabled.\nDEPRICATED - it never worked well - use hasChanged/resetHasChanged."
},
{
"name": "isValid",
},
{
"name": "markInvalid",
- "sig": "(String msg)",
+ "sig": "()",
"type": "function",
- "desc": "Mark this field as invalid"
+ "desc": "Overridden and disabled. The editor element does not support standard valid/invalid marking. @hide"
},
{
"name": "on",
"type": "function",
"desc": "Resets the current field value to the originally loaded value and clears any validation messages"
},
+ {
+ "name": "resetHasChanged",
+ "sig": "()",
+ "type": "function",
+ "desc": "stores the current value in loadedValue"
+ },
{
"name": "setDisabled",
"sig": "(Boolean disabled)",
},
{
"name": "setValue",
- "sig": "(Boolean/String value, Boolean/String suppressEvent)",
+ "sig": "(Mixed value)",
"type": "function",
- "desc": "Sets the checked state of the checkbox.\nOn is always based on a string comparison between inputValue and the param."
+ "desc": "Sets a data value into the field and validates it. To set the value directly without validation see {@link #setRawValue}."
},
{
"name": "setVisible",
"type": "function",
"desc": "Force the component's size to recalculate based on the underlying element's current height and width."
},
+ {
+ "name": "toggleSourceEdit",
+ "sig": "(Boolean sourceEdit)",
+ "type": "function",
+ "desc": "Toggles the editor between standard and source edit mode."
+ },
{
"name": "un",
"sig": "(String eventName, Function handler, Object scope)",
}
]
},
- "Roo.form.Row": {
+ "Roo.form.HtmlEditor.ToolbarContext": {
"props": [
{
- "name": "width",
- "type": "Number/String",
- "desc": "The fixed width of the column in pixels or CSS value (defaults to \"auto\")",
+ "name": "disable",
+ "type": "Object",
+ "desc": "List of toolbar elements to disable",
"memberOf": ""
},
{
- "name": "height",
- "type": "Number/String",
- "desc": "The fixed height of the column in pixels or CSS value (defaults to \"auto\")",
+ "name": "styles",
+ "type": "Object",
+ "desc": "List of styles \n eg. { '*' : [ 'headline' ] , 'TD' : [ 'underline', 'double-underline' ] } \n\nThese must be defined in the page, so they get rendered correctly..\n.headline { }\nTD.underline { }",
+ "memberOf": ""
+ }
+ ],
+ "events": [],
+ "methods": [
+ {
+ "name": "updateToolbar",
+ "sig": "()",
+ "type": "function",
+ "desc": "Protected method that will not generally be called directly. It triggers\na toolbar update by reading the markup state of the current selection in the editor.\n\nNote you can force an update by calling on('editorevent', scope, false)"
+ }
+ ]
+ },
+ "Roo.form.HtmlEditor.ToolbarStandard": {
+ "props": [
+ {
+ "name": "disable",
+ "type": "Object",
+ "desc": "List of elements to disable..",
"memberOf": ""
},
+ {
+ "name": "btns",
+ "type": "Array",
+ "desc": "List of additional buttons.\n\n\nNEEDS Extra CSS? \n.x-html-editor-tb .x-edit-none .x-btn-text { background: none; }",
+ "memberOf": ""
+ },
+ {
+ "name": "createLinkText",
+ "type": "String",
+ "desc": "The default text for the create link prompt",
+ "memberOf": ""
+ },
+ {
+ "name": "defaultLinkValue",
+ "type": "String",
+ "desc": "The default value for the create link prompt (defaults to http:/ /)",
+ "memberOf": ""
+ },
+ {
+ "name": "fontFamilies",
+ "type": "Array",
+ "desc": "An array of available font families",
+ "memberOf": ""
+ },
+ {
+ "name": "defaultFont",
+ "type": "String",
+ "desc": "default font to use.",
+ "memberOf": ""
+ }
+ ],
+ "events": [],
+ "methods": [
+ {
+ "name": "updateToolbar",
+ "sig": "()",
+ "type": "function",
+ "desc": "Protected method that will not generally be called directly. It triggers\na toolbar update by reading the markup state of the current selection in the editor."
+ }
+ ]
+ },
+ "Roo.form.Layout": {
+ "props": [
{
"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": ""
},
{
"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": ""
},
{
"name": "labelAlign",
"type": "String",
"desc": "Valid values are \"left,\" \"top\" and \"right\" (defaults to \"left\")",
- "memberOf": "Roo.form.Layout"
+ "memberOf": ""
},
{
"name": "labelWidth",
"type": "Number",
"desc": "Fixed width in pixels of all field labels (defaults to undefined)",
- "memberOf": "Roo.form.Layout"
+ "memberOf": ""
},
{
"name": "clear",
"type": "Boolean",
"desc": "True to add a clearing element at the end of this layout, equivalent to CSS clear: both (defaults to true)",
- "memberOf": "Roo.form.Layout"
+ "memberOf": ""
},
{
"name": "labelSeparator",
"type": "String",
"desc": "The separator to use after field labels (defaults to ':')",
- "memberOf": "Roo.form.Layout"
+ "memberOf": ""
},
{
"name": "hideLabels",
"type": "Boolean",
"desc": "True to suppress the display of field labels in this layout (defaults to false)",
- "memberOf": "Roo.form.Layout"
+ "memberOf": ""
},
{
"name": "disableClass",
}
]
},
- "Roo.form.Select": {
+ "Roo.form.MonthField": {
"props": [
{
- "name": "transform",
- "type": "String/HTMLElement/Element",
- "desc": "The id, DOM node or element of an existing select to convert to a ComboBox",
- "memberOf": ""
- },
- {
- "name": "lazyRender",
- "type": "Boolean",
- "desc": "True to prevent the ComboBox from rendering until requested (should always be used when\nrendering into an Roo.Editor, defaults to false)",
- "memberOf": ""
- },
- {
- "name": "autoCreate",
- "type": "Boolean/Object",
- "desc": "A DomHelper element spec, or true for a default element spec (defaults to:\n{tag: \"input\", type: \"text\", size: \"24\", autocomplete: \"off\"})",
- "memberOf": ""
- },
- {
- "name": "store",
- "type": "Roo.data.Store",
- "desc": "The data store to which this combo is bound (defaults to undefined)",
- "memberOf": ""
- },
- {
- "name": "title",
- "type": "String",
- "desc": "If supplied, a header element is created containing this text and added into the top of\nthe dropdown list (defaults to undefined, with no header element)",
- "memberOf": ""
- },
- {
- "name": "grow",
- "type": "Boolean",
- "desc": "",
- "memberOf": ""
- },
- {
- "name": "growMin",
- "type": "Number",
- "desc": "",
- "memberOf": ""
- },
- {
- "name": "growMax",
- "type": "Number",
- "desc": "",
- "memberOf": ""
- },
- {
- "name": "tpl",
- "type": "String/Roo.Template",
- "desc": "The template to use to render the output",
- "memberOf": ""
- },
- {
- "name": "listWidth",
- "type": "Number",
- "desc": "The width in pixels of the dropdown list (defaults to the width of the ComboBox field)",
- "memberOf": ""
- },
- {
- "name": "displayField",
- "type": "String",
- "desc": "The underlying data field name to bind to this CombBox (defaults to undefined if\nmode = 'remote' or 'text' if mode = 'local')",
- "memberOf": ""
- },
- {
- "name": "valueField",
- "type": "String",
- "desc": "The underlying data value name to bind to this CombBox (defaults to undefined if\nmode = 'remote' or 'value' if mode = 'local'). \nNote: use of a valueField requires the user make a selection\nin order for a value to be mapped.",
- "memberOf": ""
- },
- {
- "name": "hiddenName",
- "type": "String",
- "desc": "If specified, a hidden form field with this name is dynamically generated to store the\nfield's data value (defaults to the underlying DOM element's name)",
- "memberOf": ""
- },
- {
- "name": "listClass",
- "type": "String",
- "desc": "CSS class to apply to the dropdown list element (defaults to '')",
- "memberOf": ""
- },
- {
- "name": "selectedClass",
- "type": "String",
- "desc": "CSS class to apply to the selected item in the dropdown list (defaults to 'x-combo-selected')",
- "memberOf": ""
- },
- {
- "name": "triggerClass",
+ "name": "format",
"type": "String",
- "desc": "An additional CSS class used to style the trigger button. The trigger will always get the\nclass 'x-form-trigger' and triggerClass will be <b>appended</b> if specified (defaults to 'x-form-arrow-trigger'\nwhich displays a downward arrow icon).",
- "memberOf": ""
- },
- {
- "name": "shadow",
- "type": "Boolean/String",
- "desc": "True or \"sides\" for the default effect, \"frame\" for 4-way shadow, and \"drop\" for bottom-right",
+ "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": ""
},
{
- "name": "listAlign",
+ "name": "altFormats",
"type": "String",
- "desc": "A valid anchor position value. See {@link Roo.Element#alignTo} for details on supported\nanchor positions (defaults to 'tl-bl')",
+ "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": ""
},
{
- "name": "maxHeight",
- "type": "Number",
- "desc": "The maximum height in pixels of the dropdown list before scrollbars are shown (defaults to 300)",
+ "name": "disabledDays",
+ "type": "Array",
+ "desc": "An array of days to disable, 0 based. For example, [0, 6] disables Sunday and Saturday (defaults to null).",
"memberOf": ""
},
{
- "name": "triggerAction",
+ "name": "disabledDaysText",
"type": "String",
- "desc": "The action to execute when the trigger field is activated. Use 'all' to run the\nquery specified by the allQuery config option (defaults to 'query')",
- "memberOf": ""
- },
- {
- "name": "minChars",
- "type": "Number",
- "desc": "The minimum number of characters the user must type before autocomplete and typeahead activate\n(defaults to 4, does not apply if editable = false)",
- "memberOf": ""
- },
- {
- "name": "typeAhead",
- "type": "Boolean",
- "desc": "True to populate and autoselect the remainder of the text being typed after a configurable\ndelay (typeAheadDelay) if it matches a known value (defaults to false)",
- "memberOf": ""
- },
- {
- "name": "queryDelay",
- "type": "Number",
- "desc": "The length of time in milliseconds to delay between the start of typing and sending the\nquery to filter the dropdown list (defaults to 500 if mode = 'remote' or 10 if mode = 'local')",
- "memberOf": ""
- },
- {
- "name": "pageSize",
- "type": "Number",
- "desc": "If greater than 0, a paging toolbar is displayed in the footer of the dropdown list and the\nfilter queries will execute with page start and limit parameters. Only applies when mode = 'remote' (defaults to 0)",
- "memberOf": ""
- },
- {
- "name": "selectOnFocus",
- "type": "Boolean",
- "desc": "True to select any existing text in the field immediately on focus. Only applies\nwhen editable = true (defaults to false)",
+ "desc": "The tooltip to display when the date falls on a disabled day (defaults to 'Disabled')",
"memberOf": ""
},
{
- "name": "queryParam",
- "type": "String",
- "desc": "Name of the query as it will be passed on the querystring (defaults to 'query')",
+ "name": "disabledDates",
+ "type": "Array",
+ "desc": "An array of \"dates\" to disable, as strings. These strings will be used to build a dynamic regular\nexpression so they are very powerful. Some examples:\n<ul>\n<li>[\"03/08/2003\", \"09/16/2003\"] would disable those exact dates</li>\n<li>[\"03/08\", \"09/16\"] would disable those days for every year</li>\n<li>[\"^03/08\"] would only match the beginning (useful if you are using short years)</li>\n<li>[\"03/../2006\"] would disable every day in March 2006</li>\n<li>[\"^03\"] would disable every day in every March</li>\n</ul>\nIn order to support regular expressions, if you are using a date format that has \".\" in it, you will have to\nescape the dot when restricting dates. For example: [\"03\\\\.08\\\\.03\"].",
"memberOf": ""
},
{
- "name": "loadingText",
+ "name": "disabledDatesText",
"type": "String",
- "desc": "The text to display in the dropdown list while data is loading. Only applies\nwhen mode = 'remote' (defaults to 'Loading...')",
- "memberOf": ""
- },
- {
- "name": "resizable",
- "type": "Boolean",
- "desc": "True to add a resize handle to the bottom of the dropdown list (defaults to false)",
+ "desc": "The tooltip text to display when the date falls on a disabled date (defaults to 'Disabled')",
"memberOf": ""
},
{
- "name": "handleHeight",
- "type": "Number",
- "desc": "The height in pixels of the dropdown list resize handle if resizable = true (defaults to 8)",
+ "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": ""
},
{
- "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)",
+ "name": "maxValue",
+ "type": "Date/String",
+ "desc": "The maximum allowed date. Can be either a Javascript date object or a string date in a\nvalid format (defaults to null).",
"memberOf": ""
},
{
- "name": "allQuery",
+ "name": "minText",
"type": "String",
- "desc": "The text query to send to the server to return all records for the list with no filtering (defaults to '')",
+ "desc": "The error text to display when the date in the cell is before minValue (defaults to\n'The date in this field must be after {minValue}').",
"memberOf": ""
},
{
- "name": "mode",
+ "name": "maxTextf",
"type": "String",
- "desc": "Set to 'local' if the ComboBox loads local data (defaults to 'remote' which loads from the server)",
- "memberOf": ""
- },
- {
- "name": "minListWidth",
- "type": "Number",
- "desc": "The minimum width of the dropdown list in pixels (defaults to 70, will be ignored if\nlistWidth has a higher value)",
- "memberOf": ""
- },
- {
- "name": "forceSelection",
- "type": "Boolean",
- "desc": "True to restrict the selected value to one of the values in the list, false to\nallow the user to set arbitrary text into the field (defaults to false)",
- "memberOf": ""
- },
- {
- "name": "typeAheadDelay",
- "type": "Number",
- "desc": "The length of time in milliseconds to wait until the typeahead text is displayed\nif typeAhead = true (defaults to 250)",
+ "desc": "The error text to display when the date in the cell is after maxValue (defaults to\n'The date in this field must be before {maxValue}').",
"memberOf": ""
},
{
- "name": "valueNotFoundText",
+ "name": "invalidText",
"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)",
+ "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": ""
},
{
- "name": "defaultValue",
+ "name": "triggerClass",
"type": "String",
- "desc": "The value displayed after loading the store.",
- "memberOf": ""
- },
- {
- "name": "blockFocus",
- "type": "Boolean",
- "desc": "Prevents all focus calls, so it can work with things like HTML edtor bar",
+ "desc": "An additional CSS class used to style the trigger button. The trigger will always get the\nclass 'x-form-trigger' and triggerClass will be <b>appended</b> if specified (defaults to 'x-form-date-trigger'\nwhich displays a calendar icon).",
"memberOf": ""
},
{
- "name": "disableClear",
+ "name": "useIso",
"type": "Boolean",
- "desc": "Disable showing of clear button.",
+ "desc": "if enabled, then the date field will use a hidden field to store the \nreal value as iso formated date. default (true)",
"memberOf": ""
},
{
- "name": "alwaysQuery",
- "type": "Boolean",
- "desc": "Disable caching of results, and always send query",
+ "name": "autoCreate",
+ "type": "String/Object",
+ "desc": "A DomHelper element spec, or true for a default element spec (defaults to\n{tag: \"input\", type: \"text\", size: \"10\", autocomplete: \"off\"})",
"memberOf": ""
},
{
"desc": "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": "The CSS class to use when marking a field invalid (defaults to \"x-form-invalid\")",
"memberOf": "Roo.form.Field"
},
- {
- "name": "invalidText",
- "type": "String",
- "desc": "The error text to use when marking a field invalid and no message is provided (defaults to \"The value in this field is invalid\")",
- "memberOf": "Roo.form.Field"
- },
{
"name": "focusClass",
"type": "String",
"type": "function",
"desc": "Fires after the component is resized."
},
+ {
+ "name": "select",
+ "sig": "function (combo, date)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires when a date is selected"
+ },
{
"name": "show",
"sig": "function (_self)\n{\n\n}",
"type": "function",
"desc": "Clear any invalid styles/messages for this field"
},
- {
- "name": "clearValue",
- "sig": "()",
- "type": "function",
- "desc": "Clears any text/value currently set in the field"
- },
- {
- "name": "collapse",
- "sig": "()",
- "type": "function",
- "desc": "Hides the dropdown list if it is currently expanded. Fires the 'collapse' event on completion."
- },
{
"name": "destroy",
"sig": "()",
"type": "function",
"desc": "Disable this component."
},
- {
- "name": "doQuery",
- "sig": "(String query, Boolean forceAll)",
- "type": "function",
- "desc": "Execute a query to filter the dropdown list. Fires the beforequery event prior to performing the\nquery allowing the query action to be canceled if needed."
- },
{
"name": "enable",
"sig": "()",
"type": "function",
"desc": "Enable this component."
},
- {
- "name": "expand",
- "sig": "()",
- "type": "function",
- "desc": "Expands the dropdown list if it is currently hidden. Fires the 'expand' event on completion."
- },
{
"name": "fireEvent",
"sig": "(String eventName, Object... args)",
"name": "getValue",
"sig": "()",
"type": "function",
- "desc": "Returns the currently selected field value or empty string if no value is set."
+ "desc": "Returns the current date value of the date field."
+ },
+ {
+ "name": "hasChanged",
+ "sig": "()",
+ "type": "function",
+ "desc": "checks the current value against the 'loaded' value.\nNote - will return false if 'resetHasChanged' has not been called first."
},
{
"name": "hasListener",
"name": "isDirty",
"sig": "()",
"type": "function",
- "desc": "Returns true if this field has been changed since it was originally loaded and is not disabled."
- },
- {
- "name": "isExpanded",
- "sig": "()",
- "type": "function",
- "desc": "Returns true if the dropdown list is expanded, else false."
+ "desc": "Returns true if this field has been changed since it was originally loaded and is not disabled.\nDEPRICATED - it never worked well - use hasChanged/resetHasChanged."
},
{
"name": "isValid",
"desc": "Resets the current field value to the originally-loaded value and clears any validation messages."
},
{
- "name": "select",
- "sig": "(Number index, Boolean scrollIntoView)",
- "type": "function",
- "desc": "Select an item in the dropdown list by its numeric index in the list. This function does NOT cause the select event to fire.\nThe store must be loaded and the list expanded for this function to work, otherwise use setValue."
- },
- {
- "name": "selectByValue",
- "sig": "(String value, Boolean scrollIntoView)",
+ "name": "resetHasChanged",
+ "sig": "()",
"type": "function",
- "desc": "Select an item in the dropdown list by its data value. This function does NOT cause the select event to fire.\nThe store must be loaded and the list expanded for this function to work, otherwise use setValue."
+ "desc": "stores the current value in loadedValue"
},
{
"name": "selectText",
"type": "function",
"desc": "Convenience function for setting disabled/enabled by boolean."
},
- {
- "name": "setEditable",
- "sig": "(Boolean value)",
- "type": "function",
- "desc": "Allow or prevent the user from directly editing the field text. If false is passed,\nthe user will only be able to select from the items defined in the dropdown list. This method\nis the runtime equivalent of setting the 'editable' config option at config time."
- },
- {
- "name": "setFromData",
- "sig": "(Object value)",
- "type": "function",
- "desc": "Sets the value of the field based on a object which is related to the record format for the store."
- },
{
"name": "setPagePosition",
"sig": "(Number x, Number y)",
},
{
"name": "setValue",
- "sig": "(String value)",
+ "sig": "(String/Date date)",
"type": "function",
- "desc": "Sets the specified value into the field. If the value finds a match, the corresponding record text\nwill be displayed in the field. If the value does not match the data value of an existing item,\nand the valueNotFoundText config option is defined, it will be displayed as the default field text.\nOtherwise the field will be blank (although the value will still be set)."
+ "desc": "Sets the value of the date field. You can pass a date object or any string that can be parsed into a valid\ndate, using MonthField.format as the date format, according to the same rules as {@link Date#parseDate}\n(the default format used is \"m/d/y\").\n<br />Usage:\n<pre><code>\n//All of these calls set the same date value (May 4, 2006)\n\n//Pass a date object:\nvar dt = new Date('5/4/06');\nmonthField.setValue(dt);\n\n//Pass a date string (default format):\nmonthField.setValue('5/4/06');\n\n//Pass a date string (custom format):\nmonthField.format = 'Y-m-d';\nmonthField.setValue('2006-5-4');\n</code></pre>"
},
{
"name": "setVisible",
}
]
},
- "Roo.form.Signature": {
+ "Roo.form.NumberField": {
"props": [
{
- "name": "labels",
- "type": "Object",
- "desc": "Label to use when rendering a form.\ndefaults to \nlabels : { \n clear : \"Clear\",\n confirm : \"Confirm\"\n }",
+ "name": "fieldClass",
+ "type": "String",
+ "desc": "The default CSS class for the field (defaults to \"x-form-field x-form-num-field\")",
"memberOf": ""
},
{
- "name": "width",
+ "name": "allowDecimals",
+ "type": "Boolean",
+ "desc": "False to disallow decimal values (defaults to true)",
+ "memberOf": ""
+ },
+ {
+ "name": "decimalSeparator",
+ "type": "String",
+ "desc": "Character(s) to allow as the decimal separator (defaults to '.')",
+ "memberOf": ""
+ },
+ {
+ "name": "decimalPrecision",
"type": "Number",
- "desc": "The signature panel width (defaults to 300)",
+ "desc": "The maximum precision to display after the decimal separator (defaults to 2)",
"memberOf": ""
},
{
- "name": "height",
+ "name": "allowNegative",
+ "type": "Boolean",
+ "desc": "False to prevent entering a negative sign (defaults to true)",
+ "memberOf": ""
+ },
+ {
+ "name": "minValue",
"type": "Number",
- "desc": "The signature panel height (defaults to 100)",
+ "desc": "The minimum allowed value (defaults to Number.NEGATIVE_INFINITY)",
+ "memberOf": ""
+ },
+ {
+ "name": "maxValue",
+ "type": "Number",
+ "desc": "The maximum allowed value (defaults to Number.MAX_VALUE)",
+ "memberOf": ""
+ },
+ {
+ "name": "minText",
+ "type": "String",
+ "desc": "Error text to display if the minimum value validation fails (defaults to \"The minimum value for this field is {minValue}\")",
+ "memberOf": ""
+ },
+ {
+ "name": "maxText",
+ "type": "String",
+ "desc": "Error text to display if the maximum value validation fails (defaults to \"The maximum value for this field is {maxValue}\")",
+ "memberOf": ""
+ },
+ {
+ "name": "nanText",
+ "type": "String",
+ "desc": "Error text to display if the value is not a valid number. For example, this can happen\nif a valid character like '.' or '-' is left in the field with no number (defaults to \"{value} is not a valid number\")",
"memberOf": ""
},
+ {
+ "name": "grow",
+ "type": "Boolean",
+ "desc": "True if this field should automatically grow and shrink to its content",
+ "memberOf": "Roo.form.TextField"
+ },
+ {
+ "name": "growMin",
+ "type": "Number",
+ "desc": "The minimum width to allow when grow = true (defaults to 30)",
+ "memberOf": "Roo.form.TextField"
+ },
+ {
+ "name": "growMax",
+ "type": "Number",
+ "desc": "The maximum width to allow when grow = true (defaults to 800)",
+ "memberOf": "Roo.form.TextField"
+ },
+ {
+ "name": "vtype",
+ "type": "String",
+ "desc": "A validation type name as defined in {@link Roo.form.VTypes} (defaults to null)",
+ "memberOf": "Roo.form.TextField"
+ },
+ {
+ "name": "maskRe",
+ "type": "String",
+ "desc": "An input mask regular expression that will be used to filter keystrokes that don't match (defaults to null)",
+ "memberOf": "Roo.form.TextField"
+ },
+ {
+ "name": "disableKeyFilter",
+ "type": "Boolean",
+ "desc": "True to disable input keystroke filtering (defaults to false)",
+ "memberOf": "Roo.form.TextField"
+ },
{
"name": "allowBlank",
"type": "Boolean",
- "desc": "False to validate that the value length > 0 (defaults to false)",
- "memberOf": ""
+ "desc": "False to validate that the value length > 0 (defaults to true)",
+ "memberOf": "Roo.form.TextField"
+ },
+ {
+ "name": "minLength",
+ "type": "Number",
+ "desc": "Minimum input field length required (defaults to 0)",
+ "memberOf": "Roo.form.TextField"
+ },
+ {
+ "name": "maxLength",
+ "type": "Number",
+ "desc": "Maximum input field length allowed (defaults to Number.MAX_VALUE)",
+ "memberOf": "Roo.form.TextField"
+ },
+ {
+ "name": "minLengthText",
+ "type": "String",
+ "desc": "Error text to display if the minimum length validation fails (defaults to \"The minimum length for this field is {minLength}\")",
+ "memberOf": "Roo.form.TextField"
+ },
+ {
+ "name": "maxLengthText",
+ "type": "String",
+ "desc": "Error text to display if the maximum length validation fails (defaults to \"The maximum length for this field is {maxLength}\")",
+ "memberOf": "Roo.form.TextField"
+ },
+ {
+ "name": "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": "Error text to display if the allow blank validation fails (defaults to \"This field is required\")",
+ "memberOf": "Roo.form.TextField"
+ },
+ {
+ "name": "validator",
+ "type": "Function",
+ "desc": "A custom validation function to be called during field validation (defaults to null).\nIf available, this function will be called only after the basic validators all return true, and will be passed the\ncurrent field value and expected to return boolean true if the value is valid or a string error message if invalid.",
+ "memberOf": "Roo.form.TextField"
+ },
+ {
+ "name": "regex",
+ "type": "RegExp",
+ "desc": "A JavaScript RegExp object to be tested against the field value during validation (defaults to null).\nIf available, this regex will be evaluated only after the basic validators all return true, and will be passed the\ncurrent field value. If the test fails, the field will be marked invalid using {@link #regexText}.",
+ "memberOf": "Roo.form.TextField"
+ },
+ {
+ "name": "regexText",
+ "type": "String",
+ "desc": "The error text to display if {@link #regex} is used and the test fails during validation (defaults to \"\")",
+ "memberOf": "Roo.form.TextField"
+ },
+ {
+ "name": "emptyText",
+ "type": "String",
+ "desc": "The default text to display in an empty field - placeholder... (defaults to null).",
+ "memberOf": "Roo.form.TextField"
},
{
"name": "fieldLabel",
"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": "The default CSS class for the field (defaults to \"x-form-field\")",
- "memberOf": "Roo.form.Field"
- },
{
"name": "msgTarget",
"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",
+ "desc": "height (optional) size of component",
+ "memberOf": "Roo.BoxComponent"
+ },
{
"name": "disableClass",
"type": "String",
}
],
"events": [
+ {
+ "name": "autosize",
+ "sig": "function (_self, width)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires when the autosize function is triggered. The field may or may not have actually changed size\naccording to the default logic, but this event provides a hook for the developer to apply additional\nlogic at runtime to resize the field if needed."
+ },
{
"name": "beforedestroy",
"sig": "function (_self)\n{\n\n}",
"type": "function",
"desc": "Fires just before the field blurs if the field value has changed."
},
- {
- "name": "confirm",
- "sig": "function (combo)\n{\n\n}",
- "type": "function",
- "desc": "Fires when the 'confirm' icon is pressed (add a listener to enable add button)"
- },
{
"name": "destroy",
"sig": "function (_self)\n{\n\n}",
"type": "function",
"desc": "Fires after the component is rendered."
},
- {
- "name": "reset",
- "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": "resize",
"sig": "function (_self, adjWidth, adjHeight, rawWidth, rawHeight)\n{\n\n}",
"type": "function",
"desc": "Apply the behaviors of this component to an existing element. <b>This is used instead of render().</b>"
},
+ {
+ "name": "autoSize",
+ "sig": "()",
+ "type": "function",
+ "desc": "Automatically grows the field to accomodate the width of the text up to the maximum field width allowed.\nThis only takes effect if grow = true, and fires the autosize event."
+ },
{
"name": "capture",
"sig": "(Observable o, Function fn, Object scope)",
"type": "function",
"desc": "Clear any invalid styles/messages for this field"
},
- {
- "name": "createToolbar",
- "sig": "(HtmlEditor editor)",
- "type": "function",
- "desc": "Protected method that will not generally be called directly. It\nis called when the editor creates its toolbar. Override this method if you need to\nadd custom toolbar buttons."
- },
{
"name": "destroy",
"sig": "()",
"type": "function",
"desc": "Gets the current box measurements of the component's underlying element."
},
- {
- "name": "getConfirmed",
- "sig": "()",
- "type": "function",
- "desc": ""
- },
{
"name": "getEl",
"sig": "()",
"type": "function",
"desc": "Returns the underlying {@link Roo.Element}."
},
- {
- "name": "getHeight",
- "sig": "()",
- "type": "function",
- "desc": ""
- },
{
"name": "getId",
"sig": "()",
"type": "function",
"desc": "Returns the id of this component."
},
- {
- "name": "getImageDataURI",
- "sig": "()",
- "type": "function",
- "desc": "when user is clicked confirm then show this image....."
- },
{
"name": "getName",
"sig": "()",
"desc": "Returns the normalized data value (undefined or emptyText will be returned as ''). To return the raw value see {@link #getRawValue}."
},
{
- "name": "getWidth",
+ "name": "hasChanged",
"sig": "()",
"type": "function",
- "desc": ""
+ "desc": "checks the current value against the 'loaded' value.\nNote - will return false if 'resetHasChanged' has not been called first."
},
{
"name": "hasListener",
"name": "isDirty",
"sig": "()",
"type": "function",
- "desc": "Returns true if this field has been changed since it was originally loaded and is not disabled."
+ "desc": "Returns true if this field has been changed since it was originally loaded and is not disabled.\nDEPRICATED - it never worked well - use hasChanged/resetHasChanged."
},
{
"name": "isValid",
"name": "reset",
"sig": "()",
"type": "function",
- "desc": "Resets the current field value to the originally loaded value and clears any validation messages"
+ "desc": "Resets the current field value to the originally-loaded value and clears any validation messages."
+ },
+ {
+ "name": "resetHasChanged",
+ "sig": "()",
+ "type": "function",
+ "desc": "stores the current value in loadedValue"
+ },
+ {
+ "name": "selectText",
+ "sig": "(Number start, Number end)",
+ "type": "function",
+ "desc": "Selects text in this field"
},
{
"name": "setDisabled",
"sig": "()",
"type": "function",
"desc": "Validates the field value"
+ },
+ {
+ "name": "validateValue",
+ "sig": "(Mixed value)",
+ "type": "function",
+ "desc": "Validates a value according to the field's validation rules and marks the field as invalid\nif the validation fails"
}
]
},
- "Roo.form.TextArea": {
+ "Roo.form.Radio": {
"props": [
{
- "name": "growMin",
- "type": "Number",
- "desc": "The minimum height to allow when grow = true (defaults to 60)",
- "memberOf": ""
- },
- {
- "name": "growMax",
- "type": "Number",
- "desc": "The maximum height to allow when grow = true (defaults to 1000)",
- "memberOf": ""
- },
- {
- "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": ""
- },
- {
- "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": ""
- },
- {
- "name": "grow",
- "type": "Boolean",
- "desc": "True if this field should automatically grow and shrink to its content",
- "memberOf": "Roo.form.TextField"
- },
- {
- "name": "vtype",
+ "name": "focusClass",
"type": "String",
- "desc": "A validation type name as defined in {@link Roo.form.VTypes} (defaults to null)",
- "memberOf": "Roo.form.TextField"
+ "desc": "The CSS class to use when the checkbox receives focus (defaults to undefined)",
+ "memberOf": "Roo.form.Checkbox"
},
{
- "name": "maskRe",
+ "name": "fieldClass",
"type": "String",
- "desc": "An input mask regular expression that will be used to filter keystrokes that don't match (defaults to null)",
- "memberOf": "Roo.form.TextField"
- },
- {
- "name": "disableKeyFilter",
- "type": "Boolean",
- "desc": "True to disable input keystroke filtering (defaults to false)",
- "memberOf": "Roo.form.TextField"
+ "desc": "The default CSS class for the checkbox (defaults to \"x-form-field\")",
+ "memberOf": "Roo.form.Checkbox"
},
{
- "name": "allowBlank",
+ "name": "checked",
"type": "Boolean",
- "desc": "False to validate that the value length > 0 (defaults to true)",
- "memberOf": "Roo.form.TextField"
- },
- {
- "name": "minLength",
- "type": "Number",
- "desc": "Minimum input field length required (defaults to 0)",
- "memberOf": "Roo.form.TextField"
- },
- {
- "name": "maxLength",
- "type": "Number",
- "desc": "Maximum input field length allowed (defaults to Number.MAX_VALUE)",
- "memberOf": "Roo.form.TextField"
- },
- {
- "name": "minLengthText",
- "type": "String",
- "desc": "Error text to display if the minimum length validation fails (defaults to \"The minimum length for this field is {minLength}\")",
- "memberOf": "Roo.form.TextField"
- },
- {
- "name": "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"
+ "desc": "True if the the checkbox should render already checked (defaults to false)",
+ "memberOf": "Roo.form.Checkbox"
},
{
- "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": "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"
},
{
- "name": "blankText",
+ "name": "boxLabel",
"type": "String",
- "desc": "Error text to display if the allow blank validation fails (defaults to \"This field is required\")",
- "memberOf": "Roo.form.TextField"
- },
- {
- "name": "validator",
- "type": "Function",
- "desc": "A custom validation function to be called during field validation (defaults to null).\nIf available, this function will be called only after the basic validators all return true, and will be passed the\ncurrent field value and expected to return boolean true if the value is valid or a string error message if invalid.",
- "memberOf": "Roo.form.TextField"
- },
- {
- "name": "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"
+ "desc": "The text that appears beside the checkbox",
+ "memberOf": "Roo.form.Checkbox"
},
{
- "name": "regexText",
+ "name": "inputValue",
"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"
+ "desc": "The value that should go into the generated input element's value attribute",
+ "memberOf": "Roo.form.Checkbox"
},
{
- "name": "emptyText",
+ "name": "valueOff",
"type": "String",
- "desc": "The default text to display in an empty field - placeholder... (defaults to null).",
- "memberOf": "Roo.form.TextField"
+ "desc": "The value that should go into the generated input element's value when unchecked.",
+ "memberOf": "Roo.form.Checkbox"
},
{
"name": "fieldLabel",
"desc": "The error text to use when marking a field invalid and no message is provided (defaults to \"The value in this field is invalid\")",
"memberOf": "Roo.form.Field"
},
- {
- "name": "focusClass",
- "type": "String",
- "desc": "The CSS class to use when the field receives focus (defaults to \"x-form-focus\")",
- "memberOf": "Roo.form.Field"
- },
{
"name": "validationEvent",
"type": "String/Boolean",
"desc": "The length of time in milliseconds after user input begins until validation is initiated (defaults to 250)",
"memberOf": "Roo.form.Field"
},
- {
- "name": "fieldClass",
- "type": "String",
- "desc": "The default CSS class for the field (defaults to \"x-form-field\")",
- "memberOf": "Roo.form.Field"
- },
{
"name": "msgTarget",
"type": "String",
}
],
"events": [
- {
- "name": "autosize",
- "sig": "function (_self, width)\n{\n\n}",
- "type": "function",
- "desc": "Fires when the autosize function is triggered. The field may or may not have actually changed size\naccording to the default logic, but this event provides a hook for the developer to apply additional\nlogic at runtime to resize the field if needed."
- },
{
"name": "beforedestroy",
"sig": "function (_self)\n{\n\n}",
"type": "function",
"desc": "Fires just before the field blurs if the field value has changed."
},
+ {
+ "name": "check",
+ "sig": "function (_self, checked)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires when the checkbox is checked or unchecked."
+ },
{
"name": "destroy",
"sig": "function (_self)\n{\n\n}",
"type": "function",
"desc": "Apply the behaviors of this component to an existing element. <b>This is used instead of render().</b>"
},
- {
- "name": "autoSize",
- "sig": "()",
- "type": "function",
- "desc": "Automatically grows the field to accomodate the height of the text up to the maximum field height allowed.\nThis only takes effect if grow = true, and fires the autosize event if the height changes."
- },
{
"name": "capture",
"sig": "(Observable o, Function fn, Object scope)",
"type": "function",
"desc": "Returns the underlying {@link Roo.Element}."
},
+ {
+ "name": "getGroupValue",
+ "sig": "()",
+ "type": "function",
+ "desc": "If this radio is part of a group, it will return the selected value"
+ },
{
"name": "getId",
"sig": "()",
"name": "getValue",
"sig": "()",
"type": "function",
- "desc": "Returns the normalized data value (undefined or emptyText will be returned as ''). To return the raw value see {@link #getRawValue}."
+ "desc": "Returns the checked state of the checkbox."
+ },
+ {
+ "name": "hasChanged",
+ "sig": "()",
+ "type": "function",
+ "desc": "checks the current value against the 'loaded' value.\nNote - will return false if 'resetHasChanged' has not been called first."
},
{
"name": "hasListener",
"name": "isDirty",
"sig": "()",
"type": "function",
- "desc": "Returns true if this field has been changed since it was originally loaded and is not disabled."
+ "desc": "Returns true if this field has been changed since it was originally loaded and is not disabled.\nDEPRICATED - it never worked well - use hasChanged/resetHasChanged."
},
{
"name": "isValid",
"name": "reset",
"sig": "()",
"type": "function",
- "desc": "Resets the current field value to the originally-loaded value and clears any validation messages."
+ "desc": "Resets the current field value to the originally loaded value and clears any validation messages"
},
{
- "name": "selectText",
- "sig": "(Number start, Number end)",
+ "name": "resetHasChanged",
+ "sig": "()",
"type": "function",
- "desc": "Selects text in this field"
+ "desc": "stores the current value in loadedValue"
},
{
"name": "setDisabled",
},
{
"name": "setValue",
- "sig": "(Mixed value)",
+ "sig": "(Boolean/String value, Boolean/String suppressEvent)",
"type": "function",
- "desc": "Sets a data value into the field and validates it. To set the value directly without validation see {@link #setRawValue}."
+ "desc": "Sets the checked state of the checkbox.\nOn is always based on a string comparison between inputValue and the param."
},
{
"name": "setVisible",
"sig": "()",
"type": "function",
"desc": "Validates the field value"
- },
- {
- "name": "validateValue",
- "sig": "(Mixed value)",
- "type": "function",
- "desc": "Validates a value according to the field's validation rules and marks the field as invalid\nif the validation fails"
}
]
},
- "Roo.form.TextField": {
+ "Roo.form.Row": {
"props": [
{
- "name": "grow",
- "type": "Boolean",
- "desc": "True if this field should automatically grow and shrink to its content",
- "memberOf": ""
- },
- {
- "name": "growMin",
- "type": "Number",
- "desc": "The minimum width to allow when grow = true (defaults to 30)",
- "memberOf": ""
- },
- {
- "name": "growMax",
- "type": "Number",
- "desc": "The maximum width to allow when grow = true (defaults to 800)",
- "memberOf": ""
- },
- {
- "name": "vtype",
- "type": "String",
- "desc": "A validation type name as defined in {@link Roo.form.VTypes} (defaults to null)",
- "memberOf": ""
- },
- {
- "name": "maskRe",
- "type": "String",
- "desc": "An input mask regular expression that will be used to filter keystrokes that don't match (defaults to null)",
- "memberOf": ""
- },
- {
- "name": "disableKeyFilter",
- "type": "Boolean",
- "desc": "True to disable input keystroke filtering (defaults to false)",
- "memberOf": ""
- },
- {
- "name": "allowBlank",
- "type": "Boolean",
- "desc": "False to validate that the value length > 0 (defaults to true)",
- "memberOf": ""
- },
- {
- "name": "minLength",
- "type": "Number",
- "desc": "Minimum input field length required (defaults to 0)",
- "memberOf": ""
- },
- {
- "name": "maxLength",
- "type": "Number",
- "desc": "Maximum input field length allowed (defaults to Number.MAX_VALUE)",
- "memberOf": ""
- },
- {
- "name": "minLengthText",
- "type": "String",
- "desc": "Error text to display if the minimum length validation fails (defaults to \"The minimum length for this field is {minLength}\")",
- "memberOf": ""
- },
- {
- "name": "maxLengthText",
- "type": "String",
- "desc": "Error text to display if the maximum length validation fails (defaults to \"The maximum length for this field is {maxLength}\")",
- "memberOf": ""
- },
- {
- "name": "selectOnFocus",
- "type": "Boolean",
- "desc": "True to automatically select any existing field text when the field receives input focus (defaults to false)",
- "memberOf": ""
- },
- {
- "name": "blankText",
- "type": "String",
- "desc": "Error text to display if the allow blank validation fails (defaults to \"This field is required\")",
- "memberOf": ""
- },
- {
- "name": "validator",
- "type": "Function",
- "desc": "A custom validation function to be called during field validation (defaults to null).\nIf available, this function will be called only after the basic validators all return true, and will be passed the\ncurrent field value and expected to return boolean true if the value is valid or a string error message if invalid.",
- "memberOf": ""
- },
- {
- "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": ""
- },
- {
- "name": "regexText",
- "type": "String",
- "desc": "The error text to display if {@link #regex} is used and the test fails during validation (defaults to \"\")",
+ "name": "width",
+ "type": "Number/String",
+ "desc": "The fixed width of the column in pixels or CSS value (defaults to \"auto\")",
"memberOf": ""
},
{
- "name": "emptyText",
- "type": "String",
- "desc": "The default text to display in an empty field - placeholder... (defaults to null).",
+ "name": "height",
+ "type": "Number/String",
+ "desc": "The fixed height of the column in pixels or CSS value (defaults to \"auto\")",
"memberOf": ""
},
- {
- "name": "fieldLabel",
- "type": "String",
- "desc": "Label to use when rendering a form.",
- "memberOf": "Roo.form.Field"
- },
- {
- "name": "qtip",
- "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 CSS class to use when marking a field invalid (defaults to \"x-form-invalid\")",
- "memberOf": "Roo.form.Field"
- },
- {
- "name": "invalidText",
- "type": "String",
- "desc": "The error text to use when marking a field invalid and no message is provided (defaults to \"The value in this field is invalid\")",
- "memberOf": "Roo.form.Field"
- },
- {
- "name": "focusClass",
- "type": "String",
- "desc": "The CSS class to use when the field receives focus (defaults to \"x-form-focus\")",
- "memberOf": "Roo.form.Field"
- },
- {
- "name": "validationEvent",
- "type": "String/Boolean",
- "desc": "The event that should initiate field validation. Set to false to disable\n automatic validation (defaults to \"keyup\").",
- "memberOf": "Roo.form.Field"
- },
- {
- "name": "validateOnBlur",
- "type": "Boolean",
- "desc": "Whether the field should validate when it loses focus (defaults to true).",
- "memberOf": "Roo.form.Field"
- },
- {
- "name": "validationDelay",
- "type": "Number",
- "desc": "The length of time in milliseconds after user input begins until validation is initiated (defaults to 250)",
- "memberOf": "Roo.form.Field"
- },
{
"name": "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": "The default CSS class for the field (defaults to \"x-form-field\")",
- "memberOf": "Roo.form.Field"
- },
- {
- "name": "msgTarget",
- "type": "String",
- "desc": "The location where error text should display. Should be one of the following values (defaults to 'qtip'):\n<pre>\nValue Description\n----------- ----------------------------------------------------------------------\nqtip Display a quick tip when the user hovers over the field\ntitle Display a default browser title attribute popup\nunder Add a block div beneath the field containing the error text\nside Add an error icon to the right of the field with a popup on hover\n[element id] Add the error text directly to the innerHTML of the specified element\n</pre>",
- "memberOf": "Roo.form.Field"
- },
- {
- "name": "msgFx",
- "type": "String",
- "desc": "<b>Experimental</b> The effect used when displaying a validation message under the field (defaults to 'normal').",
- "memberOf": "Roo.form.Field"
- },
- {
- "name": "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"
+ "desc": "A DomHelper element spec used to autocreate the layout (defaults to {tag: 'div', cls: 'x-form-ct'})",
+ "memberOf": "Roo.form.Layout"
},
{
- "name": "disabled",
- "type": "Boolean",
- "desc": "True to disable the field (defaults to false).",
- "memberOf": "Roo.form.Field"
+ "name": "style",
+ "type": "String/Object/Function",
+ "desc": "A style specification string, e.g. \"width:100px\", or object in the form {width:\"100px\"}, or\na function which returns such a specification.",
+ "memberOf": "Roo.form.Layout"
},
{
- "name": "inputType",
+ "name": "labelAlign",
"type": "String",
- "desc": "The type attribute for input fields -- e.g. radio, text, password (defaults to \"text\").",
- "memberOf": "Roo.form.Field"
+ "desc": "Valid values are \"left,\" \"top\" and \"right\" (defaults to \"left\")",
+ "memberOf": "Roo.form.Layout"
},
{
- "name": "tabIndex",
+ "name": "labelWidth",
"type": "Number",
- "desc": "The tabIndex for this field. Note this only applies to fields that are rendered, not those which are built via applyTo (defaults to undefined).",
- "memberOf": "Roo.form.Field"
+ "desc": "Fixed width in pixels of all field labels (defaults to undefined)",
+ "memberOf": "Roo.form.Layout"
},
{
- "name": "value",
- "type": "Mixed",
- "desc": "A value to initialize this field with.",
- "memberOf": "Roo.form.Field"
+ "name": "clear",
+ "type": "Boolean",
+ "desc": "True to add a clearing element at the end of this layout, equivalent to CSS clear: both (defaults to true)",
+ "memberOf": "Roo.form.Layout"
},
{
- "name": "cls",
+ "name": "labelSeparator",
"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"
+ "desc": "The separator to use after field labels (defaults to ':')",
+ "memberOf": "Roo.form.Layout"
},
{
- "name": "height",
- "type": "Number",
- "desc": "height (optional) size of component",
- "memberOf": "Roo.BoxComponent"
+ "name": "hideLabels",
+ "type": "Boolean",
+ "desc": "True to suppress the display of field labels in this layout (defaults to false)",
+ "memberOf": "Roo.form.Layout"
},
{
"name": "disableClass",
}
],
"events": [
- {
- "name": "autosize",
- "sig": "function (_self, width)\n{\n\n}",
- "type": "function",
- "desc": "Fires when the autosize function is triggered. The field may or may not have actually changed size\naccording to the default logic, but this event provides a hook for the developer to apply additional\nlogic at runtime to resize the field if needed."
- },
{
"name": "beforedestroy",
"sig": "function (_self)\n{\n\n}",
"type": "function",
"desc": "Fires before the component is shown. Return false to stop the show."
},
- {
- "name": "blur",
- "sig": "function (_self)\n{\n\n}",
- "type": "function",
- "desc": "Fires when this field loses input focus."
- },
- {
- "name": "change",
- "sig": "function (_self, newValue, oldValue)\n{\n\n}",
- "type": "function",
- "desc": "Fires just before the field blurs if the field value has changed."
- },
{
"name": "destroy",
"sig": "function (_self)\n{\n\n}",
"type": "function",
"desc": "Fires after the component is enabled."
},
- {
- "name": "focus",
- "sig": "function (_self)\n{\n\n}",
- "type": "function",
- "desc": "Fires when this field receives input focus."
- },
{
"name": "hide",
"sig": "function (_self)\n{\n\n}",
"type": "function",
"desc": "Fires after the component is hidden."
},
- {
- "name": "invalid",
- "sig": "function (_self, msg)\n{\n\n}",
- "type": "function",
- "desc": "Fires after the field has been marked as invalid."
- },
- {
- "name": "keyup",
- "sig": "function (_self, e)\n{\n\n}",
- "type": "function",
- "desc": "Fires after the key up"
- },
- {
- "name": "move",
- "sig": "function (_self, x, y)\n{\n\n}",
- "type": "function",
- "desc": "Fires after the component is moved."
- },
{
"name": "render",
"sig": "function (_self)\n{\n\n}",
"type": "function",
"desc": "Fires after the component is rendered."
},
- {
- "name": "resize",
- "sig": "function (_self, adjWidth, adjHeight, rawWidth, rawHeight)\n{\n\n}",
- "type": "function",
- "desc": "Fires after the component is resized."
- },
{
"name": "show",
"sig": "function (_self)\n{\n\n}",
"type": "function",
"desc": "Fires after the component is shown."
- },
- {
- "name": "specialkey",
- "sig": "function (_self, e)\n{\n\n}",
- "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."
- },
- {
- "name": "valid",
- "sig": "function (_self)\n{\n\n}",
- "type": "function",
- "desc": "Fires after the field has been validated with no errors."
}
],
"methods": [
"desc": "Appends an event handler to this component"
},
{
- "name": "applyTo",
- "sig": "(String/HTMLElement/Element el)",
- "type": "function",
- "desc": "Apply the behaviors of this component to an existing element. <b>This is used instead of render().</b>"
- },
- {
- "name": "autoSize",
- "sig": "()",
+ "name": "addxtype",
+ "sig": "(Object config)",
"type": "function",
- "desc": "Automatically grows the field to accomodate the width of the text up to the maximum field width allowed.\nThis only takes effect if grow = true, and fires the autosize event."
+ "desc": "Adds a object form elements (using the xtype property as the factory method.)\nValid xtypes are: TextField, TextArea .... Button, Layout, FieldSet, Column"
},
{
"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."
},
- {
- "name": "clearInvalid",
- "sig": "()",
- "type": "function",
- "desc": "Clear any invalid styles/messages for this field"
- },
{
"name": "destroy",
"sig": "()",
"type": "function",
"desc": "Try to focus this component."
},
- {
- "name": "getBox",
- "sig": "(Boolean local)",
- "type": "function",
- "desc": "Gets the current box measurements of the component's underlying element."
- },
{
"name": "getEl",
"sig": "()",
"type": "function",
"desc": "Returns the id of this component."
},
- {
- "name": "getName",
- "sig": "()",
- "type": "function",
- "desc": "Returns the name attribute of the field if available"
- },
- {
- "name": "getPosition",
- "sig": "(Boolean local)",
- "type": "function",
- "desc": "Gets the current XY position of the component's underlying element."
- },
- {
- "name": "getRawValue",
- "sig": "()",
- "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}."
- },
- {
- "name": "getSize",
- "sig": "()",
- "type": "function",
- "desc": "Gets the current size of the component's underlying element."
- },
- {
- "name": "getValue",
- "sig": "()",
- "type": "function",
- "desc": "Returns the normalized data value (undefined or emptyText will be returned as ''). To return the raw value see {@link #getRawValue}."
- },
{
"name": "hasListener",
"sig": "(String eventName)",
"type": "function",
"desc": "Hide this component."
},
- {
- "name": "isDirty",
- "sig": "()",
- "type": "function",
- "desc": "Returns true if this field has been changed since it was originally loaded and is not disabled."
- },
- {
- "name": "isValid",
- "sig": "(Boolean preventMark)",
- "type": "function",
- "desc": "Returns whether or not the field value is currently valid"
- },
{
"name": "isVisible",
"sig": "()",
"type": "function",
"desc": "Returns true if this component is visible."
},
- {
- "name": "markInvalid",
- "sig": "(String msg)",
- "type": "function",
- "desc": "Mark this field as invalid"
- },
{
"name": "on",
"sig": "(String eventName, Function handler, Object scope, Object options)",
"type": "function",
"desc": "Appends an event handler to this element (shorthand for addListener)"
},
- {
- "name": "onPosition",
- "sig": "(Number x, Number y)",
- "type": "function",
- "desc": "Called after the component is moved, this method is empty by default but can be implemented by any\nsubclass that needs to perform custom logic after a move occurs."
- },
- {
- "name": "onResize",
- "sig": "(Number adjWidth, Number adjHeight, Number rawWidth, Number rawHeight)",
- "type": "function",
- "desc": "Called after the component is resized, this method is empty by default but can be implemented by any\nsubclass that needs to perform custom logic after a resize occurs."
- },
{
"name": "purgeListeners",
"sig": "()",
"desc": "If this is a lazy rendering component, render it to its container element."
},
{
- "name": "reset",
- "sig": "()",
+ "name": "setDisabled",
+ "sig": "(Boolean disabled)",
"type": "function",
- "desc": "Resets the current field value to the originally-loaded value and clears any validation messages."
+ "desc": "Convenience function for setting disabled/enabled by boolean."
},
{
- "name": "selectText",
- "sig": "(Number start, Number end)",
+ "name": "setVisible",
+ "sig": "(Boolean visible)",
"type": "function",
- "desc": "Selects text in this field"
+ "desc": "Convenience function to hide or show this component by boolean."
},
{
- "name": "setDisabled",
- "sig": "(Boolean disabled)",
+ "name": "show",
+ "sig": "()",
"type": "function",
- "desc": "Convenience function for setting disabled/enabled by boolean."
+ "desc": "Show this component."
},
{
- "name": "setPagePosition",
- "sig": "(Number x, Number y)",
+ "name": "un",
+ "sig": "(String eventName, Function handler, Object scope)",
"type": "function",
- "desc": "Sets the page XY position of the component. To set the left and top instead, use {@link #setPosition}.\nThis method fires the move event."
+ "desc": "Removes a listener (shorthand for removeListener)"
+ }
+ ]
+ },
+ "Roo.form.Select": {
+ "props": [
+ {
+ "name": "transform",
+ "type": "String/HTMLElement/Element",
+ "desc": "The id, DOM node or element of an existing select to convert to a ComboBox",
+ "memberOf": ""
},
{
- "name": "setPosition",
- "sig": "(Number left, Number top)",
- "type": "function",
- "desc": "Sets the left and top of the component. To set the page XY position instead, use {@link #setPagePosition}.\nThis method fires the move event."
+ "name": "lazyRender",
+ "type": "Boolean",
+ "desc": "True to prevent the ComboBox from rendering until requested (should always be used when\nrendering into an Roo.Editor, defaults to false)",
+ "memberOf": ""
},
{
- "name": "setRawValue",
- "sig": "(Mixed value)",
- "type": "function",
- "desc": "Sets the underlying DOM field's value directly, bypassing validation. To set the value with validation see {@link #setValue}."
+ "name": "autoCreate",
+ "type": "Boolean/Object",
+ "desc": "A DomHelper element spec, or true for a default element spec (defaults to:\n{tag: \"input\", type: \"text\", size: \"24\", autocomplete: \"off\"})",
+ "memberOf": ""
},
{
- "name": "setSize",
- "sig": "(Number/Object width, Number height)",
- "type": "function",
- "desc": "Sets the width and height of the component. This method fires the resize event. This method can accept\neither width and height as separate numeric arguments, or you can pass a size object like {width:10, height:20}."
+ "name": "store",
+ "type": "Roo.data.Store",
+ "desc": "The data store to which this combo is bound (defaults to undefined)",
+ "memberOf": ""
},
{
- "name": "setValue",
- "sig": "(Mixed value)",
- "type": "function",
- "desc": "Sets a data value into the field and validates it. To set the value directly without validation see {@link #setRawValue}."
+ "name": "title",
+ "type": "String",
+ "desc": "If supplied, a header element is created containing this text and added into the top of\nthe dropdown list (defaults to undefined, with no header element)",
+ "memberOf": ""
},
{
- "name": "setVisible",
- "sig": "(Boolean visible)",
- "type": "function",
- "desc": "Convenience function to hide or show this component by boolean."
+ "name": "grow",
+ "type": "Boolean",
+ "desc": "",
+ "memberOf": ""
},
{
- "name": "show",
- "sig": "()",
- "type": "function",
- "desc": "Show this component."
+ "name": "growMin",
+ "type": "Number",
+ "desc": "",
+ "memberOf": ""
},
{
- "name": "syncSize",
- "sig": "()",
- "type": "function",
- "desc": "Force the component's size to recalculate based on the underlying element's current height and width."
+ "name": "growMax",
+ "type": "Number",
+ "desc": "",
+ "memberOf": ""
},
{
- "name": "un",
- "sig": "(String eventName, Function handler, Object scope)",
- "type": "function",
- "desc": "Removes a listener (shorthand for removeListener)"
+ "name": "tpl",
+ "type": "String/Roo.Template",
+ "desc": "The template to use to render the output",
+ "memberOf": ""
},
{
- "name": "updateBox",
- "sig": "(Object box)",
- "type": "function",
- "desc": "Sets the current box measurements of the component's underlying element."
+ "name": "listWidth",
+ "type": "Number",
+ "desc": "The width in pixels of the dropdown list (defaults to the width of the ComboBox field)",
+ "memberOf": ""
},
{
- "name": "validate",
- "sig": "()",
- "type": "function",
- "desc": "Validates the field value"
+ "name": "displayField",
+ "type": "String",
+ "desc": "The underlying data field name to bind to this CombBox (defaults to undefined if\nmode = 'remote' or 'text' if mode = 'local')",
+ "memberOf": ""
},
{
- "name": "validateValue",
- "sig": "(Mixed value)",
- "type": "function",
- "desc": "Validates a value according to the field's validation rules and marks the field as invalid\nif the validation fails"
- }
- ]
- },
- "Roo.form.TriggerField": {
- "props": [
+ "name": "valueField",
+ "type": "String",
+ "desc": "The underlying data value name to bind to this CombBox (defaults to undefined if\nmode = 'remote' or 'value' if mode = 'local'). \nNote: use of a valueField requires the user make a selection\nin order for a value to be mapped.",
+ "memberOf": ""
+ },
+ {
+ "name": "hiddenName",
+ "type": "String",
+ "desc": "If specified, a hidden form field with this name is dynamically generated to store the\nfield's data value (defaults to the underlying DOM element's name)",
+ "memberOf": ""
+ },
+ {
+ "name": "listClass",
+ "type": "String",
+ "desc": "CSS class to apply to the dropdown list element (defaults to '')",
+ "memberOf": ""
+ },
+ {
+ "name": "selectedClass",
+ "type": "String",
+ "desc": "CSS class to apply to the selected item in the dropdown list (defaults to 'x-combo-selected')",
+ "memberOf": ""
+ },
{
"name": "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.",
+ "desc": "An additional CSS class used to style the trigger button. The trigger will always get the\nclass 'x-form-trigger' and triggerClass will be <b>appended</b> if specified (defaults to 'x-form-arrow-trigger'\nwhich displays a downward arrow icon).",
"memberOf": ""
},
{
- "name": "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\"})",
+ "name": "shadow",
+ "type": "Boolean/String",
+ "desc": "True or \"sides\" for the default effect, \"frame\" for 4-way shadow, and \"drop\" for bottom-right",
+ "memberOf": ""
+ },
+ {
+ "name": "listAlign",
+ "type": "String",
+ "desc": "A valid anchor position value. See {@link Roo.Element#alignTo} for details on supported\nanchor positions (defaults to 'tl-bl')",
+ "memberOf": ""
+ },
+ {
+ "name": "maxHeight",
+ "type": "Number",
+ "desc": "The maximum height in pixels of the dropdown list before scrollbars are shown (defaults to 300)",
+ "memberOf": ""
+ },
+ {
+ "name": "triggerAction",
+ "type": "String",
+ "desc": "The action to execute when the trigger field is activated. Use 'all' to run the\nquery specified by the allQuery config option (defaults to 'query')",
+ "memberOf": ""
+ },
+ {
+ "name": "minChars",
+ "type": "Number",
+ "desc": "The minimum number of characters the user must type before autocomplete and typeahead activate\n(defaults to 4, does not apply if editable = false)",
+ "memberOf": ""
+ },
+ {
+ "name": "typeAhead",
+ "type": "Boolean",
+ "desc": "True to populate and autoselect the remainder of the text being typed after a configurable\ndelay (typeAheadDelay) if it matches a known value (defaults to false)",
+ "memberOf": ""
+ },
+ {
+ "name": "queryDelay",
+ "type": "Number",
+ "desc": "The length of time in milliseconds to delay between the start of typing and sending the\nquery to filter the dropdown list (defaults to 500 if mode = 'remote' or 10 if mode = 'local')",
+ "memberOf": ""
+ },
+ {
+ "name": "pageSize",
+ "type": "Number",
+ "desc": "If greater than 0, a paging toolbar is displayed in the footer of the dropdown list and the\nfilter queries will execute with page start and limit parameters. Only applies when mode = 'remote' (defaults to 0)",
+ "memberOf": ""
+ },
+ {
+ "name": "selectOnFocus",
+ "type": "Boolean",
+ "desc": "True to select any existing text in the field immediately on focus. Only applies\nwhen editable = true (defaults to false)",
+ "memberOf": ""
+ },
+ {
+ "name": "queryParam",
+ "type": "String",
+ "desc": "Name of the query as it will be passed on the querystring (defaults to 'query')",
+ "memberOf": ""
+ },
+ {
+ "name": "loadingText",
+ "type": "String",
+ "desc": "The text to display in the dropdown list while data is loading. Only applies\nwhen mode = 'remote' (defaults to 'Loading...')",
+ "memberOf": ""
+ },
+ {
+ "name": "resizable",
+ "type": "Boolean",
+ "desc": "True to add a resize handle to the bottom of the dropdown list (defaults to false)",
+ "memberOf": ""
+ },
+ {
+ "name": "handleHeight",
+ "type": "Number",
+ "desc": "The height in pixels of the dropdown list resize handle if resizable = true (defaults to 8)",
+ "memberOf": ""
+ },
+ {
+ "name": "editable",
+ "type": "Boolean",
+ "desc": "False to prevent the user from typing text directly into the field, just like a\ntraditional select (defaults to true)",
+ "memberOf": ""
+ },
+ {
+ "name": "allQuery",
+ "type": "String",
+ "desc": "The text query to send to the server to return all records for the list with no filtering (defaults to '')",
+ "memberOf": ""
+ },
+ {
+ "name": "mode",
+ "type": "String",
+ "desc": "Set to 'local' if the ComboBox loads local data (defaults to 'remote' which loads from the server)",
+ "memberOf": ""
+ },
+ {
+ "name": "minListWidth",
+ "type": "Number",
+ "desc": "The minimum width of the dropdown list in pixels (defaults to 70, will be ignored if\nlistWidth has a higher value)",
+ "memberOf": ""
+ },
+ {
+ "name": "forceSelection",
+ "type": "Boolean",
+ "desc": "True to restrict the selected value to one of the values in the list, false to\nallow the user to set arbitrary text into the field (defaults to false)",
+ "memberOf": ""
+ },
+ {
+ "name": "typeAheadDelay",
+ "type": "Number",
+ "desc": "The length of time in milliseconds to wait until the typeahead text is displayed\nif typeAhead = true (defaults to 250)",
+ "memberOf": ""
+ },
+ {
+ "name": "valueNotFoundText",
+ "type": "String",
+ "desc": "When using a name/value combo, if the value passed to setValue is not found in\nthe store, valueNotFoundText will be displayed as the field text if defined (defaults to undefined)",
+ "memberOf": ""
+ },
+ {
+ "name": "defaultValue",
+ "type": "String",
+ "desc": "The value displayed after loading the store.",
+ "memberOf": ""
+ },
+ {
+ "name": "blockFocus",
+ "type": "Boolean",
+ "desc": "Prevents all focus calls, so it can work with things like HTML edtor bar",
+ "memberOf": ""
+ },
+ {
+ "name": "disableClear",
+ "type": "Boolean",
+ "desc": "Disable showing of clear button.",
+ "memberOf": ""
+ },
+ {
+ "name": "alwaysQuery",
+ "type": "Boolean",
+ "desc": "Disable caching of results, and always send query",
"memberOf": ""
},
{
"name": "hideTrigger",
"type": "Boolean",
"desc": "True to hide the trigger element and display only the base text field (defaults to false)",
- "memberOf": ""
+ "memberOf": "Roo.form.TriggerField"
},
{
"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",
"type": "function",
"desc": "Clear any invalid styles/messages for this field"
},
+ {
+ "name": "clearValue",
+ "sig": "()",
+ "type": "function",
+ "desc": "Clears any text/value currently set in the field"
+ },
+ {
+ "name": "collapse",
+ "sig": "()",
+ "type": "function",
+ "desc": "Hides the dropdown list if it is currently expanded. Fires the 'collapse' event on completion."
+ },
{
"name": "destroy",
"sig": "()",
"type": "function",
"desc": "Disable this component."
},
+ {
+ "name": "doQuery",
+ "sig": "(String query, Boolean forceAll)",
+ "type": "function",
+ "desc": "Execute a query to filter the dropdown list. Fires the beforequery event prior to performing the\nquery allowing the query action to be canceled if needed."
+ },
{
"name": "enable",
"sig": "()",
"type": "function",
"desc": "Enable this component."
},
+ {
+ "name": "expand",
+ "sig": "()",
+ "type": "function",
+ "desc": "Expands the dropdown list if it is currently hidden. Fires the 'expand' event on completion."
+ },
{
"name": "fireEvent",
"sig": "(String eventName, Object... args)",
"name": "getValue",
"sig": "()",
"type": "function",
- "desc": "Returns the normalized data value (undefined or emptyText will be returned as ''). To return the raw value see {@link #getRawValue}."
+ "desc": "Returns the currently selected field value or empty string if no value is set."
+ },
+ {
+ "name": "hasChanged",
+ "sig": "()",
+ "type": "function",
+ "desc": "checks the current value against the 'loaded' value.\nNote - will return false if 'resetHasChanged' has not been called first."
},
{
"name": "hasListener",
"name": "isDirty",
"sig": "()",
"type": "function",
- "desc": "Returns true if this field has been changed since it was originally loaded and is not disabled."
+ "desc": "Returns true if this field has been changed since it was originally loaded and is not disabled.\nDEPRICATED - it never worked well - use hasChanged/resetHasChanged."
+ },
+ {
+ "name": "isExpanded",
+ "sig": "()",
+ "type": "function",
+ "desc": "Returns true if the dropdown list is expanded, else false."
},
{
"name": "isValid",
"type": "function",
"desc": "Resets the current field value to the originally-loaded value and clears any validation messages."
},
+ {
+ "name": "resetHasChanged",
+ "sig": "()",
+ "type": "function",
+ "desc": "stores the current value in loadedValue"
+ },
+ {
+ "name": "select",
+ "sig": "(Number index, Boolean scrollIntoView)",
+ "type": "function",
+ "desc": "Select an item in the dropdown list by its numeric index in the list. This function does NOT cause the select event to fire.\nThe store must be loaded and the list expanded for this function to work, otherwise use setValue."
+ },
+ {
+ "name": "selectByValue",
+ "sig": "(String value, Boolean scrollIntoView)",
+ "type": "function",
+ "desc": "Select an item in the dropdown list by its data value. This function does NOT cause the select event to fire.\nThe store must be loaded and the list expanded for this function to work, otherwise use setValue."
+ },
{
"name": "selectText",
"sig": "(Number start, Number end)",
"type": "function",
"desc": "Convenience function for setting disabled/enabled by boolean."
},
+ {
+ "name": "setEditable",
+ "sig": "(Boolean value)",
+ "type": "function",
+ "desc": "Allow or prevent the user from directly editing the field text. If false is passed,\nthe user will only be able to select from the items defined in the dropdown list. This method\nis the runtime equivalent of setting the 'editable' config option at config time."
+ },
+ {
+ "name": "setFromData",
+ "sig": "(Object value)",
+ "type": "function",
+ "desc": "Sets the value of the field based on a object which is related to the record format for the store."
+ },
{
"name": "setPagePosition",
"sig": "(Number x, Number y)",
},
{
"name": "setValue",
- "sig": "(Mixed value)",
+ "sig": "(String value)",
"type": "function",
- "desc": "Sets a data value into the field and validates it. To set the value directly without validation see {@link #setRawValue}."
+ "desc": "Sets the specified value into the field. If the value finds a match, the corresponding record text\nwill be displayed in the field. If the value does not match the data value of an existing item,\nand the valueNotFoundText config option is defined, it will be displayed as the default field text.\nOtherwise the field will be blank (although the value will still be set)."
},
{
"name": "setVisible",
}
]
},
- "Roo.form.VTypes": {
- "props": [],
- "events": [],
- "methods": [
+ "Roo.form.Signature": {
+ "props": [
{
- "name": "alpha",
- "sig": "(String value)",
- "type": "function",
- "desc": "The function used to validate alpha values"
+ "name": "labels",
+ "type": "Object",
+ "desc": "Label to use when rendering a form.\ndefaults to \nlabels : { \n clear : \"Clear\",\n confirm : \"Confirm\"\n }",
+ "memberOf": ""
},
{
- "name": "alphanum",
- "sig": "(String value)",
- "type": "function",
- "desc": "The function used to validate alphanumeric values"
+ "name": "width",
+ "type": "Number",
+ "desc": "The signature panel width (defaults to 300)",
+ "memberOf": ""
},
{
- "name": "email",
- "sig": "(String value)",
- "type": "function",
- "desc": "The function used to validate email addresses"
+ "name": "height",
+ "type": "Number",
+ "desc": "The signature panel height (defaults to 100)",
+ "memberOf": ""
},
{
- "name": "url",
- "sig": "(String value)",
- "type": "function",
- "desc": "The function used to validate URLs"
- }
- ]
- },
- "Roo.grid": {
- "props": [],
- "events": [],
- "methods": []
- },
- "Roo.grid.AbstractGridView": {
- "props": [],
- "events": [],
- "methods": []
- },
- "Roo.grid.AbstractSelectionModel": {
- "props": [
+ "name": "allowBlank",
+ "type": "Boolean",
+ "desc": "False to validate that the value length > 0 (defaults to false)",
+ "memberOf": ""
+ },
{
- "name": "listeners",
- "type": "Object",
- "desc": "list of events and functions to call for this object, \nFor example :\n<pre><code>\n listeners : { \n 'click' : function(e) {\n ..... \n } ,\n .... \n } \n </code></pre>",
- "memberOf": "Roo.util.Observable"
- }
- ],
- "events": [],
- "methods": [
+ "name": "fieldLabel",
+ "type": "String",
+ "desc": "Label to use when rendering a form.",
+ "memberOf": "Roo.form.Field"
+ },
{
- "name": "addEvents",
- "sig": "(Object object)",
- "type": "function",
- "desc": "Used to define events on this Observable"
+ "name": "qtip",
+ "type": "String",
+ "desc": "Mouse over tip",
+ "memberOf": "Roo.form.Field"
},
{
- "name": "addListener",
- "sig": "(String eventName, Function handler, Object scope, Object options)",
- "type": "function",
- "desc": "Appends an event handler to this component"
+ "name": "name",
+ "type": "String",
+ "desc": "The field's HTML name attribute.",
+ "memberOf": "Roo.form.Field"
},
{
- "name": "capture",
- "sig": "(Observable o, Function fn, Object scope)",
- "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."
+ "name": "invalidClass",
+ "type": "String",
+ "desc": "The CSS class to use when marking a field invalid (defaults to \"x-form-invalid\")",
+ "memberOf": "Roo.form.Field"
},
{
- "name": "fireEvent",
- "sig": "(String eventName, Object... args)",
- "type": "function",
- "desc": "Fires the specified event with the passed parameters (minus the event name)."
+ "name": "invalidText",
+ "type": "String",
+ "desc": "The error text to use when marking a field invalid and no message is provided (defaults to \"The value in this field is invalid\")",
+ "memberOf": "Roo.form.Field"
},
{
- "name": "hasListener",
- "sig": "(String eventName)",
- "type": "function",
- "desc": "Checks to see if this object has any listeners for a specified event"
+ "name": "focusClass",
+ "type": "String",
+ "desc": "The CSS class to use when the field receives focus (defaults to \"x-form-focus\")",
+ "memberOf": "Roo.form.Field"
},
{
- "name": "isLocked",
- "sig": "()",
- "type": "function",
- "desc": "Returns true if the selections are locked."
+ "name": "validationEvent",
+ "type": "String/Boolean",
+ "desc": "The event that should initiate field validation. Set to false to disable\n automatic validation (defaults to \"keyup\").",
+ "memberOf": "Roo.form.Field"
},
{
- "name": "lock",
- "sig": "()",
- "type": "function",
- "desc": "Locks the selections."
+ "name": "validateOnBlur",
+ "type": "Boolean",
+ "desc": "Whether the field should validate when it loses focus (defaults to true).",
+ "memberOf": "Roo.form.Field"
},
{
- "name": "on",
- "sig": "(String eventName, Function handler, Object scope, Object options)",
- "type": "function",
- "desc": "Appends an event handler to this element (shorthand for addListener)"
+ "name": "validationDelay",
+ "type": "Number",
+ "desc": "The length of time in milliseconds after user input begins until validation is initiated (defaults to 250)",
+ "memberOf": "Roo.form.Field"
},
{
- "name": "purgeListeners",
- "sig": "()",
- "type": "function",
- "desc": "Removes all listeners for this object"
+ "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": "releaseCapture",
- "sig": "(Observable o)",
- "type": "function",
- "desc": "Removes <b>all</b> added captures from the Observable."
+ "name": "fieldClass",
+ "type": "String",
+ "desc": "The default CSS class for the field (defaults to \"x-form-field\")",
+ "memberOf": "Roo.form.Field"
},
{
- "name": "removeListener",
- "sig": "(String eventName, Function handler, Object scope)",
- "type": "function",
- "desc": "Removes a listener"
+ "name": "msgTarget",
+ "type": "String",
+ "desc": "The location where error text should display. Should be one of the following values (defaults to 'qtip'):\n<pre>\nValue Description\n----------- ----------------------------------------------------------------------\nqtip Display a quick tip when the user hovers over the field\ntitle Display a default browser title attribute popup\nunder Add a block div beneath the field containing the error text\nside Add an error icon to the right of the field with a popup on hover\n[element id] Add the error text directly to the innerHTML of the specified element\n</pre>",
+ "memberOf": "Roo.form.Field"
},
{
- "name": "un",
- "sig": "(String eventName, Function handler, Object scope)",
- "type": "function",
- "desc": "Removes a listener (shorthand for removeListener)"
+ "name": "msgFx",
+ "type": "String",
+ "desc": "<b>Experimental</b> The effect used when displaying a validation message under the field (defaults to 'normal').",
+ "memberOf": "Roo.form.Field"
},
{
- "name": "unlock",
- "sig": "()",
- "type": "function",
- "desc": "Unlocks the selections."
- }
- ]
- },
- "Roo.grid.Calendar": {
- "props": [
+ "name": "readOnly",
+ "type": "Boolean",
+ "desc": "True to mark the field as readOnly in HTML (defaults to false) -- Note: this only sets the element's readOnly DOM attribute.",
+ "memberOf": "Roo.form.Field"
+ },
{
- "name": "eventStore",
- "type": "Store",
- "desc": "The store that loads events.",
- "memberOf": ""
+ "name": "disabled",
+ "type": "Boolean",
+ "desc": "True to disable the field (defaults to false).",
+ "memberOf": "Roo.form.Field"
+ },
+ {
+ "name": "inputType",
+ "type": "String",
+ "desc": "The type attribute for input fields -- e.g. radio, text, password (defaults to \"text\").",
+ "memberOf": "Roo.form.Field"
+ },
+ {
+ "name": "tabIndex",
+ "type": "Number",
+ "desc": "The tabIndex for this field. Note this only applies to fields that are rendered, not those which are built via applyTo (defaults to undefined).",
+ "memberOf": "Roo.form.Field"
+ },
+ {
+ "name": "value",
+ "type": "Mixed",
+ "desc": "A value to initialize this field with.",
+ "memberOf": "Roo.form.Field"
+ },
+ {
+ "name": "cls",
+ "type": "String",
+ "desc": "A CSS class to apply to the field's underlying element.",
+ "memberOf": "Roo.form.Field"
+ },
+ {
+ "name": "disableClass",
+ "type": "String",
+ "desc": "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").",
+ "memberOf": "Roo.Component"
+ },
+ {
+ "name": "allowDomMove",
+ "type": "Boolean",
+ "desc": "Whether the component can move the Dom node when rendering (defaults to true).",
+ "memberOf": "Roo.Component"
+ },
+ {
+ "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\".",
+ "memberOf": "Roo.Component",
+ "optvals": [
+ "display",
+ "visibility"
+ ]
+ },
+ {
+ "name": "actionMode",
+ "type": "String",
+ "desc": "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el'",
+ "memberOf": "Roo.Component"
+ },
+ {
+ "name": "listeners",
+ "type": "Object",
+ "desc": "list of events and functions to call for 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": "bodyscroll",
- "sig": "function (scrollLeft, scrollTop)\n{\n\n}",
+ "name": "beforedestroy",
+ "sig": "function (_self)\n{\n\n}",
"type": "function",
- "desc": "Fires when the body element is scrolled"
+ "desc": "Fires before the component is destroyed. Return false to stop the destroy."
},
{
- "name": "cellclick",
- "sig": "function (_self, rowIndex, columnIndex, e)\n{\n\n}",
+ "name": "beforehide",
+ "sig": "function (_self)\n{\n\n}",
"type": "function",
- "desc": "Fires when a cell is clicked"
+ "desc": "Fires before the component is hidden. Return false to stop the hide."
},
{
- "name": "cellcontextmenu",
- "sig": "function (_self, rowIndex, cellIndex, e)\n{\n\n}",
+ "name": "beforerender",
+ "sig": "function (_self)\n{\n\n}",
"type": "function",
- "desc": "Fires when a cell is right clicked"
+ "desc": "Fires before the component is rendered. Return false to stop the render."
},
{
- "name": "celldblclick",
- "sig": "function (_self, rowIndex, columnIndex, e)\n{\n\n}",
+ "name": "beforeshow",
+ "sig": "function (_self)\n{\n\n}",
"type": "function",
- "desc": "Fires when a cell is double clicked"
+ "desc": "Fires before the component is shown. Return false to stop the show."
},
{
- "name": "click",
- "sig": "function (e)\n{\n\n}",
+ "name": "blur",
+ "sig": "function (_self)\n{\n\n}",
"type": "function",
- "desc": "The raw click event for the entire grid."
+ "desc": "Fires when this field loses input focus."
},
{
- "name": "columnmove",
- "sig": "function (oldIndex, newIndex)\n{\n\n}",
+ "name": "change",
+ "sig": "function (_self, newValue, oldValue)\n{\n\n}",
"type": "function",
- "desc": "Fires when the user moves a column"
+ "desc": "Fires just before the field blurs if the field value has changed."
},
{
- "name": "columnresize",
- "sig": "function (columnIndex, newSize)\n{\n\n}",
+ "name": "confirm",
+ "sig": "function (combo)\n{\n\n}",
"type": "function",
- "desc": "Fires when the user resizes a column"
+ "desc": "Fires when the 'confirm' icon is pressed (add a listener to enable add button)"
},
{
- "name": "contextmenu",
- "sig": "function (e)\n{\n\n}",
+ "name": "destroy",
+ "sig": "function (_self)\n{\n\n}",
"type": "function",
- "desc": "The raw contextmenu event for the entire grid."
+ "desc": "Fires after the component is destroyed."
},
{
- "name": "dblclick",
- "sig": "function (e)\n{\n\n}",
+ "name": "disable",
+ "sig": "function (_self)\n{\n\n}",
"type": "function",
- "desc": "The raw dblclick event for the entire grid."
+ "desc": "Fires after the component is disabled."
},
{
- "name": "dragdrop",
- "sig": "function (_self, dd, targetId, e)\n{\n\n}",
+ "name": "enable",
+ "sig": "function (_self)\n{\n\n}",
"type": "function",
- "desc": "Fires when dragged row(s) are dropped on a valid DD target"
+ "desc": "Fires after the component is enabled."
},
{
- "name": "dragenter\n Fires when the dragged row(s) first cross another DD target while being dragged",
- "sig": "function (_self, dd, targetId, e)\n{\n\n}",
+ "name": "focus",
+ "sig": "function (_self)\n{\n\n}",
"type": "function",
- "desc": ""
+ "desc": "Fires when this field receives input focus."
},
{
- "name": "dragout",
- "sig": "function (_self, dd, targetId, e)\n{\n\n}",
+ "name": "hide",
+ "sig": "function (_self)\n{\n\n}",
"type": "function",
- "desc": "Fires when the dragged row(s) leave another DD target while being dragged"
+ "desc": "Fires after the component is hidden."
},
{
- "name": "dragover",
- "sig": "function (_self, dd, targetId, e)\n{\n\n}",
+ "name": "invalid",
+ "sig": "function (_self, msg)\n{\n\n}",
"type": "function",
- "desc": "Fires while row(s) are being dragged. \"targetId\" is the id of the Yahoo.util.DD object the selected rows are being dragged over."
+ "desc": "Fires after the field has been marked as invalid."
},
{
- "name": "enddrag",
- "sig": "function (_self, dd, e)\n{\n\n}",
+ "name": "keyup",
+ "sig": "function (_self, e)\n{\n\n}",
"type": "function",
- "desc": "Fires when a drag operation is complete"
+ "desc": "Fires after the key up"
},
{
- "name": "eventclick",
- "sig": "function (_self, )\n{\n\n}",
+ "name": "move",
+ "sig": "function (_self, x, y)\n{\n\n}",
"type": "function",
- "desc": "Fires when the mouse click an"
+ "desc": "Fires after the component is moved."
},
{
- "name": "evententer",
- "sig": "function (_self, Event)\n{\n\n}",
+ "name": "render",
+ "sig": "function (_self)\n{\n\n}",
"type": "function",
- "desc": "Fires when mouse over an event"
+ "desc": "Fires after the component is rendered."
},
{
- "name": "eventleave",
- "sig": "function (_self, )\n{\n\n}",
+ "name": "reset",
+ "sig": "function (combo, record)\n{\n\n}",
"type": "function",
- "desc": "Fires when the mouse leaves an"
+ "desc": "Fires when the 'edit' icon is pressed (add a listener to enable add button)"
},
{
- "name": "eventrender",
- "sig": "function (_self, data)\n{\n\n}",
+ "name": "resize",
+ "sig": "function (_self, adjWidth, adjHeight, rawWidth, rawHeight)\n{\n\n}",
"type": "function",
- "desc": "Fires before each cell is rendered, so you can modify the contents, like cls / title / qtip"
+ "desc": "Fires after the component is resized."
},
{
- "name": "headerclick",
- "sig": "function (_self, columnIndex, e)\n{\n\n}",
+ "name": "show",
+ "sig": "function (_self)\n{\n\n}",
"type": "function",
- "desc": "Fires when a header is clicked"
+ "desc": "Fires after the component is shown."
},
{
- "name": "headercontextmenu",
- "sig": "function (_self, columnIndex, e)\n{\n\n}",
+ "name": "specialkey",
+ "sig": "function (_self, e)\n{\n\n}",
"type": "function",
- "desc": "Fires when a header is right clicked"
+ "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."
},
{
- "name": "headerdblclick",
- "sig": "function (_self, columnIndex, e)\n{\n\n}",
+ "name": "valid",
+ "sig": "function (_self)\n{\n\n}",
"type": "function",
- "desc": "Fires when a header cell is double clicked"
- },
+ "desc": "Fires after the field has been validated with no errors."
+ }
+ ],
+ "methods": [
{
- "name": "keydown",
- "sig": "function (e)\n{\n\n}",
+ "name": "addEvents",
+ "sig": "(Object object)",
"type": "function",
- "desc": "The raw keydown event for the entire grid."
+ "desc": "Used to define events on this Observable"
},
{
- "name": "keypress",
- "sig": "function (e)\n{\n\n}",
+ "name": "addListener",
+ "sig": "(String eventName, Function handler, Object scope, Object options)",
"type": "function",
- "desc": "The raw keypress event for the entire grid."
+ "desc": "Appends an event handler to this component"
},
{
- "name": "monthchange",
- "sig": "function (_self, date)\n{\n\n}",
+ "name": "applyTo",
+ "sig": "(String/HTMLElement/Element el)",
"type": "function",
- "desc": "Fires when the displayed month changes"
+ "desc": "Apply the behaviors of this component to an existing element. <b>This is used instead of render().</b>"
},
{
- "name": "mousedown",
- "sig": "function (e)\n{\n\n}",
+ "name": "capture",
+ "sig": "(Observable o, Function fn, Object scope)",
"type": "function",
- "desc": "The raw mousedown event for the entire grid."
+ "desc": "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\n<b>before</b> the event is fired. If the supplied function returns false,\nthe event will not fire."
},
{
- "name": "mouseout",
- "sig": "function (e)\n{\n\n}",
+ "name": "clearInvalid",
+ "sig": "()",
"type": "function",
- "desc": "The raw mouseout event for the entire grid."
+ "desc": "Clear any invalid styles/messages for this field"
},
{
- "name": "mouseover",
- "sig": "function (e)\n{\n\n}",
+ "name": "createToolbar",
+ "sig": "(HtmlEditor editor)",
"type": "function",
- "desc": "The raw mouseover event for the entire grid."
+ "desc": "Protected method that will not generally be called directly. It\nis called when the editor creates its toolbar. Override this method if you need to\nadd custom toolbar buttons."
},
{
- "name": "mouseup",
- "sig": "function (e)\n{\n\n}",
+ "name": "destroy",
+ "sig": "()",
"type": "function",
- "desc": "The raw mouseup event for the entire grid."
+ "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}."
},
{
- "name": "render",
- "sig": "function (grid)\n{\n\n}",
+ "name": "disable",
+ "sig": "()",
"type": "function",
- "desc": "Fires when the grid is rendered"
+ "desc": "Disable this component."
},
{
- "name": "rowclass",
- "sig": "function (gridview, rowcfg)\n{\n\n}",
+ "name": "enable",
+ "sig": "()",
"type": "function",
- "desc": "Fires when a row is rendered, so you can change add a style to it."
+ "desc": "Enable this component."
},
{
- "name": "rowclick",
- "sig": "function (_self, rowIndex, e)\n{\n\n}",
+ "name": "fireEvent",
+ "sig": "(String eventName, Object... args)",
"type": "function",
- "desc": "Fires when a row is clicked"
+ "desc": "Fires the specified event with the passed parameters (minus the event name)."
},
{
- "name": "rowcontextmenu",
- "sig": "function (_self, rowIndex, e)\n{\n\n}",
+ "name": "focus",
+ "sig": "(Boolean selectText)",
"type": "function",
- "desc": "Fires when a row is right clicked"
+ "desc": "Try to focus this component."
},
{
- "name": "rowdblclick",
- "sig": "function (_self, rowIndex, e)\n{\n\n}",
+ "name": "getBox",
+ "sig": "(Boolean local)",
"type": "function",
- "desc": "Fires when a row is double clicked"
+ "desc": "Gets the current box measurements of the component's underlying element."
},
{
- "name": "select",
- "sig": "function (_self, date)\n{\n\n}",
+ "name": "getConfirmed",
+ "sig": "()",
"type": "function",
- "desc": "Fires when a date is selected"
+ "desc": ""
},
{
- "name": "startdrag",
- "sig": "function (_self, dd, e)\n{\n\n}",
+ "name": "getEl",
+ "sig": "()",
"type": "function",
- "desc": "Fires when row(s) start being dragged"
- }
- ],
- "methods": [
+ "desc": "Returns the underlying {@link Roo.Element}."
+ },
{
- "name": "getSelectionModel",
+ "name": "getHeight",
"sig": "()",
"type": "function",
- "desc": "Returns the grid's SelectionModel."
- }
- ]
- },
- "Roo.grid.CellSelectionModel": {
- "props": [
+ "desc": ""
+ },
{
- "name": "enter_is_tab",
- "type": "Boolean",
- "desc": "Enter behaves the same as tab. (eg. goes to next cell) default: false",
- "memberOf": ""
+ "name": "getId",
+ "sig": "()",
+ "type": "function",
+ "desc": "Returns the id of this component."
},
{
- "name": "listeners",
- "type": "Object",
- "desc": "list of events and functions to call for this object, \nFor example :\n<pre><code>\n listeners : { \n 'click' : function(e) {\n ..... \n } ,\n .... \n } \n </code></pre>",
- "memberOf": "Roo.util.Observable"
- }
- ],
- "events": [
- {
- "name": "beforeeditnext",
- "sig": "function (eventdata)\n{\n\n}",
+ "name": "getImageDataURI",
+ "sig": "()",
"type": "function",
- "desc": "Fires before the next editable sell is made active\nYou can use this to skip to another cell or fire the tabend\n if you set cell to false"
+ "desc": "when user is clicked confirm then show this image....."
},
{
- "name": "beforerowselect",
- "sig": "function (_self, rowIndex, colIndex)\n{\n\n}",
+ "name": "getName",
+ "sig": "()",
"type": "function",
- "desc": "Fires before a cell is selected."
+ "desc": "Returns the name attribute of the field if available"
},
{
- "name": "cellselect",
- "sig": "function (_self, rowIndex, colIndex)\n{\n\n}",
+ "name": "getPosition",
+ "sig": "(Boolean local)",
"type": "function",
- "desc": "Fires when a cell is selected."
+ "desc": "Gets the current XY position of the component's underlying element."
},
{
- "name": "selectionchange",
- "sig": "function (_self, selection)\n{\n\n}",
+ "name": "getRawValue",
+ "sig": "()",
"type": "function",
- "desc": "Fires when the active selection changes."
+ "desc": "Returns the raw data value which may or may not be a valid, defined value. To return a normalized value see {@link #getValue}."
},
{
- "name": "tabend",
- "sig": "function (_self)\n{\n\n}",
- "type": "function",
- "desc": "Fires when the tab (or enter) was pressed on the last editable cell\nYou can use this to trigger add new row."
- }
- ],
- "methods": [
- {
- "name": "addEvents",
- "sig": "(Object object)",
+ "name": "getSize",
+ "sig": "()",
"type": "function",
- "desc": "Used to define events on this Observable"
+ "desc": "Gets the current size of the component's underlying element."
},
{
- "name": "addListener",
- "sig": "(String eventName, Function handler, Object scope, Object options)",
+ "name": "getValue",
+ "sig": "()",
"type": "function",
- "desc": "Appends an event handler to this component"
+ "desc": "Returns the normalized data value (undefined or emptyText will be returned as ''). To return the raw value see {@link #getRawValue}."
},
{
- "name": "capture",
- "sig": "(Observable o, Function fn, Object scope)",
+ "name": "getWidth",
+ "sig": "()",
"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."
+ "desc": ""
},
{
- "name": "clearSelections",
- "sig": "(Boolean true)",
+ "name": "hasChanged",
+ "sig": "()",
"type": "function",
- "desc": "Clears all selections."
+ "desc": "checks the current value against the 'loaded' value.\nNote - will return false if 'resetHasChanged' has not been called first."
},
{
- "name": "fireEvent",
- "sig": "(String eventName, Object... args)",
+ "name": "hasListener",
+ "sig": "(String eventName)",
"type": "function",
- "desc": "Fires the specified event with the passed parameters (minus the event name)."
+ "desc": "Checks to see if this object has any listeners for a specified event"
},
{
- "name": "getSelectedCell",
+ "name": "hide",
"sig": "()",
"type": "function",
- "desc": "Returns the currently selected cell,."
+ "desc": "Hide this component."
},
{
- "name": "hasListener",
- "sig": "(String eventName)",
+ "name": "isDirty",
+ "sig": "()",
"type": "function",
- "desc": "Checks to see if this object has any listeners for a specified event"
+ "desc": "Returns true if this field has been changed since it was originally loaded and is not disabled.\nDEPRICATED - it never worked well - use hasChanged/resetHasChanged."
},
{
- "name": "hasSelection",
- "sig": "()",
+ "name": "isValid",
+ "sig": "(Boolean preventMark)",
"type": "function",
- "desc": "Returns true if there is a selection."
+ "desc": "Returns whether or not the field value is currently valid"
},
{
- "name": "isLocked",
+ "name": "isVisible",
"sig": "()",
"type": "function",
- "desc": "Returns true if the selections are locked."
+ "desc": "Returns true if this component is visible."
},
{
- "name": "lock",
- "sig": "()",
+ "name": "markInvalid",
+ "sig": "(String msg)",
"type": "function",
- "desc": "Locks the selections."
+ "desc": "Mark this field as invalid"
},
{
"name": "on",
"desc": "Appends an event handler to this element (shorthand for addListener)"
},
{
- "name": "onEditorKey",
- "sig": "(Number field, Number e)",
+ "name": "onPosition",
+ "sig": "(Number x, Number y)",
"type": "function",
- "desc": "Selects a cell."
+ "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."
+ },
+ {
+ "name": "onResize",
+ "sig": "(Number adjWidth, Number adjHeight, Number rawWidth, Number rawHeight)",
+ "type": "function",
+ "desc": "Called after the component is resized, this method is empty by default but can be implemented by any\nsubclass that needs to perform custom logic after a resize occurs."
},
{
"name": "purgeListeners",
"desc": "Removes a listener"
},
{
- "name": "select",
- "sig": "(Number rowIndex, Number collIndex)",
+ "name": "render",
+ "sig": "(String/HTMLElement/Element container)",
"type": "function",
- "desc": "Selects a cell."
+ "desc": "If this is a lazy rendering component, render it to its container element."
},
{
- "name": "un",
- "sig": "(String eventName, Function handler, Object scope)",
+ "name": "reset",
+ "sig": "()",
"type": "function",
- "desc": "Removes a listener (shorthand for removeListener)"
+ "desc": "Resets the current field value to the originally loaded value and clears any validation messages"
},
{
- "name": "unlock",
+ "name": "resetHasChanged",
"sig": "()",
"type": "function",
- "desc": "Unlocks the selections."
- }
- ]
- },
- "Roo.grid.ColumnModel": {
- "props": [
- {
- "name": "header",
- "type": "String",
- "desc": "The header text to display in the Grid view.",
- "memberOf": ""
+ "desc": "stores the current value in loadedValue"
},
{
- "name": "dataIndex",
- "type": "String",
- "desc": "(Optional) The name of the field in the grid's {@link Roo.data.Store}'s\n{@link Roo.data.Record} definition from which to draw the column's value. If not\nspecified, the column's index is used as an index into the Record's data Array.",
- "memberOf": ""
+ "name": "setDisabled",
+ "sig": "(Boolean disabled)",
+ "type": "function",
+ "desc": "Convenience function for setting disabled/enabled by boolean."
},
{
- "name": "width",
- "type": "Number",
- "desc": "(Optional) The initial width in pixels of the column. Using this\ninstead of {@link Roo.grid.Grid#autoSizeColumns} is more efficient.",
- "memberOf": ""
+ "name": "setPagePosition",
+ "sig": "(Number x, Number y)",
+ "type": "function",
+ "desc": "Sets the page XY position of the component. To set the left and top instead, use {@link #setPosition}.\nThis method fires the move event."
},
{
- "name": "sortable",
- "type": "Boolean",
- "desc": "(Optional) True if sorting is to be allowed on this column.\nDefaults to the value of the {@link #defaultSortable} property.\nWhether local/remote sorting is used is specified in {@link Roo.data.Store#remoteSort}.",
- "memberOf": ""
+ "name": "setPosition",
+ "sig": "(Number left, Number top)",
+ "type": "function",
+ "desc": "Sets the left and top of the component. To set the page XY position instead, use {@link #setPagePosition}.\nThis method fires the move event."
},
{
- "name": "locked",
- "type": "Boolean",
- "desc": "(Optional) True to lock the column in place while scrolling the Grid. Defaults to false.",
- "memberOf": ""
+ "name": "setRawValue",
+ "sig": "(Mixed value)",
+ "type": "function",
+ "desc": "Sets the underlying DOM field's value directly, bypassing validation. To set the value with validation see {@link #setValue}."
},
{
- "name": "fixed",
- "type": "Boolean",
- "desc": "(Optional) True if the column width cannot be changed. Defaults to false.",
- "memberOf": ""
+ "name": "setSize",
+ "sig": "(Number/Object width, Number height)",
+ "type": "function",
+ "desc": "Sets the width and height of the component. This method fires the resize event. This method can accept\neither width and height as separate numeric arguments, or you can pass a size object like {width:10, height:20}."
},
{
- "name": "resizable",
- "type": "Boolean",
- "desc": "(Optional) False to disable column resizing. Defaults to true.",
- "memberOf": ""
+ "name": "setValue",
+ "sig": "(Mixed value)",
+ "type": "function",
+ "desc": "Sets a data value into the field and validates it. To set the value directly without validation see {@link #setRawValue}."
},
{
- "name": "hidden",
- "type": "Boolean",
- "desc": "(Optional) True to hide the column. Defaults to false.",
- "memberOf": ""
+ "name": "setVisible",
+ "sig": "(Boolean visible)",
+ "type": "function",
+ "desc": "Convenience function to hide or show this component by boolean."
},
{
- "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 uses the raw data value. If an object is returned (bootstrap only)\nthen it is treated as a Roo Component object instance, and it is rendered after the initial row is rendered",
- "memberOf": ""
+ "name": "show",
+ "sig": "()",
+ "type": "function",
+ "desc": "Show this component."
},
{
- "name": "editor",
- "type": "Roo.grid.GridEditor",
- "desc": "(Optional) For grid editors - returns the grid editor",
- "memberOf": ""
+ "name": "syncSize",
+ "sig": "()",
+ "type": "function",
+ "desc": "Force the component's size to recalculate based on the underlying element's current height and width."
},
{
- "name": "align",
- "type": "String",
- "desc": "(Optional) Set the CSS text-align property of the column. Defaults to undefined.",
- "memberOf": ""
+ "name": "un",
+ "sig": "(String eventName, Function handler, Object scope)",
+ "type": "function",
+ "desc": "Removes a listener (shorthand for removeListener)"
},
{
- "name": "cursor",
- "type": "String",
- "desc": "(Optional)",
- "memberOf": ""
+ "name": "updateBox",
+ "sig": "(Object box)",
+ "type": "function",
+ "desc": "Sets the current box measurements of the component's underlying element."
},
{
- "name": "tooltip",
- "type": "String",
- "desc": "(Optional)",
- "memberOf": ""
- },
+ "name": "validate",
+ "sig": "()",
+ "type": "function",
+ "desc": "Validates the field value"
+ }
+ ]
+ },
+ "Roo.form.TextArea": {
+ "props": [
{
- "name": "xs",
+ "name": "growMin",
"type": "Number",
- "desc": "(Optional)",
+ "desc": "The minimum height to allow when grow = true (defaults to 60)",
"memberOf": ""
},
{
- "name": "sm",
+ "name": "growMax",
"type": "Number",
- "desc": "(Optional)",
+ "desc": "The maximum height to allow when grow = true (defaults to 1000)",
"memberOf": ""
},
{
- "name": "md",
- "type": "Number",
- "desc": "(Optional)",
+ "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": ""
},
{
- "name": "lg",
- "type": "Number",
- "desc": "(Optional)",
+ "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": ""
},
{
- "name": "listeners",
- "type": "Object",
- "desc": "list of events and functions to call for 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": "columlockchange",
- "sig": "function (_self, colIndex, locked)\n{\n\n}",
- "type": "function",
- "desc": "Fires when a column's locked state is changed"
+ "name": "grow",
+ "type": "Boolean",
+ "desc": "True if this field should automatically grow and shrink to its content",
+ "memberOf": "Roo.form.TextField"
},
{
- "name": "columnmoved",
- "sig": "function (_self, oldIndex, newIndex)\n{\n\n}",
- "type": "function",
- "desc": "Fires when a column is moved."
+ "name": "vtype",
+ "type": "String",
+ "desc": "A validation type name as defined in {@link Roo.form.VTypes} (defaults to null)",
+ "memberOf": "Roo.form.TextField"
},
{
- "name": "headerchange",
- "sig": "function (_self, columnIndex, newText)\n{\n\n}",
- "type": "function",
- "desc": "Fires when the text of a header changes."
+ "name": "maskRe",
+ "type": "String",
+ "desc": "An input mask regular expression that will be used to filter keystrokes that don't match (defaults to null)",
+ "memberOf": "Roo.form.TextField"
},
{
- "name": "hiddenchange",
- "sig": "function (_self, columnIndex, hidden)\n{\n\n}",
- "type": "function",
- "desc": "Fires when a column is hidden or \"unhidden\"."
+ "name": "disableKeyFilter",
+ "type": "Boolean",
+ "desc": "True to disable input keystroke filtering (defaults to false)",
+ "memberOf": "Roo.form.TextField"
},
{
- "name": "widthchange",
- "sig": "function (_self, columnIndex, newWidth)\n{\n\n}",
- "type": "function",
- "desc": "Fires when the width of a column changes."
- }
- ],
- "methods": [
+ "name": "allowBlank",
+ "type": "Boolean",
+ "desc": "False to validate that the value length > 0 (defaults to true)",
+ "memberOf": "Roo.form.TextField"
+ },
{
- "name": "addEvents",
- "sig": "(Object object)",
- "type": "function",
- "desc": "Used to define events on this Observable"
+ "name": "minLength",
+ "type": "Number",
+ "desc": "Minimum input field length required (defaults to 0)",
+ "memberOf": "Roo.form.TextField"
},
{
- "name": "addListener",
- "sig": "(String eventName, Function handler, Object scope, Object options)",
- "type": "function",
- "desc": "Appends an event handler to this component"
+ "name": "maxLength",
+ "type": "Number",
+ "desc": "Maximum input field length allowed (defaults to Number.MAX_VALUE)",
+ "memberOf": "Roo.form.TextField"
},
{
- "name": "capture",
- "sig": "(Observable o, Function fn, Object scope)",
- "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."
+ "name": "minLengthText",
+ "type": "String",
+ "desc": "Error text to display if the minimum length validation fails (defaults to \"The minimum length for this field is {minLength}\")",
+ "memberOf": "Roo.form.TextField"
},
{
- "name": "findColumnIndex",
- "sig": "(String dataIndex)",
- "type": "function",
- "desc": "Returns the index for a specified column dataIndex."
+ "name": "maxLengthText",
+ "type": "String",
+ "desc": "Error text to display if the maximum length validation fails (defaults to \"The maximum length for this field is {maxLength}\")",
+ "memberOf": "Roo.form.TextField"
},
{
- "name": "fireEvent",
- "sig": "(String eventName, Object... args)",
- "type": "function",
- "desc": "Fires the specified event with the passed parameters (minus the event name)."
+ "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": "getCellEditor",
- "sig": "(Number colIndex, Number rowIndex)",
- "type": "function",
- "desc": "Returns the editor defined for the cell/column.\nreturn false or null to disable editing."
+ "name": "blankText",
+ "type": "String",
+ "desc": "Error text to display if the allow blank validation fails (defaults to \"This field is required\")",
+ "memberOf": "Roo.form.TextField"
},
{
- "name": "getColumnByDataIndex",
- "sig": "(String dataIndex)",
- "type": "function",
- "desc": "Returns the column for a specified dataIndex."
+ "name": "validator",
+ "type": "Function",
+ "desc": "A custom validation function to be called during field validation (defaults to null).\nIf available, this function will be called only after the basic validators all return true, and will be passed the\ncurrent field value and expected to return boolean true if the value is valid or a string error message if invalid.",
+ "memberOf": "Roo.form.TextField"
},
{
- "name": "getColumnById",
- "sig": "(String id)",
- "type": "function",
- "desc": "Returns the column for a specified id."
+ "name": "regex",
+ "type": "RegExp",
+ "desc": "A JavaScript RegExp object to be tested against the field value during validation (defaults to null).\nIf available, this regex will be evaluated only after the basic validators all return true, and will be passed the\ncurrent field value. If the test fails, the field will be marked invalid using {@link #regexText}.",
+ "memberOf": "Roo.form.TextField"
},
{
- "name": "getColumnCount",
- "sig": "()",
- "type": "function",
- "desc": "Returns the number of columns."
+ "name": "regexText",
+ "type": "String",
+ "desc": "The error text to display if {@link #regex} is used and the test fails during validation (defaults to \"\")",
+ "memberOf": "Roo.form.TextField"
},
{
- "name": "getColumnHeader",
- "sig": "(Number col)",
- "type": "function",
- "desc": "Returns the header for the specified column."
+ "name": "emptyText",
+ "type": "String",
+ "desc": "The default text to display in an empty field - placeholder... (defaults to null).",
+ "memberOf": "Roo.form.TextField"
},
{
- "name": "getColumnId",
- "sig": "(Number index)",
- "type": "function",
- "desc": "Returns the id of the column at the specified index."
+ "name": "fieldLabel",
+ "type": "String",
+ "desc": "Label to use when rendering a form.",
+ "memberOf": "Roo.form.Field"
},
{
- "name": "getColumnTooltip",
- "sig": "(Number col)",
- "type": "function",
- "desc": "Returns the tooltip for the specified column."
+ "name": "qtip",
+ "type": "String",
+ "desc": "Mouse over tip",
+ "memberOf": "Roo.form.Field"
},
{
- "name": "getColumnWidth",
- "sig": "(Number col)",
- "type": "function",
- "desc": "Returns the width for the specified column."
+ "name": "name",
+ "type": "String",
+ "desc": "The field's HTML name attribute.",
+ "memberOf": "Roo.form.Field"
},
{
- "name": "getColumnsBy",
- "sig": "(Function fn, Object scope)",
- "type": "function",
- "desc": "Returns the column configs that return true by the passed function that is called with (columnConfig, index)"
+ "name": "invalidClass",
+ "type": "String",
+ "desc": "The CSS class to use when marking a field invalid (defaults to \"x-form-invalid\")",
+ "memberOf": "Roo.form.Field"
},
{
- "name": "getDataIndex",
- "sig": "(Number col)",
- "type": "function",
- "desc": "Returns the dataIndex for the specified column."
+ "name": "invalidText",
+ "type": "String",
+ "desc": "The error text to use when marking a field invalid and no message is provided (defaults to \"The value in this field is invalid\")",
+ "memberOf": "Roo.form.Field"
},
{
- "name": "getIndexById",
- "sig": "(String id)",
- "type": "function",
- "desc": "Returns the index for a specified column id."
+ "name": "focusClass",
+ "type": "String",
+ "desc": "The CSS class to use when the field receives focus (defaults to \"x-form-focus\")",
+ "memberOf": "Roo.form.Field"
},
{
- "name": "getRenderer",
- "sig": "(Number col)",
- "type": "function",
- "desc": "Returns the rendering (formatting) function defined for the column."
+ "name": "validationEvent",
+ "type": "String/Boolean",
+ "desc": "The event that should initiate field validation. Set to false to disable\n automatic validation (defaults to \"keyup\").",
+ "memberOf": "Roo.form.Field"
},
{
- "name": "getTotalWidth",
- "sig": "(Boolean includeHidden)",
- "type": "function",
- "desc": "Returns the total width of all columns."
+ "name": "validateOnBlur",
+ "type": "Boolean",
+ "desc": "Whether the field should validate when it loses focus (defaults to true).",
+ "memberOf": "Roo.form.Field"
},
{
- "name": "hasListener",
- "sig": "(String eventName)",
- "type": "function",
- "desc": "Checks to see if this object has any listeners for a specified event"
+ "name": "validationDelay",
+ "type": "Number",
+ "desc": "The length of time in milliseconds after user input begins until validation is initiated (defaults to 250)",
+ "memberOf": "Roo.form.Field"
},
{
- "name": "isCellEditable",
- "sig": "(Number colIndex, Number rowIndex)",
- "type": "function",
- "desc": "Returns true if the cell is editable."
+ "name": "fieldClass",
+ "type": "String",
+ "desc": "The default CSS class for the field (defaults to \"x-form-field\")",
+ "memberOf": "Roo.form.Field"
},
{
- "name": "isFixed",
- "sig": "()",
- "type": "function",
- "desc": "Returns true if the column width cannot be changed"
+ "name": "msgTarget",
+ "type": "String",
+ "desc": "The location where error text should display. Should be one of the following values (defaults to 'qtip'):\n<pre>\nValue Description\n----------- ----------------------------------------------------------------------\nqtip Display a quick tip when the user hovers over the field\ntitle Display a default browser title attribute popup\nunder Add a block div beneath the field containing the error text\nside Add an error icon to the right of the field with a popup on hover\n[element id] Add the error text directly to the innerHTML of the specified element\n</pre>",
+ "memberOf": "Roo.form.Field"
},
{
- "name": "isHidden",
- "sig": "(Number colIndex)",
- "type": "function",
- "desc": "Returns true if the column is hidden."
+ "name": "msgFx",
+ "type": "String",
+ "desc": "<b>Experimental</b> The effect used when displaying a validation message under the field (defaults to 'normal').",
+ "memberOf": "Roo.form.Field"
},
{
- "name": "isResizable",
- "sig": "()",
- "type": "function",
- "desc": "Returns true if the column can be resized"
+ "name": "readOnly",
+ "type": "Boolean",
+ "desc": "True to mark the field as readOnly in HTML (defaults to false) -- Note: this only sets the element's readOnly DOM attribute.",
+ "memberOf": "Roo.form.Field"
},
{
- "name": "isSortable",
- "sig": "(Number col)",
- "type": "function",
- "desc": "Returns true if the specified column is sortable."
+ "name": "disabled",
+ "type": "Boolean",
+ "desc": "True to disable the field (defaults to false).",
+ "memberOf": "Roo.form.Field"
},
{
- "name": "on",
- "sig": "(String eventName, Function handler, Object scope, Object options)",
- "type": "function",
- "desc": "Appends an event handler to this element (shorthand for addListener)"
+ "name": "inputType",
+ "type": "String",
+ "desc": "The type attribute for input fields -- e.g. radio, text, password (defaults to \"text\").",
+ "memberOf": "Roo.form.Field"
},
{
- "name": "purgeListeners",
- "sig": "()",
- "type": "function",
- "desc": "Removes all listeners for this object"
+ "name": "tabIndex",
+ "type": "Number",
+ "desc": "The tabIndex for this field. Note this only applies to fields that are rendered, not those which are built via applyTo (defaults to undefined).",
+ "memberOf": "Roo.form.Field"
},
{
- "name": "releaseCapture",
- "sig": "(Observable o)",
- "type": "function",
- "desc": "Removes <b>all</b> added captures from the Observable."
- },
- {
- "name": "removeListener",
- "sig": "(String eventName, Function handler, Object scope)",
- "type": "function",
- "desc": "Removes a listener"
- },
- {
- "name": "setColumnHeader",
- "sig": "(Number col, String header)",
- "type": "function",
- "desc": "Sets the header for a column."
- },
- {
- "name": "setColumnTooltip",
- "sig": "(Number col, String tooltip)",
- "type": "function",
- "desc": "Sets the tooltip for a column."
- },
- {
- "name": "setColumnWidth",
- "sig": "(Number col, Number width)",
- "type": "function",
- "desc": "Sets the width for a column."
- },
- {
- "name": "setDataIndex",
- "sig": "(Number col, Number dataIndex)",
- "type": "function",
- "desc": "Sets the dataIndex for a column."
- },
- {
- "name": "setEditable",
- "sig": "(Number col, Boolean editable)",
- "type": "function",
- "desc": "Sets if a column is editable."
- },
- {
- "name": "setEditor",
- "sig": "(Number col, Object editor)",
- "type": "function",
- "desc": "Sets the editor for a column."
- },
- {
- "name": "setHidden",
- "sig": "(Number colIndex, Boolean hidden)",
- "type": "function",
- "desc": "Sets if a column is hidden."
- },
- {
- "name": "setRenderer",
- "sig": "(Number col, Function fn)",
- "type": "function",
- "desc": "Sets the rendering (formatting) function for a column."
- },
- {
- "name": "un",
- "sig": "(String eventName, Function handler, Object scope)",
- "type": "function",
- "desc": "Removes a listener (shorthand for removeListener)"
- }
- ]
- },
- "Roo.grid.EditorGrid": {
- "props": [
- {
- "name": "clicksToEdit",
- "type": "Number",
- "desc": "The number of clicks on a cell required to display the cell's editor (defaults to 2)",
- "memberOf": ""
+ "name": "value",
+ "type": "Mixed",
+ "desc": "A value to initialize this field with.",
+ "memberOf": "Roo.form.Field"
},
{
- "name": "ddGroup",
+ "name": "cls",
"type": "String",
- "desc": "- drag drop group.",
- "memberOf": "Roo.grid.Grid"
- },
- {
- "name": "enableDrag",
- "type": "Boolean",
- "desc": "True to enable drag of rows. Default is false. (double check if this is needed?)",
- "memberOf": "Roo.grid.Grid"
- },
- {
- "name": "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"
+ "desc": "A CSS class to apply to the field's underlying element.",
+ "memberOf": "Roo.form.Field"
},
{
- "name": "maxHeight",
+ "name": "width",
"type": "Number",
- "desc": "Sets the maximum height of the grid - ignored if autoHeight is not on.",
- "memberOf": "Roo.grid.Grid"
+ "desc": "width (optional) size of component",
+ "memberOf": "Roo.BoxComponent"
},
{
- "name": "minColumnWidth",
+ "name": "height",
"type": "Number",
- "desc": "The minimum width a column can be resized to. Default is 25.",
- "memberOf": "Roo.grid.Grid"
- },
- {
- "name": "autoSizeColumns",
- "type": "Boolean",
- "desc": "True to automatically resize the columns to fit their content\n<b>on initial render.</b> It is more efficient to explicitly size the columns\nthrough the ColumnModel's {@link Roo.grid.ColumnModel#width} config option. Default is false.",
- "memberOf": "Roo.grid.Grid"
- },
- {
- "name": "autoSizeHeaders",
- "type": "Boolean",
- "desc": "True to measure headers with column data when auto sizing columns. Default is true.",
- "memberOf": "Roo.grid.Grid"
- },
- {
- "name": "monitorWindowResize",
- "type": "Boolean",
- "desc": "True to autoSize the grid when the window resizes. Default is true.",
- "memberOf": "Roo.grid.Grid"
- },
- {
- "name": "maxRowsToMeasure",
- "type": "Boolean",
- "desc": "If autoSizeColumns is on, maxRowsToMeasure can be used to limit the number of\nrows measured to get a columns size. Default is 0 (all rows).",
- "memberOf": "Roo.grid.Grid"
- },
- {
- "name": "trackMouseOver",
- "type": "Boolean",
- "desc": "True to highlight rows when the mouse is over. Default is true.",
- "memberOf": "Roo.grid.Grid"
- },
- {
- "name": "enableDragDrop",
- "type": "Boolean",
- "desc": "True to enable drag and drop of rows. Default is false.",
- "memberOf": "Roo.grid.Grid"
- },
- {
- "name": "enableColumnMove",
- "type": "Boolean",
- "desc": "True to enable drag and drop reorder of columns. Default is true.",
- "memberOf": "Roo.grid.Grid"
- },
- {
- "name": "enableColumnHide",
- "type": "Boolean",
- "desc": "True to enable hiding of columns with the header context menu. Default is true.",
- "memberOf": "Roo.grid.Grid"
- },
- {
- "name": "enableRowHeightSync",
- "type": "Boolean",
- "desc": "True to manually sync row heights across locked and not locked rows. Default is false.",
- "memberOf": "Roo.grid.Grid"
+ "desc": "height (optional) size of component",
+ "memberOf": "Roo.BoxComponent"
},
{
- "name": "stripeRows",
- "type": "Boolean",
- "desc": "True to stripe the rows. Default is true.",
- "memberOf": "Roo.grid.Grid"
+ "name": "disableClass",
+ "type": "String",
+ "desc": "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").",
+ "memberOf": "Roo.Component"
},
{
- "name": "autoHeight",
+ "name": "allowDomMove",
"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"
+ "desc": "Whether the component can move the Dom node when rendering (defaults to true).",
+ "memberOf": "Roo.Component"
},
{
- "name": "autoExpandColumn",
+ "name": "hideMode",
"type": "String",
- "desc": "The id (or dataIndex) of a column in this grid that should expand to fill unused space. This id can not be 0. Default is false.",
- "memberOf": "Roo.grid.Grid"
- },
- {
- "name": "autoExpandMin",
- "type": "Number",
- "desc": "The minimum width the autoExpandColumn can have (if enabled).\nDefault is 50.",
- "memberOf": "Roo.grid.Grid"
- },
- {
- "name": "autoExpandMax",
- "type": "Number",
- "desc": "The maximum width the autoExpandColumn can have (if enabled). Default is 1000.",
- "memberOf": "Roo.grid.Grid"
- },
- {
- "name": "view",
- "type": "Object",
- "desc": "The {@link Roo.grid.GridView} used by the grid. This can be set before a call to render().",
- "memberOf": "Roo.grid.Grid"
- },
- {
- "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"
+ "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\".",
+ "memberOf": "Roo.Component",
+ "optvals": [
+ "display",
+ "visibility"
+ ]
},
{
- "name": "dropTarget",
- "type": "Roo.dd.DropTarget",
- "desc": "An {@link Roo.dd.DropTarget} config",
- "memberOf": "Roo.grid.Grid"
+ "name": "actionMode",
+ "type": "String",
+ "desc": "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el'",
+ "memberOf": "Roo.Component"
},
{
"name": "listeners",
],
"events": [
{
- "name": "afteredit",
- "sig": "function (e)\n{\n\n}",
+ "name": "autosize",
+ "sig": "function (_self, width)\n{\n\n}",
"type": "function",
- "desc": "Fires after a cell is edited. <br />\n<ul style=\"padding:5px;padding-left:16px;\">\n<li>grid - This grid</li>\n<li>record - The record being edited</li>\n<li>field - The field name being edited</li>\n<li>value - The value being set</li>\n<li>originalValue - The original value for the field, before the edit.</li>\n<li>row - The grid row index</li>\n<li>column - The grid column index</li>\n</ul>"
+ "desc": "Fires when the autosize function is triggered. The field may or may not have actually changed size\naccording to the default logic, but this event provides a hook for the developer to apply additional\nlogic at runtime to resize the field if needed."
},
{
- "name": "beforeedit",
- "sig": "function (e)\n{\n\n}",
+ "name": "beforedestroy",
+ "sig": "function (_self)\n{\n\n}",
"type": "function",
- "desc": "Fires before cell editing is triggered. The edit event object has the following properties <br />\n<ul style=\"padding:5px;padding-left:16px;\">\n<li>grid - This grid</li>\n<li>record - The record being edited</li>\n<li>field - The field name being edited</li>\n<li>value - The value for the field being edited.</li>\n<li>row - The grid row index</li>\n<li>column - The grid column index</li>\n<li>cancel - Set this to true to cancel the edit or return false from your handler.</li>\n</ul>"
+ "desc": "Fires before the component is destroyed. Return false to stop the destroy."
},
{
- "name": "bodyscroll",
- "sig": "function (scrollLeft, scrollTop)\n{\n\n}",
+ "name": "beforehide",
+ "sig": "function (_self)\n{\n\n}",
"type": "function",
- "desc": "Fires when the body element is scrolled"
+ "desc": "Fires before the component is hidden. Return false to stop the hide."
},
{
- "name": "cellclick",
- "sig": "function (_self, rowIndex, columnIndex, e)\n{\n\n}",
+ "name": "beforerender",
+ "sig": "function (_self)\n{\n\n}",
"type": "function",
- "desc": "Fires when a cell is clicked"
+ "desc": "Fires before the component is rendered. Return false to stop the render."
},
{
- "name": "cellcontextmenu",
- "sig": "function (_self, rowIndex, cellIndex, e)\n{\n\n}",
+ "name": "beforeshow",
+ "sig": "function (_self)\n{\n\n}",
"type": "function",
- "desc": "Fires when a cell is right clicked"
+ "desc": "Fires before the component is shown. Return false to stop the show."
},
{
- "name": "celldblclick",
- "sig": "function (_self, rowIndex, columnIndex, e)\n{\n\n}",
+ "name": "blur",
+ "sig": "function (_self)\n{\n\n}",
"type": "function",
- "desc": "Fires when a cell is double clicked"
+ "desc": "Fires when this field loses input focus."
},
{
- "name": "click",
- "sig": "function (e)\n{\n\n}",
+ "name": "change",
+ "sig": "function (_self, newValue, oldValue)\n{\n\n}",
"type": "function",
- "desc": "The raw click event for the entire grid."
+ "desc": "Fires just before the field blurs if the field value has changed."
},
{
- "name": "columnmove",
- "sig": "function (oldIndex, newIndex)\n{\n\n}",
+ "name": "destroy",
+ "sig": "function (_self)\n{\n\n}",
"type": "function",
- "desc": "Fires when the user moves a column"
+ "desc": "Fires after the component is destroyed."
},
{
- "name": "columnresize",
- "sig": "function (columnIndex, newSize)\n{\n\n}",
+ "name": "disable",
+ "sig": "function (_self)\n{\n\n}",
"type": "function",
- "desc": "Fires when the user resizes a column"
+ "desc": "Fires after the component is disabled."
},
{
- "name": "contextmenu",
- "sig": "function (e)\n{\n\n}",
+ "name": "enable",
+ "sig": "function (_self)\n{\n\n}",
"type": "function",
- "desc": "The raw contextmenu event for the entire grid."
+ "desc": "Fires after the component is enabled."
},
{
- "name": "dblclick",
- "sig": "function (e)\n{\n\n}",
+ "name": "focus",
+ "sig": "function (_self)\n{\n\n}",
"type": "function",
- "desc": "The raw dblclick event for the entire grid."
+ "desc": "Fires when this field receives input focus."
},
{
- "name": "dragdrop",
- "sig": "function (_self, dd, targetId, e)\n{\n\n}",
+ "name": "hide",
+ "sig": "function (_self)\n{\n\n}",
"type": "function",
- "desc": "Fires when dragged row(s) are dropped on a valid DD target"
+ "desc": "Fires after the component is hidden."
},
{
- "name": "dragenter\n Fires when the dragged row(s) first cross another DD target while being dragged",
- "sig": "function (_self, dd, targetId, e)\n{\n\n}",
+ "name": "invalid",
+ "sig": "function (_self, msg)\n{\n\n}",
"type": "function",
- "desc": ""
+ "desc": "Fires after the field has been marked as invalid."
},
{
- "name": "dragout",
- "sig": "function (_self, dd, targetId, e)\n{\n\n}",
+ "name": "keyup",
+ "sig": "function (_self, e)\n{\n\n}",
"type": "function",
- "desc": "Fires when the dragged row(s) leave another DD target while being dragged"
+ "desc": "Fires after the key up"
},
{
- "name": "dragover",
- "sig": "function (_self, dd, targetId, e)\n{\n\n}",
+ "name": "move",
+ "sig": "function (_self, x, y)\n{\n\n}",
"type": "function",
- "desc": "Fires while row(s) are being dragged. \"targetId\" is the id of the Yahoo.util.DD object the selected rows are being dragged over."
+ "desc": "Fires after the component is moved."
},
{
- "name": "enddrag",
- "sig": "function (_self, dd, e)\n{\n\n}",
+ "name": "render",
+ "sig": "function (_self)\n{\n\n}",
"type": "function",
- "desc": "Fires when a drag operation is complete"
+ "desc": "Fires after the component is rendered."
},
{
- "name": "headerclick",
- "sig": "function (_self, columnIndex, e)\n{\n\n}",
+ "name": "resize",
+ "sig": "function (_self, adjWidth, adjHeight, rawWidth, rawHeight)\n{\n\n}",
"type": "function",
- "desc": "Fires when a header is clicked"
+ "desc": "Fires after the component is resized."
},
{
- "name": "headercontextmenu",
- "sig": "function (_self, columnIndex, e)\n{\n\n}",
+ "name": "show",
+ "sig": "function (_self)\n{\n\n}",
"type": "function",
- "desc": "Fires when a header is right clicked"
+ "desc": "Fires after the component is shown."
},
{
- "name": "headerdblclick",
- "sig": "function (_self, columnIndex, e)\n{\n\n}",
+ "name": "specialkey",
+ "sig": "function (_self, e)\n{\n\n}",
"type": "function",
- "desc": "Fires when a header cell is double clicked"
+ "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."
},
{
- "name": "keydown",
- "sig": "function (e)\n{\n\n}",
+ "name": "valid",
+ "sig": "function (_self)\n{\n\n}",
"type": "function",
- "desc": "The raw keydown event for the entire grid."
- },
+ "desc": "Fires after the field has been validated with no errors."
+ }
+ ],
+ "methods": [
{
- "name": "keypress",
- "sig": "function (e)\n{\n\n}",
+ "name": "addEvents",
+ "sig": "(Object object)",
"type": "function",
- "desc": "The raw keypress event for the entire grid."
+ "desc": "Used to define events on this Observable"
},
{
- "name": "mousedown",
- "sig": "function (e)\n{\n\n}",
+ "name": "addListener",
+ "sig": "(String eventName, Function handler, Object scope, Object options)",
"type": "function",
- "desc": "The raw mousedown event for the entire grid."
+ "desc": "Appends an event handler to this component"
},
{
- "name": "mouseout",
- "sig": "function (e)\n{\n\n}",
+ "name": "applyTo",
+ "sig": "(String/HTMLElement/Element el)",
"type": "function",
- "desc": "The raw mouseout event for the entire grid."
+ "desc": "Apply the behaviors of this component to an existing element. <b>This is used instead of render().</b>"
},
{
- "name": "mouseover",
- "sig": "function (e)\n{\n\n}",
+ "name": "autoSize",
+ "sig": "()",
"type": "function",
- "desc": "The raw mouseover event for the entire grid."
+ "desc": "Automatically grows the field to accomodate the height of the text up to the maximum field height allowed.\nThis only takes effect if grow = true, and fires the autosize event if the height changes."
},
{
- "name": "mouseup",
- "sig": "function (e)\n{\n\n}",
+ "name": "capture",
+ "sig": "(Observable o, Function fn, Object scope)",
"type": "function",
- "desc": "The raw mouseup event for the entire grid."
+ "desc": "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\n<b>before</b> the event is fired. If the supplied function returns false,\nthe event will not fire."
},
{
- "name": "render",
- "sig": "function (grid)\n{\n\n}",
+ "name": "clearInvalid",
+ "sig": "()",
"type": "function",
- "desc": "Fires when the grid is rendered"
+ "desc": "Clear any invalid styles/messages for this field"
},
{
- "name": "rowclass",
- "sig": "function (gridview, rowcfg)\n{\n\n}",
+ "name": "destroy",
+ "sig": "()",
"type": "function",
- "desc": "Fires when a row is rendered, so you can change add a style to it."
+ "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}."
},
{
- "name": "rowclick",
- "sig": "function (_self, rowIndex, e)\n{\n\n}",
+ "name": "disable",
+ "sig": "()",
"type": "function",
- "desc": "Fires when a row is clicked"
+ "desc": "Disable this component."
},
{
- "name": "rowcontextmenu",
- "sig": "function (_self, rowIndex, e)\n{\n\n}",
+ "name": "enable",
+ "sig": "()",
"type": "function",
- "desc": "Fires when a row is right clicked"
+ "desc": "Enable this component."
},
{
- "name": "rowdblclick",
- "sig": "function (_self, rowIndex, e)\n{\n\n}",
+ "name": "fireEvent",
+ "sig": "(String eventName, Object... args)",
"type": "function",
- "desc": "Fires when a row is double clicked"
+ "desc": "Fires the specified event with the passed parameters (minus the event name)."
},
{
- "name": "startdrag",
- "sig": "function (_self, dd, e)\n{\n\n}",
+ "name": "focus",
+ "sig": "(Boolean selectText)",
"type": "function",
- "desc": "Fires when row(s) start being dragged"
+ "desc": "Try to focus this component."
},
{
- "name": "validateedit",
- "sig": "function (e)\n{\n\n}",
+ "name": "getBox",
+ "sig": "(Boolean local)",
"type": "function",
- "desc": "Fires after a cell is edited, but before the value is set in the record. \nYou can use this to modify the value being set in the field, Return false\nto cancel the change. The edit event object has the following properties <br />\n<ul style=\"padding:5px;padding-left:16px;\">\n<li>editor - This editor</li>\n<li>grid - This grid</li>\n<li>record - The record being edited</li>\n<li>field - The field name being edited</li>\n<li>value - The value being set</li>\n<li>originalValue - The original value for the field, before the edit.</li>\n<li>row - The grid row index</li>\n<li>column - The grid column index</li>\n<li>cancel - Set this to true to cancel the edit or return false from your handler.</li>\n</ul>"
- }
- ],
- "methods": [
+ "desc": "Gets the current box measurements of the component's underlying element."
+ },
{
- "name": "addEvents",
- "sig": "(Object object)",
+ "name": "getEl",
+ "sig": "()",
"type": "function",
- "desc": "Used to define events on this Observable"
+ "desc": "Returns the underlying {@link Roo.Element}."
},
{
- "name": "addListener",
- "sig": "(String eventName, Function handler, Object scope, Object options)",
+ "name": "getId",
+ "sig": "()",
"type": "function",
- "desc": "Appends an event handler to this component"
+ "desc": "Returns the id of this component."
},
{
- "name": "autoSize",
+ "name": "getName",
"sig": "()",
"type": "function",
- "desc": "Causes the grid to manually recalculate its dimensions. Generally this is done automatically,\nbut if manual update is required this method will initiate it."
+ "desc": "Returns the name attribute of the field if available"
},
{
- "name": "capture",
- "sig": "(Observable o, Function fn, Object scope)",
+ "name": "getPosition",
+ "sig": "(Boolean local)",
"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."
+ "desc": "Gets the current XY position of the component's underlying element."
},
{
- "name": "destroy",
- "sig": "(Boolean removeEl)",
+ "name": "getRawValue",
+ "sig": "()",
"type": "function",
- "desc": "Destroy this grid."
+ "desc": "Returns the raw data value which may or may not be a valid, defined value. To return a normalized value see {@link #getValue}."
},
{
- "name": "fireEvent",
- "sig": "(String eventName, Object... args)",
+ "name": "getSize",
+ "sig": "()",
"type": "function",
- "desc": "Fires the specified event with the passed parameters (minus the event name)."
+ "desc": "Gets the current size of the component's underlying element."
},
{
- "name": "getColumnModel",
+ "name": "getValue",
"sig": "()",
"type": "function",
- "desc": "Returns the grid's ColumnModel."
+ "desc": "Returns the normalized data value (undefined or emptyText will be returned as ''). To return the raw value see {@link #getRawValue}."
},
{
- "name": "getDataSource",
+ "name": "hasChanged",
"sig": "()",
"type": "function",
- "desc": "Returns the grid's DataSource."
+ "desc": "checks the current value against the 'loaded' value.\nNote - will return false if 'resetHasChanged' has not been called first."
},
{
- "name": "getDragDropText",
- "sig": "()",
+ "name": "hasListener",
+ "sig": "(String eventName)",
"type": "function",
- "desc": "Called to get grid's drag proxy text, by default returns this.ddText."
+ "desc": "Checks to see if this object has any listeners for a specified event"
},
{
- "name": "getGridEl",
+ "name": "hide",
"sig": "()",
"type": "function",
- "desc": "Returns the grid's underlying element."
+ "desc": "Hide this component."
},
{
- "name": "getSelectionModel",
+ "name": "isDirty",
"sig": "()",
"type": "function",
- "desc": "Returns the grid's SelectionModel."
+ "desc": "Returns true if this field has been changed since it was originally loaded and is not disabled.\nDEPRICATED - it never worked well - use hasChanged/resetHasChanged."
},
{
- "name": "getView",
+ "name": "isValid",
+ "sig": "(Boolean preventMark)",
+ "type": "function",
+ "desc": "Returns whether or not the field value is currently valid"
+ },
+ {
+ "name": "isVisible",
"sig": "()",
"type": "function",
- "desc": "Returns the grid's GridView object."
+ "desc": "Returns true if this component is visible."
},
{
- "name": "hasListener",
- "sig": "(String eventName)",
+ "name": "markInvalid",
+ "sig": "(String msg)",
"type": "function",
- "desc": "Checks to see if this object has any listeners for a specified event"
+ "desc": "Mark this field as invalid"
},
{
"name": "on",
"desc": "Appends an event handler to this element (shorthand for addListener)"
},
{
- "name": "purgeListeners",
- "sig": "()",
+ "name": "onPosition",
+ "sig": "(Number x, Number y)",
"type": "function",
- "desc": "Removes all listeners for this object"
+ "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."
},
{
- "name": "reconfigure",
- "sig": "(Roo.data.Store dataSource, Roo.grid.ColumnModel The)",
+ "name": "onResize",
+ "sig": "(Number adjWidth, Number adjHeight, Number rawWidth, Number rawHeight)",
"type": "function",
- "desc": "Reconfigures the grid to use a different Store and Column Model.\nThe View will be bound to the new objects and refreshed."
+ "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."
+ },
+ {
+ "name": "purgeListeners",
+ "sig": "()",
+ "type": "function",
+ "desc": "Removes all listeners for this object"
},
{
"name": "releaseCapture",
},
{
"name": "render",
- "sig": "()",
+ "sig": "(String/HTMLElement/Element container)",
"type": "function",
- "desc": "Called once after all setup has been completed and the grid is ready to be rendered."
+ "desc": "If this is a lazy rendering component, render it to its container element."
},
{
- "name": "startEditing",
- "sig": "(Number rowIndex, Number colIndex)",
+ "name": "reset",
+ "sig": "()",
"type": "function",
- "desc": "Starts editing the specified for the specified row/column"
+ "desc": "Resets the current field value to the originally-loaded value and clears any validation messages."
},
{
- "name": "stopEditing",
+ "name": "resetHasChanged",
"sig": "()",
"type": "function",
- "desc": "Stops any active editing"
+ "desc": "stores the current value in loadedValue"
+ },
+ {
+ "name": "selectText",
+ "sig": "(Number start, Number end)",
+ "type": "function",
+ "desc": "Selects text in this field"
+ },
+ {
+ "name": "setDisabled",
+ "sig": "(Boolean disabled)",
+ "type": "function",
+ "desc": "Convenience function for setting disabled/enabled by boolean."
+ },
+ {
+ "name": "setPagePosition",
+ "sig": "(Number x, Number y)",
+ "type": "function",
+ "desc": "Sets the page XY position of the component. To set the left and top instead, use {@link #setPosition}.\nThis method fires the move event."
+ },
+ {
+ "name": "setPosition",
+ "sig": "(Number left, Number top)",
+ "type": "function",
+ "desc": "Sets the left and top of the component. To set the page XY position instead, use {@link #setPagePosition}.\nThis method fires the move event."
+ },
+ {
+ "name": "setRawValue",
+ "sig": "(Mixed value)",
+ "type": "function",
+ "desc": "Sets the underlying DOM field's value directly, bypassing validation. To set the value with validation see {@link #setValue}."
+ },
+ {
+ "name": "setSize",
+ "sig": "(Number/Object width, Number height)",
+ "type": "function",
+ "desc": "Sets the width and height of the component. This method fires the resize event. This method can accept\neither width and height as separate numeric arguments, or you can pass a size object like {width:10, height:20}."
+ },
+ {
+ "name": "setValue",
+ "sig": "(Mixed value)",
+ "type": "function",
+ "desc": "Sets a data value into the field and validates it. To set the value directly without validation see {@link #setRawValue}."
+ },
+ {
+ "name": "setVisible",
+ "sig": "(Boolean visible)",
+ "type": "function",
+ "desc": "Convenience function to hide or show this component by boolean."
+ },
+ {
+ "name": "show",
+ "sig": "()",
+ "type": "function",
+ "desc": "Show this component."
+ },
+ {
+ "name": "syncSize",
+ "sig": "()",
+ "type": "function",
+ "desc": "Force the component's size to recalculate based on the underlying element's current height and width."
},
{
"name": "un",
"sig": "(String eventName, Function handler, Object scope)",
"type": "function",
"desc": "Removes a listener (shorthand for removeListener)"
+ },
+ {
+ "name": "updateBox",
+ "sig": "(Object box)",
+ "type": "function",
+ "desc": "Sets the current box measurements of the component's underlying element."
+ },
+ {
+ "name": "validate",
+ "sig": "()",
+ "type": "function",
+ "desc": "Validates the field value"
+ },
+ {
+ "name": "validateValue",
+ "sig": "(Mixed value)",
+ "type": "function",
+ "desc": "Validates a value according to the field's validation rules and marks the field as invalid\nif the validation fails"
}
]
},
- "Roo.grid.Grid": {
+ "Roo.form.TextField": {
"props": [
{
- "name": "ddGroup",
- "type": "String",
- "desc": "- drag drop group.",
- "memberOf": ""
- },
- {
- "name": "enableDrag",
+ "name": "grow",
"type": "Boolean",
- "desc": "True to enable drag of rows. Default is false. (double check if this is needed?)",
+ "desc": "True if this field should automatically grow and shrink to its content",
"memberOf": ""
},
{
- "name": "autoWidth",
- "type": "Boolean",
- "desc": "True to set the grid's width to the default total width of the grid's columns instead\nof a fixed width. Default is false.",
+ "name": "growMin",
+ "type": "Number",
+ "desc": "The minimum width to allow when grow = true (defaults to 30)",
"memberOf": ""
},
{
- "name": "maxHeight",
+ "name": "growMax",
"type": "Number",
- "desc": "Sets the maximum height of the grid - ignored if autoHeight is not on.",
+ "desc": "The maximum width to allow when grow = true (defaults to 800)",
"memberOf": ""
},
{
- "name": "minColumnWidth",
- "type": "Number",
- "desc": "The minimum width a column can be resized to. Default is 25.",
+ "name": "vtype",
+ "type": "String",
+ "desc": "A validation type name as defined in {@link Roo.form.VTypes} (defaults to null)",
"memberOf": ""
},
{
- "name": "autoSizeColumns",
- "type": "Boolean",
- "desc": "True to automatically resize the columns to fit their content\n<b>on initial render.</b> It is more efficient to explicitly size the columns\nthrough the ColumnModel's {@link Roo.grid.ColumnModel#width} config option. Default is false.",
+ "name": "maskRe",
+ "type": "String",
+ "desc": "An input mask regular expression that will be used to filter keystrokes that don't match (defaults to null)",
"memberOf": ""
},
{
- "name": "autoSizeHeaders",
+ "name": "disableKeyFilter",
"type": "Boolean",
- "desc": "True to measure headers with column data when auto sizing columns. Default is true.",
+ "desc": "True to disable input keystroke filtering (defaults to false)",
"memberOf": ""
},
{
- "name": "monitorWindowResize",
+ "name": "allowBlank",
"type": "Boolean",
- "desc": "True to autoSize the grid when the window resizes. Default is true.",
+ "desc": "False to validate that the value length > 0 (defaults to true)",
"memberOf": ""
},
{
- "name": "maxRowsToMeasure",
- "type": "Boolean",
- "desc": "If autoSizeColumns is on, maxRowsToMeasure can be used to limit the number of\nrows measured to get a columns size. Default is 0 (all rows).",
+ "name": "minLength",
+ "type": "Number",
+ "desc": "Minimum input field length required (defaults to 0)",
"memberOf": ""
},
{
- "name": "trackMouseOver",
- "type": "Boolean",
- "desc": "True to highlight rows when the mouse is over. Default is true.",
+ "name": "maxLength",
+ "type": "Number",
+ "desc": "Maximum input field length allowed (defaults to Number.MAX_VALUE)",
"memberOf": ""
},
{
- "name": "enableDragDrop",
- "type": "Boolean",
- "desc": "True to enable drag and drop of rows. Default is false.",
+ "name": "minLengthText",
+ "type": "String",
+ "desc": "Error text to display if the minimum length validation fails (defaults to \"The minimum length for this field is {minLength}\")",
"memberOf": ""
},
{
- "name": "enableColumnMove",
- "type": "Boolean",
- "desc": "True to enable drag and drop reorder of columns. Default is true.",
+ "name": "maxLengthText",
+ "type": "String",
+ "desc": "Error text to display if the maximum length validation fails (defaults to \"The maximum length for this field is {maxLength}\")",
"memberOf": ""
},
{
- "name": "enableColumnHide",
+ "name": "selectOnFocus",
"type": "Boolean",
- "desc": "True to enable hiding of columns with the header context menu. Default is true.",
+ "desc": "True to automatically select any existing field text when the field receives input focus (defaults to false)",
"memberOf": ""
},
{
- "name": "enableRowHeightSync",
- "type": "Boolean",
- "desc": "True to manually sync row heights across locked and not locked rows. Default is false.",
+ "name": "blankText",
+ "type": "String",
+ "desc": "Error text to display if the allow blank validation fails (defaults to \"This field is required\")",
"memberOf": ""
},
{
- "name": "stripeRows",
- "type": "Boolean",
- "desc": "True to stripe the rows. Default is true.",
+ "name": "validator",
+ "type": "Function",
+ "desc": "A custom validation function to be called during field validation (defaults to null).\nIf available, this function will be called only after the basic validators all return true, and will be passed the\ncurrent field value and expected to return boolean true if the value is valid or a string error message if invalid.",
"memberOf": ""
},
{
- "name": "autoHeight",
- "type": "Boolean",
- "desc": "True to fit the height of the grid container to the height of the data. Default is false.",
+ "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": ""
},
{
- "name": "autoExpandColumn",
+ "name": "regexText",
"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.",
+ "desc": "The error text to display if {@link #regex} is used and the test fails during validation (defaults to \"\")",
"memberOf": ""
},
{
- "name": "autoExpandMin",
- "type": "Number",
- "desc": "The minimum width the autoExpandColumn can have (if enabled).\nDefault is 50.",
+ "name": "emptyText",
+ "type": "String",
+ "desc": "The default text to display in an empty field - placeholder... (defaults to null).",
"memberOf": ""
},
{
- "name": "autoExpandMax",
+ "name": "fieldLabel",
+ "type": "String",
+ "desc": "Label to use when rendering a form.",
+ "memberOf": "Roo.form.Field"
+ },
+ {
+ "name": "qtip",
+ "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 CSS class to use when marking a field invalid (defaults to \"x-form-invalid\")",
+ "memberOf": "Roo.form.Field"
+ },
+ {
+ "name": "invalidText",
+ "type": "String",
+ "desc": "The error text to use when marking a field invalid and no message is provided (defaults to \"The value in this field is invalid\")",
+ "memberOf": "Roo.form.Field"
+ },
+ {
+ "name": "focusClass",
+ "type": "String",
+ "desc": "The CSS class to use when the field receives focus (defaults to \"x-form-focus\")",
+ "memberOf": "Roo.form.Field"
+ },
+ {
+ "name": "validationEvent",
+ "type": "String/Boolean",
+ "desc": "The event that should initiate field validation. Set to false to disable\n automatic validation (defaults to \"keyup\").",
+ "memberOf": "Roo.form.Field"
+ },
+ {
+ "name": "validateOnBlur",
+ "type": "Boolean",
+ "desc": "Whether the field should validate when it loses focus (defaults to true).",
+ "memberOf": "Roo.form.Field"
+ },
+ {
+ "name": "validationDelay",
"type": "Number",
- "desc": "The maximum width the autoExpandColumn can have (if enabled). Default is 1000.",
- "memberOf": ""
+ "desc": "The length of time in milliseconds after user input begins until validation is initiated (defaults to 250)",
+ "memberOf": "Roo.form.Field"
},
{
- "name": "view",
- "type": "Object",
- "desc": "The {@link Roo.grid.GridView} used by the grid. This can be set before a call to render().",
- "memberOf": ""
+ "name": "autoCreate",
+ "type": "String/Object",
+ "desc": "A DomHelper element spec, or true for a default element spec (defaults to\n{tag: \"input\", type: \"text\", size: \"20\", autocomplete: \"off\"})",
+ "memberOf": "Roo.form.Field"
},
{
- "name": "loadMask",
- "type": "Object",
- "desc": "An {@link Roo.LoadMask} config or true to mask the grid while loading. Default is false.",
- "memberOf": ""
+ "name": "fieldClass",
+ "type": "String",
+ "desc": "The default CSS class for the field (defaults to \"x-form-field\")",
+ "memberOf": "Roo.form.Field"
},
{
- "name": "dropTarget",
- "type": "Roo.dd.DropTarget",
- "desc": "An {@link Roo.dd.DropTarget} config",
- "memberOf": ""
+ "name": "msgTarget",
+ "type": "String",
+ "desc": "The location where error text should display. Should be one of the following values (defaults to 'qtip'):\n<pre>\nValue Description\n----------- ----------------------------------------------------------------------\nqtip Display a quick tip when the user hovers over the field\ntitle Display a default browser title attribute popup\nunder Add a block div beneath the field containing the error text\nside Add an error icon to the right of the field with a popup on hover\n[element id] Add the error text directly to the innerHTML of the specified element\n</pre>",
+ "memberOf": "Roo.form.Field"
},
{
- "name": "listeners",
- "type": "Object",
- "desc": "list of events and functions to call for 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": "msgFx",
+ "type": "String",
+ "desc": "<b>Experimental</b> The effect used when displaying a validation message under the field (defaults to 'normal').",
+ "memberOf": "Roo.form.Field"
+ },
{
- "name": "bodyscroll",
- "sig": "function (scrollLeft, scrollTop)\n{\n\n}",
- "type": "function",
- "desc": "Fires when the body element is scrolled"
+ "name": "readOnly",
+ "type": "Boolean",
+ "desc": "True to mark the field as readOnly in HTML (defaults to false) -- Note: this only sets the element's readOnly DOM attribute.",
+ "memberOf": "Roo.form.Field"
},
{
- "name": "cellclick",
- "sig": "function (_self, rowIndex, columnIndex, e)\n{\n\n}",
- "type": "function",
- "desc": "Fires when a cell is clicked"
+ "name": "disabled",
+ "type": "Boolean",
+ "desc": "True to disable the field (defaults to false).",
+ "memberOf": "Roo.form.Field"
},
{
- "name": "cellcontextmenu",
- "sig": "function (_self, rowIndex, cellIndex, e)\n{\n\n}",
- "type": "function",
- "desc": "Fires when a cell is right clicked"
+ "name": "inputType",
+ "type": "String",
+ "desc": "The type attribute for input fields -- e.g. radio, text, password (defaults to \"text\").",
+ "memberOf": "Roo.form.Field"
},
{
- "name": "celldblclick",
- "sig": "function (_self, rowIndex, columnIndex, e)\n{\n\n}",
- "type": "function",
- "desc": "Fires when a cell is double clicked"
+ "name": "tabIndex",
+ "type": "Number",
+ "desc": "The tabIndex for this field. Note this only applies to fields that are rendered, not those which are built via applyTo (defaults to undefined).",
+ "memberOf": "Roo.form.Field"
},
{
- "name": "click",
- "sig": "function (e)\n{\n\n}",
- "type": "function",
- "desc": "The raw click event for the entire grid."
+ "name": "value",
+ "type": "Mixed",
+ "desc": "A value to initialize this field with.",
+ "memberOf": "Roo.form.Field"
},
{
- "name": "columnmove",
- "sig": "function (oldIndex, newIndex)\n{\n\n}",
- "type": "function",
- "desc": "Fires when the user moves a column"
+ "name": "cls",
+ "type": "String",
+ "desc": "A CSS class to apply to the field's underlying element.",
+ "memberOf": "Roo.form.Field"
},
{
- "name": "columnresize",
- "sig": "function (columnIndex, newSize)\n{\n\n}",
- "type": "function",
- "desc": "Fires when the user resizes a column"
+ "name": "width",
+ "type": "Number",
+ "desc": "width (optional) size of component",
+ "memberOf": "Roo.BoxComponent"
},
{
- "name": "contextmenu",
- "sig": "function (e)\n{\n\n}",
- "type": "function",
- "desc": "The raw contextmenu event for the entire grid."
+ "name": "height",
+ "type": "Number",
+ "desc": "height (optional) size of component",
+ "memberOf": "Roo.BoxComponent"
},
{
- "name": "dblclick",
- "sig": "function (e)\n{\n\n}",
- "type": "function",
- "desc": "The raw dblclick event for the entire grid."
+ "name": "disableClass",
+ "type": "String",
+ "desc": "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").",
+ "memberOf": "Roo.Component"
},
{
- "name": "dragdrop",
- "sig": "function (_self, dd, targetId, e)\n{\n\n}",
+ "name": "allowDomMove",
+ "type": "Boolean",
+ "desc": "Whether the component can move the Dom node when rendering (defaults to true).",
+ "memberOf": "Roo.Component"
+ },
+ {
+ "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\".",
+ "memberOf": "Roo.Component",
+ "optvals": [
+ "display",
+ "visibility"
+ ]
+ },
+ {
+ "name": "actionMode",
+ "type": "String",
+ "desc": "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el'",
+ "memberOf": "Roo.Component"
+ },
+ {
+ "name": "listeners",
+ "type": "Object",
+ "desc": "list of events and functions to call for 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": "autosize",
+ "sig": "function (_self, width)\n{\n\n}",
"type": "function",
- "desc": "Fires when dragged row(s) are dropped on a valid DD target"
+ "desc": "Fires when the autosize function is triggered. The field may or may not have actually changed size\naccording to the default logic, but this event provides a hook for the developer to apply additional\nlogic at runtime to resize the field if needed."
},
{
- "name": "dragenter\n Fires when the dragged row(s) first cross another DD target while being dragged",
- "sig": "function (_self, dd, targetId, e)\n{\n\n}",
+ "name": "beforedestroy",
+ "sig": "function (_self)\n{\n\n}",
"type": "function",
- "desc": ""
+ "desc": "Fires before the component is destroyed. Return false to stop the destroy."
},
{
- "name": "dragout",
- "sig": "function (_self, dd, targetId, e)\n{\n\n}",
+ "name": "beforehide",
+ "sig": "function (_self)\n{\n\n}",
"type": "function",
- "desc": "Fires when the dragged row(s) leave another DD target while being dragged"
+ "desc": "Fires before the component is hidden. Return false to stop the hide."
},
{
- "name": "dragover",
- "sig": "function (_self, dd, targetId, e)\n{\n\n}",
+ "name": "beforerender",
+ "sig": "function (_self)\n{\n\n}",
"type": "function",
- "desc": "Fires while row(s) are being dragged. \"targetId\" is the id of the Yahoo.util.DD object the selected rows are being dragged over."
+ "desc": "Fires before the component is rendered. Return false to stop the render."
},
{
- "name": "enddrag",
- "sig": "function (_self, dd, e)\n{\n\n}",
+ "name": "beforeshow",
+ "sig": "function (_self)\n{\n\n}",
"type": "function",
- "desc": "Fires when a drag operation is complete"
+ "desc": "Fires before the component is shown. Return false to stop the show."
},
{
- "name": "headerclick",
- "sig": "function (_self, columnIndex, e)\n{\n\n}",
+ "name": "blur",
+ "sig": "function (_self)\n{\n\n}",
"type": "function",
- "desc": "Fires when a header is clicked"
+ "desc": "Fires when this field loses input focus."
},
{
- "name": "headercontextmenu",
- "sig": "function (_self, columnIndex, e)\n{\n\n}",
+ "name": "change",
+ "sig": "function (_self, newValue, oldValue)\n{\n\n}",
"type": "function",
- "desc": "Fires when a header is right clicked"
+ "desc": "Fires just before the field blurs if the field value has changed."
},
{
- "name": "headerdblclick",
- "sig": "function (_self, columnIndex, e)\n{\n\n}",
+ "name": "destroy",
+ "sig": "function (_self)\n{\n\n}",
"type": "function",
- "desc": "Fires when a header cell is double clicked"
+ "desc": "Fires after the component is destroyed."
},
{
- "name": "keydown",
- "sig": "function (e)\n{\n\n}",
+ "name": "disable",
+ "sig": "function (_self)\n{\n\n}",
"type": "function",
- "desc": "The raw keydown event for the entire grid."
+ "desc": "Fires after the component is disabled."
},
{
- "name": "keypress",
- "sig": "function (e)\n{\n\n}",
+ "name": "enable",
+ "sig": "function (_self)\n{\n\n}",
"type": "function",
- "desc": "The raw keypress event for the entire grid."
+ "desc": "Fires after the component is enabled."
},
{
- "name": "mousedown",
- "sig": "function (e)\n{\n\n}",
+ "name": "focus",
+ "sig": "function (_self)\n{\n\n}",
"type": "function",
- "desc": "The raw mousedown event for the entire grid."
+ "desc": "Fires when this field receives input focus."
},
{
- "name": "mouseout",
- "sig": "function (e)\n{\n\n}",
+ "name": "hide",
+ "sig": "function (_self)\n{\n\n}",
"type": "function",
- "desc": "The raw mouseout event for the entire grid."
+ "desc": "Fires after the component is hidden."
},
{
- "name": "mouseover",
- "sig": "function (e)\n{\n\n}",
+ "name": "invalid",
+ "sig": "function (_self, msg)\n{\n\n}",
"type": "function",
- "desc": "The raw mouseover event for the entire grid."
+ "desc": "Fires after the field has been marked as invalid."
},
{
- "name": "mouseup",
- "sig": "function (e)\n{\n\n}",
+ "name": "keyup",
+ "sig": "function (_self, e)\n{\n\n}",
"type": "function",
- "desc": "The raw mouseup event for the entire grid."
+ "desc": "Fires after the key up"
},
{
- "name": "render",
- "sig": "function (grid)\n{\n\n}",
+ "name": "move",
+ "sig": "function (_self, x, y)\n{\n\n}",
"type": "function",
- "desc": "Fires when the grid is rendered"
+ "desc": "Fires after the component is moved."
},
{
- "name": "rowclass",
- "sig": "function (gridview, rowcfg)\n{\n\n}",
+ "name": "render",
+ "sig": "function (_self)\n{\n\n}",
"type": "function",
- "desc": "Fires when a row is rendered, so you can change add a style to it."
+ "desc": "Fires after the component is rendered."
},
{
- "name": "rowclick",
- "sig": "function (_self, rowIndex, e)\n{\n\n}",
+ "name": "resize",
+ "sig": "function (_self, adjWidth, adjHeight, rawWidth, rawHeight)\n{\n\n}",
"type": "function",
- "desc": "Fires when a row is clicked"
+ "desc": "Fires after the component is resized."
},
{
- "name": "rowcontextmenu",
- "sig": "function (_self, rowIndex, e)\n{\n\n}",
+ "name": "show",
+ "sig": "function (_self)\n{\n\n}",
"type": "function",
- "desc": "Fires when a row is right clicked"
+ "desc": "Fires after the component is shown."
},
{
- "name": "rowdblclick",
- "sig": "function (_self, rowIndex, e)\n{\n\n}",
+ "name": "specialkey",
+ "sig": "function (_self, e)\n{\n\n}",
"type": "function",
- "desc": "Fires when a row is double clicked"
+ "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."
},
{
- "name": "startdrag",
- "sig": "function (_self, dd, e)\n{\n\n}",
+ "name": "valid",
+ "sig": "function (_self)\n{\n\n}",
"type": "function",
- "desc": "Fires when row(s) start being dragged"
+ "desc": "Fires after the field has been validated with no errors."
}
],
"methods": [
"type": "function",
"desc": "Appends an event handler to this component"
},
+ {
+ "name": "applyTo",
+ "sig": "(String/HTMLElement/Element el)",
+ "type": "function",
+ "desc": "Apply the behaviors of this component to an existing element. <b>This is used instead of render().</b>"
+ },
{
"name": "autoSize",
"sig": "()",
"type": "function",
- "desc": "Causes the grid to manually recalculate its dimensions. Generally this is done automatically,\nbut if manual update is required this method will initiate it."
+ "desc": "Automatically grows the field to accomodate the width of the text up to the maximum field width allowed.\nThis only takes effect if grow = true, and fires the autosize event."
},
{
"name": "capture",
"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."
},
{
- "name": "destroy",
- "sig": "(Boolean removeEl)",
+ "name": "clearInvalid",
+ "sig": "()",
"type": "function",
- "desc": "Destroy this grid."
+ "desc": "Clear any invalid styles/messages for this field"
},
{
- "name": "fireEvent",
- "sig": "(String eventName, Object... args)",
+ "name": "destroy",
+ "sig": "()",
"type": "function",
- "desc": "Fires the specified event with the passed parameters (minus the event name)."
+ "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}."
},
{
- "name": "getColumnModel",
+ "name": "disable",
"sig": "()",
"type": "function",
- "desc": "Returns the grid's ColumnModel."
+ "desc": "Disable this component."
},
{
- "name": "getDataSource",
+ "name": "enable",
"sig": "()",
"type": "function",
- "desc": "Returns the grid's DataSource."
+ "desc": "Enable this component."
},
{
- "name": "getDragDropText",
+ "name": "fireEvent",
+ "sig": "(String eventName, Object... args)",
+ "type": "function",
+ "desc": "Fires the specified event with the passed parameters (minus the event name)."
+ },
+ {
+ "name": "focus",
+ "sig": "(Boolean selectText)",
+ "type": "function",
+ "desc": "Try to focus this component."
+ },
+ {
+ "name": "getBox",
+ "sig": "(Boolean local)",
+ "type": "function",
+ "desc": "Gets the current box measurements of the component's underlying element."
+ },
+ {
+ "name": "getEl",
"sig": "()",
"type": "function",
- "desc": "Called to get grid's drag proxy text, by default returns this.ddText."
+ "desc": "Returns the underlying {@link Roo.Element}."
},
{
- "name": "getGridEl",
+ "name": "getId",
"sig": "()",
"type": "function",
- "desc": "Returns the grid's underlying element."
+ "desc": "Returns the id of this component."
},
{
- "name": "getSelectionModel",
+ "name": "getName",
"sig": "()",
"type": "function",
- "desc": "Returns the grid's SelectionModel."
+ "desc": "Returns the name attribute of the field if available"
},
{
- "name": "getView",
+ "name": "getPosition",
+ "sig": "(Boolean local)",
+ "type": "function",
+ "desc": "Gets the current XY position of the component's underlying element."
+ },
+ {
+ "name": "getRawValue",
"sig": "()",
"type": "function",
- "desc": "Returns the grid's GridView object."
+ "desc": "Returns the raw data value which may or may not be a valid, defined value. To return a normalized value see {@link #getValue}."
+ },
+ {
+ "name": "getSize",
+ "sig": "()",
+ "type": "function",
+ "desc": "Gets the current size of the component's underlying element."
+ },
+ {
+ "name": "getValue",
+ "sig": "()",
+ "type": "function",
+ "desc": "Returns the normalized data value (undefined or emptyText will be returned as ''). To return the raw value see {@link #getRawValue}."
+ },
+ {
+ "name": "hasChanged",
+ "sig": "()",
+ "type": "function",
+ "desc": "checks the current value against the 'loaded' value.\nNote - will return false if 'resetHasChanged' has not been called first."
},
{
"name": "hasListener",
"type": "function",
"desc": "Checks to see if this object has any listeners for a specified event"
},
+ {
+ "name": "hide",
+ "sig": "()",
+ "type": "function",
+ "desc": "Hide this component."
+ },
+ {
+ "name": "isDirty",
+ "sig": "()",
+ "type": "function",
+ "desc": "Returns true if this field has been changed since it was originally loaded and is not disabled.\nDEPRICATED - it never worked well - use hasChanged/resetHasChanged."
+ },
+ {
+ "name": "isValid",
+ "sig": "(Boolean preventMark)",
+ "type": "function",
+ "desc": "Returns whether or not the field value is currently valid"
+ },
+ {
+ "name": "isVisible",
+ "sig": "()",
+ "type": "function",
+ "desc": "Returns true if this component is visible."
+ },
+ {
+ "name": "markInvalid",
+ "sig": "(String msg)",
+ "type": "function",
+ "desc": "Mark this field as invalid"
+ },
{
"name": "on",
"sig": "(String eventName, Function handler, Object scope, Object options)",
"desc": "Appends an event handler to this element (shorthand for addListener)"
},
{
- "name": "purgeListeners",
- "sig": "()",
+ "name": "onPosition",
+ "sig": "(Number x, Number y)",
"type": "function",
- "desc": "Removes all listeners for this object"
+ "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."
},
{
- "name": "reconfigure",
- "sig": "(Roo.data.Store dataSource, Roo.grid.ColumnModel The)",
+ "name": "onResize",
+ "sig": "(Number adjWidth, Number adjHeight, Number rawWidth, Number rawHeight)",
"type": "function",
- "desc": "Reconfigures the grid to use a different Store and Column Model.\nThe View will be bound to the new objects and refreshed."
+ "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."
+ },
+ {
+ "name": "purgeListeners",
+ "sig": "()",
+ "type": "function",
+ "desc": "Removes all listeners for this object"
},
{
"name": "releaseCapture",
},
{
"name": "render",
+ "sig": "(String/HTMLElement/Element container)",
+ "type": "function",
+ "desc": "If this is a lazy rendering component, render it to its container element."
+ },
+ {
+ "name": "reset",
"sig": "()",
"type": "function",
- "desc": "Called once after all setup has been completed and the grid is ready to be rendered."
+ "desc": "Resets the current field value to the originally-loaded value and clears any validation messages."
+ },
+ {
+ "name": "resetHasChanged",
+ "sig": "()",
+ "type": "function",
+ "desc": "stores the current value in loadedValue"
+ },
+ {
+ "name": "selectText",
+ "sig": "(Number start, Number end)",
+ "type": "function",
+ "desc": "Selects text in this field"
+ },
+ {
+ "name": "setDisabled",
+ "sig": "(Boolean disabled)",
+ "type": "function",
+ "desc": "Convenience function for setting disabled/enabled by boolean."
+ },
+ {
+ "name": "setPagePosition",
+ "sig": "(Number x, Number y)",
+ "type": "function",
+ "desc": "Sets the page XY position of the component. To set the left and top instead, use {@link #setPosition}.\nThis method fires the move event."
+ },
+ {
+ "name": "setPosition",
+ "sig": "(Number left, Number top)",
+ "type": "function",
+ "desc": "Sets the left and top of the component. To set the page XY position instead, use {@link #setPagePosition}.\nThis method fires the move event."
+ },
+ {
+ "name": "setRawValue",
+ "sig": "(Mixed value)",
+ "type": "function",
+ "desc": "Sets the underlying DOM field's value directly, bypassing validation. To set the value with validation see {@link #setValue}."
+ },
+ {
+ "name": "setSize",
+ "sig": "(Number/Object width, Number height)",
+ "type": "function",
+ "desc": "Sets the width and height of the component. This method fires the resize event. This method can accept\neither width and height as separate numeric arguments, or you can pass a size object like {width:10, height:20}."
+ },
+ {
+ "name": "setValue",
+ "sig": "(Mixed value)",
+ "type": "function",
+ "desc": "Sets a data value into the field and validates it. To set the value directly without validation see {@link #setRawValue}."
+ },
+ {
+ "name": "setVisible",
+ "sig": "(Boolean visible)",
+ "type": "function",
+ "desc": "Convenience function to hide or show this component by boolean."
+ },
+ {
+ "name": "show",
+ "sig": "()",
+ "type": "function",
+ "desc": "Show this component."
+ },
+ {
+ "name": "syncSize",
+ "sig": "()",
+ "type": "function",
+ "desc": "Force the component's size to recalculate based on the underlying element's current height and width."
},
{
"name": "un",
"sig": "(String eventName, Function handler, Object scope)",
"type": "function",
"desc": "Removes a listener (shorthand for removeListener)"
+ },
+ {
+ "name": "updateBox",
+ "sig": "(Object box)",
+ "type": "function",
+ "desc": "Sets the current box measurements of the component's underlying element."
+ },
+ {
+ "name": "validate",
+ "sig": "()",
+ "type": "function",
+ "desc": "Validates the field value"
+ },
+ {
+ "name": "validateValue",
+ "sig": "(Mixed value)",
+ "type": "function",
+ "desc": "Validates a value according to the field's validation rules and marks the field as invalid\nif the validation fails"
}
]
},
- "Roo.grid.GridEditor": {
+ "Roo.form.TriggerField": {
"props": [
{
- "name": "field",
- "type": "Roo.form.Field",
- "desc": "Field to wrap (or xtyped)",
+ "name": "triggerClass",
+ "type": "String",
+ "desc": "An additional CSS class used to style the trigger button. The trigger will always get the\nclass 'x-form-trigger' by default and triggerClass will be <b>appended</b> if specified.",
"memberOf": ""
},
{
- "name": "autosize",
- "type": "Boolean/String",
- "desc": "True for the editor to automatically adopt the size of the underlying field, \"width\" to adopt the width only,\nor \"height\" to adopt the height only (defaults to false)",
- "memberOf": "Roo.Editor"
+ "name": "autoCreate",
+ "type": "String/Object",
+ "desc": "A DomHelper element spec, or true for a default element spec (defaults to\n{tag: \"input\", type: \"text\", size: \"16\", autocomplete: \"off\"})",
+ "memberOf": ""
},
{
- "name": "revertInvalid",
+ "name": "hideTrigger",
"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"
+ "desc": "True to hide the trigger element and display only the base text field (defaults to false)",
+ "memberOf": ""
},
{
- "name": "ignoreNoChange",
+ "name": "vtype",
+ "type": "String",
+ "desc": "A validation type name as defined in {@link Roo.form.VTypes} (defaults to null)",
+ "memberOf": "Roo.form.TextField"
+ },
+ {
+ "name": "maskRe",
+ "type": "String",
+ "desc": "An input mask regular expression that will be used to filter keystrokes that don't match (defaults to null)",
+ "memberOf": "Roo.form.TextField"
+ },
+ {
+ "name": "disableKeyFilter",
"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"
+ "desc": "True to disable input keystroke filtering (defaults to false)",
+ "memberOf": "Roo.form.TextField"
},
{
- "name": "hideEl",
+ "name": "allowBlank",
"type": "Boolean",
- "desc": "False to keep the bound element visible while the editor is displayed (defaults to true)",
- "memberOf": "Roo.Editor"
+ "desc": "False to validate that the value length > 0 (defaults to true)",
+ "memberOf": "Roo.form.TextField"
},
{
- "name": "value",
- "type": "Mixed",
- "desc": "The data value of the underlying field (defaults to \"\")",
- "memberOf": "Roo.Editor"
+ "name": "minLength",
+ "type": "Number",
+ "desc": "Minimum input field length required (defaults to 0)",
+ "memberOf": "Roo.form.TextField"
},
{
- "name": "alignment",
+ "name": "maxLength",
+ "type": "Number",
+ "desc": "Maximum input field length allowed (defaults to Number.MAX_VALUE)",
+ "memberOf": "Roo.form.TextField"
+ },
+ {
+ "name": "minLengthText",
"type": "String",
- "desc": "The position to align to (see {@link Roo.Element#alignTo} for more details, defaults to \"c-c?\").",
- "memberOf": "Roo.Editor"
+ "desc": "Error text to display if the minimum length validation fails (defaults to \"The minimum length for this field is {minLength}\")",
+ "memberOf": "Roo.form.TextField"
},
{
- "name": "shadow",
- "type": "Boolean/String",
- "desc": "\"sides\" for sides/bottom only, \"frame\" for 4-way shadow, and \"drop\"\nfor bottom-right shadow (defaults to \"frame\")",
- "memberOf": "Roo.Editor"
+ "name": "maxLengthText",
+ "type": "String",
+ "desc": "Error text to display if the maximum length validation fails (defaults to \"The maximum length for this field is {maxLength}\")",
+ "memberOf": "Roo.form.TextField"
},
{
- "name": "constrain",
+ "name": "selectOnFocus",
"type": "Boolean",
- "desc": "True to constrain the editor to the viewport",
- "memberOf": "Roo.Editor"
+ "desc": "True to automatically select any existing field text when the field receives input focus (defaults to false)",
+ "memberOf": "Roo.form.TextField"
},
{
- "name": "completeOnEnter",
+ "name": "blankText",
+ "type": "String",
+ "desc": "Error text to display if the allow blank validation fails (defaults to \"This field is required\")",
+ "memberOf": "Roo.form.TextField"
+ },
+ {
+ "name": "validator",
+ "type": "Function",
+ "desc": "A custom validation function to be called during field validation (defaults to null).\nIf available, this function will be called only after the basic validators all return true, and will be passed the\ncurrent field value and expected to return boolean true if the value is valid or a string error message if invalid.",
+ "memberOf": "Roo.form.TextField"
+ },
+ {
+ "name": "regex",
+ "type": "RegExp",
+ "desc": "A JavaScript RegExp object to be tested against the field value during validation (defaults to null).\nIf available, this regex will be evaluated only after the basic validators all return true, and will be passed the\ncurrent field value. If the test fails, the field will be marked invalid using {@link #regexText}.",
+ "memberOf": "Roo.form.TextField"
+ },
+ {
+ "name": "regexText",
+ "type": "String",
+ "desc": "The error text to display if {@link #regex} is used and the test fails during validation (defaults to \"\")",
+ "memberOf": "Roo.form.TextField"
+ },
+ {
+ "name": "emptyText",
+ "type": "String",
+ "desc": "The default text to display in an empty field - placeholder... (defaults to null).",
+ "memberOf": "Roo.form.TextField"
+ },
+ {
+ "name": "fieldLabel",
+ "type": "String",
+ "desc": "Label to use when rendering a form.",
+ "memberOf": "Roo.form.Field"
+ },
+ {
+ "name": "qtip",
+ "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 CSS class to use when marking a field invalid (defaults to \"x-form-invalid\")",
+ "memberOf": "Roo.form.Field"
+ },
+ {
+ "name": "invalidText",
+ "type": "String",
+ "desc": "The error text to use when marking a field invalid and no message is provided (defaults to \"The value in this field is invalid\")",
+ "memberOf": "Roo.form.Field"
+ },
+ {
+ "name": "focusClass",
+ "type": "String",
+ "desc": "The CSS class to use when the field receives focus (defaults to \"x-form-focus\")",
+ "memberOf": "Roo.form.Field"
+ },
+ {
+ "name": "validationEvent",
+ "type": "String/Boolean",
+ "desc": "The event that should initiate field validation. Set to false to disable\n automatic validation (defaults to \"keyup\").",
+ "memberOf": "Roo.form.Field"
+ },
+ {
+ "name": "validateOnBlur",
"type": "Boolean",
- "desc": "True to complete the edit when the enter key is pressed (defaults to false)",
- "memberOf": "Roo.Editor"
+ "desc": "Whether the field should validate when it loses focus (defaults to true).",
+ "memberOf": "Roo.form.Field"
},
{
- "name": "cancelOnEsc",
+ "name": "validationDelay",
+ "type": "Number",
+ "desc": "The length of time in milliseconds after user input begins until validation is initiated (defaults to 250)",
+ "memberOf": "Roo.form.Field"
+ },
+ {
+ "name": "fieldClass",
+ "type": "String",
+ "desc": "The default CSS class for the field (defaults to \"x-form-field\")",
+ "memberOf": "Roo.form.Field"
+ },
+ {
+ "name": "msgTarget",
+ "type": "String",
+ "desc": "The location where error text should display. Should be one of the following values (defaults to 'qtip'):\n<pre>\nValue Description\n----------- ----------------------------------------------------------------------\nqtip Display a quick tip when the user hovers over the field\ntitle Display a default browser title attribute popup\nunder Add a block div beneath the field containing the error text\nside Add an error icon to the right of the field with a popup on hover\n[element id] Add the error text directly to the innerHTML of the specified element\n</pre>",
+ "memberOf": "Roo.form.Field"
+ },
+ {
+ "name": "msgFx",
+ "type": "String",
+ "desc": "<b>Experimental</b> The effect used when displaying a validation message under the field (defaults to 'normal').",
+ "memberOf": "Roo.form.Field"
+ },
+ {
+ "name": "readOnly",
"type": "Boolean",
- "desc": "True to cancel the edit when the escape key is pressed (defaults to false)",
- "memberOf": "Roo.Editor"
+ "desc": "True to mark the field as readOnly in HTML (defaults to false) -- Note: this only sets the element's readOnly DOM attribute.",
+ "memberOf": "Roo.form.Field"
},
{
- "name": "updateEl",
+ "name": "disabled",
"type": "Boolean",
- "desc": "True to update the innerHTML of the bound element when the update completes (defaults to false)",
- "memberOf": "Roo.Editor"
+ "desc": "True to disable the field (defaults to false).",
+ "memberOf": "Roo.form.Field"
+ },
+ {
+ "name": "inputType",
+ "type": "String",
+ "desc": "The type attribute for input fields -- e.g. radio, text, password (defaults to \"text\").",
+ "memberOf": "Roo.form.Field"
+ },
+ {
+ "name": "tabIndex",
+ "type": "Number",
+ "desc": "The tabIndex for this field. Note this only applies to fields that are rendered, not those which are built via applyTo (defaults to undefined).",
+ "memberOf": "Roo.form.Field"
+ },
+ {
+ "name": "value",
+ "type": "Mixed",
+ "desc": "A value to initialize this field with.",
+ "memberOf": "Roo.form.Field"
+ },
+ {
+ "name": "cls",
+ "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",
+ "desc": "height (optional) size of component",
+ "memberOf": "Roo.BoxComponent"
},
{
"name": "disableClass",
],
"events": [
{
- "name": "beforecomplete",
- "sig": "function (_self, value, startValue)\n{\n\n}",
+ "name": "autosize",
+ "sig": "function (_self, width)\n{\n\n}",
"type": "function",
- "desc": "Fires after a change has been made to the field, but before the change is reflected in the underlying\nfield. Saving the change to the field can be canceled by returning false from the handler of this event.\nNote that if the value has not changed and ignoreNoChange = true, the editing will still end but this\nevent will not fire since no edit actually occurred."
+ "desc": "Fires when the autosize function is triggered. The field may or may not have actually changed size\naccording to the default logic, but this event provides a hook for the developer to apply additional\nlogic at runtime to resize the field if needed."
},
{
"name": "beforedestroy",
"desc": "Fires before the component is shown. Return false to stop the show."
},
{
- "name": "beforestartedit",
- "sig": "function (_self, boundEl, value)\n{\n\n}",
+ "name": "blur",
+ "sig": "function (_self)\n{\n\n}",
"type": "function",
- "desc": "Fires when editing is initiated, but before the value changes. Editing can be canceled by returning\nfalse from the handler of this event."
+ "desc": "Fires when this field loses input focus."
},
{
- "name": "complete",
- "sig": "function (_self, value, startValue)\n{\n\n}",
+ "name": "change",
+ "sig": "function (_self, newValue, oldValue)\n{\n\n}",
"type": "function",
- "desc": "Fires after editing is complete and any changed value has been written to the underlying field."
+ "desc": "Fires just before the field blurs if the field value has changed."
},
{
"name": "destroy",
"type": "function",
"desc": "Fires after the component is enabled."
},
+ {
+ "name": "focus",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires when this field receives input focus."
+ },
{
"name": "hide",
"sig": "function (_self)\n{\n\n}",
"type": "function",
"desc": "Fires after the component is hidden."
},
+ {
+ "name": "invalid",
+ "sig": "function (_self, msg)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires after the field has been marked as invalid."
+ },
+ {
+ "name": "keyup",
+ "sig": "function (_self, e)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires after the key up"
+ },
+ {
+ "name": "move",
+ "sig": "function (_self, x, y)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires after the component is moved."
+ },
{
"name": "render",
"sig": "function (_self)\n{\n\n}",
"type": "function",
"desc": "Fires after the component is rendered."
},
+ {
+ "name": "resize",
+ "sig": "function (_self, adjWidth, adjHeight, rawWidth, rawHeight)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires after the component is resized."
+ },
{
"name": "show",
"sig": "function (_self)\n{\n\n}",
"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."
},
{
- "name": "startedit",
- "sig": "function (boundEl, value)\n{\n\n}",
+ "name": "valid",
+ "sig": "function (_self)\n{\n\n}",
"type": "function",
- "desc": "Fires when this editor is displayed"
+ "desc": "Fires after the field has been validated with no errors."
}
],
"methods": [
"desc": "Appends an event handler to this component"
},
{
- "name": "cancelEdit",
- "sig": "(Boolean remainVisible)",
+ "name": "applyTo",
+ "sig": "(String/HTMLElement/Element el)",
"type": "function",
- "desc": "Cancels the editing process and hides the editor without persisting any changes. The field value will be\nreverted to the original starting value."
+ "desc": "Apply the behaviors of this component to an existing element. <b>This is used instead of render().</b>"
},
{
"name": "capture",
"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."
},
{
- "name": "completeEdit",
- "sig": "(Boolean remainVisible)",
+ "name": "clearInvalid",
+ "sig": "()",
"type": "function",
- "desc": "Ends the editing process, persists the changed value to the underlying field, and hides the editor."
+ "desc": "Clear any invalid styles/messages for this field"
},
{
"name": "destroy",
"type": "function",
"desc": "Try to focus this component."
},
+ {
+ "name": "getBox",
+ "sig": "(Boolean local)",
+ "type": "function",
+ "desc": "Gets the current box measurements of the component's underlying element."
+ },
{
"name": "getEl",
"sig": "()",
"desc": "Returns the id of this component."
},
{
- "name": "getValue",
+ "name": "getName",
"sig": "()",
"type": "function",
- "desc": "Gets the data value of the editor"
+ "desc": "Returns the name attribute of the field if available"
},
{
- "name": "hasListener",
- "sig": "(String eventName)",
+ "name": "getPosition",
+ "sig": "(Boolean local)",
"type": "function",
- "desc": "Checks to see if this object has any listeners for a specified event"
+ "desc": "Gets the current XY position of the component's underlying element."
+ },
+ {
+ "name": "getRawValue",
+ "sig": "()",
+ "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}."
+ },
+ {
+ "name": "getSize",
+ "sig": "()",
+ "type": "function",
+ "desc": "Gets the current size of the component's underlying element."
+ },
+ {
+ "name": "getValue",
+ "sig": "()",
+ "type": "function",
+ "desc": "Returns the normalized data value (undefined or emptyText will be returned as ''). To return the raw value see {@link #getRawValue}."
+ },
+ {
+ "name": "hasChanged",
+ "sig": "()",
+ "type": "function",
+ "desc": "checks the current value against the 'loaded' value.\nNote - will return false if 'resetHasChanged' has not been called first."
+ },
+ {
+ "name": "hasListener",
+ "sig": "(String eventName)",
+ "type": "function",
+ "desc": "Checks to see if this object has any listeners for a specified event"
},
{
"name": "hide",
"type": "function",
"desc": "Hide this component."
},
+ {
+ "name": "isDirty",
+ "sig": "()",
+ "type": "function",
+ "desc": "Returns true if this field has been changed since it was originally loaded and is not disabled.\nDEPRICATED - it never worked well - use hasChanged/resetHasChanged."
+ },
+ {
+ "name": "isValid",
+ "sig": "(Boolean preventMark)",
+ "type": "function",
+ "desc": "Returns whether or not the field value is currently valid"
+ },
{
"name": "isVisible",
"sig": "()",
"type": "function",
"desc": "Returns true if this component is visible."
},
+ {
+ "name": "markInvalid",
+ "sig": "(String msg)",
+ "type": "function",
+ "desc": "Mark this field as invalid"
+ },
{
"name": "on",
"sig": "(String eventName, Function handler, Object scope, Object options)",
"desc": "Appends an event handler to this element (shorthand for addListener)"
},
{
- "name": "purgeListeners",
- "sig": "()",
+ "name": "onPosition",
+ "sig": "(Number x, Number y)",
"type": "function",
- "desc": "Removes all listeners for this object"
+ "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."
},
{
- "name": "realign",
+ "name": "onResize",
+ "sig": "(Number adjWidth, Number adjHeight, Number rawWidth, Number rawHeight)",
+ "type": "function",
+ "desc": "Called after the component is resized, this method is empty by default but can be implemented by any\nsubclass that needs to perform custom logic after a resize occurs."
+ },
+ {
+ "name": "onTriggerClick",
+ "sig": "(EventObject e)",
+ "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."
+ },
+ {
+ "name": "purgeListeners",
"sig": "()",
"type": "function",
- "desc": "Realigns the editor to the bound field based on the current alignment config value."
+ "desc": "Removes all listeners for this object"
},
{
"name": "releaseCapture",
"type": "function",
"desc": "If this is a lazy rendering component, render it to its container element."
},
+ {
+ "name": "reset",
+ "sig": "()",
+ "type": "function",
+ "desc": "Resets the current field value to the originally-loaded value and clears any validation messages."
+ },
+ {
+ "name": "resetHasChanged",
+ "sig": "()",
+ "type": "function",
+ "desc": "stores the current value in loadedValue"
+ },
+ {
+ "name": "selectText",
+ "sig": "(Number start, Number end)",
+ "type": "function",
+ "desc": "Selects text in this field"
+ },
{
"name": "setDisabled",
"sig": "(Boolean disabled)",
"type": "function",
"desc": "Convenience function for setting disabled/enabled by boolean."
},
+ {
+ "name": "setPagePosition",
+ "sig": "(Number x, Number y)",
+ "type": "function",
+ "desc": "Sets the page XY position of the component. To set the left and top instead, use {@link #setPosition}.\nThis method fires the move event."
+ },
+ {
+ "name": "setPosition",
+ "sig": "(Number left, Number top)",
+ "type": "function",
+ "desc": "Sets the left and top of the component. To set the page XY position instead, use {@link #setPagePosition}.\nThis method fires the move event."
+ },
+ {
+ "name": "setRawValue",
+ "sig": "(Mixed value)",
+ "type": "function",
+ "desc": "Sets the underlying DOM field's value directly, bypassing validation. To set the value with validation see {@link #setValue}."
+ },
{
"name": "setSize",
- "sig": "(Number width, Number height)",
+ "sig": "(Number/Object width, Number height)",
"type": "function",
- "desc": "Sets the height and width of this editor."
+ "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}."
},
{
"name": "setValue",
"sig": "(Mixed value)",
"type": "function",
- "desc": "Sets the data value of the editor"
+ "desc": "Sets a data value into the field and validates it. To set the value directly without validation see {@link #setRawValue}."
},
{
"name": "setVisible",
"desc": "Show this component."
},
{
- "name": "startEdit",
- "sig": "(String/HTMLElement/Element el, String value)",
+ "name": "syncSize",
+ "sig": "()",
"type": "function",
- "desc": "Starts the editing process and shows the editor."
+ "desc": "Force the component's size to recalculate based on the underlying element's current height and width."
},
{
"name": "un",
"sig": "(String eventName, Function handler, Object scope)",
"type": "function",
"desc": "Removes a listener (shorthand for removeListener)"
+ },
+ {
+ "name": "updateBox",
+ "sig": "(Object box)",
+ "type": "function",
+ "desc": "Sets the current box measurements of the component's underlying element."
+ },
+ {
+ "name": "validate",
+ "sig": "()",
+ "type": "function",
+ "desc": "Validates the field value"
+ },
+ {
+ "name": "validateValue",
+ "sig": "(Mixed value)",
+ "type": "function",
+ "desc": "Validates a value according to the field's validation rules and marks the field as invalid\nif the validation fails"
}
]
},
- "Roo.grid.GridView": {
+ "Roo.form.VTypes": {
+ "props": [],
+ "events": [],
+ "methods": [
+ {
+ "name": "alpha",
+ "sig": "(String value)",
+ "type": "function",
+ "desc": "The function used to validate alpha values"
+ },
+ {
+ "name": "alphanum",
+ "sig": "(String value)",
+ "type": "function",
+ "desc": "The function used to validate alphanumeric values"
+ },
+ {
+ "name": "email",
+ "sig": "(String value)",
+ "type": "function",
+ "desc": "The function used to validate email addresses"
+ },
+ {
+ "name": "url",
+ "sig": "(String value)",
+ "type": "function",
+ "desc": "The function used to validate URLs"
+ }
+ ]
+ },
+ "Roo.grid": {
+ "props": [],
+ "events": [],
+ "methods": []
+ },
+ "Roo.grid.AbstractGridView": {
+ "props": [],
+ "events": [],
+ "methods": []
+ },
+ "Roo.grid.AbstractSelectionModel": {
"props": [
{
"name": "listeners",
"type": "function",
"desc": "Appends an event handler to this component"
},
- {
- "name": "autoSizeColumn",
- "sig": "(Number colIndex, Boolean forceMinSize)",
- "type": "function",
- "desc": "Autofit a column to its content."
- },
- {
- "name": "autoSizeColumns",
- "sig": "()",
- "type": "function",
- "desc": "Autofits all columns to their content and then expands to fit any extra space in the grid"
- },
{
"name": "capture",
"sig": "(Observable o, Function fn, Object scope)",
"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."
},
- {
- "name": "ensureVisible",
- "sig": "(Number row, Number col, Boolean hscroll)",
- "type": "function",
- "desc": "Scrolls the specified cell into view"
- },
{
"name": "fireEvent",
"sig": "(String eventName, Object... args)",
"desc": "Fires the specified event with the passed parameters (minus the event name)."
},
{
- "name": "fitColumns",
- "sig": "(Boolean reserveScrollSpace)",
- "type": "function",
- "desc": "Autofits all columns to the grid's width proportionate with their current size"
- },
- {
- "name": "focusCell",
- "sig": "(Number row, Number col, Boolean hscroll)",
- "type": "function",
- "desc": "Focuses the specified cell."
- },
- {
- "name": "focusRow",
- "sig": "(Number row)",
- "type": "function",
- "desc": "Focuses the specified row."
- },
- {
- "name": "getCell",
- "sig": "(Integer rowIndex, Integer colIndex)",
- "type": "function",
- "desc": "Gets the 'td' of the cell"
- },
- {
- "name": "getFooterPanel",
- "sig": "(Boolean doShow)",
+ "name": "hasListener",
+ "sig": "(String eventName)",
"type": "function",
- "desc": "Gets a panel in the footer of the grid that can be used for toolbars etc.\nAfter modifying the contents of this panel a call to grid.autoSize() may be\nrequired to register any changes in size."
+ "desc": "Checks to see if this object has any listeners for a specified event"
},
{
- "name": "getHeaderPanel",
- "sig": "(Boolean doShow)",
+ "name": "isLocked",
+ "sig": "()",
"type": "function",
- "desc": "Gets a panel in the header of the grid that can be used for toolbars etc.\nAfter modifying the contents of this panel a call to grid.autoSize() may be\nrequired to register any changes in size."
+ "desc": "Returns true if the selections are locked."
},
{
- "name": "hasListener",
- "sig": "(String eventName)",
+ "name": "lock",
+ "sig": "()",
"type": "function",
- "desc": "Checks to see if this object has any listeners for a specified event"
+ "desc": "Locks the selections."
},
{
"name": "on",
"type": "function",
"desc": "Removes all listeners for this object"
},
- {
- "name": "refresh",
- "sig": "(Boolean headersToo)",
- "type": "function",
- "desc": "Refreshes the grid"
- },
{
"name": "releaseCapture",
"sig": "(Observable o)",
"type": "function",
"desc": "Removes a listener"
},
- {
- "name": "scrollToTop",
- "sig": "()",
- "type": "function",
- "desc": "Scrolls the grid to the top"
- },
{
"name": "un",
"sig": "(String eventName, Function handler, Object scope)",
"type": "function",
"desc": "Removes a listener (shorthand for removeListener)"
+ },
+ {
+ "name": "unlock",
+ "sig": "()",
+ "type": "function",
+ "desc": "Unlocks the selections."
}
]
},
- "Roo.grid.PropertyGrid": {
+ "Roo.grid.Calendar": {
"props": [
{
- "name": "customEditors",
- "type": "Object",
- "desc": "map of colnames=> custom editors.\nthe custom editor can be one of the standard ones (date|string|number|int|boolean), or a\ngrid editor eg. Roo.grid.GridEditor(new Roo.form.TextArea({selectOnFocus:true})),\nfalse disables editing of the field.",
- "memberOf": ""
- },
- {
- "name": "propertyNames",
- "type": "Object",
- "desc": "map of property Names to their displayed value",
+ "name": "eventStore",
+ "type": "Store",
+ "desc": "The store that loads events.",
"memberOf": ""
- },
- {
- "name": "clicksToEdit",
- "type": "Number",
- "desc": "The number of clicks on a cell required to display the cell's editor (defaults to 2)",
- "memberOf": "Roo.grid.EditorGrid"
- },
- {
- "name": "ddGroup",
- "type": "String",
- "desc": "- drag drop group.",
- "memberOf": "Roo.grid.Grid"
- },
- {
- "name": "enableDrag",
- "type": "Boolean",
- "desc": "True to enable drag of rows. Default is false. (double check if this is needed?)",
- "memberOf": "Roo.grid.Grid"
- },
- {
- "name": "autoWidth",
- "type": "Boolean",
- "desc": "True to set the grid's width to the default total width of the grid's columns instead\nof a fixed width. Default is false.",
- "memberOf": "Roo.grid.Grid"
- },
- {
- "name": "maxHeight",
- "type": "Number",
- "desc": "Sets the maximum height of the grid - ignored if autoHeight is not on.",
- "memberOf": "Roo.grid.Grid"
- },
- {
- "name": "minColumnWidth",
- "type": "Number",
- "desc": "The minimum width a column can be resized to. Default is 25.",
- "memberOf": "Roo.grid.Grid"
- },
- {
- "name": "autoSizeColumns",
- "type": "Boolean",
- "desc": "True to automatically resize the columns to fit their content\n<b>on initial render.</b> It is more efficient to explicitly size the columns\nthrough the ColumnModel's {@link Roo.grid.ColumnModel#width} config option. Default is false.",
- "memberOf": "Roo.grid.Grid"
- },
- {
- "name": "autoSizeHeaders",
- "type": "Boolean",
- "desc": "True to measure headers with column data when auto sizing columns. Default is true.",
- "memberOf": "Roo.grid.Grid"
- },
- {
- "name": "monitorWindowResize",
- "type": "Boolean",
- "desc": "True to autoSize the grid when the window resizes. Default is true.",
- "memberOf": "Roo.grid.Grid"
- },
- {
- "name": "maxRowsToMeasure",
- "type": "Boolean",
- "desc": "If autoSizeColumns is on, maxRowsToMeasure can be used to limit the number of\nrows measured to get a columns size. Default is 0 (all rows).",
- "memberOf": "Roo.grid.Grid"
- },
- {
- "name": "trackMouseOver",
- "type": "Boolean",
- "desc": "True to highlight rows when the mouse is over. Default is true.",
- "memberOf": "Roo.grid.Grid"
- },
- {
- "name": "enableDragDrop",
- "type": "Boolean",
- "desc": "True to enable drag and drop of rows. Default is false.",
- "memberOf": "Roo.grid.Grid"
- },
- {
- "name": "enableColumnMove",
- "type": "Boolean",
- "desc": "True to enable drag and drop reorder of columns. Default is true.",
- "memberOf": "Roo.grid.Grid"
- },
- {
- "name": "enableColumnHide",
- "type": "Boolean",
- "desc": "True to enable hiding of columns with the header context menu. Default is true.",
- "memberOf": "Roo.grid.Grid"
- },
- {
- "name": "enableRowHeightSync",
- "type": "Boolean",
- "desc": "True to manually sync row heights across locked and not locked rows. Default is false.",
- "memberOf": "Roo.grid.Grid"
- },
- {
- "name": "stripeRows",
- "type": "Boolean",
- "desc": "True to stripe the rows. Default is true.",
- "memberOf": "Roo.grid.Grid"
- },
- {
- "name": "autoHeight",
- "type": "Boolean",
- "desc": "True to fit the height of the grid container to the height of the data. Default is false.",
- "memberOf": "Roo.grid.Grid"
- },
- {
- "name": "autoExpandColumn",
- "type": "String",
- "desc": "The id (or dataIndex) of a column in this grid that should expand to fill unused space. This id can not be 0. Default is false.",
- "memberOf": "Roo.grid.Grid"
- },
- {
- "name": "autoExpandMin",
- "type": "Number",
- "desc": "The minimum width the autoExpandColumn can have (if enabled).\nDefault is 50.",
- "memberOf": "Roo.grid.Grid"
- },
- {
- "name": "autoExpandMax",
- "type": "Number",
- "desc": "The maximum width the autoExpandColumn can have (if enabled). Default is 1000.",
- "memberOf": "Roo.grid.Grid"
- },
- {
- "name": "view",
- "type": "Object",
- "desc": "The {@link Roo.grid.GridView} used by the grid. This can be set before a call to render().",
- "memberOf": "Roo.grid.Grid"
- },
- {
- "name": "loadMask",
- "type": "Object",
- "desc": "An {@link Roo.LoadMask} config or true to mask the grid while loading. Default is false.",
- "memberOf": "Roo.grid.Grid"
- },
- {
- "name": "dropTarget",
- "type": "Roo.dd.DropTarget",
- "desc": "An {@link Roo.dd.DropTarget} config",
- "memberOf": "Roo.grid.Grid"
- },
- {
- "name": "listeners",
- "type": "Object",
- "desc": "list of events and functions to call for this object, \nFor example :\n<pre><code>\n listeners : { \n 'click' : function(e) {\n ..... \n } ,\n .... \n } \n </code></pre>",
- "memberOf": "Roo.util.Observable"
}
],
"events": [
- {
- "name": "afteredit",
- "sig": "function (e)\n{\n\n}",
- "type": "function",
- "desc": "Fires after a cell is edited. <br />\n<ul style=\"padding:5px;padding-left:16px;\">\n<li>grid - This grid</li>\n<li>record - The record being edited</li>\n<li>field - The field name being edited</li>\n<li>value - The value being set</li>\n<li>originalValue - The original value for the field, before the edit.</li>\n<li>row - The grid row index</li>\n<li>column - The grid column index</li>\n</ul>"
- },
- {
- "name": "beforeedit",
- "sig": "function (e)\n{\n\n}",
- "type": "function",
- "desc": "Fires before cell editing is triggered. The edit event object has the following properties <br />\n<ul style=\"padding:5px;padding-left:16px;\">\n<li>grid - This grid</li>\n<li>record - The record being edited</li>\n<li>field - The field name being edited</li>\n<li>value - The value for the field being edited.</li>\n<li>row - The grid row index</li>\n<li>column - The grid column index</li>\n<li>cancel - Set this to true to cancel the edit or return false from your handler.</li>\n</ul>"
- },
- {
- "name": "beforepropertychange",
- "sig": "function (grid, id, newval, oldval)\n{\n\n}",
- "type": "function",
- "desc": "Fires before a property changes (return false to stop?)"
- },
{
"name": "bodyscroll",
"sig": "function (scrollLeft, scrollTop)\n{\n\n}",
"type": "function",
"desc": "Fires when a drag operation is complete"
},
+ {
+ "name": "eventclick",
+ "sig": "function (_self, )\n{\n\n}",
+ "type": "function",
+ "desc": "Fires when the mouse click an"
+ },
+ {
+ "name": "evententer",
+ "sig": "function (_self, Event)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires when mouse over an event"
+ },
+ {
+ "name": "eventleave",
+ "sig": "function (_self, )\n{\n\n}",
+ "type": "function",
+ "desc": "Fires when the mouse leaves an"
+ },
+ {
+ "name": "eventrender",
+ "sig": "function (_self, data)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires before each cell is rendered, so you can modify the contents, like cls / title / qtip"
+ },
{
"name": "headerclick",
"sig": "function (_self, columnIndex, e)\n{\n\n}",
"type": "function",
"desc": "The raw keypress event for the entire grid."
},
+ {
+ "name": "monthchange",
+ "sig": "function (_self, date)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires when the displayed month changes"
+ },
{
"name": "mousedown",
"sig": "function (e)\n{\n\n}",
"type": "function",
"desc": "The raw mouseup event for the entire grid."
},
- {
- "name": "propertychange",
- "sig": "function (grid, id, newval, oldval)\n{\n\n}",
- "type": "function",
- "desc": "Fires after a property changes"
- },
{
"name": "render",
"sig": "function (grid)\n{\n\n}",
"name": "rowclass",
"sig": "function (gridview, rowcfg)\n{\n\n}",
"type": "function",
- "desc": "Fires when a row is rendered, so you can change add a style to it."
+ "desc": "Fires when a row is rendered, so you can change add a style to it."
+ },
+ {
+ "name": "rowclick",
+ "sig": "function (_self, rowIndex, e)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires when a row is clicked"
+ },
+ {
+ "name": "rowcontextmenu",
+ "sig": "function (_self, rowIndex, e)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires when a row is right clicked"
+ },
+ {
+ "name": "rowdblclick",
+ "sig": "function (_self, rowIndex, e)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires when a row is double clicked"
+ },
+ {
+ "name": "select",
+ "sig": "function (_self, date)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires when a date is selected"
+ },
+ {
+ "name": "startdrag",
+ "sig": "function (_self, dd, e)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires when row(s) start being dragged"
+ }
+ ],
+ "methods": [
+ {
+ "name": "getSelectionModel",
+ "sig": "()",
+ "type": "function",
+ "desc": "Returns the grid's SelectionModel."
+ }
+ ]
+ },
+ "Roo.grid.CellSelectionModel": {
+ "props": [
+ {
+ "name": "enter_is_tab",
+ "type": "Boolean",
+ "desc": "Enter behaves the same as tab. (eg. goes to next cell) default: false",
+ "memberOf": ""
+ },
+ {
+ "name": "listeners",
+ "type": "Object",
+ "desc": "list of events and functions to call for this object, \nFor example :\n<pre><code>\n listeners : { \n 'click' : function(e) {\n ..... \n } ,\n .... \n } \n </code></pre>",
+ "memberOf": "Roo.util.Observable"
+ }
+ ],
+ "events": [
+ {
+ "name": "beforeeditnext",
+ "sig": "function (eventdata)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires before the next editable sell is made active\nYou can use this to skip to another cell or fire the tabend\n if you set cell to false"
+ },
+ {
+ "name": "beforerowselect",
+ "sig": "function (_self, rowIndex, colIndex)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires before a cell is selected."
+ },
+ {
+ "name": "cellselect",
+ "sig": "function (_self, rowIndex, colIndex)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires when a cell is selected."
+ },
+ {
+ "name": "selectionchange",
+ "sig": "function (_self, selection)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires when the active selection changes."
+ },
+ {
+ "name": "tabend",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires when the tab (or enter) was pressed on the last editable cell\nYou can use this to trigger add new row."
+ }
+ ],
+ "methods": [
+ {
+ "name": "addEvents",
+ "sig": "(Object object)",
+ "type": "function",
+ "desc": "Used to define events on this Observable"
+ },
+ {
+ "name": "addListener",
+ "sig": "(String eventName, Function handler, Object scope, Object options)",
+ "type": "function",
+ "desc": "Appends an event handler to this component"
+ },
+ {
+ "name": "capture",
+ "sig": "(Observable o, Function fn, Object scope)",
+ "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."
+ },
+ {
+ "name": "clearSelections",
+ "sig": "(Boolean true)",
+ "type": "function",
+ "desc": "Clears all selections."
+ },
+ {
+ "name": "fireEvent",
+ "sig": "(String eventName, Object... args)",
+ "type": "function",
+ "desc": "Fires the specified event with the passed parameters (minus the event name)."
+ },
+ {
+ "name": "getSelectedCell",
+ "sig": "()",
+ "type": "function",
+ "desc": "Returns the currently selected cell,."
+ },
+ {
+ "name": "hasListener",
+ "sig": "(String eventName)",
+ "type": "function",
+ "desc": "Checks to see if this object has any listeners for a specified event"
+ },
+ {
+ "name": "hasSelection",
+ "sig": "()",
+ "type": "function",
+ "desc": "Returns true if there is a selection."
+ },
+ {
+ "name": "isLocked",
+ "sig": "()",
+ "type": "function",
+ "desc": "Returns true if the selections are locked."
+ },
+ {
+ "name": "lock",
+ "sig": "()",
+ "type": "function",
+ "desc": "Locks the selections."
+ },
+ {
+ "name": "on",
+ "sig": "(String eventName, Function handler, Object scope, Object options)",
+ "type": "function",
+ "desc": "Appends an event handler to this element (shorthand for addListener)"
+ },
+ {
+ "name": "onEditorKey",
+ "sig": "(Number field, Number e)",
+ "type": "function",
+ "desc": "Selects a cell."
+ },
+ {
+ "name": "purgeListeners",
+ "sig": "()",
+ "type": "function",
+ "desc": "Removes all listeners for this object"
+ },
+ {
+ "name": "releaseCapture",
+ "sig": "(Observable o)",
+ "type": "function",
+ "desc": "Removes <b>all</b> added captures from the Observable."
+ },
+ {
+ "name": "removeListener",
+ "sig": "(String eventName, Function handler, Object scope)",
+ "type": "function",
+ "desc": "Removes a listener"
+ },
+ {
+ "name": "select",
+ "sig": "(Number rowIndex, Number collIndex)",
+ "type": "function",
+ "desc": "Selects a cell."
+ },
+ {
+ "name": "un",
+ "sig": "(String eventName, Function handler, Object scope)",
+ "type": "function",
+ "desc": "Removes a listener (shorthand for removeListener)"
+ },
+ {
+ "name": "unlock",
+ "sig": "()",
+ "type": "function",
+ "desc": "Unlocks the selections."
+ }
+ ]
+ },
+ "Roo.grid.ColumnModel": {
+ "props": [
+ {
+ "name": "header",
+ "type": "String",
+ "desc": "The header text to display in the Grid view.",
+ "memberOf": ""
+ },
+ {
+ "name": "dataIndex",
+ "type": "String",
+ "desc": "(Optional) The name of the field in the grid's {@link Roo.data.Store}'s\n{@link Roo.data.Record} definition from which to draw the column's value. If not\nspecified, the column's index is used as an index into the Record's data Array.",
+ "memberOf": ""
+ },
+ {
+ "name": "width",
+ "type": "Number",
+ "desc": "(Optional) The initial width in pixels of the column. Using this\ninstead of {@link Roo.grid.Grid#autoSizeColumns} is more efficient.",
+ "memberOf": ""
+ },
+ {
+ "name": "sortable",
+ "type": "Boolean",
+ "desc": "(Optional) True if sorting is to be allowed on this column.\nDefaults to the value of the {@link #defaultSortable} property.\nWhether local/remote sorting is used is specified in {@link Roo.data.Store#remoteSort}.",
+ "memberOf": ""
+ },
+ {
+ "name": "locked",
+ "type": "Boolean",
+ "desc": "(Optional) True to lock the column in place while scrolling the Grid. Defaults to false.",
+ "memberOf": ""
+ },
+ {
+ "name": "fixed",
+ "type": "Boolean",
+ "desc": "(Optional) True if the column width cannot be changed. Defaults to false.",
+ "memberOf": ""
+ },
+ {
+ "name": "resizable",
+ "type": "Boolean",
+ "desc": "(Optional) False to disable column resizing. Defaults to true.",
+ "memberOf": ""
+ },
+ {
+ "name": "hidden",
+ "type": "Boolean",
+ "desc": "(Optional) True to hide the column. Defaults to false.",
+ "memberOf": ""
+ },
+ {
+ "name": "renderer",
+ "type": "Function",
+ "desc": "(Optional) A function used to generate HTML markup for a cell\ngiven the cell's data value. See {@link #setRenderer}. If not specified, the\ndefault renderer uses the raw data value. If an object is returned (bootstrap only)\nthen it is treated as a Roo Component object instance, and it is rendered after the initial row is rendered",
+ "memberOf": ""
+ },
+ {
+ "name": "editor",
+ "type": "Roo.grid.GridEditor",
+ "desc": "(Optional) For grid editors - returns the grid editor",
+ "memberOf": ""
+ },
+ {
+ "name": "align",
+ "type": "String",
+ "desc": "(Optional) Set the CSS text-align property of the column. Defaults to undefined.",
+ "memberOf": ""
+ },
+ {
+ "name": "cursor",
+ "type": "String",
+ "desc": "(Optional)",
+ "memberOf": ""
+ },
+ {
+ "name": "tooltip",
+ "type": "String",
+ "desc": "(Optional)",
+ "memberOf": ""
+ },
+ {
+ "name": "xs",
+ "type": "Number",
+ "desc": "(Optional)",
+ "memberOf": ""
+ },
+ {
+ "name": "sm",
+ "type": "Number",
+ "desc": "(Optional)",
+ "memberOf": ""
+ },
+ {
+ "name": "md",
+ "type": "Number",
+ "desc": "(Optional)",
+ "memberOf": ""
+ },
+ {
+ "name": "lg",
+ "type": "Number",
+ "desc": "(Optional)",
+ "memberOf": ""
+ },
+ {
+ "name": "listeners",
+ "type": "Object",
+ "desc": "list of events and functions to call for this object, \nFor example :\n<pre><code>\n listeners : { \n 'click' : function(e) {\n ..... \n } ,\n .... \n } \n </code></pre>",
+ "memberOf": "Roo.util.Observable"
+ }
+ ],
+ "events": [
+ {
+ "name": "columlockchange",
+ "sig": "function (_self, colIndex, locked)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires when a column's locked state is changed"
+ },
+ {
+ "name": "columnmoved",
+ "sig": "function (_self, oldIndex, newIndex)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires when a column is moved."
+ },
+ {
+ "name": "headerchange",
+ "sig": "function (_self, columnIndex, newText)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires when the text of a header changes."
+ },
+ {
+ "name": "hiddenchange",
+ "sig": "function (_self, columnIndex, hidden)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires when a column is hidden or \"unhidden\"."
+ },
+ {
+ "name": "widthchange",
+ "sig": "function (_self, columnIndex, newWidth)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires when the width of a column changes."
+ }
+ ],
+ "methods": [
+ {
+ "name": "addEvents",
+ "sig": "(Object object)",
+ "type": "function",
+ "desc": "Used to define events on this Observable"
+ },
+ {
+ "name": "addListener",
+ "sig": "(String eventName, Function handler, Object scope, Object options)",
+ "type": "function",
+ "desc": "Appends an event handler to this component"
+ },
+ {
+ "name": "capture",
+ "sig": "(Observable o, Function fn, Object scope)",
+ "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."
+ },
+ {
+ "name": "findColumnIndex",
+ "sig": "(String dataIndex)",
+ "type": "function",
+ "desc": "Returns the index for a specified column dataIndex."
+ },
+ {
+ "name": "fireEvent",
+ "sig": "(String eventName, Object... args)",
+ "type": "function",
+ "desc": "Fires the specified event with the passed parameters (minus the event name)."
+ },
+ {
+ "name": "getCellEditor",
+ "sig": "(Number colIndex, Number rowIndex)",
+ "type": "function",
+ "desc": "Returns the editor defined for the cell/column.\nreturn false or null to disable editing."
+ },
+ {
+ "name": "getColumnByDataIndex",
+ "sig": "(String dataIndex)",
+ "type": "function",
+ "desc": "Returns the column for a specified dataIndex."
+ },
+ {
+ "name": "getColumnById",
+ "sig": "(String id)",
+ "type": "function",
+ "desc": "Returns the column for a specified id."
+ },
+ {
+ "name": "getColumnCount",
+ "sig": "()",
+ "type": "function",
+ "desc": "Returns the number of columns."
+ },
+ {
+ "name": "getColumnHeader",
+ "sig": "(Number col)",
+ "type": "function",
+ "desc": "Returns the header for the specified column."
+ },
+ {
+ "name": "getColumnId",
+ "sig": "(Number index)",
+ "type": "function",
+ "desc": "Returns the id of the column at the specified index."
+ },
+ {
+ "name": "getColumnTooltip",
+ "sig": "(Number col)",
+ "type": "function",
+ "desc": "Returns the tooltip for the specified column."
+ },
+ {
+ "name": "getColumnWidth",
+ "sig": "(Number col)",
+ "type": "function",
+ "desc": "Returns the width for the specified column."
+ },
+ {
+ "name": "getColumnsBy",
+ "sig": "(Function fn, Object scope)",
+ "type": "function",
+ "desc": "Returns the column configs that return true by the passed function that is called with (columnConfig, index)"
+ },
+ {
+ "name": "getDataIndex",
+ "sig": "(Number col)",
+ "type": "function",
+ "desc": "Returns the dataIndex for the specified column."
+ },
+ {
+ "name": "getIndexById",
+ "sig": "(String id)",
+ "type": "function",
+ "desc": "Returns the index for a specified column id."
+ },
+ {
+ "name": "getRenderer",
+ "sig": "(Number col)",
+ "type": "function",
+ "desc": "Returns the rendering (formatting) function defined for the column."
+ },
+ {
+ "name": "getTotalWidth",
+ "sig": "(Boolean includeHidden)",
+ "type": "function",
+ "desc": "Returns the total width of all columns."
+ },
+ {
+ "name": "hasListener",
+ "sig": "(String eventName)",
+ "type": "function",
+ "desc": "Checks to see if this object has any listeners for a specified event"
+ },
+ {
+ "name": "isCellEditable",
+ "sig": "(Number colIndex, Number rowIndex)",
+ "type": "function",
+ "desc": "Returns true if the cell is editable."
+ },
+ {
+ "name": "isFixed",
+ "sig": "()",
+ "type": "function",
+ "desc": "Returns true if the column width cannot be changed"
+ },
+ {
+ "name": "isHidden",
+ "sig": "(Number colIndex)",
+ "type": "function",
+ "desc": "Returns true if the column is hidden."
+ },
+ {
+ "name": "isResizable",
+ "sig": "()",
+ "type": "function",
+ "desc": "Returns true if the column can be resized"
+ },
+ {
+ "name": "isSortable",
+ "sig": "(Number col)",
+ "type": "function",
+ "desc": "Returns true if the specified column is sortable."
+ },
+ {
+ "name": "on",
+ "sig": "(String eventName, Function handler, Object scope, Object options)",
+ "type": "function",
+ "desc": "Appends an event handler to this element (shorthand for addListener)"
+ },
+ {
+ "name": "purgeListeners",
+ "sig": "()",
+ "type": "function",
+ "desc": "Removes all listeners for this object"
+ },
+ {
+ "name": "releaseCapture",
+ "sig": "(Observable o)",
+ "type": "function",
+ "desc": "Removes <b>all</b> added captures from the Observable."
+ },
+ {
+ "name": "removeListener",
+ "sig": "(String eventName, Function handler, Object scope)",
+ "type": "function",
+ "desc": "Removes a listener"
+ },
+ {
+ "name": "setColumnHeader",
+ "sig": "(Number col, String header)",
+ "type": "function",
+ "desc": "Sets the header for a column."
+ },
+ {
+ "name": "setColumnTooltip",
+ "sig": "(Number col, String tooltip)",
+ "type": "function",
+ "desc": "Sets the tooltip for a column."
+ },
+ {
+ "name": "setColumnWidth",
+ "sig": "(Number col, Number width)",
+ "type": "function",
+ "desc": "Sets the width for a column."
+ },
+ {
+ "name": "setDataIndex",
+ "sig": "(Number col, Number dataIndex)",
+ "type": "function",
+ "desc": "Sets the dataIndex for a column."
+ },
+ {
+ "name": "setEditable",
+ "sig": "(Number col, Boolean editable)",
+ "type": "function",
+ "desc": "Sets if a column is editable."
+ },
+ {
+ "name": "setEditor",
+ "sig": "(Number col, Object editor)",
+ "type": "function",
+ "desc": "Sets the editor for a column."
+ },
+ {
+ "name": "setHidden",
+ "sig": "(Number colIndex, Boolean hidden)",
+ "type": "function",
+ "desc": "Sets if a column is hidden."
+ },
+ {
+ "name": "setRenderer",
+ "sig": "(Number col, Function fn)",
+ "type": "function",
+ "desc": "Sets the rendering (formatting) function for a column."
+ },
+ {
+ "name": "un",
+ "sig": "(String eventName, Function handler, Object scope)",
+ "type": "function",
+ "desc": "Removes a listener (shorthand for removeListener)"
+ }
+ ]
+ },
+ "Roo.grid.EditorGrid": {
+ "props": [
+ {
+ "name": "clicksToEdit",
+ "type": "Number",
+ "desc": "The number of clicks on a cell required to display the cell's editor (defaults to 2)",
+ "memberOf": ""
+ },
+ {
+ "name": "ddGroup",
+ "type": "String",
+ "desc": "- drag drop group.",
+ "memberOf": "Roo.grid.Grid"
+ },
+ {
+ "name": "enableDrag",
+ "type": "Boolean",
+ "desc": "True to enable drag of rows. Default is false. (double check if this is needed?)",
+ "memberOf": "Roo.grid.Grid"
+ },
+ {
+ "name": "autoWidth",
+ "type": "Boolean",
+ "desc": "True to set the grid's width to the default total width of the grid's columns instead\nof a fixed width. Default is false.",
+ "memberOf": "Roo.grid.Grid"
+ },
+ {
+ "name": "maxHeight",
+ "type": "Number",
+ "desc": "Sets the maximum height of the grid - ignored if autoHeight is not on.",
+ "memberOf": "Roo.grid.Grid"
+ },
+ {
+ "name": "minColumnWidth",
+ "type": "Number",
+ "desc": "The minimum width a column can be resized to. Default is 25.",
+ "memberOf": "Roo.grid.Grid"
+ },
+ {
+ "name": "autoSizeColumns",
+ "type": "Boolean",
+ "desc": "True to automatically resize the columns to fit their content\n<b>on initial render.</b> It is more efficient to explicitly size the columns\nthrough the ColumnModel's {@link Roo.grid.ColumnModel#width} config option. Default is false.",
+ "memberOf": "Roo.grid.Grid"
+ },
+ {
+ "name": "autoSizeHeaders",
+ "type": "Boolean",
+ "desc": "True to measure headers with column data when auto sizing columns. Default is true.",
+ "memberOf": "Roo.grid.Grid"
+ },
+ {
+ "name": "monitorWindowResize",
+ "type": "Boolean",
+ "desc": "True to autoSize the grid when the window resizes. Default is true.",
+ "memberOf": "Roo.grid.Grid"
+ },
+ {
+ "name": "maxRowsToMeasure",
+ "type": "Boolean",
+ "desc": "If autoSizeColumns is on, maxRowsToMeasure can be used to limit the number of\nrows measured to get a columns size. Default is 0 (all rows).",
+ "memberOf": "Roo.grid.Grid"
+ },
+ {
+ "name": "trackMouseOver",
+ "type": "Boolean",
+ "desc": "True to highlight rows when the mouse is over. Default is true.",
+ "memberOf": "Roo.grid.Grid"
+ },
+ {
+ "name": "enableDragDrop",
+ "type": "Boolean",
+ "desc": "True to enable drag and drop of rows. Default is false.",
+ "memberOf": "Roo.grid.Grid"
+ },
+ {
+ "name": "enableColumnMove",
+ "type": "Boolean",
+ "desc": "True to enable drag and drop reorder of columns. Default is true.",
+ "memberOf": "Roo.grid.Grid"
+ },
+ {
+ "name": "enableColumnHide",
+ "type": "Boolean",
+ "desc": "True to enable hiding of columns with the header context menu. Default is true.",
+ "memberOf": "Roo.grid.Grid"
+ },
+ {
+ "name": "enableRowHeightSync",
+ "type": "Boolean",
+ "desc": "True to manually sync row heights across locked and not locked rows. Default is false.",
+ "memberOf": "Roo.grid.Grid"
+ },
+ {
+ "name": "stripeRows",
+ "type": "Boolean",
+ "desc": "True to stripe the rows. Default is true.",
+ "memberOf": "Roo.grid.Grid"
+ },
+ {
+ "name": "autoHeight",
+ "type": "Boolean",
+ "desc": "True to fit the height of the grid container to the height of the data. Default is false.",
+ "memberOf": "Roo.grid.Grid"
+ },
+ {
+ "name": "autoExpandColumn",
+ "type": "String",
+ "desc": "The id (or dataIndex) of a column in this grid that should expand to fill unused space. This id can not be 0. Default is false.",
+ "memberOf": "Roo.grid.Grid"
+ },
+ {
+ "name": "autoExpandMin",
+ "type": "Number",
+ "desc": "The minimum width the autoExpandColumn can have (if enabled).\nDefault is 50.",
+ "memberOf": "Roo.grid.Grid"
+ },
+ {
+ "name": "autoExpandMax",
+ "type": "Number",
+ "desc": "The maximum width the autoExpandColumn can have (if enabled). Default is 1000.",
+ "memberOf": "Roo.grid.Grid"
+ },
+ {
+ "name": "view",
+ "type": "Object",
+ "desc": "The {@link Roo.grid.GridView} used by the grid. This can be set before a call to render().",
+ "memberOf": "Roo.grid.Grid"
+ },
+ {
+ "name": "loadMask",
+ "type": "Object",
+ "desc": "An {@link Roo.LoadMask} config or true to mask the grid while loading. Default is false.",
+ "memberOf": "Roo.grid.Grid"
+ },
+ {
+ "name": "dropTarget",
+ "type": "Roo.dd.DropTarget",
+ "desc": "An {@link Roo.dd.DropTarget} config",
+ "memberOf": "Roo.grid.Grid"
+ },
+ {
+ "name": "listeners",
+ "type": "Object",
+ "desc": "list of events and functions to call for this object, \nFor example :\n<pre><code>\n listeners : { \n 'click' : function(e) {\n ..... \n } ,\n .... \n } \n </code></pre>",
+ "memberOf": "Roo.util.Observable"
+ }
+ ],
+ "events": [
+ {
+ "name": "afteredit",
+ "sig": "function (e)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires after a cell is edited. <br />\n<ul style=\"padding:5px;padding-left:16px;\">\n<li>grid - This grid</li>\n<li>record - The record being edited</li>\n<li>field - The field name being edited</li>\n<li>value - The value being set</li>\n<li>originalValue - The original value for the field, before the edit.</li>\n<li>row - The grid row index</li>\n<li>column - The grid column index</li>\n</ul>"
+ },
+ {
+ "name": "beforeedit",
+ "sig": "function (e)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires before cell editing is triggered. The edit event object has the following properties <br />\n<ul style=\"padding:5px;padding-left:16px;\">\n<li>grid - This grid</li>\n<li>record - The record being edited</li>\n<li>field - The field name being edited</li>\n<li>value - The value for the field being edited.</li>\n<li>row - The grid row index</li>\n<li>column - The grid column index</li>\n<li>cancel - Set this to true to cancel the edit or return false from your handler.</li>\n</ul>"
+ },
+ {
+ "name": "bodyscroll",
+ "sig": "function (scrollLeft, scrollTop)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires when the body element is scrolled"
+ },
+ {
+ "name": "cellclick",
+ "sig": "function (_self, rowIndex, columnIndex, e)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires when a cell is clicked"
+ },
+ {
+ "name": "cellcontextmenu",
+ "sig": "function (_self, rowIndex, cellIndex, e)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires when a cell is right clicked"
+ },
+ {
+ "name": "celldblclick",
+ "sig": "function (_self, rowIndex, columnIndex, e)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires when a cell is double clicked"
+ },
+ {
+ "name": "click",
+ "sig": "function (e)\n{\n\n}",
+ "type": "function",
+ "desc": "The raw click event for the entire grid."
+ },
+ {
+ "name": "columnmove",
+ "sig": "function (oldIndex, newIndex)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires when the user moves a column"
+ },
+ {
+ "name": "columnresize",
+ "sig": "function (columnIndex, newSize)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires when the user resizes a column"
+ },
+ {
+ "name": "contextmenu",
+ "sig": "function (e)\n{\n\n}",
+ "type": "function",
+ "desc": "The raw contextmenu event for the entire grid."
+ },
+ {
+ "name": "dblclick",
+ "sig": "function (e)\n{\n\n}",
+ "type": "function",
+ "desc": "The raw dblclick event for the entire grid."
+ },
+ {
+ "name": "dragdrop",
+ "sig": "function (_self, dd, targetId, e)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires when dragged row(s) are dropped on a valid DD target"
+ },
+ {
+ "name": "dragenter\n Fires when the dragged row(s) first cross another DD target while being dragged",
+ "sig": "function (_self, dd, targetId, e)\n{\n\n}",
+ "type": "function",
+ "desc": ""
+ },
+ {
+ "name": "dragout",
+ "sig": "function (_self, dd, targetId, e)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires when the dragged row(s) leave another DD target while being dragged"
+ },
+ {
+ "name": "dragover",
+ "sig": "function (_self, dd, targetId, e)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires while row(s) are being dragged. \"targetId\" is the id of the Yahoo.util.DD object the selected rows are being dragged over."
+ },
+ {
+ "name": "enddrag",
+ "sig": "function (_self, dd, e)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires when a drag operation is complete"
+ },
+ {
+ "name": "headerclick",
+ "sig": "function (_self, columnIndex, e)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires when a header is clicked"
+ },
+ {
+ "name": "headercontextmenu",
+ "sig": "function (_self, columnIndex, e)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires when a header is right clicked"
+ },
+ {
+ "name": "headerdblclick",
+ "sig": "function (_self, columnIndex, e)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires when a header cell is double clicked"
+ },
+ {
+ "name": "keydown",
+ "sig": "function (e)\n{\n\n}",
+ "type": "function",
+ "desc": "The raw keydown event for the entire grid."
+ },
+ {
+ "name": "keypress",
+ "sig": "function (e)\n{\n\n}",
+ "type": "function",
+ "desc": "The raw keypress event for the entire grid."
+ },
+ {
+ "name": "mousedown",
+ "sig": "function (e)\n{\n\n}",
+ "type": "function",
+ "desc": "The raw mousedown event for the entire grid."
+ },
+ {
+ "name": "mouseout",
+ "sig": "function (e)\n{\n\n}",
+ "type": "function",
+ "desc": "The raw mouseout event for the entire grid."
+ },
+ {
+ "name": "mouseover",
+ "sig": "function (e)\n{\n\n}",
+ "type": "function",
+ "desc": "The raw mouseover event for the entire grid."
+ },
+ {
+ "name": "mouseup",
+ "sig": "function (e)\n{\n\n}",
+ "type": "function",
+ "desc": "The raw mouseup event for the entire grid."
+ },
+ {
+ "name": "render",
+ "sig": "function (grid)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires when the grid is rendered"
+ },
+ {
+ "name": "rowclass",
+ "sig": "function (gridview, rowcfg)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires when a row is rendered, so you can change add a style to it."
+ },
+ {
+ "name": "rowclick",
+ "sig": "function (_self, rowIndex, e)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires when a row is clicked"
+ },
+ {
+ "name": "rowcontextmenu",
+ "sig": "function (_self, rowIndex, e)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires when a row is right clicked"
+ },
+ {
+ "name": "rowdblclick",
+ "sig": "function (_self, rowIndex, e)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires when a row is double clicked"
+ },
+ {
+ "name": "startdrag",
+ "sig": "function (_self, dd, e)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires when row(s) start being dragged"
+ },
+ {
+ "name": "validateedit",
+ "sig": "function (e)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires after a cell is edited, but before the value is set in the record. \nYou can use this to modify the value being set in the field, Return false\nto cancel the change. The edit event object has the following properties <br />\n<ul style=\"padding:5px;padding-left:16px;\">\n<li>editor - This editor</li>\n<li>grid - This grid</li>\n<li>record - The record being edited</li>\n<li>field - The field name being edited</li>\n<li>value - The value being set</li>\n<li>originalValue - The original value for the field, before the edit.</li>\n<li>row - The grid row index</li>\n<li>column - The grid column index</li>\n<li>cancel - Set this to true to cancel the edit or return false from your handler.</li>\n</ul>"
+ }
+ ],
+ "methods": [
+ {
+ "name": "addEvents",
+ "sig": "(Object object)",
+ "type": "function",
+ "desc": "Used to define events on this Observable"
+ },
+ {
+ "name": "addListener",
+ "sig": "(String eventName, Function handler, Object scope, Object options)",
+ "type": "function",
+ "desc": "Appends an event handler to this component"
+ },
+ {
+ "name": "autoSize",
+ "sig": "()",
+ "type": "function",
+ "desc": "Causes the grid to manually recalculate its dimensions. Generally this is done automatically,\nbut if manual update is required this method will initiate it."
+ },
+ {
+ "name": "capture",
+ "sig": "(Observable o, Function fn, Object scope)",
+ "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."
+ },
+ {
+ "name": "destroy",
+ "sig": "(Boolean removeEl)",
+ "type": "function",
+ "desc": "Destroy this grid."
+ },
+ {
+ "name": "fireEvent",
+ "sig": "(String eventName, Object... args)",
+ "type": "function",
+ "desc": "Fires the specified event with the passed parameters (minus the event name)."
+ },
+ {
+ "name": "getColumnModel",
+ "sig": "()",
+ "type": "function",
+ "desc": "Returns the grid's ColumnModel."
+ },
+ {
+ "name": "getDataSource",
+ "sig": "()",
+ "type": "function",
+ "desc": "Returns the grid's DataSource."
+ },
+ {
+ "name": "getDragDropText",
+ "sig": "()",
+ "type": "function",
+ "desc": "Called to get grid's drag proxy text, by default returns this.ddText."
+ },
+ {
+ "name": "getGridEl",
+ "sig": "()",
+ "type": "function",
+ "desc": "Returns the grid's underlying element."
+ },
+ {
+ "name": "getSelectionModel",
+ "sig": "()",
+ "type": "function",
+ "desc": "Returns the grid's SelectionModel."
+ },
+ {
+ "name": "getView",
+ "sig": "()",
+ "type": "function",
+ "desc": "Returns the grid's GridView object."
+ },
+ {
+ "name": "hasListener",
+ "sig": "(String eventName)",
+ "type": "function",
+ "desc": "Checks to see if this object has any listeners for a specified event"
+ },
+ {
+ "name": "on",
+ "sig": "(String eventName, Function handler, Object scope, Object options)",
+ "type": "function",
+ "desc": "Appends an event handler to this element (shorthand for addListener)"
+ },
+ {
+ "name": "purgeListeners",
+ "sig": "()",
+ "type": "function",
+ "desc": "Removes all listeners for this object"
+ },
+ {
+ "name": "reconfigure",
+ "sig": "(Roo.data.Store dataSource, Roo.grid.ColumnModel The)",
+ "type": "function",
+ "desc": "Reconfigures the grid to use a different Store and Column Model.\nThe View will be bound to the new objects and refreshed."
+ },
+ {
+ "name": "releaseCapture",
+ "sig": "(Observable o)",
+ "type": "function",
+ "desc": "Removes <b>all</b> added captures from the Observable."
+ },
+ {
+ "name": "removeListener",
+ "sig": "(String eventName, Function handler, Object scope)",
+ "type": "function",
+ "desc": "Removes a listener"
+ },
+ {
+ "name": "render",
+ "sig": "()",
+ "type": "function",
+ "desc": "Called once after all setup has been completed and the grid is ready to be rendered."
+ },
+ {
+ "name": "startEditing",
+ "sig": "(Number rowIndex, Number colIndex)",
+ "type": "function",
+ "desc": "Starts editing the specified for the specified row/column"
+ },
+ {
+ "name": "stopEditing",
+ "sig": "()",
+ "type": "function",
+ "desc": "Stops any active editing"
+ },
+ {
+ "name": "un",
+ "sig": "(String eventName, Function handler, Object scope)",
+ "type": "function",
+ "desc": "Removes a listener (shorthand for removeListener)"
+ }
+ ]
+ },
+ "Roo.grid.Grid": {
+ "props": [
+ {
+ "name": "ddGroup",
+ "type": "String",
+ "desc": "- drag drop group.",
+ "memberOf": ""
+ },
+ {
+ "name": "enableDrag",
+ "type": "Boolean",
+ "desc": "True to enable drag of rows. Default is false. (double check if this is needed?)",
+ "memberOf": ""
+ },
+ {
+ "name": "autoWidth",
+ "type": "Boolean",
+ "desc": "True to set the grid's width to the default total width of the grid's columns instead\nof a fixed width. Default is false.",
+ "memberOf": ""
+ },
+ {
+ "name": "maxHeight",
+ "type": "Number",
+ "desc": "Sets the maximum height of the grid - ignored if autoHeight is not on.",
+ "memberOf": ""
+ },
+ {
+ "name": "minColumnWidth",
+ "type": "Number",
+ "desc": "The minimum width a column can be resized to. Default is 25.",
+ "memberOf": ""
+ },
+ {
+ "name": "autoSizeColumns",
+ "type": "Boolean",
+ "desc": "True to automatically resize the columns to fit their content\n<b>on initial render.</b> It is more efficient to explicitly size the columns\nthrough the ColumnModel's {@link Roo.grid.ColumnModel#width} config option. Default is false.",
+ "memberOf": ""
+ },
+ {
+ "name": "autoSizeHeaders",
+ "type": "Boolean",
+ "desc": "True to measure headers with column data when auto sizing columns. Default is true.",
+ "memberOf": ""
+ },
+ {
+ "name": "monitorWindowResize",
+ "type": "Boolean",
+ "desc": "True to autoSize the grid when the window resizes. Default is true.",
+ "memberOf": ""
+ },
+ {
+ "name": "maxRowsToMeasure",
+ "type": "Boolean",
+ "desc": "If autoSizeColumns is on, maxRowsToMeasure can be used to limit the number of\nrows measured to get a columns size. Default is 0 (all rows).",
+ "memberOf": ""
+ },
+ {
+ "name": "trackMouseOver",
+ "type": "Boolean",
+ "desc": "True to highlight rows when the mouse is over. Default is true.",
+ "memberOf": ""
+ },
+ {
+ "name": "enableDragDrop",
+ "type": "Boolean",
+ "desc": "True to enable drag and drop of rows. Default is false.",
+ "memberOf": ""
+ },
+ {
+ "name": "enableColumnMove",
+ "type": "Boolean",
+ "desc": "True to enable drag and drop reorder of columns. Default is true.",
+ "memberOf": ""
+ },
+ {
+ "name": "enableColumnHide",
+ "type": "Boolean",
+ "desc": "True to enable hiding of columns with the header context menu. Default is true.",
+ "memberOf": ""
+ },
+ {
+ "name": "enableRowHeightSync",
+ "type": "Boolean",
+ "desc": "True to manually sync row heights across locked and not locked rows. Default is false.",
+ "memberOf": ""
+ },
+ {
+ "name": "stripeRows",
+ "type": "Boolean",
+ "desc": "True to stripe the rows. Default is true.",
+ "memberOf": ""
+ },
+ {
+ "name": "autoHeight",
+ "type": "Boolean",
+ "desc": "True to fit the height of the grid container to the height of the data. Default is false.",
+ "memberOf": ""
+ },
+ {
+ "name": "autoExpandColumn",
+ "type": "String",
+ "desc": "The id (or dataIndex) of a column in this grid that should expand to fill unused space. This id can not be 0. Default is false.",
+ "memberOf": ""
+ },
+ {
+ "name": "autoExpandMin",
+ "type": "Number",
+ "desc": "The minimum width the autoExpandColumn can have (if enabled).\nDefault is 50.",
+ "memberOf": ""
+ },
+ {
+ "name": "autoExpandMax",
+ "type": "Number",
+ "desc": "The maximum width the autoExpandColumn can have (if enabled). Default is 1000.",
+ "memberOf": ""
+ },
+ {
+ "name": "view",
+ "type": "Object",
+ "desc": "The {@link Roo.grid.GridView} used by the grid. This can be set before a call to render().",
+ "memberOf": ""
+ },
+ {
+ "name": "loadMask",
+ "type": "Object",
+ "desc": "An {@link Roo.LoadMask} config or true to mask the grid while loading. Default is false.",
+ "memberOf": ""
+ },
+ {
+ "name": "dropTarget",
+ "type": "Roo.dd.DropTarget",
+ "desc": "An {@link Roo.dd.DropTarget} config",
+ "memberOf": ""
+ },
+ {
+ "name": "listeners",
+ "type": "Object",
+ "desc": "list of events and functions to call for this object, \nFor example :\n<pre><code>\n listeners : { \n 'click' : function(e) {\n ..... \n } ,\n .... \n } \n </code></pre>",
+ "memberOf": "Roo.util.Observable"
+ }
+ ],
+ "events": [
+ {
+ "name": "bodyscroll",
+ "sig": "function (scrollLeft, scrollTop)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires when the body element is scrolled"
+ },
+ {
+ "name": "cellclick",
+ "sig": "function (_self, rowIndex, columnIndex, e)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires when a cell is clicked"
+ },
+ {
+ "name": "cellcontextmenu",
+ "sig": "function (_self, rowIndex, cellIndex, e)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires when a cell is right clicked"
+ },
+ {
+ "name": "celldblclick",
+ "sig": "function (_self, rowIndex, columnIndex, e)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires when a cell is double clicked"
+ },
+ {
+ "name": "click",
+ "sig": "function (e)\n{\n\n}",
+ "type": "function",
+ "desc": "The raw click event for the entire grid."
+ },
+ {
+ "name": "columnmove",
+ "sig": "function (oldIndex, newIndex)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires when the user moves a column"
+ },
+ {
+ "name": "columnresize",
+ "sig": "function (columnIndex, newSize)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires when the user resizes a column"
+ },
+ {
+ "name": "contextmenu",
+ "sig": "function (e)\n{\n\n}",
+ "type": "function",
+ "desc": "The raw contextmenu event for the entire grid."
+ },
+ {
+ "name": "dblclick",
+ "sig": "function (e)\n{\n\n}",
+ "type": "function",
+ "desc": "The raw dblclick event for the entire grid."
+ },
+ {
+ "name": "dragdrop",
+ "sig": "function (_self, dd, targetId, e)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires when dragged row(s) are dropped on a valid DD target"
+ },
+ {
+ "name": "dragenter\n Fires when the dragged row(s) first cross another DD target while being dragged",
+ "sig": "function (_self, dd, targetId, e)\n{\n\n}",
+ "type": "function",
+ "desc": ""
+ },
+ {
+ "name": "dragout",
+ "sig": "function (_self, dd, targetId, e)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires when the dragged row(s) leave another DD target while being dragged"
+ },
+ {
+ "name": "dragover",
+ "sig": "function (_self, dd, targetId, e)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires while row(s) are being dragged. \"targetId\" is the id of the Yahoo.util.DD object the selected rows are being dragged over."
+ },
+ {
+ "name": "enddrag",
+ "sig": "function (_self, dd, e)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires when a drag operation is complete"
+ },
+ {
+ "name": "headerclick",
+ "sig": "function (_self, columnIndex, e)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires when a header is clicked"
+ },
+ {
+ "name": "headercontextmenu",
+ "sig": "function (_self, columnIndex, e)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires when a header is right clicked"
+ },
+ {
+ "name": "headerdblclick",
+ "sig": "function (_self, columnIndex, e)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires when a header cell is double clicked"
+ },
+ {
+ "name": "keydown",
+ "sig": "function (e)\n{\n\n}",
+ "type": "function",
+ "desc": "The raw keydown event for the entire grid."
+ },
+ {
+ "name": "keypress",
+ "sig": "function (e)\n{\n\n}",
+ "type": "function",
+ "desc": "The raw keypress event for the entire grid."
+ },
+ {
+ "name": "mousedown",
+ "sig": "function (e)\n{\n\n}",
+ "type": "function",
+ "desc": "The raw mousedown event for the entire grid."
+ },
+ {
+ "name": "mouseout",
+ "sig": "function (e)\n{\n\n}",
+ "type": "function",
+ "desc": "The raw mouseout event for the entire grid."
+ },
+ {
+ "name": "mouseover",
+ "sig": "function (e)\n{\n\n}",
+ "type": "function",
+ "desc": "The raw mouseover event for the entire grid."
+ },
+ {
+ "name": "mouseup",
+ "sig": "function (e)\n{\n\n}",
+ "type": "function",
+ "desc": "The raw mouseup event for the entire grid."
+ },
+ {
+ "name": "render",
+ "sig": "function (grid)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires when the grid is rendered"
+ },
+ {
+ "name": "rowclass",
+ "sig": "function (gridview, rowcfg)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires when a row is rendered, so you can change add a style to it."
+ },
+ {
+ "name": "rowclick",
+ "sig": "function (_self, rowIndex, e)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires when a row is clicked"
+ },
+ {
+ "name": "rowcontextmenu",
+ "sig": "function (_self, rowIndex, e)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires when a row is right clicked"
+ },
+ {
+ "name": "rowdblclick",
+ "sig": "function (_self, rowIndex, e)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires when a row is double clicked"
+ },
+ {
+ "name": "startdrag",
+ "sig": "function (_self, dd, e)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires when row(s) start being dragged"
+ }
+ ],
+ "methods": [
+ {
+ "name": "addEvents",
+ "sig": "(Object object)",
+ "type": "function",
+ "desc": "Used to define events on this Observable"
+ },
+ {
+ "name": "addListener",
+ "sig": "(String eventName, Function handler, Object scope, Object options)",
+ "type": "function",
+ "desc": "Appends an event handler to this component"
+ },
+ {
+ "name": "autoSize",
+ "sig": "()",
+ "type": "function",
+ "desc": "Causes the grid to manually recalculate its dimensions. Generally this is done automatically,\nbut if manual update is required this method will initiate it."
+ },
+ {
+ "name": "capture",
+ "sig": "(Observable o, Function fn, Object scope)",
+ "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."
+ },
+ {
+ "name": "destroy",
+ "sig": "(Boolean removeEl)",
+ "type": "function",
+ "desc": "Destroy this grid."
+ },
+ {
+ "name": "fireEvent",
+ "sig": "(String eventName, Object... args)",
+ "type": "function",
+ "desc": "Fires the specified event with the passed parameters (minus the event name)."
+ },
+ {
+ "name": "getColumnModel",
+ "sig": "()",
+ "type": "function",
+ "desc": "Returns the grid's ColumnModel."
+ },
+ {
+ "name": "getDataSource",
+ "sig": "()",
+ "type": "function",
+ "desc": "Returns the grid's DataSource."
+ },
+ {
+ "name": "getDragDropText",
+ "sig": "()",
+ "type": "function",
+ "desc": "Called to get grid's drag proxy text, by default returns this.ddText."
+ },
+ {
+ "name": "getGridEl",
+ "sig": "()",
+ "type": "function",
+ "desc": "Returns the grid's underlying element."
+ },
+ {
+ "name": "getSelectionModel",
+ "sig": "()",
+ "type": "function",
+ "desc": "Returns the grid's SelectionModel."
+ },
+ {
+ "name": "getView",
+ "sig": "()",
+ "type": "function",
+ "desc": "Returns the grid's GridView object."
+ },
+ {
+ "name": "hasListener",
+ "sig": "(String eventName)",
+ "type": "function",
+ "desc": "Checks to see if this object has any listeners for a specified event"
+ },
+ {
+ "name": "on",
+ "sig": "(String eventName, Function handler, Object scope, Object options)",
+ "type": "function",
+ "desc": "Appends an event handler to this element (shorthand for addListener)"
+ },
+ {
+ "name": "purgeListeners",
+ "sig": "()",
+ "type": "function",
+ "desc": "Removes all listeners for this object"
+ },
+ {
+ "name": "reconfigure",
+ "sig": "(Roo.data.Store dataSource, Roo.grid.ColumnModel The)",
+ "type": "function",
+ "desc": "Reconfigures the grid to use a different Store and Column Model.\nThe View will be bound to the new objects and refreshed."
+ },
+ {
+ "name": "releaseCapture",
+ "sig": "(Observable o)",
+ "type": "function",
+ "desc": "Removes <b>all</b> added captures from the Observable."
+ },
+ {
+ "name": "removeListener",
+ "sig": "(String eventName, Function handler, Object scope)",
+ "type": "function",
+ "desc": "Removes a listener"
+ },
+ {
+ "name": "render",
+ "sig": "()",
+ "type": "function",
+ "desc": "Called once after all setup has been completed and the grid is ready to be rendered."
+ },
+ {
+ "name": "un",
+ "sig": "(String eventName, Function handler, Object scope)",
+ "type": "function",
+ "desc": "Removes a listener (shorthand for removeListener)"
+ }
+ ]
+ },
+ "Roo.grid.GridEditor": {
+ "props": [
+ {
+ "name": "field",
+ "type": "Roo.form.Field",
+ "desc": "Field to wrap (or xtyped)",
+ "memberOf": ""
+ },
+ {
+ "name": "autosize",
+ "type": "Boolean/String",
+ "desc": "True for the editor to automatically adopt the size of the underlying field, \"width\" to adopt the width only,\nor \"height\" to adopt the height only (defaults to false)",
+ "memberOf": "Roo.Editor"
+ },
+ {
+ "name": "revertInvalid",
+ "type": "Boolean",
+ "desc": "True to automatically revert the field value and cancel the edit when the user completes an edit and the field\nvalidation fails (defaults to true)",
+ "memberOf": "Roo.Editor"
+ },
+ {
+ "name": "ignoreNoChange",
+ "type": "Boolean",
+ "desc": "True to skip the the edit completion process (no save, no events fired) if the user completes an edit and\nthe value has not changed (defaults to false). Applies only to string values - edits for other data types\nwill never be ignored.",
+ "memberOf": "Roo.Editor"
+ },
+ {
+ "name": "hideEl",
+ "type": "Boolean",
+ "desc": "False to keep the bound element visible while the editor is displayed (defaults to true)",
+ "memberOf": "Roo.Editor"
+ },
+ {
+ "name": "value",
+ "type": "Mixed",
+ "desc": "The data value of the underlying field (defaults to \"\")",
+ "memberOf": "Roo.Editor"
+ },
+ {
+ "name": "alignment",
+ "type": "String",
+ "desc": "The position to align to (see {@link Roo.Element#alignTo} for more details, defaults to \"c-c?\").",
+ "memberOf": "Roo.Editor"
+ },
+ {
+ "name": "shadow",
+ "type": "Boolean/String",
+ "desc": "\"sides\" for sides/bottom only, \"frame\" for 4-way shadow, and \"drop\"\nfor bottom-right shadow (defaults to \"frame\")",
+ "memberOf": "Roo.Editor"
+ },
+ {
+ "name": "constrain",
+ "type": "Boolean",
+ "desc": "True to constrain the editor to the viewport",
+ "memberOf": "Roo.Editor"
+ },
+ {
+ "name": "completeOnEnter",
+ "type": "Boolean",
+ "desc": "True to complete the edit when the enter key is pressed (defaults to false)",
+ "memberOf": "Roo.Editor"
+ },
+ {
+ "name": "cancelOnEsc",
+ "type": "Boolean",
+ "desc": "True to cancel the edit when the escape key is pressed (defaults to false)",
+ "memberOf": "Roo.Editor"
+ },
+ {
+ "name": "updateEl",
+ "type": "Boolean",
+ "desc": "True to update the innerHTML of the bound element when the update completes (defaults to false)",
+ "memberOf": "Roo.Editor"
+ },
+ {
+ "name": "disableClass",
+ "type": "String",
+ "desc": "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").",
+ "memberOf": "Roo.Component"
+ },
+ {
+ "name": "allowDomMove",
+ "type": "Boolean",
+ "desc": "Whether the component can move the Dom node when rendering (defaults to true).",
+ "memberOf": "Roo.Component"
+ },
+ {
+ "name": "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\".",
+ "memberOf": "Roo.Component",
+ "optvals": [
+ "display",
+ "visibility"
+ ]
+ },
+ {
+ "name": "actionMode",
+ "type": "String",
+ "desc": "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el'",
+ "memberOf": "Roo.Component"
+ },
+ {
+ "name": "listeners",
+ "type": "Object",
+ "desc": "list of events and functions to call for 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": "beforecomplete",
+ "sig": "function (_self, value, startValue)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires after a change has been made to the field, but before the change is reflected in the underlying\nfield. Saving the change to the field can be canceled by returning false from the handler of this event.\nNote that if the value has not changed and ignoreNoChange = true, the editing will still end but this\nevent will not fire since no edit actually occurred."
+ },
+ {
+ "name": "beforedestroy",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires before the component is destroyed. Return false to stop the destroy."
+ },
+ {
+ "name": "beforehide",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires before the component is hidden. Return false to stop the hide."
+ },
+ {
+ "name": "beforerender",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires before the component is rendered. Return false to stop the render."
+ },
+ {
+ "name": "beforeshow",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires before the component is shown. Return false to stop the show."
+ },
+ {
+ "name": "beforestartedit",
+ "sig": "function (_self, boundEl, value)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires when editing is initiated, but before the value changes. Editing can be canceled by returning\nfalse from the handler of this event."
+ },
+ {
+ "name": "complete",
+ "sig": "function (_self, value, startValue)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires after editing is complete and any changed value has been written to the underlying field."
+ },
+ {
+ "name": "destroy",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires after the component is destroyed."
+ },
+ {
+ "name": "disable",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires after the component is disabled."
+ },
+ {
+ "name": "enable",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires after the component is enabled."
+ },
+ {
+ "name": "hide",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires after the component is hidden."
+ },
+ {
+ "name": "render",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires after the component is rendered."
+ },
+ {
+ "name": "show",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires after the component is shown."
+ },
+ {
+ "name": "specialkey",
+ "sig": "function (_self, e)\n{\n\n}",
+ "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."
+ },
+ {
+ "name": "startedit",
+ "sig": "function (boundEl, value)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires when this editor is displayed"
+ }
+ ],
+ "methods": [
+ {
+ "name": "addEvents",
+ "sig": "(Object object)",
+ "type": "function",
+ "desc": "Used to define events on this Observable"
+ },
+ {
+ "name": "addListener",
+ "sig": "(String eventName, Function handler, Object scope, Object options)",
+ "type": "function",
+ "desc": "Appends an event handler to this component"
+ },
+ {
+ "name": "cancelEdit",
+ "sig": "(Boolean remainVisible)",
+ "type": "function",
+ "desc": "Cancels the editing process and hides the editor without persisting any changes. The field value will be\nreverted to the original starting value."
+ },
+ {
+ "name": "capture",
+ "sig": "(Observable o, Function fn, Object scope)",
+ "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."
+ },
+ {
+ "name": "completeEdit",
+ "sig": "(Boolean remainVisible)",
+ "type": "function",
+ "desc": "Ends the editing process, persists the changed value to the underlying field, and hides the editor."
+ },
+ {
+ "name": "destroy",
+ "sig": "()",
+ "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}."
+ },
+ {
+ "name": "disable",
+ "sig": "()",
+ "type": "function",
+ "desc": "Disable this component."
+ },
+ {
+ "name": "enable",
+ "sig": "()",
+ "type": "function",
+ "desc": "Enable this component."
+ },
+ {
+ "name": "fireEvent",
+ "sig": "(String eventName, Object... args)",
+ "type": "function",
+ "desc": "Fires the specified event with the passed parameters (minus the event name)."
+ },
+ {
+ "name": "focus",
+ "sig": "(Boolean selectText)",
+ "type": "function",
+ "desc": "Try to focus this component."
+ },
+ {
+ "name": "getEl",
+ "sig": "()",
+ "type": "function",
+ "desc": "Returns the underlying {@link Roo.Element}."
+ },
+ {
+ "name": "getId",
+ "sig": "()",
+ "type": "function",
+ "desc": "Returns the id of this component."
+ },
+ {
+ "name": "getValue",
+ "sig": "()",
+ "type": "function",
+ "desc": "Gets the data value of the editor"
+ },
+ {
+ "name": "hasListener",
+ "sig": "(String eventName)",
+ "type": "function",
+ "desc": "Checks to see if this object has any listeners for a specified event"
+ },
+ {
+ "name": "hide",
+ "sig": "()",
+ "type": "function",
+ "desc": "Hide this component."
+ },
+ {
+ "name": "isVisible",
+ "sig": "()",
+ "type": "function",
+ "desc": "Returns true if this component is visible."
+ },
+ {
+ "name": "on",
+ "sig": "(String eventName, Function handler, Object scope, Object options)",
+ "type": "function",
+ "desc": "Appends an event handler to this element (shorthand for addListener)"
+ },
+ {
+ "name": "purgeListeners",
+ "sig": "()",
+ "type": "function",
+ "desc": "Removes all listeners for this object"
+ },
+ {
+ "name": "realign",
+ "sig": "()",
+ "type": "function",
+ "desc": "Realigns the editor to the bound field based on the current alignment config value."
+ },
+ {
+ "name": "releaseCapture",
+ "sig": "(Observable o)",
+ "type": "function",
+ "desc": "Removes <b>all</b> added captures from the Observable."
+ },
+ {
+ "name": "removeListener",
+ "sig": "(String eventName, Function handler, Object scope)",
+ "type": "function",
+ "desc": "Removes a listener"
+ },
+ {
+ "name": "render",
+ "sig": "(String/HTMLElement/Element container)",
+ "type": "function",
+ "desc": "If this is a lazy rendering component, render it to its container element."
+ },
+ {
+ "name": "setDisabled",
+ "sig": "(Boolean disabled)",
+ "type": "function",
+ "desc": "Convenience function for setting disabled/enabled by boolean."
+ },
+ {
+ "name": "setSize",
+ "sig": "(Number width, Number height)",
+ "type": "function",
+ "desc": "Sets the height and width of this editor."
+ },
+ {
+ "name": "setValue",
+ "sig": "(Mixed value)",
+ "type": "function",
+ "desc": "Sets the data value of the editor"
+ },
+ {
+ "name": "setVisible",
+ "sig": "(Boolean visible)",
+ "type": "function",
+ "desc": "Convenience function to hide or show this component by boolean."
+ },
+ {
+ "name": "show",
+ "sig": "()",
+ "type": "function",
+ "desc": "Show this component."
+ },
+ {
+ "name": "startEdit",
+ "sig": "(String/HTMLElement/Element el, String value)",
+ "type": "function",
+ "desc": "Starts the editing process and shows the editor."
+ },
+ {
+ "name": "un",
+ "sig": "(String eventName, Function handler, Object scope)",
+ "type": "function",
+ "desc": "Removes a listener (shorthand for removeListener)"
+ }
+ ]
+ },
+ "Roo.grid.GridView": {
+ "props": [
+ {
+ "name": "listeners",
+ "type": "Object",
+ "desc": "list of events and functions to call for this object, \nFor example :\n<pre><code>\n listeners : { \n 'click' : function(e) {\n ..... \n } ,\n .... \n } \n </code></pre>",
+ "memberOf": "Roo.util.Observable"
+ }
+ ],
+ "events": [],
+ "methods": [
+ {
+ "name": "addEvents",
+ "sig": "(Object object)",
+ "type": "function",
+ "desc": "Used to define events on this Observable"
+ },
+ {
+ "name": "addListener",
+ "sig": "(String eventName, Function handler, Object scope, Object options)",
+ "type": "function",
+ "desc": "Appends an event handler to this component"
+ },
+ {
+ "name": "autoSizeColumn",
+ "sig": "(Number colIndex, Boolean forceMinSize)",
+ "type": "function",
+ "desc": "Autofit a column to its content."
+ },
+ {
+ "name": "autoSizeColumns",
+ "sig": "()",
+ "type": "function",
+ "desc": "Autofits all columns to their content and then expands to fit any extra space in the grid"
+ },
+ {
+ "name": "capture",
+ "sig": "(Observable o, Function fn, Object scope)",
+ "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."
+ },
+ {
+ "name": "ensureVisible",
+ "sig": "(Number row, Number col, Boolean hscroll)",
+ "type": "function",
+ "desc": "Scrolls the specified cell into view"
+ },
+ {
+ "name": "fireEvent",
+ "sig": "(String eventName, Object... args)",
+ "type": "function",
+ "desc": "Fires the specified event with the passed parameters (minus the event name)."
+ },
+ {
+ "name": "fitColumns",
+ "sig": "(Boolean reserveScrollSpace)",
+ "type": "function",
+ "desc": "Autofits all columns to the grid's width proportionate with their current size"
+ },
+ {
+ "name": "focusCell",
+ "sig": "(Number row, Number col, Boolean hscroll)",
+ "type": "function",
+ "desc": "Focuses the specified cell."
+ },
+ {
+ "name": "focusRow",
+ "sig": "(Number row)",
+ "type": "function",
+ "desc": "Focuses the specified row."
+ },
+ {
+ "name": "getCell",
+ "sig": "(Integer rowIndex, Integer colIndex)",
+ "type": "function",
+ "desc": "Gets the 'td' of the cell"
+ },
+ {
+ "name": "getFooterPanel",
+ "sig": "(Boolean doShow)",
+ "type": "function",
+ "desc": "Gets a panel in the footer of the grid that can be used for toolbars etc.\nAfter modifying the contents of this panel a call to grid.autoSize() may be\nrequired to register any changes in size."
+ },
+ {
+ "name": "getHeaderPanel",
+ "sig": "(Boolean doShow)",
+ "type": "function",
+ "desc": "Gets a panel in the header of the grid that can be used for toolbars etc.\nAfter modifying the contents of this panel a call to grid.autoSize() may be\nrequired to register any changes in size."
+ },
+ {
+ "name": "hasListener",
+ "sig": "(String eventName)",
+ "type": "function",
+ "desc": "Checks to see if this object has any listeners for a specified event"
+ },
+ {
+ "name": "on",
+ "sig": "(String eventName, Function handler, Object scope, Object options)",
+ "type": "function",
+ "desc": "Appends an event handler to this element (shorthand for addListener)"
+ },
+ {
+ "name": "purgeListeners",
+ "sig": "()",
+ "type": "function",
+ "desc": "Removes all listeners for this object"
+ },
+ {
+ "name": "refresh",
+ "sig": "(Boolean headersToo)",
+ "type": "function",
+ "desc": "Refreshes the grid"
+ },
+ {
+ "name": "releaseCapture",
+ "sig": "(Observable o)",
+ "type": "function",
+ "desc": "Removes <b>all</b> added captures from the Observable."
+ },
+ {
+ "name": "removeListener",
+ "sig": "(String eventName, Function handler, Object scope)",
+ "type": "function",
+ "desc": "Removes a listener"
+ },
+ {
+ "name": "scrollToTop",
+ "sig": "()",
+ "type": "function",
+ "desc": "Scrolls the grid to the top"
+ },
+ {
+ "name": "un",
+ "sig": "(String eventName, Function handler, Object scope)",
+ "type": "function",
+ "desc": "Removes a listener (shorthand for removeListener)"
+ }
+ ]
+ },
+ "Roo.grid.PropertyGrid": {
+ "props": [
+ {
+ "name": "customEditors",
+ "type": "Object",
+ "desc": "map of colnames=> custom editors.\nthe custom editor can be one of the standard ones (date|string|number|int|boolean), or a\ngrid editor eg. Roo.grid.GridEditor(new Roo.form.TextArea({selectOnFocus:true})),\nfalse disables editing of the field.",
+ "memberOf": ""
+ },
+ {
+ "name": "propertyNames",
+ "type": "Object",
+ "desc": "map of property Names to their displayed value",
+ "memberOf": ""
+ },
+ {
+ "name": "clicksToEdit",
+ "type": "Number",
+ "desc": "The number of clicks on a cell required to display the cell's editor (defaults to 2)",
+ "memberOf": "Roo.grid.EditorGrid"
+ },
+ {
+ "name": "ddGroup",
+ "type": "String",
+ "desc": "- drag drop group.",
+ "memberOf": "Roo.grid.Grid"
+ },
+ {
+ "name": "enableDrag",
+ "type": "Boolean",
+ "desc": "True to enable drag of rows. Default is false. (double check if this is needed?)",
+ "memberOf": "Roo.grid.Grid"
+ },
+ {
+ "name": "autoWidth",
+ "type": "Boolean",
+ "desc": "True to set the grid's width to the default total width of the grid's columns instead\nof a fixed width. Default is false.",
+ "memberOf": "Roo.grid.Grid"
+ },
+ {
+ "name": "maxHeight",
+ "type": "Number",
+ "desc": "Sets the maximum height of the grid - ignored if autoHeight is not on.",
+ "memberOf": "Roo.grid.Grid"
+ },
+ {
+ "name": "minColumnWidth",
+ "type": "Number",
+ "desc": "The minimum width a column can be resized to. Default is 25.",
+ "memberOf": "Roo.grid.Grid"
+ },
+ {
+ "name": "autoSizeColumns",
+ "type": "Boolean",
+ "desc": "True to automatically resize the columns to fit their content\n<b>on initial render.</b> It is more efficient to explicitly size the columns\nthrough the ColumnModel's {@link Roo.grid.ColumnModel#width} config option. Default is false.",
+ "memberOf": "Roo.grid.Grid"
+ },
+ {
+ "name": "autoSizeHeaders",
+ "type": "Boolean",
+ "desc": "True to measure headers with column data when auto sizing columns. Default is true.",
+ "memberOf": "Roo.grid.Grid"
+ },
+ {
+ "name": "monitorWindowResize",
+ "type": "Boolean",
+ "desc": "True to autoSize the grid when the window resizes. Default is true.",
+ "memberOf": "Roo.grid.Grid"
+ },
+ {
+ "name": "maxRowsToMeasure",
+ "type": "Boolean",
+ "desc": "If autoSizeColumns is on, maxRowsToMeasure can be used to limit the number of\nrows measured to get a columns size. Default is 0 (all rows).",
+ "memberOf": "Roo.grid.Grid"
+ },
+ {
+ "name": "trackMouseOver",
+ "type": "Boolean",
+ "desc": "True to highlight rows when the mouse is over. Default is true.",
+ "memberOf": "Roo.grid.Grid"
+ },
+ {
+ "name": "enableDragDrop",
+ "type": "Boolean",
+ "desc": "True to enable drag and drop of rows. Default is false.",
+ "memberOf": "Roo.grid.Grid"
+ },
+ {
+ "name": "enableColumnMove",
+ "type": "Boolean",
+ "desc": "True to enable drag and drop reorder of columns. Default is true.",
+ "memberOf": "Roo.grid.Grid"
+ },
+ {
+ "name": "enableColumnHide",
+ "type": "Boolean",
+ "desc": "True to enable hiding of columns with the header context menu. Default is true.",
+ "memberOf": "Roo.grid.Grid"
+ },
+ {
+ "name": "enableRowHeightSync",
+ "type": "Boolean",
+ "desc": "True to manually sync row heights across locked and not locked rows. Default is false.",
+ "memberOf": "Roo.grid.Grid"
+ },
+ {
+ "name": "stripeRows",
+ "type": "Boolean",
+ "desc": "True to stripe the rows. Default is true.",
+ "memberOf": "Roo.grid.Grid"
+ },
+ {
+ "name": "autoHeight",
+ "type": "Boolean",
+ "desc": "True to fit the height of the grid container to the height of the data. Default is false.",
+ "memberOf": "Roo.grid.Grid"
+ },
+ {
+ "name": "autoExpandColumn",
+ "type": "String",
+ "desc": "The id (or dataIndex) of a column in this grid that should expand to fill unused space. This id can not be 0. Default is false.",
+ "memberOf": "Roo.grid.Grid"
+ },
+ {
+ "name": "autoExpandMin",
+ "type": "Number",
+ "desc": "The minimum width the autoExpandColumn can have (if enabled).\nDefault is 50.",
+ "memberOf": "Roo.grid.Grid"
+ },
+ {
+ "name": "autoExpandMax",
+ "type": "Number",
+ "desc": "The maximum width the autoExpandColumn can have (if enabled). Default is 1000.",
+ "memberOf": "Roo.grid.Grid"
+ },
+ {
+ "name": "view",
+ "type": "Object",
+ "desc": "The {@link Roo.grid.GridView} used by the grid. This can be set before a call to render().",
+ "memberOf": "Roo.grid.Grid"
+ },
+ {
+ "name": "loadMask",
+ "type": "Object",
+ "desc": "An {@link Roo.LoadMask} config or true to mask the grid while loading. Default is false.",
+ "memberOf": "Roo.grid.Grid"
+ },
+ {
+ "name": "dropTarget",
+ "type": "Roo.dd.DropTarget",
+ "desc": "An {@link Roo.dd.DropTarget} config",
+ "memberOf": "Roo.grid.Grid"
+ },
+ {
+ "name": "listeners",
+ "type": "Object",
+ "desc": "list of events and functions to call for this object, \nFor example :\n<pre><code>\n listeners : { \n 'click' : function(e) {\n ..... \n } ,\n .... \n } \n </code></pre>",
+ "memberOf": "Roo.util.Observable"
+ }
+ ],
+ "events": [
+ {
+ "name": "afteredit",
+ "sig": "function (e)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires after a cell is edited. <br />\n<ul style=\"padding:5px;padding-left:16px;\">\n<li>grid - This grid</li>\n<li>record - The record being edited</li>\n<li>field - The field name being edited</li>\n<li>value - The value being set</li>\n<li>originalValue - The original value for the field, before the edit.</li>\n<li>row - The grid row index</li>\n<li>column - The grid column index</li>\n</ul>"
+ },
+ {
+ "name": "beforeedit",
+ "sig": "function (e)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires before cell editing is triggered. The edit event object has the following properties <br />\n<ul style=\"padding:5px;padding-left:16px;\">\n<li>grid - This grid</li>\n<li>record - The record being edited</li>\n<li>field - The field name being edited</li>\n<li>value - The value for the field being edited.</li>\n<li>row - The grid row index</li>\n<li>column - The grid column index</li>\n<li>cancel - Set this to true to cancel the edit or return false from your handler.</li>\n</ul>"
+ },
+ {
+ "name": "beforepropertychange",
+ "sig": "function (grid, id, newval, oldval)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires before a property changes (return false to stop?)"
+ },
+ {
+ "name": "bodyscroll",
+ "sig": "function (scrollLeft, scrollTop)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires when the body element is scrolled"
+ },
+ {
+ "name": "cellclick",
+ "sig": "function (_self, rowIndex, columnIndex, e)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires when a cell is clicked"
+ },
+ {
+ "name": "cellcontextmenu",
+ "sig": "function (_self, rowIndex, cellIndex, e)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires when a cell is right clicked"
+ },
+ {
+ "name": "celldblclick",
+ "sig": "function (_self, rowIndex, columnIndex, e)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires when a cell is double clicked"
+ },
+ {
+ "name": "click",
+ "sig": "function (e)\n{\n\n}",
+ "type": "function",
+ "desc": "The raw click event for the entire grid."
+ },
+ {
+ "name": "columnmove",
+ "sig": "function (oldIndex, newIndex)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires when the user moves a column"
+ },
+ {
+ "name": "columnresize",
+ "sig": "function (columnIndex, newSize)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires when the user resizes a column"
+ },
+ {
+ "name": "contextmenu",
+ "sig": "function (e)\n{\n\n}",
+ "type": "function",
+ "desc": "The raw contextmenu event for the entire grid."
+ },
+ {
+ "name": "dblclick",
+ "sig": "function (e)\n{\n\n}",
+ "type": "function",
+ "desc": "The raw dblclick event for the entire grid."
+ },
+ {
+ "name": "dragdrop",
+ "sig": "function (_self, dd, targetId, e)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires when dragged row(s) are dropped on a valid DD target"
+ },
+ {
+ "name": "dragenter\n Fires when the dragged row(s) first cross another DD target while being dragged",
+ "sig": "function (_self, dd, targetId, e)\n{\n\n}",
+ "type": "function",
+ "desc": ""
+ },
+ {
+ "name": "dragout",
+ "sig": "function (_self, dd, targetId, e)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires when the dragged row(s) leave another DD target while being dragged"
+ },
+ {
+ "name": "dragover",
+ "sig": "function (_self, dd, targetId, e)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires while row(s) are being dragged. \"targetId\" is the id of the Yahoo.util.DD object the selected rows are being dragged over."
+ },
+ {
+ "name": "enddrag",
+ "sig": "function (_self, dd, e)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires when a drag operation is complete"
+ },
+ {
+ "name": "headerclick",
+ "sig": "function (_self, columnIndex, e)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires when a header is clicked"
+ },
+ {
+ "name": "headercontextmenu",
+ "sig": "function (_self, columnIndex, e)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires when a header is right clicked"
+ },
+ {
+ "name": "headerdblclick",
+ "sig": "function (_self, columnIndex, e)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires when a header cell is double clicked"
+ },
+ {
+ "name": "keydown",
+ "sig": "function (e)\n{\n\n}",
+ "type": "function",
+ "desc": "The raw keydown event for the entire grid."
+ },
+ {
+ "name": "keypress",
+ "sig": "function (e)\n{\n\n}",
+ "type": "function",
+ "desc": "The raw keypress event for the entire grid."
+ },
+ {
+ "name": "mousedown",
+ "sig": "function (e)\n{\n\n}",
+ "type": "function",
+ "desc": "The raw mousedown event for the entire grid."
+ },
+ {
+ "name": "mouseout",
+ "sig": "function (e)\n{\n\n}",
+ "type": "function",
+ "desc": "The raw mouseout event for the entire grid."
+ },
+ {
+ "name": "mouseover",
+ "sig": "function (e)\n{\n\n}",
+ "type": "function",
+ "desc": "The raw mouseover event for the entire grid."
+ },
+ {
+ "name": "mouseup",
+ "sig": "function (e)\n{\n\n}",
+ "type": "function",
+ "desc": "The raw mouseup event for the entire grid."
+ },
+ {
+ "name": "propertychange",
+ "sig": "function (grid, id, newval, oldval)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires after a property changes"
+ },
+ {
+ "name": "render",
+ "sig": "function (grid)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires when the grid is rendered"
+ },
+ {
+ "name": "rowclass",
+ "sig": "function (gridview, rowcfg)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires when a row is rendered, so you can change add a style to it."
+ },
+ {
+ "name": "rowclick",
+ "sig": "function (_self, rowIndex, e)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires when a row is clicked"
+ },
+ {
+ "name": "rowcontextmenu",
+ "sig": "function (_self, rowIndex, e)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires when a row is right clicked"
+ },
+ {
+ "name": "rowdblclick",
+ "sig": "function (_self, rowIndex, e)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires when a row is double clicked"
+ },
+ {
+ "name": "startdrag",
+ "sig": "function (_self, dd, e)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires when row(s) start being dragged"
+ },
+ {
+ "name": "validateedit",
+ "sig": "function (e)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires after a cell is edited, but before the value is set in the record. \nYou can use this to modify the value being set in the field, Return false\nto cancel the change. The edit event object has the following properties <br />\n<ul style=\"padding:5px;padding-left:16px;\">\n<li>editor - This editor</li>\n<li>grid - This grid</li>\n<li>record - The record being edited</li>\n<li>field - The field name being edited</li>\n<li>value - The value being set</li>\n<li>originalValue - The original value for the field, before the edit.</li>\n<li>row - The grid row index</li>\n<li>column - The grid column index</li>\n<li>cancel - Set this to true to cancel the edit or return false from your handler.</li>\n</ul>"
+ }
+ ],
+ "methods": [
+ {
+ "name": "addEvents",
+ "sig": "(Object object)",
+ "type": "function",
+ "desc": "Used to define events on this Observable"
+ },
+ {
+ "name": "addListener",
+ "sig": "(String eventName, Function handler, Object scope, Object options)",
+ "type": "function",
+ "desc": "Appends an event handler to this component"
+ },
+ {
+ "name": "autoSize",
+ "sig": "()",
+ "type": "function",
+ "desc": "Causes the grid to manually recalculate its dimensions. Generally this is done automatically,\nbut if manual update is required this method will initiate it."
+ },
+ {
+ "name": "capture",
+ "sig": "(Observable o, Function fn, Object scope)",
+ "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."
+ },
+ {
+ "name": "destroy",
+ "sig": "(Boolean removeEl)",
+ "type": "function",
+ "desc": "Destroy this grid."
+ },
+ {
+ "name": "fireEvent",
+ "sig": "(String eventName, Object... args)",
+ "type": "function",
+ "desc": "Fires the specified event with the passed parameters (minus the event name)."
+ },
+ {
+ "name": "getColumnModel",
+ "sig": "()",
+ "type": "function",
+ "desc": "Returns the grid's ColumnModel."
+ },
+ {
+ "name": "getDataSource",
+ "sig": "()",
+ "type": "function",
+ "desc": "Returns the grid's DataSource."
+ },
+ {
+ "name": "getDragDropText",
+ "sig": "()",
+ "type": "function",
+ "desc": "Called to get grid's drag proxy text, by default returns this.ddText."
+ },
+ {
+ "name": "getGridEl",
+ "sig": "()",
+ "type": "function",
+ "desc": "Returns the grid's underlying element."
+ },
+ {
+ "name": "getSelectionModel",
+ "sig": "()",
+ "type": "function",
+ "desc": "Returns the grid's SelectionModel."
+ },
+ {
+ "name": "getSource",
+ "sig": "()",
+ "type": "function",
+ "desc": "Gets all the data from the grid."
+ },
+ {
+ "name": "getView",
+ "sig": "()",
+ "type": "function",
+ "desc": "Returns the grid's GridView object."
+ },
+ {
+ "name": "hasListener",
+ "sig": "(String eventName)",
+ "type": "function",
+ "desc": "Checks to see if this object has any listeners for a specified event"
+ },
+ {
+ "name": "on",
+ "sig": "(String eventName, Function handler, Object scope, Object options)",
+ "type": "function",
+ "desc": "Appends an event handler to this element (shorthand for addListener)"
+ },
+ {
+ "name": "purgeListeners",
+ "sig": "()",
+ "type": "function",
+ "desc": "Removes all listeners for this object"
+ },
+ {
+ "name": "reconfigure",
+ "sig": "(Roo.data.Store dataSource, Roo.grid.ColumnModel The)",
+ "type": "function",
+ "desc": "Reconfigures the grid to use a different Store and Column Model.\nThe View will be bound to the new objects and refreshed."
+ },
+ {
+ "name": "releaseCapture",
+ "sig": "(Observable o)",
+ "type": "function",
+ "desc": "Removes <b>all</b> added captures from the Observable."
+ },
+ {
+ "name": "removeListener",
+ "sig": "(String eventName, Function handler, Object scope)",
+ "type": "function",
+ "desc": "Removes a listener"
+ },
+ {
+ "name": "render",
+ "sig": "()",
+ "type": "function",
+ "desc": "Called once after all setup has been completed and the grid is ready to be rendered."
+ },
+ {
+ "name": "setSource",
+ "sig": "(Object data)",
+ "type": "function",
+ "desc": "Sets the data for the Grid\naccepts a Key => Value object of all the elements avaiable."
+ },
+ {
+ "name": "startEditing",
+ "sig": "(Number rowIndex, Number colIndex)",
+ "type": "function",
+ "desc": "Starts editing the specified for the specified row/column"
+ },
+ {
+ "name": "stopEditing",
+ "sig": "()",
+ "type": "function",
+ "desc": "Stops any active editing"
+ },
+ {
+ "name": "un",
+ "sig": "(String eventName, Function handler, Object scope)",
+ "type": "function",
+ "desc": "Removes a listener (shorthand for removeListener)"
+ }
+ ]
+ },
+ "Roo.grid.RowSelectionModel": {
+ "props": [
+ {
+ "name": "singleSelect",
+ "type": "Boolean",
+ "desc": "True to allow selection of only one row at a time (defaults to false)",
+ "memberOf": ""
+ },
+ {
+ "name": "listeners",
+ "type": "Object",
+ "desc": "list of events and functions to call for this object, \nFor example :\n<pre><code>\n listeners : { \n 'click' : function(e) {\n ..... \n } ,\n .... \n } \n </code></pre>",
+ "memberOf": "Roo.util.Observable"
+ }
+ ],
+ "events": [
+ {
+ "name": "afterselectionchange",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires after the selection changes (eg. by key press or clicking)"
+ },
+ {
+ "name": "beforerowselect",
+ "sig": "function (_self, rowIndex, keepExisting)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires when a row is selected being selected, return false to cancel."
+ },
+ {
+ "name": "rowdeselect",
+ "sig": "function (_self, rowIndex)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires when a row is deselected."
+ },
+ {
+ "name": "rowselect",
+ "sig": "function (_self, rowIndex, r)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires when a row is selected."
+ },
+ {
+ "name": "selectionchange",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires when the selection changes"
+ }
+ ],
+ "methods": [
+ {
+ "name": "addEvents",
+ "sig": "(Object object)",
+ "type": "function",
+ "desc": "Used to define events on this Observable"
+ },
+ {
+ "name": "addListener",
+ "sig": "(String eventName, Function handler, Object scope, Object options)",
+ "type": "function",
+ "desc": "Appends an event handler to this component"
+ },
+ {
+ "name": "capture",
+ "sig": "(Observable o, Function fn, Object scope)",
+ "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."
+ },
+ {
+ "name": "clearSelections",
+ "sig": "()",
+ "type": "function",
+ "desc": "Clears all selections."
+ },
+ {
+ "name": "deselectRange",
+ "sig": "(Number startRow, Number endRow)",
+ "type": "function",
+ "desc": "Deselects a range of rows. All rows in between startRow and endRow are also deselected."
+ },
+ {
+ "name": "deselectRow",
+ "sig": "(Number row)",
+ "type": "function",
+ "desc": "Deselects a row."
+ },
+ {
+ "name": "fireEvent",
+ "sig": "(String eventName, Object... args)",
+ "type": "function",
+ "desc": "Fires the specified event with the passed parameters (minus the event name)."
+ },
+ {
+ "name": "getCount",
+ "sig": "()",
+ "type": "function",
+ "desc": "Gets the number of selected rows."
+ },
+ {
+ "name": "getSelected",
+ "sig": "()",
+ "type": "function",
+ "desc": "Returns the first selected record."
+ },
+ {
+ "name": "getSelections",
+ "sig": "()",
+ "type": "function",
+ "desc": "Returns the selected records"
+ },
+ {
+ "name": "hasListener",
+ "sig": "(String eventName)",
+ "type": "function",
+ "desc": "Checks to see if this object has any listeners for a specified event"
+ },
+ {
+ "name": "hasSelection",
+ "sig": "()",
+ "type": "function",
+ "desc": "Returns True if there is a selection."
+ },
+ {
+ "name": "isIdSelected",
+ "sig": "(String id)",
+ "type": "function",
+ "desc": "Returns True if the specified record id is selected."
+ },
+ {
+ "name": "isLocked",
+ "sig": "()",
+ "type": "function",
+ "desc": "Returns true if the selections are locked."
+ },
+ {
+ "name": "isSelected",
+ "sig": "(Number/Record record)",
+ "type": "function",
+ "desc": "Returns True if the specified row is selected."
+ },
+ {
+ "name": "lock",
+ "sig": "()",
+ "type": "function",
+ "desc": "Locks the selections."
+ },
+ {
+ "name": "on",
+ "sig": "(String eventName, Function handler, Object scope, Object options)",
+ "type": "function",
+ "desc": "Appends an event handler to this element (shorthand for addListener)"
+ },
+ {
+ "name": "purgeListeners",
+ "sig": "()",
+ "type": "function",
+ "desc": "Removes all listeners for this object"
+ },
+ {
+ "name": "releaseCapture",
+ "sig": "(Observable o)",
+ "type": "function",
+ "desc": "Removes <b>all</b> added captures from the Observable."
+ },
+ {
+ "name": "removeListener",
+ "sig": "(String eventName, Function handler, Object scope)",
+ "type": "function",
+ "desc": "Removes a listener"
+ },
+ {
+ "name": "selectAll",
+ "sig": "()",
+ "type": "function",
+ "desc": "Selects all rows."
+ },
+ {
+ "name": "selectFirstRow",
+ "sig": "()",
+ "type": "function",
+ "desc": "Selects the first row in the grid."
+ },
+ {
+ "name": "selectLastRow",
+ "sig": "(Boolean keepExisting)",
+ "type": "function",
+ "desc": "Select the last row."
+ },
+ {
+ "name": "selectNext",
+ "sig": "(Boolean keepExisting)",
+ "type": "function",
+ "desc": "Selects the row immediately following the last selected row."
+ },
+ {
+ "name": "selectPrevious",
+ "sig": "(Boolean keepExisting)",
+ "type": "function",
+ "desc": "Selects the row that precedes the last selected row."
+ },
+ {
+ "name": "selectRange",
+ "sig": "(Number startRow, Number endRow, Boolean keepExisting)",
+ "type": "function",
+ "desc": "Selects a range of rows. All rows in between startRow and endRow are also selected."
+ },
+ {
+ "name": "selectRecords",
+ "sig": "(Array records, Boolean keepExisting)",
+ "type": "function",
+ "desc": "Select records."
+ },
+ {
+ "name": "selectRow",
+ "sig": "(Number row, Boolean keepExisting)",
+ "type": "function",
+ "desc": "Selects a row."
+ },
+ {
+ "name": "selectRows",
+ "sig": "(Array rows, Boolean keepExisting)",
+ "type": "function",
+ "desc": "Selects multiple rows."
+ },
+ {
+ "name": "un",
+ "sig": "(String eventName, Function handler, Object scope)",
+ "type": "function",
+ "desc": "Removes a listener (shorthand for removeListener)"
+ },
+ {
+ "name": "unlock",
+ "sig": "()",
+ "type": "function",
+ "desc": "Unlocks the selections."
+ }
+ ]
+ },
+ "Roo.lib": {
+ "props": [],
+ "events": [],
+ "methods": []
+ },
+ "Roo.lib.Ajax": {
+ "props": [],
+ "events": [],
+ "methods": [
+ {
+ "name": "request",
+ "sig": "()",
+ "type": "function",
+ "desc": ""
+ }
+ ]
+ },
+ "Roo.lib.Dom": {
+ "props": [],
+ "events": [],
+ "methods": []
+ },
+ "Roo.mailer": {
+ "props": [],
+ "events": [],
+ "methods": []
+ },
+ "Roo.mailer.Block": {
+ "props": [
+ {
+ "name": "cls",
+ "type": "String",
+ "desc": "class of the element",
+ "memberOf": ""
+ },
+ {
+ "name": "html",
+ "type": "String",
+ "desc": "content of header (not used for columns)",
+ "memberOf": ""
+ },
+ {
+ "name": "blocktype",
+ "type": "String",
+ "desc": "",
+ "memberOf": "",
+ "optvals": [
+ "header",
+ "preheader",
+ "footer",
+ "body",
+ "row"
+ ]
+ },
+ {
+ "name": "style",
+ "type": "String",
+ "desc": "any extra css",
+ "memberOf": "Roo.bootstrap.Component"
+ },
+ {
+ "name": "xattr",
+ "type": "Object",
+ "desc": "extra attributes to add to 'element' (used by builder to store stuff.)",
+ "memberOf": "Roo.bootstrap.Component"
+ },
+ {
+ "name": "can_build_overlaid",
+ "type": "Boolean",
+ "desc": "True if element can be rebuild from a HTML page",
+ "memberOf": "Roo.bootstrap.Component"
+ },
+ {
+ "name": "dataId",
+ "type": "string",
+ "desc": "cutomer id",
+ "memberOf": "Roo.bootstrap.Component"
+ },
+ {
+ "name": "name",
+ "type": "string",
+ "desc": "Specifies name attribute",
+ "memberOf": "Roo.bootstrap.Component"
+ },
+ {
+ "name": "tooltip",
+ "type": "string",
+ "desc": "Text for the tooltip",
+ "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": "disableClass",
+ "type": "String",
+ "desc": "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").",
+ "memberOf": "Roo.Component"
+ },
+ {
+ "name": "allowDomMove",
+ "type": "Boolean",
+ "desc": "Whether the component can move the Dom node when rendering (defaults to true).",
+ "memberOf": "Roo.Component"
+ },
+ {
+ "name": "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\".",
+ "memberOf": "Roo.Component",
+ "optvals": [
+ "display",
+ "visibility"
+ ]
+ },
+ {
+ "name": "actionMode",
+ "type": "String",
+ "desc": "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el'",
+ "memberOf": "Roo.Component"
+ },
+ {
+ "name": "listeners",
+ "type": "Object",
+ "desc": "list of events and functions to call for 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": "beforedestroy",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires before the component is destroyed. Return false to stop the destroy."
+ },
+ {
+ "name": "beforehide",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires before the component is hidden. Return false to stop the hide."
+ },
+ {
+ "name": "beforerender",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires before the component is rendered. Return false to stop the render."
+ },
+ {
+ "name": "beforeshow",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires before the component is shown. Return false to stop the show."
+ },
+ {
+ "name": "childrenrendered",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires when the children have been rendered.."
+ },
+ {
+ "name": "destroy",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires after the component is destroyed."
+ },
+ {
+ "name": "disable",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires after the component is disabled."
+ },
+ {
+ "name": "enable",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires after the component is enabled."
+ },
+ {
+ "name": "hide",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires after the component is hidden."
+ },
+ {
+ "name": "render",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires after the component is rendered."
+ },
+ {
+ "name": "show",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires after the component is shown."
+ }
+ ],
+ "methods": [
+ {
+ "name": "addEvents",
+ "sig": "(Object object)",
+ "type": "function",
+ "desc": "Used to define events on this Observable"
+ },
+ {
+ "name": "addListener",
+ "sig": "(String eventName, Function handler, Object scope, Object options)",
+ "type": "function",
+ "desc": "Appends an event handler to this component"
+ },
+ {
+ "name": "capture",
+ "sig": "(Observable o, Function fn, Object scope)",
+ "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."
+ },
+ {
+ "name": "destroy",
+ "sig": "()",
+ "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}."
+ },
+ {
+ "name": "disable",
+ "sig": "()",
+ "type": "function",
+ "desc": "Disable this component."
+ },
+ {
+ "name": "enable",
+ "sig": "()",
+ "type": "function",
+ "desc": "Enable this component."
+ },
+ {
+ "name": "fireEvent",
+ "sig": "(String eventName, Object... args)",
+ "type": "function",
+ "desc": "Fires the specified event with the passed parameters (minus the event name)."
+ },
+ {
+ "name": "focus",
+ "sig": "(Boolean selectText)",
+ "type": "function",
+ "desc": "Try to focus this component."
+ },
+ {
+ "name": "getChildContainer",
+ "sig": "()",
+ "type": "function",
+ "desc": "Fetch the element to add children to"
+ },
+ {
+ "name": "getEl",
+ "sig": "()",
+ "type": "function",
+ "desc": "Returns the underlying {@link Roo.Element}."
+ },
+ {
+ "name": "getId",
+ "sig": "()",
+ "type": "function",
+ "desc": "Returns the id of this component."
+ },
+ {
+ "name": "hasListener",
+ "sig": "(String eventName)",
+ "type": "function",
+ "desc": "Checks to see if this object has any listeners for a specified event"
+ },
+ {
+ "name": "hide",
+ "sig": "()",
+ "type": "function",
+ "desc": "Hide a component - adds 'hidden' class"
+ },
+ {
+ "name": "initEvents",
+ "sig": "()",
+ "type": "function",
+ "desc": "Initialize Events for the element"
+ },
+ {
+ "name": "isVisible",
+ "sig": "()",
+ "type": "function",
+ "desc": "Returns true if this component is visible."
+ },
+ {
+ "name": "on",
+ "sig": "(String eventName, Function handler, Object scope, Object options)",
+ "type": "function",
+ "desc": "Appends an event handler to this element (shorthand for addListener)"
+ },
+ {
+ "name": "purgeListeners",
+ "sig": "()",
+ "type": "function",
+ "desc": "Removes all listeners for this object"
+ },
+ {
+ "name": "releaseCapture",
+ "sig": "(Observable o)",
+ "type": "function",
+ "desc": "Removes <b>all</b> added captures from the Observable."
+ },
+ {
+ "name": "removeListener",
+ "sig": "(String eventName, Function handler, Object scope)",
+ "type": "function",
+ "desc": "Removes a listener"
+ },
+ {
+ "name": "render",
+ "sig": "(String/HTMLElement/Element container)",
+ "type": "function",
+ "desc": "If this is a lazy rendering component, render it to its container element."
+ },
+ {
+ "name": "setDisabled",
+ "sig": "(Boolean disabled)",
+ "type": "function",
+ "desc": "Convenience function for setting disabled/enabled by boolean."
+ },
+ {
+ "name": "setVisible",
+ "sig": "(Boolean visible)",
+ "type": "function",
+ "desc": "Convenience function to hide or show this component by boolean."
+ },
+ {
+ "name": "show",
+ "sig": "()",
+ "type": "function",
+ "desc": "Show a component - removes 'hidden' class"
+ },
+ {
+ "name": "tooltipEl",
+ "sig": "()",
+ "type": "function",
+ "desc": "Fetch the element to display the tooltip on."
+ },
+ {
+ "name": "un",
+ "sig": "(String eventName, Function handler, Object scope)",
+ "type": "function",
+ "desc": "Removes a listener (shorthand for removeListener)"
+ }
+ ]
+ },
+ "Roo.mailer.Body": {
+ "props": [
+ {
+ "name": "cls",
+ "type": "String",
+ "desc": "css class",
+ "memberOf": "Roo.bootstrap.Component"
+ },
+ {
+ "name": "style",
+ "type": "String",
+ "desc": "any extra css",
+ "memberOf": "Roo.bootstrap.Component"
+ },
+ {
+ "name": "xattr",
+ "type": "Object",
+ "desc": "extra attributes to add to 'element' (used by builder to store stuff.)",
+ "memberOf": "Roo.bootstrap.Component"
+ },
+ {
+ "name": "can_build_overlaid",
+ "type": "Boolean",
+ "desc": "True if element can be rebuild from a HTML page",
+ "memberOf": "Roo.bootstrap.Component"
+ },
+ {
+ "name": "dataId",
+ "type": "string",
+ "desc": "cutomer id",
+ "memberOf": "Roo.bootstrap.Component"
+ },
+ {
+ "name": "name",
+ "type": "string",
+ "desc": "Specifies name attribute",
+ "memberOf": "Roo.bootstrap.Component"
+ },
+ {
+ "name": "tooltip",
+ "type": "string",
+ "desc": "Text for the tooltip",
+ "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": "disableClass",
+ "type": "String",
+ "desc": "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").",
+ "memberOf": "Roo.Component"
+ },
+ {
+ "name": "allowDomMove",
+ "type": "Boolean",
+ "desc": "Whether the component can move the Dom node when rendering (defaults to true).",
+ "memberOf": "Roo.Component"
+ },
+ {
+ "name": "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\".",
+ "memberOf": "Roo.Component",
+ "optvals": [
+ "display",
+ "visibility"
+ ]
+ },
+ {
+ "name": "actionMode",
+ "type": "String",
+ "desc": "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el'",
+ "memberOf": "Roo.Component"
+ },
+ {
+ "name": "listeners",
+ "type": "Object",
+ "desc": "list of events and functions to call for 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": "beforedestroy",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires before the component is destroyed. Return false to stop the destroy."
+ },
+ {
+ "name": "beforehide",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires before the component is hidden. Return false to stop the hide."
+ },
+ {
+ "name": "beforerender",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires before the component is rendered. Return false to stop the render."
+ },
+ {
+ "name": "beforeshow",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires before the component is shown. Return false to stop the show."
+ },
+ {
+ "name": "childrenrendered",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires when the children have been rendered.."
+ },
+ {
+ "name": "destroy",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires after the component is destroyed."
+ },
+ {
+ "name": "disable",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires after the component is disabled."
+ },
+ {
+ "name": "enable",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires after the component is enabled."
+ },
+ {
+ "name": "hide",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires after the component is hidden."
+ },
+ {
+ "name": "render",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires after the component is rendered."
+ },
+ {
+ "name": "show",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires after the component is shown."
+ }
+ ],
+ "methods": [
+ {
+ "name": "addEvents",
+ "sig": "(Object object)",
+ "type": "function",
+ "desc": "Used to define events on this Observable"
+ },
+ {
+ "name": "addListener",
+ "sig": "(String eventName, Function handler, Object scope, Object options)",
+ "type": "function",
+ "desc": "Appends an event handler to this component"
+ },
+ {
+ "name": "capture",
+ "sig": "(Observable o, Function fn, Object scope)",
+ "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."
+ },
+ {
+ "name": "destroy",
+ "sig": "()",
+ "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}."
+ },
+ {
+ "name": "disable",
+ "sig": "()",
+ "type": "function",
+ "desc": "Disable this component."
+ },
+ {
+ "name": "enable",
+ "sig": "()",
+ "type": "function",
+ "desc": "Enable this component."
+ },
+ {
+ "name": "fireEvent",
+ "sig": "(String eventName, Object... args)",
+ "type": "function",
+ "desc": "Fires the specified event with the passed parameters (minus the event name)."
+ },
+ {
+ "name": "focus",
+ "sig": "(Boolean selectText)",
+ "type": "function",
+ "desc": "Try to focus this component."
+ },
+ {
+ "name": "getChildContainer",
+ "sig": "()",
+ "type": "function",
+ "desc": "Fetch the element to add children to"
+ },
+ {
+ "name": "getEl",
+ "sig": "()",
+ "type": "function",
+ "desc": "Returns the underlying {@link Roo.Element}."
+ },
+ {
+ "name": "getId",
+ "sig": "()",
+ "type": "function",
+ "desc": "Returns the id of this component."
+ },
+ {
+ "name": "hasListener",
+ "sig": "(String eventName)",
+ "type": "function",
+ "desc": "Checks to see if this object has any listeners for a specified event"
+ },
+ {
+ "name": "hide",
+ "sig": "()",
+ "type": "function",
+ "desc": "Hide a component - adds 'hidden' class"
+ },
+ {
+ "name": "initEvents",
+ "sig": "()",
+ "type": "function",
+ "desc": "Initialize Events for the element"
+ },
+ {
+ "name": "isVisible",
+ "sig": "()",
+ "type": "function",
+ "desc": "Returns true if this component is visible."
+ },
+ {
+ "name": "on",
+ "sig": "(String eventName, Function handler, Object scope, Object options)",
+ "type": "function",
+ "desc": "Appends an event handler to this element (shorthand for addListener)"
+ },
+ {
+ "name": "purgeListeners",
+ "sig": "()",
+ "type": "function",
+ "desc": "Removes all listeners for this object"
+ },
+ {
+ "name": "releaseCapture",
+ "sig": "(Observable o)",
+ "type": "function",
+ "desc": "Removes <b>all</b> added captures from the Observable."
+ },
+ {
+ "name": "removeListener",
+ "sig": "(String eventName, Function handler, Object scope)",
+ "type": "function",
+ "desc": "Removes a listener"
+ },
+ {
+ "name": "render",
+ "sig": "(String/HTMLElement/Element container)",
+ "type": "function",
+ "desc": "If this is a lazy rendering component, render it to its container element."
+ },
+ {
+ "name": "setDisabled",
+ "sig": "(Boolean disabled)",
+ "type": "function",
+ "desc": "Convenience function for setting disabled/enabled by boolean."
+ },
+ {
+ "name": "setVisible",
+ "sig": "(Boolean visible)",
+ "type": "function",
+ "desc": "Convenience function to hide or show this component by boolean."
+ },
+ {
+ "name": "show",
+ "sig": "()",
+ "type": "function",
+ "desc": "Show a component - removes 'hidden' class"
+ },
+ {
+ "name": "tooltipEl",
+ "sig": "()",
+ "type": "function",
+ "desc": "Fetch the element to display the tooltip on."
+ },
+ {
+ "name": "un",
+ "sig": "(String eventName, Function handler, Object scope)",
+ "type": "function",
+ "desc": "Removes a listener (shorthand for removeListener)"
+ }
+ ]
+ },
+ "Roo.mailer.BodyContainer": {
+ "props": [
+ {
+ "name": "cls",
+ "type": "String",
+ "desc": "class of the element",
+ "memberOf": ""
+ },
+ {
+ "name": "style",
+ "type": "String",
+ "desc": "any extra css",
+ "memberOf": "Roo.bootstrap.Component"
+ },
+ {
+ "name": "xattr",
+ "type": "Object",
+ "desc": "extra attributes to add to 'element' (used by builder to store stuff.)",
+ "memberOf": "Roo.bootstrap.Component"
+ },
+ {
+ "name": "can_build_overlaid",
+ "type": "Boolean",
+ "desc": "True if element can be rebuild from a HTML page",
+ "memberOf": "Roo.bootstrap.Component"
+ },
+ {
+ "name": "dataId",
+ "type": "string",
+ "desc": "cutomer id",
+ "memberOf": "Roo.bootstrap.Component"
+ },
+ {
+ "name": "name",
+ "type": "string",
+ "desc": "Specifies name attribute",
+ "memberOf": "Roo.bootstrap.Component"
+ },
+ {
+ "name": "tooltip",
+ "type": "string",
+ "desc": "Text for the tooltip",
+ "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": "disableClass",
+ "type": "String",
+ "desc": "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").",
+ "memberOf": "Roo.Component"
+ },
+ {
+ "name": "allowDomMove",
+ "type": "Boolean",
+ "desc": "Whether the component can move the Dom node when rendering (defaults to true).",
+ "memberOf": "Roo.Component"
+ },
+ {
+ "name": "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\".",
+ "memberOf": "Roo.Component",
+ "optvals": [
+ "display",
+ "visibility"
+ ]
+ },
+ {
+ "name": "actionMode",
+ "type": "String",
+ "desc": "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el'",
+ "memberOf": "Roo.Component"
+ },
+ {
+ "name": "listeners",
+ "type": "Object",
+ "desc": "list of events and functions to call for 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": "beforedestroy",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires before the component is destroyed. Return false to stop the destroy."
+ },
+ {
+ "name": "beforehide",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires before the component is hidden. Return false to stop the hide."
+ },
+ {
+ "name": "beforerender",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires before the component is rendered. Return false to stop the render."
+ },
+ {
+ "name": "beforeshow",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires before the component is shown. Return false to stop the show."
+ },
+ {
+ "name": "childrenrendered",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires when the children have been rendered.."
+ },
+ {
+ "name": "destroy",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires after the component is destroyed."
+ },
+ {
+ "name": "disable",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires after the component is disabled."
+ },
+ {
+ "name": "enable",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires after the component is enabled."
+ },
+ {
+ "name": "hide",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires after the component is hidden."
+ },
+ {
+ "name": "render",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires after the component is rendered."
+ },
+ {
+ "name": "show",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires after the component is shown."
+ }
+ ],
+ "methods": [
+ {
+ "name": "addEvents",
+ "sig": "(Object object)",
+ "type": "function",
+ "desc": "Used to define events on this Observable"
+ },
+ {
+ "name": "addListener",
+ "sig": "(String eventName, Function handler, Object scope, Object options)",
+ "type": "function",
+ "desc": "Appends an event handler to this component"
+ },
+ {
+ "name": "capture",
+ "sig": "(Observable o, Function fn, Object scope)",
+ "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."
+ },
+ {
+ "name": "destroy",
+ "sig": "()",
+ "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}."
+ },
+ {
+ "name": "disable",
+ "sig": "()",
+ "type": "function",
+ "desc": "Disable this component."
+ },
+ {
+ "name": "enable",
+ "sig": "()",
+ "type": "function",
+ "desc": "Enable this component."
+ },
+ {
+ "name": "fireEvent",
+ "sig": "(String eventName, Object... args)",
+ "type": "function",
+ "desc": "Fires the specified event with the passed parameters (minus the event name)."
+ },
+ {
+ "name": "focus",
+ "sig": "(Boolean selectText)",
+ "type": "function",
+ "desc": "Try to focus this component."
+ },
+ {
+ "name": "getChildContainer",
+ "sig": "()",
+ "type": "function",
+ "desc": "Fetch the element to add children to"
+ },
+ {
+ "name": "getEl",
+ "sig": "()",
+ "type": "function",
+ "desc": "Returns the underlying {@link Roo.Element}."
+ },
+ {
+ "name": "getId",
+ "sig": "()",
+ "type": "function",
+ "desc": "Returns the id of this component."
+ },
+ {
+ "name": "hasListener",
+ "sig": "(String eventName)",
+ "type": "function",
+ "desc": "Checks to see if this object has any listeners for a specified event"
+ },
+ {
+ "name": "hide",
+ "sig": "()",
+ "type": "function",
+ "desc": "Hide a component - adds 'hidden' class"
+ },
+ {
+ "name": "initEvents",
+ "sig": "()",
+ "type": "function",
+ "desc": "Initialize Events for the element"
+ },
+ {
+ "name": "isVisible",
+ "sig": "()",
+ "type": "function",
+ "desc": "Returns true if this component is visible."
+ },
+ {
+ "name": "on",
+ "sig": "(String eventName, Function handler, Object scope, Object options)",
+ "type": "function",
+ "desc": "Appends an event handler to this element (shorthand for addListener)"
+ },
+ {
+ "name": "purgeListeners",
+ "sig": "()",
+ "type": "function",
+ "desc": "Removes all listeners for this object"
+ },
+ {
+ "name": "releaseCapture",
+ "sig": "(Observable o)",
+ "type": "function",
+ "desc": "Removes <b>all</b> added captures from the Observable."
+ },
+ {
+ "name": "removeListener",
+ "sig": "(String eventName, Function handler, Object scope)",
+ "type": "function",
+ "desc": "Removes a listener"
+ },
+ {
+ "name": "render",
+ "sig": "(String/HTMLElement/Element container)",
+ "type": "function",
+ "desc": "If this is a lazy rendering component, render it to its container element."
+ },
+ {
+ "name": "setDisabled",
+ "sig": "(Boolean disabled)",
+ "type": "function",
+ "desc": "Convenience function for setting disabled/enabled by boolean."
+ },
+ {
+ "name": "setVisible",
+ "sig": "(Boolean visible)",
+ "type": "function",
+ "desc": "Convenience function to hide or show this component by boolean."
+ },
+ {
+ "name": "show",
+ "sig": "()",
+ "type": "function",
+ "desc": "Show a component - removes 'hidden' class"
+ },
+ {
+ "name": "tooltipEl",
+ "sig": "()",
+ "type": "function",
+ "desc": "Fetch the element to display the tooltip on."
+ },
+ {
+ "name": "un",
+ "sig": "(String eventName, Function handler, Object scope)",
+ "type": "function",
+ "desc": "Removes a listener (shorthand for removeListener)"
+ }
+ ]
+ },
+ "Roo.mailer.Column": {
+ "props": [
+ {
+ "name": "cls",
+ "type": "String",
+ "desc": "class of the element",
+ "memberOf": ""
+ },
+ {
+ "name": "html",
+ "type": "String",
+ "desc": "content of body",
+ "memberOf": ""
+ },
+ {
+ "name": "src",
+ "type": "String",
+ "desc": "image url",
+ "memberOf": ""
+ },
+ {
+ "name": "column",
+ "type": "String",
+ "desc": "",
+ "memberOf": "",
+ "optvals": [
+ "left",
+ "right"
+ ]
+ },
+ {
+ "name": "",
+ "type": "",
+ "desc": "{String width (100%|200|340|260)",
+ "memberOf": ""
+ },
+ {
+ "name": "style",
+ "type": "String",
+ "desc": "any extra css",
+ "memberOf": "Roo.bootstrap.Component"
+ },
+ {
+ "name": "xattr",
+ "type": "Object",
+ "desc": "extra attributes to add to 'element' (used by builder to store stuff.)",
+ "memberOf": "Roo.bootstrap.Component"
+ },
+ {
+ "name": "can_build_overlaid",
+ "type": "Boolean",
+ "desc": "True if element can be rebuild from a HTML page",
+ "memberOf": "Roo.bootstrap.Component"
+ },
+ {
+ "name": "dataId",
+ "type": "string",
+ "desc": "cutomer id",
+ "memberOf": "Roo.bootstrap.Component"
+ },
+ {
+ "name": "name",
+ "type": "string",
+ "desc": "Specifies name attribute",
+ "memberOf": "Roo.bootstrap.Component"
+ },
+ {
+ "name": "tooltip",
+ "type": "string",
+ "desc": "Text for the tooltip",
+ "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": "disableClass",
+ "type": "String",
+ "desc": "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").",
+ "memberOf": "Roo.Component"
+ },
+ {
+ "name": "allowDomMove",
+ "type": "Boolean",
+ "desc": "Whether the component can move the Dom node when rendering (defaults to true).",
+ "memberOf": "Roo.Component"
+ },
+ {
+ "name": "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\".",
+ "memberOf": "Roo.Component",
+ "optvals": [
+ "display",
+ "visibility"
+ ]
+ },
+ {
+ "name": "actionMode",
+ "type": "String",
+ "desc": "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el'",
+ "memberOf": "Roo.Component"
+ },
+ {
+ "name": "listeners",
+ "type": "Object",
+ "desc": "list of events and functions to call for 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": "beforedestroy",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires before the component is destroyed. Return false to stop the destroy."
+ },
+ {
+ "name": "beforehide",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires before the component is hidden. Return false to stop the hide."
+ },
+ {
+ "name": "beforerender",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires before the component is rendered. Return false to stop the render."
+ },
+ {
+ "name": "beforeshow",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires before the component is shown. Return false to stop the show."
+ },
+ {
+ "name": "childrenrendered",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires when the children have been rendered.."
+ },
+ {
+ "name": "destroy",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires after the component is destroyed."
},
{
- "name": "rowclick",
- "sig": "function (_self, rowIndex, e)\n{\n\n}",
+ "name": "disable",
+ "sig": "function (_self)\n{\n\n}",
"type": "function",
- "desc": "Fires when a row is clicked"
+ "desc": "Fires after the component is disabled."
},
{
- "name": "rowcontextmenu",
- "sig": "function (_self, rowIndex, e)\n{\n\n}",
+ "name": "enable",
+ "sig": "function (_self)\n{\n\n}",
"type": "function",
- "desc": "Fires when a row is right clicked"
+ "desc": "Fires after the component is enabled."
},
{
- "name": "rowdblclick",
- "sig": "function (_self, rowIndex, e)\n{\n\n}",
+ "name": "hide",
+ "sig": "function (_self)\n{\n\n}",
"type": "function",
- "desc": "Fires when a row is double clicked"
+ "desc": "Fires after the component is hidden."
},
{
- "name": "startdrag",
- "sig": "function (_self, dd, e)\n{\n\n}",
+ "name": "render",
+ "sig": "function (_self)\n{\n\n}",
"type": "function",
- "desc": "Fires when row(s) start being dragged"
+ "desc": "Fires after the component is rendered."
},
{
- "name": "validateedit",
- "sig": "function (e)\n{\n\n}",
+ "name": "show",
+ "sig": "function (_self)\n{\n\n}",
"type": "function",
- "desc": "Fires after a cell is edited, but before the value is set in the record. \nYou can use this to modify the value being set in the field, Return false\nto cancel the change. The edit event object has the following properties <br />\n<ul style=\"padding:5px;padding-left:16px;\">\n<li>editor - This editor</li>\n<li>grid - This grid</li>\n<li>record - The record being edited</li>\n<li>field - The field name being edited</li>\n<li>value - The value being set</li>\n<li>originalValue - The original value for the field, before the edit.</li>\n<li>row - The grid row index</li>\n<li>column - The grid column index</li>\n<li>cancel - Set this to true to cancel the edit or return false from your handler.</li>\n</ul>"
+ "desc": "Fires after the component is shown."
}
],
"methods": [
"type": "function",
"desc": "Appends an event handler to this component"
},
- {
- "name": "autoSize",
- "sig": "()",
- "type": "function",
- "desc": "Causes the grid to manually recalculate its dimensions. Generally this is done automatically,\nbut if manual update is required this method will initiate it."
- },
{
"name": "capture",
"sig": "(Observable o, Function fn, Object scope)",
},
{
"name": "destroy",
- "sig": "(Boolean removeEl)",
+ "sig": "()",
"type": "function",
- "desc": "Destroy this grid."
+ "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}."
+ },
+ {
+ "name": "disable",
+ "sig": "()",
+ "type": "function",
+ "desc": "Disable this component."
+ },
+ {
+ "name": "enable",
+ "sig": "()",
+ "type": "function",
+ "desc": "Enable this component."
},
{
"name": "fireEvent",
"desc": "Fires the specified event with the passed parameters (minus the event name)."
},
{
- "name": "getColumnModel",
- "sig": "()",
+ "name": "focus",
+ "sig": "(Boolean selectText)",
"type": "function",
- "desc": "Returns the grid's ColumnModel."
+ "desc": "Try to focus this component."
},
{
- "name": "getDataSource",
+ "name": "getChildContainer",
"sig": "()",
"type": "function",
- "desc": "Returns the grid's DataSource."
+ "desc": "Fetch the element to add children to"
},
{
- "name": "getDragDropText",
+ "name": "getEl",
"sig": "()",
"type": "function",
- "desc": "Called to get grid's drag proxy text, by default returns this.ddText."
+ "desc": "Returns the underlying {@link Roo.Element}."
},
{
- "name": "getGridEl",
+ "name": "getId",
"sig": "()",
"type": "function",
- "desc": "Returns the grid's underlying element."
+ "desc": "Returns the id of this component."
},
{
- "name": "getSelectionModel",
- "sig": "()",
+ "name": "hasListener",
+ "sig": "(String eventName)",
"type": "function",
- "desc": "Returns the grid's SelectionModel."
+ "desc": "Checks to see if this object has any listeners for a specified event"
},
{
- "name": "getSource",
+ "name": "hide",
"sig": "()",
"type": "function",
- "desc": "Gets all the data from the grid."
+ "desc": "Hide a component - adds 'hidden' class"
},
{
- "name": "getView",
+ "name": "initEvents",
"sig": "()",
"type": "function",
- "desc": "Returns the grid's GridView object."
+ "desc": "Initialize Events for the element"
},
{
- "name": "hasListener",
- "sig": "(String eventName)",
+ "name": "isVisible",
+ "sig": "()",
"type": "function",
- "desc": "Checks to see if this object has any listeners for a specified event"
+ "desc": "Returns true if this component is visible."
},
{
"name": "on",
"type": "function",
"desc": "Removes all listeners for this object"
},
- {
- "name": "reconfigure",
- "sig": "(Roo.data.Store dataSource, Roo.grid.ColumnModel The)",
- "type": "function",
- "desc": "Reconfigures the grid to use a different Store and Column Model.\nThe View will be bound to the new objects and refreshed."
- },
{
"name": "releaseCapture",
"sig": "(Observable o)",
},
{
"name": "render",
- "sig": "()",
+ "sig": "(String/HTMLElement/Element container)",
"type": "function",
- "desc": "Called once after all setup has been completed and the grid is ready to be rendered."
+ "desc": "If this is a lazy rendering component, render it to its container element."
},
{
- "name": "setSource",
- "sig": "(Object data)",
+ "name": "setDisabled",
+ "sig": "(Boolean disabled)",
"type": "function",
- "desc": "Sets the data for the Grid\naccepts a Key => Value object of all the elements avaiable."
+ "desc": "Convenience function for setting disabled/enabled by boolean."
},
{
- "name": "startEditing",
- "sig": "(Number rowIndex, Number colIndex)",
+ "name": "setVisible",
+ "sig": "(Boolean visible)",
"type": "function",
- "desc": "Starts editing the specified for the specified row/column"
+ "desc": "Convenience function to hide or show this component by boolean."
},
{
- "name": "stopEditing",
+ "name": "show",
"sig": "()",
"type": "function",
- "desc": "Stops any active editing"
+ "desc": "Show a component - removes 'hidden' class"
+ },
+ {
+ "name": "tooltipEl",
+ "sig": "()",
+ "type": "function",
+ "desc": "Fetch the element to display the tooltip on."
},
{
"name": "un",
}
]
},
- "Roo.grid.RowSelectionModel": {
+ "Roo.mailer.Example": {
"props": [
{
- "name": "singleSelect",
- "type": "Boolean",
- "desc": "True to allow selection of only one row at a time (defaults to false)",
+ "name": "lang",
+ "type": "String",
+ "desc": "section type.",
+ "memberOf": "",
+ "optvals": [
+ "phpcode",
+ "programlisting"
+ ]
+ },
+ {
+ "name": "code",
+ "type": "String",
+ "desc": "",
+ "memberOf": ""
+ }
+ ],
+ "events": [],
+ "methods": []
+ },
+ "Roo.mailer.Para": {
+ "props": [
+ {
+ "name": "html",
+ "type": "String",
+ "desc": "",
"memberOf": ""
},
+ {
+ "name": "cls",
+ "type": "String",
+ "desc": "css class",
+ "memberOf": "Roo.bootstrap.Component"
+ },
+ {
+ "name": "style",
+ "type": "String",
+ "desc": "any extra css",
+ "memberOf": "Roo.bootstrap.Component"
+ },
+ {
+ "name": "xattr",
+ "type": "Object",
+ "desc": "extra attributes to add to 'element' (used by builder to store stuff.)",
+ "memberOf": "Roo.bootstrap.Component"
+ },
+ {
+ "name": "can_build_overlaid",
+ "type": "Boolean",
+ "desc": "True if element can be rebuild from a HTML page",
+ "memberOf": "Roo.bootstrap.Component"
+ },
+ {
+ "name": "dataId",
+ "type": "string",
+ "desc": "cutomer id",
+ "memberOf": "Roo.bootstrap.Component"
+ },
+ {
+ "name": "name",
+ "type": "string",
+ "desc": "Specifies name attribute",
+ "memberOf": "Roo.bootstrap.Component"
+ },
+ {
+ "name": "tooltip",
+ "type": "string",
+ "desc": "Text for the tooltip",
+ "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": "disableClass",
+ "type": "String",
+ "desc": "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").",
+ "memberOf": "Roo.Component"
+ },
+ {
+ "name": "allowDomMove",
+ "type": "Boolean",
+ "desc": "Whether the component can move the Dom node when rendering (defaults to true).",
+ "memberOf": "Roo.Component"
+ },
+ {
+ "name": "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\".",
+ "memberOf": "Roo.Component",
+ "optvals": [
+ "display",
+ "visibility"
+ ]
+ },
+ {
+ "name": "actionMode",
+ "type": "String",
+ "desc": "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el'",
+ "memberOf": "Roo.Component"
+ },
{
"name": "listeners",
"type": "Object",
],
"events": [
{
- "name": "afterselectionchange",
+ "name": "beforedestroy",
"sig": "function (_self)\n{\n\n}",
"type": "function",
- "desc": "Fires after the selection changes (eg. by key press or clicking)"
+ "desc": "Fires before the component is destroyed. Return false to stop the destroy."
},
{
- "name": "beforerowselect",
- "sig": "function (_self, rowIndex, keepExisting)\n{\n\n}",
+ "name": "beforehide",
+ "sig": "function (_self)\n{\n\n}",
"type": "function",
- "desc": "Fires when a row is selected being selected, return false to cancel."
+ "desc": "Fires before the component is hidden. Return false to stop the hide."
},
{
- "name": "rowdeselect",
- "sig": "function (_self, rowIndex)\n{\n\n}",
+ "name": "beforerender",
+ "sig": "function (_self)\n{\n\n}",
"type": "function",
- "desc": "Fires when a row is deselected."
+ "desc": "Fires before the component is rendered. Return false to stop the render."
},
{
- "name": "rowselect",
- "sig": "function (_self, rowIndex, r)\n{\n\n}",
+ "name": "beforeshow",
+ "sig": "function (_self)\n{\n\n}",
"type": "function",
- "desc": "Fires when a row is selected."
+ "desc": "Fires before the component is shown. Return false to stop the show."
},
{
- "name": "selectionchange",
+ "name": "childrenrendered",
"sig": "function (_self)\n{\n\n}",
"type": "function",
- "desc": "Fires when the selection changes"
+ "desc": "Fires when the children have been rendered.."
+ },
+ {
+ "name": "destroy",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires after the component is destroyed."
+ },
+ {
+ "name": "disable",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires after the component is disabled."
+ },
+ {
+ "name": "enable",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires after the component is enabled."
+ },
+ {
+ "name": "hide",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires after the component is hidden."
+ },
+ {
+ "name": "render",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires after the component is rendered."
+ },
+ {
+ "name": "show",
+ "sig": "function (_self)\n{\n\n}",
+ "type": "function",
+ "desc": "Fires after the component is shown."
}
],
"methods": [
"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."
},
{
- "name": "clearSelections",
+ "name": "destroy",
"sig": "()",
"type": "function",
- "desc": "Clears all selections."
+ "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}."
},
{
- "name": "deselectRange",
- "sig": "(Number startRow, Number endRow)",
+ "name": "disable",
+ "sig": "()",
"type": "function",
- "desc": "Deselects a range of rows. All rows in between startRow and endRow are also deselected."
+ "desc": "Disable this component."
},
{
- "name": "deselectRow",
- "sig": "(Number row)",
+ "name": "enable",
+ "sig": "()",
"type": "function",
- "desc": "Deselects a row."
+ "desc": "Enable this component."
},
{
"name": "fireEvent",
"desc": "Fires the specified event with the passed parameters (minus the event name)."
},
{
- "name": "getCount",
+ "name": "focus",
+ "sig": "(Boolean selectText)",
+ "type": "function",
+ "desc": "Try to focus this component."
+ },
+ {
+ "name": "getChildContainer",
"sig": "()",
"type": "function",
- "desc": "Gets the number of selected rows."
+ "desc": "Fetch the element to add children to"
},
{
- "name": "getSelected",
+ "name": "getEl",
"sig": "()",
"type": "function",
- "desc": "Returns the first selected record."
+ "desc": "Returns the underlying {@link Roo.Element}."
},
{
- "name": "getSelections",
+ "name": "getId",
"sig": "()",
"type": "function",
- "desc": "Returns the selected records"
+ "desc": "Returns the id of this component."
},
{
"name": "hasListener",
"desc": "Checks to see if this object has any listeners for a specified event"
},
{
- "name": "hasSelection",
+ "name": "hide",
"sig": "()",
"type": "function",
- "desc": "Returns True if there is a selection."
- },
- {
- "name": "isIdSelected",
- "sig": "(String id)",
- "type": "function",
- "desc": "Returns True if the specified record id is selected."
+ "desc": "Hide a component - adds 'hidden' class"
},
{
- "name": "isLocked",
+ "name": "initEvents",
"sig": "()",
"type": "function",
- "desc": "Returns true if the selections are locked."
- },
- {
- "name": "isSelected",
- "sig": "(Number/Record record)",
- "type": "function",
- "desc": "Returns True if the specified row is selected."
+ "desc": "Initialize Events for the element"
},
{
- "name": "lock",
+ "name": "isVisible",
"sig": "()",
"type": "function",
- "desc": "Locks the selections."
+ "desc": "Returns true if this component is visible."
},
{
"name": "on",
"desc": "Removes a listener"
},
{
- "name": "selectAll",
- "sig": "()",
- "type": "function",
- "desc": "Selects all rows."
- },
- {
- "name": "selectFirstRow",
- "sig": "()",
- "type": "function",
- "desc": "Selects the first row in the grid."
- },
- {
- "name": "selectLastRow",
- "sig": "(Boolean keepExisting)",
- "type": "function",
- "desc": "Select the last row."
- },
- {
- "name": "selectNext",
- "sig": "(Boolean keepExisting)",
- "type": "function",
- "desc": "Selects the row immediately following the last selected row."
- },
- {
- "name": "selectPrevious",
- "sig": "(Boolean keepExisting)",
+ "name": "render",
+ "sig": "(String/HTMLElement/Element container)",
"type": "function",
- "desc": "Selects the row that precedes the last selected row."
+ "desc": "If this is a lazy rendering component, render it to its container element."
},
{
- "name": "selectRange",
- "sig": "(Number startRow, Number endRow, Boolean keepExisting)",
+ "name": "setDisabled",
+ "sig": "(Boolean disabled)",
"type": "function",
- "desc": "Selects a range of rows. All rows in between startRow and endRow are also selected."
+ "desc": "Convenience function for setting disabled/enabled by boolean."
},
{
- "name": "selectRecords",
- "sig": "(Array records, Boolean keepExisting)",
+ "name": "setVisible",
+ "sig": "(Boolean visible)",
"type": "function",
- "desc": "Select records."
+ "desc": "Convenience function to hide or show this component by boolean."
},
{
- "name": "selectRow",
- "sig": "(Number row, Boolean keepExisting)",
+ "name": "show",
+ "sig": "()",
"type": "function",
- "desc": "Selects a row."
+ "desc": "Show a component - removes 'hidden' class"
},
{
- "name": "selectRows",
- "sig": "(Array rows, Boolean keepExisting)",
+ "name": "tooltipEl",
+ "sig": "()",
"type": "function",
- "desc": "Selects multiple rows."
+ "desc": "Fetch the element to display the tooltip on."
},
{
"name": "un",
"sig": "(String eventName, Function handler, Object scope)",
"type": "function",
"desc": "Removes a listener (shorthand for removeListener)"
- },
- {
- "name": "unlock",
- "sig": "()",
- "type": "function",
- "desc": "Unlocks the selections."
- }
- ]
- },
- "Roo.lib": {
- "props": [],
- "events": [],
- "methods": []
- },
- "Roo.lib.Ajax": {
- "props": [],
- "events": [],
- "methods": [
- {
- "name": "request",
- "sig": "()",
- "type": "function",
- "desc": ""
}
]
},
- "Roo.lib.Dom": {
- "props": [],
- "events": [],
- "methods": []
- },
- "Roo.mailer": {
- "props": [],
- "events": [],
- "methods": []
- },
- "Roo.mailer.Block": {
+ "Roo.mailer.Param": {
"props": [
{
- "name": "cls",
- "type": "String",
- "desc": "class of the element",
+ "name": "is_optional",
+ "type": "bool",
+ "desc": "",
"memberOf": ""
},
{
- "name": "html",
+ "name": "type",
"type": "String",
- "desc": "content of header (not used for columns)",
+ "desc": "argument type",
"memberOf": ""
},
{
- "name": "blocktype",
+ "name": "name",
"type": "String",
"desc": "",
- "memberOf": "",
- "optvals": [
- "header",
- "preheader",
- "footer",
- "body",
- "row"
- ]
+ "memberOf": ""
+ },
+ {
+ "name": "desc",
+ "type": "String",
+ "desc": "short description",
+ "memberOf": ""
+ },
+ {
+ "name": "defaultvalue",
+ "type": "String",
+ "desc": "default value",
+ "memberOf": ""
+ },
+ {
+ "name": "cls",
+ "type": "String",
+ "desc": "css class",
+ "memberOf": "Roo.bootstrap.Component"
},
{
"name": "style",
"desc": "cutomer id",
"memberOf": "Roo.bootstrap.Component"
},
- {
- "name": "name",
- "type": "string",
- "desc": "Specifies name attribute",
- "memberOf": "Roo.bootstrap.Component"
- },
{
"name": "tooltip",
"type": "string",
}
]
},
- "Roo.mailer.BodyContainer": {
+ "Roo.mailer.Section": {
"props": [
+ {
+ "name": "stype",
+ "type": "String",
+ "desc": "section type.",
+ "memberOf": "",
+ "optvals": [
+ "desc",
+ "parameter",
+ "return",
+ "note",
+ "example"
+ ]
+ },
{
"name": "cls",
"type": "String",
- "desc": "class of the element",
- "memberOf": ""
+ "desc": "css class",
+ "memberOf": "Roo.bootstrap.Component"
},
{
"name": "style",
}
]
},
- "Roo.mailer.Column": {
+ "Roo.mailer.Synopsis": {
"props": [
{
- "name": "cls",
- "type": "String",
- "desc": "class of the element",
- "memberOf": ""
- },
- {
- "name": "html",
+ "name": "returntype",
"type": "String",
- "desc": "content of body",
+ "desc": "return value",
"memberOf": ""
},
{
- "name": "src",
+ "name": "name",
"type": "String",
- "desc": "image url",
+ "desc": "title really..",
"memberOf": ""
},
{
- "name": "column",
+ "name": "stype",
"type": "String",
"desc": "",
"memberOf": "",
"optvals": [
- "left",
- "right"
+ "function",
+ "constant"
]
},
{
- "name": "",
- "type": "",
- "desc": "{String width (100%|200|340|260)",
- "memberOf": ""
+ "name": "cls",
+ "type": "String",
+ "desc": "css class",
+ "memberOf": "Roo.bootstrap.Component"
},
{
"name": "style",
"desc": "cutomer id",
"memberOf": "Roo.bootstrap.Component"
},
- {
- "name": "name",
- "type": "string",
- "desc": "Specifies name attribute",
- "memberOf": "Roo.bootstrap.Component"
- },
{
"name": "tooltip",
"type": "string",
projects / roojs1 / blobdiff