X-Git-Url: http://git.roojs.org/?a=blobdiff_plain;f=docs%2Fsymbols%2FRoo.form.Radio.json;h=d41ae4191346c8b81b39387ebfa41f734325f9d5;hb=ace3bd1cd175b8285e20933c004e7c5aa826028a;hp=e69debfa127e5f059a78ab6d48712cdd23bf733c;hpb=9ff8ded6bbbd258ecd646184ba26020874e2c085;p=roojs1 diff --git a/docs/symbols/Roo.form.Radio.json b/docs/symbols/Roo.form.Radio.json index e69debfa12..d41ae41913 100644 --- a/docs/symbols/Roo.form.Radio.json +++ b/docs/symbols/Roo.form.Radio.json @@ -7,10 +7,15 @@ "Roo.Component", "Roo.util.Observable" ], + "childClasses" : { }, + "tree_children" : [], + "tree_parent" : [], "desc" : "Single radio field. Same as Checkbox, but provided as a convenience for automatically setting the input type.\nRadio grouping is handled automatically by the browser if you give each radio in a group the same name.", "isSingleton" : false, "isStatic" : false, "isBuiltin" : false, + "isAbstract" : false, + "isBuilderTop" : false, "memberOf" : "Radio", "example" : "", "deprecated" : "", @@ -24,73 +29,75 @@ "isOptional" : false } ], - "returns" : [ - ], + "returns" : [], + "throws" : "", + "requires" : "", "config" : [ { "name" : "inputType", "type" : "String", "desc" : "The type attribute for input fields -- e.g. radio, text, password (defaults to \"text\").", "memberOf" : "Roo.form.Field", - "values" : [ - ] + "isOptional" : false, + "optvals" : [] }, { "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" : "msgFx", "type" : "String", "desc" : "Experimental The effect used when displaying a validation message under the field (defaults to 'normal').", "memberOf" : "Roo.form.Field", - "values" : [ - ] + "isOptional" : false, + "optvals" : [] }, { "name" : "inputValue", "type" : "String", "desc" : "The value that should go into the generated input element's value attribute", "memberOf" : "Roo.form.Checkbox", - "values" : [ - ] + "isOptional" : false, + "optvals" : [] }, { "name" : "fieldLabel", "type" : "String", "desc" : "Label to use when rendering a form.", "memberOf" : "Roo.form.Field", - "values" : [ - ] + "isOptional" : false, + "optvals" : [] }, { "name" : "validationDelay", "type" : "Number", "desc" : "The length of time in milliseconds after user input begins until validation is initiated (defaults to 250)", "memberOf" : "Roo.form.Field", - "values" : [ - ] + "isOptional" : false, + "optvals" : [] }, { "name" : "msgTarget", "type" : "String", "desc" : "The location where error text should display. Should be one of the following values (defaults to 'qtip'):\n
\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
", "memberOf" : "Roo.form.Field", - "values" : [ - ] + "isOptional" : false, + "optvals" : [] }, { "name" : "hideMode", "type" : "String", - "desc" : "How this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display\".", + "desc" : "y)\nHow this component should hidden. Supported values are\n\"visibility\" (css visibility), \"offsets\" (negative offset position) and\n\"display\" (css display) - defaults to \"display", "memberOf" : "Roo.Component", - "values" : [ - "(display", - "visibility)" + "isOptional" : false, + "optvals" : [ + "display", + "visibility" ] }, { @@ -98,192 +105,204 @@ "type" : "Boolean", "desc" : "True to disable the field (defaults to false).", "memberOf" : "Roo.form.Field", - "values" : [ - ] + "isOptional" : false, + "optvals" : [] }, { "name" : "value", "type" : "Mixed", "desc" : "A value to initialize this field with.", "memberOf" : "Roo.form.Field", - "values" : [ - ] + "isOptional" : false, + "optvals" : [] + }, + { + "name" : "style", + "type" : "String", + "desc" : "css styles to add to component\neg. text-align:right;", + "memberOf" : "Roo.Component", + "isOptional" : false, + "optvals" : [] }, { "name" : "allowDomMove", "type" : "Boolean", "desc" : "Whether the component can move the Dom node when rendering (defaults to true).", "memberOf" : "Roo.Component", - "values" : [ - ] + "isOptional" : false, + "optvals" : [] }, { "name" : "tabIndex", "type" : "Number", "desc" : "The tabIndex for this field. Note this only applies to fields that are rendered, not those which are built via applyTo (defaults to undefined).", "memberOf" : "Roo.form.Field", - "values" : [ - ] + "isOptional" : false, + "optvals" : [] }, { "name" : "readOnly", "type" : "Boolean", "desc" : "True to mark the field as readOnly in HTML (defaults to false) -- Note: this only sets the element's readOnly DOM attribute.", "memberOf" : "Roo.form.Field", - "values" : [ - ] + "isOptional" : false, + "optvals" : [] }, { "name" : "invalidClass", "type" : "String", "desc" : "The CSS class to use when marking a field invalid (defaults to \"x-form-invalid\")", "memberOf" : "Roo.form.Field", - "values" : [ - ] + "isOptional" : false, + "optvals" : [] }, { "name" : "cls", "type" : "String", "desc" : "A CSS class to apply to the field's underlying element.", "memberOf" : "Roo.form.Field", - "values" : [ - ] + "isOptional" : false, + "optvals" : [] }, { "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", - "values" : [ - ] + "isOptional" : false, + "optvals" : [] }, { "name" : "valueOff", "type" : "String", "desc" : "The value that should go into the generated input element's value when unchecked.", "memberOf" : "Roo.form.Checkbox", - "values" : [ - ] + "isOptional" : false, + "optvals" : [] }, { "name" : "invalidText", "type" : "String", "desc" : "The error text to use when marking a field invalid and no message is provided (defaults to \"The value in this field is invalid\")", "memberOf" : "Roo.form.Field", - "values" : [ - ] + "isOptional" : false, + "optvals" : [] }, { "name" : "actionMode", "type" : "String", - "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el'", + "desc" : "which property holds the element that used for hide() / show() / disable() / enable()\ndefault is 'el' for forms you probably want to set this to fieldEl", "memberOf" : "Roo.Component", - "values" : [ - ] + "isOptional" : false, + "optvals" : [] }, { "name" : "boxLabel", "type" : "String", "desc" : "The text that appears beside the checkbox", "memberOf" : "Roo.form.Checkbox", - "values" : [ - ] + "isOptional" : false, + "optvals" : [] }, { "name" : "width", "type" : "Number", "desc" : "width (optional) size of component", "memberOf" : "Roo.BoxComponent", - "values" : [ - ] + "isOptional" : false, + "optvals" : [] }, { "name" : "validateOnBlur", "type" : "Boolean", "desc" : "Whether the field should validate when it loses focus (defaults to true).", "memberOf" : "Roo.form.Field", - "values" : [ - ] + "isOptional" : false, + "optvals" : [] }, { "name" : "validationEvent", "type" : "String/Boolean", "desc" : "The event that should initiate field validation. Set to false to disable\n automatic validation (defaults to \"keyup\").", "memberOf" : "Roo.form.Field", - "values" : [ - ] + "isOptional" : false, + "optvals" : [] }, { "name" : "fieldClass", "type" : "String", "desc" : "The default CSS class for the checkbox (defaults to \"x-form-field\")", "memberOf" : "Roo.form.Checkbox", - "values" : [ - ] + "isOptional" : false, + "optvals" : [] }, { "name" : "checked", "type" : "Boolean", "desc" : "True if the the checkbox should render already checked (defaults to false)", "memberOf" : "Roo.form.Checkbox", - "values" : [ - ] + "isOptional" : false, + "optvals" : [] }, { "name" : "focusClass", "type" : "String", "desc" : "The CSS class to use when the checkbox receives focus (defaults to undefined)", "memberOf" : "Roo.form.Checkbox", - "values" : [ - ] + "isOptional" : false, + "optvals" : [] }, { "name" : "name", "type" : "String", "desc" : "The field's HTML name attribute.", "memberOf" : "Roo.form.Field", - "values" : [ - ] + "isOptional" : false, + "optvals" : [] }, { "name" : "qtip", "type" : "String", "desc" : "Mouse over tip", "memberOf" : "Roo.form.Field", - "values" : [ - ] + "isOptional" : false, + "optvals" : [] }, { "name" : "height", "type" : "Number", "desc" : "height (optional) size of component", "memberOf" : "Roo.BoxComponent", - "values" : [ - ] + "isOptional" : false, + "optvals" : [] }, { "name" : "disableClass", "type" : "String", "desc" : "CSS class added to the component when it is disabled (defaults to \"x-item-disabled\").", "memberOf" : "Roo.Component", - "values" : [ - ] + "isOptional" : false, + "optvals" : [] } ], "methods" : [ { "name" : "getGroupValue", + "type" : "function", "desc" : "If this radio is part of a group, it will return the selected value", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.form.Radio", "example" : "", "deprecated" : "", "since" : "", "see" : "", - "params" : [ - ], + "exceptions" : "", + "requires" : "", + "params" : [], "returns" : [ { "name" : "", @@ -294,15 +313,20 @@ }, { "name" : "setValue", + "type" : "function", "desc" : "Sets the checked state of the checkbox.\nOn is always based on a string comparison between inputValue and the param.", + "sig" : "(value, suppressEvent)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.form.Checkbox", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "value", @@ -317,22 +341,25 @@ "isOptional" : false } ], - "returns" : [ - ] + "returns" : [] }, { "name" : "getValue", + "type" : "function", "desc" : "Returns the checked state of the checkbox.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.form.Checkbox", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.form.Checkbox", "example" : "", "deprecated" : "", "since" : "", "see" : "", - "params" : [ - ], + "exceptions" : "", + "requires" : "", + "params" : [], "returns" : [ { "name" : "", @@ -343,17 +370,21 @@ }, { "name" : "validate", + "type" : "function", "desc" : "Validates the field value", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.form.Field", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.form.Field", "example" : "", "deprecated" : "", "since" : "", "see" : "", - "params" : [ - ], + "exceptions" : "", + "requires" : "", + "params" : [], "returns" : [ { "name" : "", @@ -364,17 +395,21 @@ }, { "name" : "getName", + "type" : "function", "desc" : "Returns the name attribute of the field if available", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.form.Field", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.form.Field", "example" : "", "deprecated" : "", "since" : "", "see" : "", - "params" : [ - ], + "exceptions" : "", + "requires" : "", + "params" : [], "returns" : [ { "name" : "", @@ -385,15 +420,20 @@ }, { "name" : "markInvalid", + "type" : "function", "desc" : "Mark this field as invalid", + "sig" : "(msg)", + "static" : false, + "memberOf" : "Roo.form.Field", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.form.Field", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "msg", @@ -402,22 +442,25 @@ "isOptional" : false } ], - "returns" : [ - ] + "returns" : [] }, { "name" : "getRawValue", + "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}.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.form.Field", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.form.Field", "example" : "", "deprecated" : "", "since" : "", "see" : "", - "params" : [ - ], + "exceptions" : "", + "requires" : "", + "params" : [], "returns" : [ { "name" : "", @@ -428,15 +471,20 @@ }, { "name" : "applyTo", + "type" : "function", "desc" : "Apply the behaviors of this component to an existing element. This is used instead of render().", + "sig" : "(el)", + "static" : false, + "memberOf" : "Roo.form.Field", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.form.Field", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "el", @@ -455,47 +503,58 @@ }, { "name" : "resetHasChanged", + "type" : "function", "desc" : "stores the current value in loadedValue", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.form.Field", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.form.Field", "example" : "", "deprecated" : "", "since" : "", "see" : "", - "params" : [ - ], - "returns" : [ - ] + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "isDirty", + "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.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.form.Field", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.form.Field", "example" : "", "deprecated" : "", "since" : "", "see" : "", - "params" : [ - ], - "returns" : [ - ] + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "setRawValue", + "type" : "function", "desc" : "Sets the underlying DOM field's value directly, bypassing validation. To set the value with validation see {@link #setValue}.", + "sig" : "(value)", + "static" : false, + "memberOf" : "Roo.form.Field", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.form.Field", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "value", @@ -504,36 +563,43 @@ "isOptional" : false } ], - "returns" : [ - ] + "returns" : [] }, { "name" : "clearInvalid", + "type" : "function", "desc" : "Clear any invalid styles/messages for this field", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.form.Field", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.form.Field", "example" : "", "deprecated" : "", "since" : "", "see" : "", - "params" : [ - ], - "returns" : [ - ] + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "isValid", + "type" : "function", "desc" : "Returns whether or not the field value is currently valid", + "sig" : "(preventMark)", + "static" : false, + "memberOf" : "Roo.form.Field", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.form.Field", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "preventMark", @@ -552,47 +618,58 @@ }, { "name" : "reset", + "type" : "function", "desc" : "Resets the current field value to the originally loaded value and clears any validation messages", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.form.Field", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.form.Field", "example" : "", "deprecated" : "", "since" : "", "see" : "", - "params" : [ - ], - "returns" : [ - ] + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "hasChanged", + "type" : "function", "desc" : "checks the current value against the 'loaded' value.\nNote - will return false if 'resetHasChanged' has not been called first.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.form.Field", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.form.Field", "example" : "", "deprecated" : "", "since" : "", "see" : "", - "params" : [ - ], - "returns" : [ - ] + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "updateBox", + "type" : "function", "desc" : "Sets the current box measurements of the component's underlying element.", + "sig" : "(box)", + "static" : false, + "memberOf" : "Roo.BoxComponent", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.BoxComponent", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "box", @@ -601,20 +678,24 @@ "isOptional" : false } ], - "returns" : [ - ] + "returns" : [] }, { "name" : "setPagePosition", + "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.", + "sig" : "(x, y)", + "static" : false, + "memberOf" : "Roo.BoxComponent", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.BoxComponent", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "x", @@ -629,36 +710,43 @@ "isOptional" : false } ], - "returns" : [ - ] + "returns" : [] }, { "name" : "syncSize", + "type" : "function", "desc" : "Force the component's size to recalculate based on the underlying element's current height and width.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.BoxComponent", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.BoxComponent", "example" : "", "deprecated" : "", "since" : "", "see" : "", - "params" : [ - ], - "returns" : [ - ] + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "setSize", + "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}.", + "sig" : "(width, height)", + "static" : false, + "memberOf" : "Roo.BoxComponent", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.BoxComponent", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "width", @@ -683,15 +771,20 @@ }, { "name" : "getPosition", + "type" : "function", "desc" : "Gets the current XY position of the component's underlying element.", + "sig" : "(local)", + "static" : false, + "memberOf" : "Roo.BoxComponent", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.BoxComponent", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "local", @@ -710,15 +803,20 @@ }, { "name" : "onResize", + "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.", + "sig" : "(adjWidth, adjHeight, rawWidth, rawHeight)", + "static" : false, + "memberOf" : "Roo.BoxComponent", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.BoxComponent", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "adjWidth", @@ -745,20 +843,24 @@ "isOptional" : false } ], - "returns" : [ - ] + "returns" : [] }, { "name" : "getBox", + "type" : "function", "desc" : "Gets the current box measurements of the component's underlying element.", + "sig" : "(local)", + "static" : false, + "memberOf" : "Roo.BoxComponent", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.BoxComponent", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "local", @@ -767,22 +869,25 @@ "isOptional" : false } ], - "returns" : [ - ] + "returns" : [] }, { "name" : "getSize", + "type" : "function", "desc" : "Gets the current size of the component's underlying element.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.BoxComponent", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.BoxComponent", "example" : "", "deprecated" : "", "since" : "", "see" : "", - "params" : [ - ], + "exceptions" : "", + "requires" : "", + "params" : [], "returns" : [ { "name" : "", @@ -793,15 +898,20 @@ }, { "name" : "onPosition", + "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.", + "sig" : "(x, y)", + "static" : false, + "memberOf" : "Roo.BoxComponent", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.BoxComponent", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "x", @@ -816,20 +926,24 @@ "isOptional" : false } ], - "returns" : [ - ] + "returns" : [] }, { "name" : "setPosition", + "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.", + "sig" : "(left, top)", + "static" : false, + "memberOf" : "Roo.BoxComponent", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.BoxComponent", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "left", @@ -844,22 +958,25 @@ "isOptional" : false } ], - "returns" : [ - ] + "returns" : [] }, { "name" : "getId", + "type" : "function", "desc" : "Returns the id of this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", - "params" : [ - ], + "exceptions" : "", + "requires" : "", + "params" : [], "returns" : [ { "name" : "", @@ -870,15 +987,20 @@ }, { "name" : "render", + "type" : "function", "desc" : "If this is a lazy rendering component, render it to its container element.", + "sig" : "(container)", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "container", @@ -887,52 +1009,62 @@ "isOptional" : false } ], - "returns" : [ - ] + "returns" : [] }, { "name" : "destroy", + "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}.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", - "params" : [ - ], - "returns" : [ - ] + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "isVisible", + "type" : "function", "desc" : "Returns true if this component is visible.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", - "params" : [ - ], - "returns" : [ - ] + "exceptions" : "", + "requires" : "", + "params" : [], + "returns" : [] }, { "name" : "setDisabled", + "type" : "function", "desc" : "Convenience function for setting disabled/enabled by boolean.", + "sig" : "(disabled)", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "disabled", @@ -941,22 +1073,25 @@ "isOptional" : false } ], - "returns" : [ - ] + "returns" : [] }, { "name" : "hide", + "type" : "function", "desc" : "Hide this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", - "params" : [ - ], + "exceptions" : "", + "requires" : "", + "params" : [], "returns" : [ { "name" : "", @@ -967,15 +1102,20 @@ }, { "name" : "focus", + "type" : "function", "desc" : "Try to focus this component.", + "sig" : "(selectText)", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "selectText", @@ -994,17 +1134,21 @@ }, { "name" : "show", + "type" : "function", "desc" : "Show this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", - "params" : [ - ], + "exceptions" : "", + "requires" : "", + "params" : [], "returns" : [ { "name" : "", @@ -1015,17 +1159,21 @@ }, { "name" : "enable", + "type" : "function", "desc" : "Enable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", - "params" : [ - ], + "exceptions" : "", + "requires" : "", + "params" : [], "returns" : [ { "name" : "", @@ -1036,15 +1184,20 @@ }, { "name" : "setVisible", + "type" : "function", "desc" : "Convenience function to hide or show this component by boolean.", + "sig" : "(visible)", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "visible", @@ -1063,17 +1216,21 @@ }, { "name" : "disable", + "type" : "function", "desc" : "Disable this component.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", - "params" : [ - ], + "exceptions" : "", + "requires" : "", + "params" : [], "returns" : [ { "name" : "", @@ -1084,17 +1241,21 @@ }, { "name" : "getEl", + "type" : "function", "desc" : "Returns the underlying {@link Roo.Element}.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.Component", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", "since" : "", "see" : "", - "params" : [ - ], + "exceptions" : "", + "requires" : "", + "params" : [], "returns" : [ { "name" : "", @@ -1105,31 +1266,39 @@ }, { "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", @@ -1156,20 +1325,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", @@ -1190,20 +1363,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", @@ -1212,20 +1389,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", @@ -1234,20 +1415,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", @@ -1268,20 +1453,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", @@ -1306,15 +1495,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", @@ -1333,15 +1527,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", @@ -1362,20 +1561,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", @@ -1402,14 +1605,15 @@ "isOptional" : false } ], - "returns" : [ - ] + "returns" : [] } ], "events" : [ { "name" : "check", + "type" : "function", "desc" : "Fires when the checkbox is checked or unchecked.", + "sig" : "function (_self, checked)\n{\n\n}", "memberOf" : "Roo.form.Checkbox", "example" : "", "deprecated" : "", @@ -1429,12 +1633,13 @@ "isOptional" : false } ], - "returns" : [ - ] + "returns" : [] }, { "name" : "blur", + "type" : "function", "desc" : "Fires when this field loses input focus.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.form.Field", "example" : "", "deprecated" : "", @@ -1448,12 +1653,13 @@ "isOptional" : false } ], - "returns" : [ - ] + "returns" : [] }, { "name" : "valid", + "type" : "function", "desc" : "Fires after the field has been validated with no errors.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.form.Field", "example" : "", "deprecated" : "", @@ -1467,12 +1673,13 @@ "isOptional" : false } ], - "returns" : [ - ] + "returns" : [] }, { "name" : "specialkey", + "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.", + "sig" : "function (_self, e)\n{\n\n}", "memberOf" : "Roo.form.Field", "example" : "", "deprecated" : "", @@ -1492,12 +1699,13 @@ "isOptional" : false } ], - "returns" : [ - ] + "returns" : [] }, { "name" : "focus", + "type" : "function", "desc" : "Fires when this field receives input focus.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.form.Field", "example" : "", "deprecated" : "", @@ -1511,12 +1719,13 @@ "isOptional" : false } ], - "returns" : [ - ] + "returns" : [] }, { "name" : "keyup", + "type" : "function", "desc" : "Fires after the key up", + "sig" : "function (_self, e)\n{\n\n}", "memberOf" : "Roo.form.Field", "example" : "", "deprecated" : "", @@ -1536,12 +1745,13 @@ "isOptional" : false } ], - "returns" : [ - ] + "returns" : [] }, { "name" : "invalid", + "type" : "function", "desc" : "Fires after the field has been marked as invalid.", + "sig" : "function (_self, msg)\n{\n\n}", "memberOf" : "Roo.form.Field", "example" : "", "deprecated" : "", @@ -1561,12 +1771,13 @@ "isOptional" : false } ], - "returns" : [ - ] + "returns" : [] }, { "name" : "change", + "type" : "function", "desc" : "Fires just before the field blurs if the field value has changed.", + "sig" : "function (_self, newValue, oldValue)\n{\n\n}", "memberOf" : "Roo.form.Field", "example" : "", "deprecated" : "", @@ -1592,12 +1803,13 @@ "isOptional" : false } ], - "returns" : [ - ] + "returns" : [] }, { "name" : "move", + "type" : "function", "desc" : "Fires after the component is moved.", + "sig" : "function (_self, x, y)\n{\n\n}", "memberOf" : "Roo.BoxComponent", "example" : "", "deprecated" : "", @@ -1623,12 +1835,13 @@ "isOptional" : false } ], - "returns" : [ - ] + "returns" : [] }, { "name" : "resize", + "type" : "function", "desc" : "Fires after the component is resized.", + "sig" : "function (_self, adjWidth, adjHeight, rawWidth, rawHeight)\n{\n\n}", "memberOf" : "Roo.BoxComponent", "example" : "", "deprecated" : "", @@ -1666,12 +1879,13 @@ "isOptional" : false } ], - "returns" : [ - ] + "returns" : [] }, { "name" : "beforerender", + "type" : "function", "desc" : "Fires before the component is rendered. Return false to stop the render.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -1685,12 +1899,13 @@ "isOptional" : false } ], - "returns" : [ - ] + "returns" : [] }, { "name" : "disable", + "type" : "function", "desc" : "Fires after the component is disabled.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -1704,12 +1919,13 @@ "isOptional" : false } ], - "returns" : [ - ] + "returns" : [] }, { "name" : "render", + "type" : "function", "desc" : "Fires after the component is rendered.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -1723,12 +1939,13 @@ "isOptional" : false } ], - "returns" : [ - ] + "returns" : [] }, { "name" : "destroy", + "type" : "function", "desc" : "Fires after the component is destroyed.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -1742,12 +1959,13 @@ "isOptional" : false } ], - "returns" : [ - ] + "returns" : [] }, { "name" : "hide", + "type" : "function", "desc" : "Fires after the component is hidden.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -1761,12 +1979,13 @@ "isOptional" : false } ], - "returns" : [ - ] + "returns" : [] }, { "name" : "beforehide", + "type" : "function", "desc" : "Fires before the component is hidden. Return false to stop the hide.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -1780,12 +1999,13 @@ "isOptional" : false } ], - "returns" : [ - ] + "returns" : [] }, { "name" : "show", + "type" : "function", "desc" : "Fires after the component is shown.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -1799,12 +2019,13 @@ "isOptional" : false } ], - "returns" : [ - ] + "returns" : [] }, { "name" : "beforeshow", + "type" : "function", "desc" : "Fires before the component is shown. Return false to stop the show.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -1818,12 +2039,13 @@ "isOptional" : false } ], - "returns" : [ - ] + "returns" : [] }, { "name" : "enable", + "type" : "function", "desc" : "Fires after the component is enabled.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -1837,12 +2059,13 @@ "isOptional" : false } ], - "returns" : [ - ] + "returns" : [] }, { "name" : "beforedestroy", + "type" : "function", "desc" : "Fires before the component is destroyed. Return false to stop the destroy.", + "sig" : "function (_self)\n{\n\n}", "memberOf" : "Roo.Component", "example" : "", "deprecated" : "", @@ -1856,8 +2079,7 @@ "isOptional" : false } ], - "returns" : [ - ] + "returns" : [] } ] } \ No newline at end of file