Upgrade to ExtJS 3.3.0 - Released 10/06/2010

[extjs.git] / examples / docs / output / Ext.ux.form.FileUploadField.html

<div class="body-wrap" xmlns:ext="http://www.extjs.com"><div class="top-tools"><a class="inner-link" href="#Ext.ux.form.FileUploadField-props"><img src="resources/images/default/s.gif" class="item-icon icon-prop">Properties</a>&#13;<a class="inner-link" href="#Ext.ux.form.FileUploadField-methods"><img src="resources/images/default/s.gif" class="item-icon icon-method">Methods</a>&#13;<a class="inner-link" href="#Ext.ux.form.FileUploadField-events"><img src="resources/images/default/s.gif" class="item-icon icon-event">Events</a>&#13;<a class="inner-link" href="#Ext.ux.form.FileUploadField-configs"><img src="resources/images/default/s.gif" class="item-icon icon-config">Config Options</a>&#13;<a class="bookmark" href="../docs/?class=Ext.ux.form.FileUploadField"><img src="resources/images/default/s.gif" class="item-icon icon-fav">Direct Link</a>&#13;</div><h1>Class <a href="source/ux-all-debug.html#cls-Ext.ux.form.FileUploadField">Ext.ux.form.FileUploadField</a></h1><table cellspacing="0"><tr><td class="label">Package:</td><td class="hd-info">Ext.ux.form</td></tr><tr><td class="label">Defined In:</td><td class="hd-info"><a href="source/ux-all-debug.html#cls-Ext.ux.form.FileUploadField">ux-all-debug.js</a></td></tr><tr><td class="label">Class:</td><td class="hd-info"><a href="source/ux-all-debug.html#cls-Ext.ux.form.FileUploadField">FileUploadField</a></td></tr><tr><td class="label">Extends:</td><td class="hd-info">Object</td></tr></table><div class="description">Creates a file upload field.</div><div class="hr"></div><a id="Ext.ux.form.FileUploadField-configs"></a><h2>Config Options</h2><table cellspacing="0" class="member-table"><tbody><tr><th colspan="2" class="sig-header">Config Options</th><th class="msource-header">Defined By</th></tr><tr class="config-row  "><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.ux.form.FileUploadField-buttonCfg"></a><b><a href="source/ux-all-debug.html#cfg-Ext.ux.form.FileUploadField-buttonCfg">buttonCfg</a></b> : Object<div class="mdesc">A standard <a href="output/Ext.Button.html" ext:cls="Ext.Button">Ext.Button</a> config object.</div></td><td class="msource">FileUploadField</td></tr><tr class="config-row  "><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.ux.form.FileUploadField-buttonCfg"></a><b><a href="source/FileUploadField.html#cfg-Ext.ux.form.FileUploadField-buttonCfg">buttonCfg</a></b> : Object<div class="mdesc">A standard <a href="output/Ext.Button.html" ext:cls="Ext.Button">Ext.Button</a> config object.</div></td><td class="msource">FileUploadField</td></tr><tr class="config-row expandable "><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.ux.form.FileUploadField-buttonOffset"></a><b><a href="source/ux-all-debug.html#cfg-Ext.ux.form.FileUploadField-buttonOffset">buttonOffset</a></b> : Number<div class="mdesc"><div class="short">The number of pixels of space reserved between the button and the text field
(defaults to 3).  Note that this only ap...</div><div class="long">The number of pixels of space reserved between the button and the text field
(defaults to 3).  Note that this only applies if <a href="output/Ext.ux.form.FileUploadField.html#Ext.ux.form.FileUploadField-buttonOnly" ext:member="buttonOnly" ext:cls="Ext.ux.form.FileUploadField">buttonOnly</a> = false.</div></div></td><td class="msource">FileUploadField</td></tr><tr class="config-row expandable "><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.ux.form.FileUploadField-buttonOffset"></a><b><a href="source/FileUploadField.html#cfg-Ext.ux.form.FileUploadField-buttonOffset">buttonOffset</a></b> : Number<div class="mdesc"><div class="short">The number of pixels of space reserved between the button and the text field
(defaults to 3).  Note that this only ap...</div><div class="long">The number of pixels of space reserved between the button and the text field
(defaults to 3).  Note that this only applies if <a href="output/Ext.ux.form.FileUploadField.html#Ext.ux.form.FileUploadField-buttonOnly" ext:member="buttonOnly" ext:cls="Ext.ux.form.FileUploadField">buttonOnly</a> = false.</div></div></td><td class="msource">FileUploadField</td></tr><tr class="config-row expandable "><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.ux.form.FileUploadField-buttonOnly"></a><b><a href="source/ux-all-debug.html#cfg-Ext.ux.form.FileUploadField-buttonOnly">buttonOnly</a></b> : Boolean<div class="mdesc"><div class="short">True to display the file upload field as a button with no visible
text field (defaults to false).  If true, all inher...</div><div class="long">True to display the file upload field as a button with no visible
text field (defaults to false).  If true, all inherited TextField members will still be available.</div></div></td><td class="msource">FileUploadField</td></tr><tr class="config-row expandable "><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.ux.form.FileUploadField-buttonOnly"></a><b><a href="source/FileUploadField.html#cfg-Ext.ux.form.FileUploadField-buttonOnly">buttonOnly</a></b> : Boolean<div class="mdesc"><div class="short">True to display the file upload field as a button with no visible
text field (defaults to false).  If true, all inher...</div><div class="long">True to display the file upload field as a button with no visible
text field (defaults to false).  If true, all inherited TextField members will still be available.</div></div></td><td class="msource">FileUploadField</td></tr><tr class="config-row expandable "><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.ux.form.FileUploadField-buttonText"></a><b><a href="source/ux-all-debug.html#cfg-Ext.ux.form.FileUploadField-buttonText">buttonText</a></b> : String<div class="mdesc"><div class="short">The button text to display on the upload button (defaults to
'Browse...').  Note that if you supply a value for butto...</div><div class="long">The button text to display on the upload button (defaults to
'Browse...').  Note that if you supply a value for <a href="output/Ext.ux.form.FileUploadField.html#Ext.ux.form.FileUploadField-buttonCfg" ext:member="buttonCfg" ext:cls="Ext.ux.form.FileUploadField">buttonCfg</a>, the buttonCfg.text
value will be used instead if available.</div></div></td><td class="msource">FileUploadField</td></tr><tr class="config-row expandable "><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.ux.form.FileUploadField-buttonText"></a><b><a href="source/FileUploadField.html#cfg-Ext.ux.form.FileUploadField-buttonText">buttonText</a></b> : String<div class="mdesc"><div class="short">The button text to display on the upload button (defaults to
'Browse...').  Note that if you supply a value for butto...</div><div class="long">The button text to display on the upload button (defaults to
'Browse...').  Note that if you supply a value for <a href="output/Ext.ux.form.FileUploadField.html#Ext.ux.form.FileUploadField-buttonCfg" ext:member="buttonCfg" ext:cls="Ext.ux.form.FileUploadField">buttonCfg</a>, the buttonCfg.text
value will be used instead if available.</div></div></td><td class="msource">FileUploadField</td></tr></tbody></table><a id="Ext.ux.form.FileUploadField-props"></a><h2>Public Properties</h2><div class="no-members">This class has no public properties.</div><a id="Ext.ux.form.FileUploadField-methods"></a><h2>Public Methods</h2><div class="no-members">This class has no public methods.</div><a id="Ext.ux.form.FileUploadField-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 "><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.ux.form.FileUploadField-fileselected"></a><b><a href="source/ux-all-debug.html#event-Ext.ux.form.FileUploadField-fileselected">fileselected</a></b> :
                                      (&nbsp;<code>Ext.ux.form.FileUploadField&nbsp;this</code>,&nbsp;<code>String&nbsp;value</code>&nbsp;)
    <div class="mdesc"><div class="short">Fires when the underlying file input field's value has changed from the user
