-after the <a href="output/Ext.util.Observable.html#Ext.util.Observable-resumeEvents" ext:member="resumeEvents" ext:cls="Ext.util.Observable">resumeEvents</a> call instead of discarding all suspended events;</div></li></ul><strong>Returns:</strong><ul><li>void</li></ul></div></div></div></td><td class="msource"><a href="output/Ext.util.Observable.html#suspendEvents" ext:member="#suspendEvents" ext:cls="Ext.util.Observable">Observable</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.BoxComponent-syncSize"></a><b><a href="source/BoxComponent.html#method-Ext.BoxComponent-syncSize">syncSize</a></b>()
- :
- Ext.BoxComponent<div class="mdesc"><div class="short">Force the component's size to recalculate based on the underlying element's current height and width.</div><div class="long">Force the component's size to recalculate based on the underlying element's current height and width.<div class="mdetail-params"><strong>Parameters:</strong><ul><li>None.</li></ul><strong>Returns:</strong><ul><li><code>Ext.BoxComponent</code><div class="sub-desc">this</div></li></ul></div></div></div></td><td class="msource"><a href="output/Ext.BoxComponent.html#syncSize" ext:member="#syncSize" ext:cls="Ext.BoxComponent">BoxComponent</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.util.Observable-un"></a><b><a href="source/Observable.html#method-Ext.util.Observable-un">un</a></b>( <code>String eventName</code>, <code>Function handler</code>, <span title="Optional" class="optional">[<code>Object scope</code>]</span> )
- :
- void<div class="mdesc"><div class="short">Removes an event handler (shorthand for removeListener.)</div><div class="long">Removes an event handler (shorthand for <a href="output/Ext.util.Observable.html#Ext.util.Observable-removeListener" ext:member="removeListener" ext:cls="Ext.util.Observable">removeListener</a>.)<div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>eventName</code> : String<div class="sub-desc">The type of event the handler was associated with.</div></li><li><code>handler</code> : Function<div class="sub-desc">The handler to remove. <b>This must be a reference to the function passed into the <a href="output/Ext.util.Observable.html#Ext.util.Observable-addListener" ext:member="addListener" ext:cls="Ext.util.Observable">addListener</a> call.</b></div></li><li><code>scope</code> : Object<div class="sub-desc">(optional) The scope originally specified for the handler.</div></li></ul><strong>Returns:</strong><ul><li>void</li></ul></div></div></div></td><td class="msource"><a href="output/Ext.util.Observable.html#un" ext:member="#un" ext:cls="Ext.util.Observable">Observable</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.BoxComponent-updateBox"></a><b><a href="source/BoxComponent.html#method-Ext.BoxComponent-updateBox">updateBox</a></b>( <code>Object box</code> )
- :
- Ext.BoxComponent<div class="mdesc"><div class="short">Sets the current box measurements of the component's underlying element.</div><div class="long">Sets the current box measurements of the component's underlying element.<div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>box</code> : Object<div class="sub-desc">An object in the format {x, y, width, height}</div></li></ul><strong>Returns:</strong><ul><li><code>Ext.BoxComponent</code><div class="sub-desc">this</div></li></ul></div></div></div></td><td class="msource"><a href="output/Ext.BoxComponent.html#updateBox" ext:member="#updateBox" ext:cls="Ext.BoxComponent">BoxComponent</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.form.Field-validate"></a><b><a href="source/Field.html#method-Ext.form.Field-validate">validate</a></b>()
- :
- Boolean<div class="mdesc"><div class="short">Validates the field value</div><div class="long">Validates the field value<div class="mdetail-params"><strong>Parameters:</strong><ul><li>None.</li></ul><strong>Returns:</strong><ul><li><code>Boolean</code><div class="sub-desc">True if the value is valid, else false</div></li></ul></div></div></div></td><td class="msource"><a href="output/Ext.form.Field.html#validate" ext:member="#validate" ext:cls="Ext.form.Field">Field</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.form.TextField-validateValue"></a><b><a href="source/TextField.html#method-Ext.form.TextField-validateValue">validateValue</a></b>( <code>Mixed value</code> )
- :
- Boolean<div class="mdesc"><div class="short">Validates a value according to the field's validation rules and marks the field as invalid
-if the validation fails</div><div class="long">Validates a value according to the field's validation rules and marks the field as invalid
-if the validation fails<div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>value</code> : Mixed<div class="sub-desc">The value to validate</div></li></ul><strong>Returns:</strong><ul><li><code>Boolean</code><div class="sub-desc">True if the value is valid, else false</div></li></ul></div></div></div></td><td class="msource"><a href="output/Ext.form.TextField.html#validateValue" ext:member="#validateValue" ext:cls="Ext.form.TextField">TextField</a></td></tr></tbody></table><a id="Ext.form.TextArea-events"></a><h2>Public Events</h2><table cellspacing="0" class="member-table"><tbody><tr><th colspan="2" class="sig-header">Event</th><th class="msource-header">Defined By</th></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.Component-afterrender"></a><b><a href="source/Component.html#event-Ext.Component-afterrender">afterrender</a></b> :
- ( <code>Ext.Component this</code> )
- <div class="mdesc"><div class="short">Fires after the component rendering is finished.
+after the <a href="output/Ext.util.Observable.html#Ext.util.Observable-resumeEvents" ext:member="resumeEvents" ext:cls="Ext.util.Observable">resumeEvents</a> call instead of discarding all suspended events;</div></li></ul><strong>Returns:</strong><ul><li>void</li></ul></div></div></div></td><td class="msource"><a href="output/Ext.util.Observable.html#suspendEvents" ext:member="#suspendEvents" ext:cls="Ext.util.Observable">Observable</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.BoxComponent-syncSize"></a><b><a href="source/BoxComponent.html#method-Ext.BoxComponent-syncSize">syncSize</a></b>()\r
+ :\r
+ Ext.BoxComponent<div class="mdesc"><div class="short">Force the component's size to recalculate based on the underlying element's current height and width.</div><div class="long">Force the component's size to recalculate based on the underlying element's current height and width.<div class="mdetail-params"><strong>Parameters:</strong><ul><li>None.</li></ul><strong>Returns:</strong><ul><li><code>Ext.BoxComponent</code><div class="sub-desc">this</div></li></ul></div></div></div></td><td class="msource"><a href="output/Ext.BoxComponent.html#syncSize" ext:member="#syncSize" ext:cls="Ext.BoxComponent">BoxComponent</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.util.Observable-un"></a><b><a href="source/Observable.html#method-Ext.util.Observable-un">un</a></b>( <code>String eventName</code>, <code>Function handler</code>, <span title="Optional" class="optional">[<code>Object scope</code>]</span> )\r
+ :\r
+ void<div class="mdesc"><div class="short">Removes an event handler (shorthand for removeListener.)</div><div class="long">Removes an event handler (shorthand for <a href="output/Ext.util.Observable.html#Ext.util.Observable-removeListener" ext:member="removeListener" ext:cls="Ext.util.Observable">removeListener</a>.)<div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>eventName</code> : String<div class="sub-desc">The type of event the handler was associated with.</div></li><li><code>handler</code> : Function<div class="sub-desc">The handler to remove. <b>This must be a reference to the function passed into the <a href="output/Ext.util.Observable.html#Ext.util.Observable-addListener" ext:member="addListener" ext:cls="Ext.util.Observable">addListener</a> call.</b></div></li><li><code>scope</code> : Object<div class="sub-desc">(optional) The scope originally specified for the handler.</div></li></ul><strong>Returns:</strong><ul><li>void</li></ul></div></div></div></td><td class="msource"><a href="output/Ext.util.Observable.html#un" ext:member="#un" ext:cls="Ext.util.Observable">Observable</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.Component-update"></a><b><a href="source/Component.html#method-Ext.Component-update">update</a></b>( <code>Mixed htmlOrData</code>, <span title="Optional" class="optional">[<code>Boolean loadScripts</code>]</span>, <span title="Optional" class="optional">[<code>Function callback</code>]</span> )\r
+ :\r
+ void<div class="mdesc"><div class="short">Update the content area of a component.</div><div class="long">Update the content area of a component.<div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>htmlOrData</code> : Mixed<div class="sub-desc">If this component has been configured with a template via the tpl config
+then it will use this argument as data to populate the template.
+If this component was not configured with a template, the components
+content area will be updated via Ext.Element update</div></li><li><code>loadScripts</code> : Boolean<div class="sub-desc">(optional) Only legitimate when using the html configuration. Defaults to false</div></li><li><code>callback</code> : Function<div class="sub-desc">(optional) Only legitimate when using the html configuration. Callback to execute when scripts have finished loading</div></li></ul><strong>Returns:</strong><ul><li>void</li></ul></div></div></div></td><td class="msource"><a href="output/Ext.Component.html#update" ext:member="#update" ext:cls="Ext.Component">Component</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.BoxComponent-updateBox"></a><b><a href="source/BoxComponent.html#method-Ext.BoxComponent-updateBox">updateBox</a></b>( <code>Object box</code> )\r
+ :\r
+ Ext.BoxComponent<div class="mdesc"><div class="short">Sets the current box measurements of the component's underlying element.</div><div class="long">Sets the current box measurements of the component's underlying element.<div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>box</code> : Object<div class="sub-desc">An object in the format {x, y, width, height}</div></li></ul><strong>Returns:</strong><ul><li><code>Ext.BoxComponent</code><div class="sub-desc">this</div></li></ul></div></div></div></td><td class="msource"><a href="output/Ext.BoxComponent.html#updateBox" ext:member="#updateBox" ext:cls="Ext.BoxComponent">BoxComponent</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.form.Field-validate"></a><b><a href="source/Field.html#method-Ext.form.Field-validate">validate</a></b>()\r
+ :\r
+ Boolean<div class="mdesc"><div class="short">Validates the field value</div><div class="long">Validates the field value<div class="mdetail-params"><strong>Parameters:</strong><ul><li>None.</li></ul><strong>Returns:</strong><ul><li><code>Boolean</code><div class="sub-desc">True if the value is valid, else false</div></li></ul></div></div></div></td><td class="msource"><a href="output/Ext.form.Field.html#validate" ext:member="#validate" ext:cls="Ext.form.Field">Field</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.form.TextField-validateValue"></a><b><a href="source/TextField.html#method-Ext.form.TextField-validateValue">validateValue</a></b>( <code>Mixed value</code> )\r
+ :\r
+ Boolean<div class="mdesc"><div class="short">Validates a value according to the field's validation rules and marks the field as invalid\r
+if the validation fails. V...</div><div class="long"><p>Validates a value according to the field's validation rules and marks the field as invalid
+if the validation fails. Validation rules are processed in the following order:</p>
+<div class="mdetail-params"><ul>
+<li><b>1. Field specific validator</b>
+<div class="sub-desc">
+<p>A validator offers a way to customize and reuse a validation specification.
+If a field is configured with a <code><a href="output/Ext.form.TextField.html#Ext.form.TextField-validator" ext:member="validator" ext:cls="Ext.form.TextField">validator</a></code>
+function, it will be passed the current field value. The <code><a href="output/Ext.form.TextField.html#Ext.form.TextField-validator" ext:member="validator" ext:cls="Ext.form.TextField">validator</a></code>
+function is expected to return either:
+<div class="mdetail-params"><ul>
+<li>Boolean <tt>true</tt> if the value is valid (validation continues).</li>
+<li>a String to represent the invalid message if invalid (validation halts).</li>
+</ul></div>
+</div></li>
+<li><b>2. Basic Validation</b>
+<div class="sub-desc">
+<p>If the <code><a href="output/Ext.form.TextField.html#Ext.form.TextField-validator" ext:member="validator" ext:cls="Ext.form.TextField">validator</a></code> has not halted validation,
+basic validation proceeds as follows:</p>
+<div class="mdetail-params"><ul>
+<li><code><a href="output/Ext.form.TextField.html#Ext.form.TextField-allowBlank" ext:member="allowBlank" ext:cls="Ext.form.TextField">allowBlank</a></code> : (Invalid message =
+<code><a href="output/Ext.form.TextField.html#Ext.form.TextField-emptyText" ext:member="emptyText" ext:cls="Ext.form.TextField">emptyText</a></code>)<div class="sub-desc">
+Depending on the configuration of <code><a href="output/Ext.form.TextField.html#Ext.form.TextField-allowBlank" ext:member="allowBlank" ext:cls="Ext.form.TextField">allowBlank</a></code>, a
+blank field will cause validation to halt at this step and return
+Boolean true or false accordingly.
+</div></li>
+<li><code><a href="output/Ext.form.TextField.html#Ext.form.TextField-minLength" ext:member="minLength" ext:cls="Ext.form.TextField">minLength</a></code> : (Invalid message =
+<code><a href="output/Ext.form.TextField.html#Ext.form.TextField-minLengthText" ext:member="minLengthText" ext:cls="Ext.form.TextField">minLengthText</a></code>)<div class="sub-desc">
+If the passed value does not satisfy the <code><a href="output/Ext.form.TextField.html#Ext.form.TextField-minLength" ext:member="minLength" ext:cls="Ext.form.TextField">minLength</a></code>
+specified, validation halts.
+</div></li>
+<li><code><a href="output/Ext.form.TextField.html#Ext.form.TextField-maxLength" ext:member="maxLength" ext:cls="Ext.form.TextField">maxLength</a></code> : (Invalid message =
+<code><a href="output/Ext.form.TextField.html#Ext.form.TextField-maxLengthText" ext:member="maxLengthText" ext:cls="Ext.form.TextField">maxLengthText</a></code>)<div class="sub-desc">
+If the passed value does not satisfy the <code><a href="output/Ext.form.TextField.html#Ext.form.TextField-maxLength" ext:member="maxLength" ext:cls="Ext.form.TextField">maxLength</a></code>
+specified, validation halts.
+</div></li>
+</ul></div>
+</div></li>
+<li><b>3. Preconfigured Validation Types (VTypes)</b>
+<div class="sub-desc">
+<p>If none of the prior validation steps halts validation, a field
+configured with a <code><a href="output/Ext.form.TextField.html#Ext.form.TextField-vtype" ext:member="vtype" ext:cls="Ext.form.TextField">vtype</a></code> will utilize the
+corresponding <a href="output/Ext.form.VTypes.html" ext:cls="Ext.form.VTypes">VTypes</a> validation function.
+If invalid, either the field's <code><a href="output/Ext.form.TextField.html#Ext.form.TextField-vtypeText" ext:member="vtypeText" ext:cls="Ext.form.TextField">vtypeText</a></code> or
+the VTypes vtype Text property will be used for the invalid message.
+Keystrokes on the field will be filtered according to the VTypes
+vtype Mask property.</p>
+</div></li>
+<li><b>4. Field specific regex test</b>
+<div class="sub-desc">
+<p>If none of the prior validation steps halts validation, a field's
+configured <code><a href="output/Ext.form.TextField.html#Ext.form.TextField-regex" ext:member="regex" ext:cls="Ext.form.TextField">regex</a></code> test will be processed.
+The invalid message for this test is configured with
+<code><a href="output/Ext.form.TextField.html#Ext.form.TextField-regexText" ext:member="regexText" ext:cls="Ext.form.TextField">regexText</a></code>.</p>
+</div></li><div class="mdetail-params"><strong>Parameters:</strong><ul><li><code>value</code> : Mixed<div class="sub-desc">The value to validate</div></li></ul><strong>Returns:</strong><ul><li><code>Boolean</code><div class="sub-desc">True if the value is valid, else false</div></li></ul></div></div></div></td><td class="msource"><a href="output/Ext.form.TextField.html#validateValue" ext:member="#validateValue" ext:cls="Ext.form.TextField">TextField</a></td></tr></tbody></table><a id="Ext.form.TextArea-events"></a><h2>Public Events</h2><table cellspacing="0" class="member-table"><tbody><tr><th colspan="2" class="sig-header">Event</th><th class="msource-header">Defined By</th></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.Component-added"></a><b><a href="source/Component.html#event-Ext.Component-added">added</a></b> :\r
+ ( <code>Ext.Component this</code>, <code>Ext.Container ownerCt</code>, <code>number index</code> )\r
+ <div class="mdesc"><div class="short">Fires when a component is added to an Ext.Container</div><div class="long">Fires when a component is added to an Ext.Container<div class="mdetail-params"><strong style="font-weight: normal;">Listeners will be called with the following arguments:</strong><ul><li><code>this</code> : Ext.Component<div class="sub-desc"></div></li><li><code>ownerCt</code> : Ext.Container<div class="sub-desc">Container which holds the component</div></li><li><code>index</code> : number<div class="sub-desc">Position at which the component was added</div></li></ul></div></div></div></td><td class="msource"><a href="output/Ext.Component.html#added" ext:member="#added" ext:cls="Ext.Component">Component</a></td></tr><tr class="method-row expandable inherited"><td class="micon"><a href="#expand" class="exi"> </a></td><td class="sig"><a id="Ext.Component-afterrender"></a><b><a href="source/Component.html#event-Ext.Component-afterrender">afterrender</a></b> :\r
+ ( <code>Ext.Component this</code> )\r
+ <div class="mdesc"><div class="short">Fires after the component rendering is finished.\r
git.ithinksw.org / extjs.git / blobdiff