X-Git-Url: http://git.roojs.org/?a=blobdiff_plain;f=docs%2Fsymbols%2FRoo.form.BasicForm.json;h=abd6d5f199247878b794e397b29e96850182aedc;hb=ace3bd1cd175b8285e20933c004e7c5aa826028a;hp=a60351bd67fcc6e73105abf8ebf4ba7ddc166bdb;hpb=c1c0168c0e693c4262f3f744a82419f9d9b1807f;p=roojs1
diff --git a/docs/symbols/Roo.form.BasicForm.json b/docs/symbols/Roo.form.BasicForm.json
index a60351bd67..abd6d5f199 100644
--- a/docs/symbols/Roo.form.BasicForm.json
+++ b/docs/symbols/Roo.form.BasicForm.json
@@ -3,10 +3,19 @@
"augments" : [
"Roo.util.Observable"
],
+ "childClasses" : {
+ "Roo.form.BasicForm" : [
+ "Roo.form.Form"
+ ]
+ },
+ "tree_children" : [],
+ "tree_parent" : [],
"desc" : "Supplies the functionality to do \"actions\" on forms and initialize Roo.form.Field types on existing markup.",
"isSingleton" : false,
"isStatic" : false,
"isBuiltin" : false,
+ "isAbstract" : false,
+ "isBuilderTop" : false,
"memberOf" : "BasicForm",
"example" : "",
"deprecated" : "",
@@ -26,94 +35,119 @@
"isOptional" : false
}
],
- "returns" : [
- ],
+ "returns" : [],
+ "throws" : "",
+ "requires" : "",
"config" : [
{
"name" : "listeners",
"type" : "Object",
"desc" : "list of events and functions to call for this object, \nFor example :\n\n listeners : { \n 'click' : function(e) {\n ..... \n } ,\n .... \n } \n
",
"memberOf" : "Roo.util.Observable",
- "values" : [
- ]
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "fileUpload",
"type" : "Boolean",
"desc" : "Set to true if this form is a file upload.",
- "memberOf" : "Roo.form.BasicForm",
- "values" : [
- ]
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "method",
"type" : "String",
"desc" : "The request method to use (GET or POST) for form actions if one isn't supplied in the action options.",
- "memberOf" : "Roo.form.BasicForm",
- "values" : [
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "errorMask",
+ "type" : "Boolean",
+ "desc" : "e) default fal",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : [
+ "true",
+ "false"
]
},
{
"name" : "timeout",
"type" : "Number",
"desc" : "Timeout for form actions in seconds (default is 30 seconds).",
- "memberOf" : "Roo.form.BasicForm",
- "values" : [
- ]
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "baseParams",
"type" : "Object",
"desc" : "Parameters to pass with all requests. e.g. baseParams: {id: '123', foo: 'bar'}.",
- "memberOf" : "Roo.form.BasicForm",
- "values" : [
- ]
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "trackResetOnLoad",
"type" : "Boolean",
"desc" : "If set to true, form.reset() resets to the last loaded\nor setValues() data instead of when the form was first created.",
- "memberOf" : "Roo.form.BasicForm",
- "values" : [
- ]
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "reader",
"type" : "DataReader",
"desc" : "An Roo.data.DataReader (e.g. {@link Roo.data.XmlReader}) to be used to read data when executing \"load\" actions.\nThis is optional as there is built-in support for processing JSON.",
- "memberOf" : "Roo.form.BasicForm",
- "values" : [
- ]
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "errorReader",
"type" : "DataReader",
"desc" : "An Roo.data.DataReader (e.g. {@link Roo.data.XmlReader}) to be used to read data when reading validation errors on \"submit\" actions.\nThis is completely optional as there is built-in support for processing JSON.",
- "memberOf" : "Roo.form.BasicForm",
- "values" : [
- ]
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
},
{
"name" : "url",
"type" : "String",
"desc" : "The URL to use for form actions if one isn't supplied in the action options.",
- "memberOf" : "Roo.form.BasicForm",
- "values" : [
- ]
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
+ },
+ {
+ "name" : "maskOffset",
+ "type" : "Number",
+ "desc" : "Default 100",
+ "memberOf" : "",
+ "isOptional" : false,
+ "optvals" : []
}
],
"methods" : [
{
"name" : "remove",
+ "type" : "function",
"desc" : "Removes a field from the items collection (does NOT remove its markup).",
+ "sig" : "(field)",
+ "static" : false,
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
- "memberOf" : "Roo.form.BasicForm",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
"name" : "field",
@@ -132,15 +166,20 @@
},
{
"name" : "loadRecord",
+ "type" : "function",
"desc" : "Loads an Roo.data.Record into this form.",
+ "sig" : "(record)",
+ "static" : false,
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
- "memberOf" : "Roo.form.BasicForm",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
"name" : "record",
@@ -159,15 +198,20 @@
},
{
"name" : "load",
+ "type" : "function",
"desc" : "Shortcut to do a load action.",
+ "sig" : "(options)",
+ "static" : false,
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
- "memberOf" : "Roo.form.BasicForm",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
"name" : "options",
@@ -186,15 +230,20 @@
},
{
"name" : "doAction",
+ "type" : "function",
"desc" : "Performs a predefined action (submit or load) or custom actions you define on this form.",
+ "sig" : "(actionName, options)",
+ "static" : false,
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
- "memberOf" : "Roo.form.BasicForm",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
"name" : "actionName",
@@ -219,20 +268,25 @@
},
{
"name" : "getValues",
+ "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.",
+ "sig" : "(asString)",
+ "static" : false,
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
- "memberOf" : "Roo.form.BasicForm",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
"name" : "asString",
"type" : "Boolean",
- "desc" : "",
+ "desc" : "(def)",
"isOptional" : false
}
],
@@ -246,17 +300,21 @@
},
{
"name" : "resetHasChanged",
+ "type" : "function",
"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",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
- "memberOf" : "Roo.form.BasicForm",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "params" : [
- ],
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
"returns" : [
{
"name" : "",
@@ -267,17 +325,21 @@
},
{
"name" : "clearInvalid",
+ "type" : "function",
"desc" : "Clears all invalid messages in this form.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
- "memberOf" : "Roo.form.BasicForm",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "params" : [
- ],
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
"returns" : [
{
"name" : "",
@@ -288,17 +350,21 @@
},
{
"name" : "isDirty",
+ "type" : "function",
"desc" : "DEPRICATED Returns true if any fields in this form have changed since their original load.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
- "memberOf" : "Roo.form.BasicForm",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "params" : [
- ],
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
"returns" : [
{
"name" : "",
@@ -309,15 +375,20 @@
},
{
"name" : "updateRecord",
+ "type" : "function",
"desc" : "Persists the values in this form into the passed Roo.data.Record object in a beginEdit/endEdit block.",
+ "sig" : "(record)",
+ "static" : false,
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
- "memberOf" : "Roo.form.BasicForm",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
"name" : "record",
@@ -336,17 +407,21 @@
},
{
"name" : "hasChanged",
+ "type" : "function",
"desc" : "Returns true if any fields in this form have changed since their original load. (New version)",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
- "memberOf" : "Roo.form.BasicForm",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "params" : [
- ],
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
"returns" : [
{
"name" : "",
@@ -357,15 +432,20 @@
},
{
"name" : "applyToFields",
+ "type" : "function",
"desc" : "Calls {@link Ext#apply} for all fields in this form with the passed object.",
+ "sig" : "(values)",
+ "static" : false,
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
- "memberOf" : "Roo.form.BasicForm",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
"name" : "values",
@@ -384,16 +464,27 @@
},
{
"name" : "getFieldValues",
- "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.",
+ "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.\nNormally this will not return readOnly data",
+ "sig" : "(with_readonly)",
+ "static" : false,
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
- "memberOf" : "Roo.form.BasicForm",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
+ {
+ "name" : "with_readonly",
+ "type" : "Boolean",
+ "desc" : "return readonly field data.",
+ "isOptional" : false
+ }
],
"returns" : [
{
@@ -405,15 +496,20 @@
},
{
"name" : "submit",
+ "type" : "function",
"desc" : "Shortcut to do a submit action.",
+ "sig" : "(options)",
+ "static" : false,
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
- "memberOf" : "Roo.form.BasicForm",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
"name" : "options",
@@ -432,15 +528,20 @@
},
{
"name" : "markInvalid",
+ "type" : "function",
"desc" : "Mark fields in this form invalid in bulk.",
+ "sig" : "(errors)",
+ "static" : false,
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
- "memberOf" : "Roo.form.BasicForm",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
"name" : "errors",
@@ -459,15 +560,20 @@
},
{
"name" : "setValues",
+ "type" : "function",
"desc" : "Set values for fields in this form in bulk.",
+ "sig" : "(values)",
+ "static" : false,
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
- "memberOf" : "Roo.form.BasicForm",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
"name" : "values",
@@ -486,17 +592,21 @@
},
{
"name" : "isValid",
+ "type" : "function",
"desc" : "Returns true if client-side validation on the form is successful.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
- "memberOf" : "Roo.form.BasicForm",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "params" : [
- ],
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
"returns" : [
{
"name" : "",
@@ -505,19 +615,48 @@
}
]
},
+ {
+ "name" : "invalidFields",
+ "type" : "function",
+ "desc" : "Returns array of invalid form fields.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "",
+ "isStatic" : false,
+ "isConstructor" : false,
+ "isPrivate" : false,
+ "example" : "",
+ "deprecated" : "",
+ "since" : "",
+ "see" : "",
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : [
+ {
+ "name" : "",
+ "type" : "",
+ "desc" : "Array"
+ }
+ ]
+ },
{
"name" : "render",
+ "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.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
- "memberOf" : "Roo.form.BasicForm",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "params" : [
- ],
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
"returns" : [
{
"name" : "",
@@ -528,15 +667,20 @@
},
{
"name" : "add",
+ "type" : "function",
"desc" : "Add Roo.form components to this form.",
+ "sig" : "(field1, field2, etc)",
+ "static" : false,
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
- "memberOf" : "Roo.form.BasicForm",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
"name" : "field1",
@@ -567,15 +711,20 @@
},
{
"name" : "applyIfToFields",
+ "type" : "function",
"desc" : "Calls {@link Ext#applyIf} for all field in this form with the passed object.",
+ "sig" : "(values)",
+ "static" : false,
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
- "memberOf" : "Roo.form.BasicForm",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
"name" : "values",
@@ -594,15 +743,20 @@
},
{
"name" : "findField",
+ "type" : "function",
"desc" : "Find a Roo.form.Field in this form by id, dataIndex, name or hiddenName",
+ "sig" : "(id)",
+ "static" : false,
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
- "memberOf" : "Roo.form.BasicForm",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
"name" : "id",
@@ -621,17 +775,21 @@
},
{
"name" : "reset",
+ "type" : "function",
"desc" : "Resets this form.",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
- "memberOf" : "Roo.form.BasicForm",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "params" : [
- ],
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
"returns" : [
{
"name" : "",
@@ -642,15 +800,20 @@
},
{
"name" : "addForm",
+ "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.",
+ "sig" : "(form)",
+ "static" : false,
+ "memberOf" : "",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
- "memberOf" : "Roo.form.BasicForm",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
"name" : "form",
@@ -659,36 +822,43 @@
"isOptional" : false
}
],
- "returns" : [
- ]
+ "returns" : []
},
{
"name" : "purgeListeners",
+ "type" : "function",
"desc" : "Removes all listeners for this object",
+ "sig" : "()\n{\n\n}",
+ "static" : false,
+ "memberOf" : "Roo.util.Observable",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
- "memberOf" : "Roo.util.Observable",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
- "params" : [
- ],
- "returns" : [
- ]
+ "exceptions" : "",
+ "requires" : "",
+ "params" : [],
+ "returns" : []
},
{
"name" : "on",
+ "type" : "function",
"desc" : "Appends an event handler to this element (shorthand for addListener)",
+ "sig" : "(eventName, handler, scope, options)",
+ "static" : false,
+ "memberOf" : "Roo.util.Observable",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
- "memberOf" : "Roo.util.Observable",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
"name" : "eventName",
@@ -715,20 +885,24 @@
"isOptional" : false
}
],
- "returns" : [
- ]
+ "returns" : []
},
{
"name" : "un",
+ "type" : "function",
"desc" : "Removes a listener (shorthand for removeListener)",
+ "sig" : "(eventName, handler, scope)",
+ "static" : false,
+ "memberOf" : "Roo.util.Observable",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
- "memberOf" : "Roo.util.Observable",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
"name" : "eventName",
@@ -749,20 +923,24 @@
"isOptional" : false
}
],
- "returns" : [
- ]
+ "returns" : []
},
{
"name" : "addEvents",
+ "type" : "function",
"desc" : "Used to define events on this Observable",
+ "sig" : "(object)",
+ "static" : false,
+ "memberOf" : "Roo.util.Observable",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
- "memberOf" : "Roo.util.Observable",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
"name" : "object",
@@ -771,20 +949,24 @@
"isOptional" : false
}
],
- "returns" : [
- ]
+ "returns" : []
},
{
"name" : "releaseCapture",
+ "type" : "function",
"desc" : "Removes all added captures from the Observable.",
+ "sig" : "(o)",
+ "static" : true,
+ "memberOf" : "Roo.util.Observable",
"isStatic" : true,
"isConstructor" : false,
"isPrivate" : false,
- "memberOf" : "Roo.util.Observable",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
"name" : "o",
@@ -793,20 +975,24 @@
"isOptional" : false
}
],
- "returns" : [
- ]
+ "returns" : []
},
{
"name" : "removeListener",
+ "type" : "function",
"desc" : "Removes a listener",
+ "sig" : "(eventName, handler, scope)",
+ "static" : false,
+ "memberOf" : "Roo.util.Observable",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
- "memberOf" : "Roo.util.Observable",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
"name" : "eventName",
@@ -827,20 +1013,24 @@
"isOptional" : false
}
],
- "returns" : [
- ]
+ "returns" : []
},
{
"name" : "fireEvent",
+ "type" : "function",
"desc" : "Fires the specified event with the passed parameters (minus the event name).",
+ "sig" : "(eventName, args)",
+ "static" : false,
+ "memberOf" : "Roo.util.Observable",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
- "memberOf" : "Roo.util.Observable",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
"name" : "eventName",
@@ -865,15 +1055,20 @@
},
{
"name" : "hasListener",
+ "type" : "function",
"desc" : "Checks to see if this object has any listeners for a specified event",
+ "sig" : "(eventName)",
+ "static" : false,
+ "memberOf" : "Roo.util.Observable",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
- "memberOf" : "Roo.util.Observable",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
"name" : "eventName",
@@ -892,15 +1087,20 @@
},
{
"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\nbefore the event is fired. If the supplied function returns false,\nthe event will not fire.",
+ "sig" : "(o, fn, scope)",
+ "static" : true,
+ "memberOf" : "Roo.util.Observable",
"isStatic" : true,
"isConstructor" : false,
"isPrivate" : false,
- "memberOf" : "Roo.util.Observable",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
"name" : "o",
@@ -921,20 +1121,24 @@
"isOptional" : false
}
],
- "returns" : [
- ]
+ "returns" : []
},
{
"name" : "addListener",
+ "type" : "function",
"desc" : "Appends an event handler to this component",
+ "sig" : "(eventName, handler, scope, options)",
+ "static" : false,
+ "memberOf" : "Roo.util.Observable",
"isStatic" : false,
"isConstructor" : false,
"isPrivate" : false,
- "memberOf" : "Roo.util.Observable",
"example" : "",
"deprecated" : "",
"since" : "",
"see" : "",
+ "exceptions" : "",
+ "requires" : "",
"params" : [
{
"name" : "eventName",
@@ -961,14 +1165,15 @@
"isOptional" : false
}
],
- "returns" : [
- ]
+ "returns" : []
}
],
"events" : [
{
"name" : "beforeaction",
+ "type" : "function",
"desc" : "Fires before any action is performed. Return false to cancel the action.",
+ "sig" : "function (_self, action)\n{\n\n}",
"memberOf" : "",
"example" : "",
"deprecated" : "",
@@ -988,12 +1193,13 @@
"isOptional" : false
}
],
- "returns" : [
- ]
+ "returns" : []
},
{
"name" : "actioncomplete",
+ "type" : "function",
"desc" : "Fires when an action is completed.",
+ "sig" : "function (_self, action)\n{\n\n}",
"memberOf" : "",
"example" : "",
"deprecated" : "",
@@ -1013,12 +1219,13 @@
"isOptional" : false
}
],
- "returns" : [
- ]
+ "returns" : []
},
{
"name" : "actionfailed",
+ "type" : "function",
"desc" : "Fires when an action fails.",
+ "sig" : "function (_self, action)\n{\n\n}",
"memberOf" : "",
"example" : "",
"deprecated" : "",
@@ -1038,8 +1245,7 @@
"isOptional" : false
}
],
- "returns" : [
- ]
+ "returns" : []
}
]
}
\ No newline at end of file