selecting a new file from the system fil...</div><div class="long">Fires when the underlying file input field's value has changed from the user
selecting a new file from the system file selection dialog.<div class="mdetail-params"><strong style="font-weight: normal;">Listeners will be called with the following arguments:</strong><ul><li><code>this</code> : Ext.ux.form.FileUploadField<div class="sub-desc"></div></li><li><code>value</code> : String<div class="sub-desc">The file value returned by the underlying file input field</div></li></ul></div></div></div></td><td class="msource">FileUploadField</td></tr><tr class="method-row expandable "><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.ux.form.FileUploadField-fileselected"></a><b><a href="source/FileUploadField.html#event-Ext.ux.form.FileUploadField-fileselected">fileselected</a></b> :
                                      (&nbsp;<code>Ext.ux.form.FileUploadField&nbsp;this</code>,&nbsp;<code>String&nbsp;value</code>&nbsp;)
    <div class="mdesc"><div class="short">Fires when the underlying file input field's value has changed from the user
selecting a new file from the system fil...</div><div class="long">Fires when the underlying file input field's value has changed from the user
selecting a new file from the system file selection dialog.<div class="mdetail-params"><strong style="font-weight: normal;">Listeners will be called with the following arguments:</strong><ul><li><code>this</code> : Ext.ux.form.FileUploadField<div class="sub-desc"></div></li><li><code>value</code> : String<div class="sub-desc">The file value returned by the underlying file input field</div></li></ul></div></div></div></td><td class="msource">FileUploadField</td></tr></tbody></table></div>