X-Git-Url: http://git.ithinksw.org/extjs.git/blobdiff_plain/0494b8d9b9bb03ab6c22b34dae81261e3cd7e3e6..7a654f8d43fdb43d78b63d90528bed6e86b608cc:/docs/output/Ext.form.BasicForm.html diff --git a/docs/output/Ext.form.BasicForm.html b/docs/output/Ext.form.BasicForm.html deleted file mode 100644 index be57263b..00000000 --- a/docs/output/Ext.form.BasicForm.html +++ /dev/null @@ -1,466 +0,0 @@ -
Observable - BasicForm
Package: | Ext.form |
Defined In: | BasicForm.js |
Class: | BasicForm |
Extends: | Observable |
Encapsulates the DOM <form> element at the heart of the FormPanel class, and provides -input field management, validation, submission, and form loading services.
-By default, Ext Forms are submitted through Ajax, using an instance of Ext.form.Action.Submit. -To enable normal browser submission of an Ext Form, use the standardSubmit config option.
-File Uploads
-File uploads are not performed using Ajax submission, that -is they are not performed using XMLHttpRequests. Instead the form is submitted in the standard -manner with the DOM <form> element temporarily modified to have its -target set to refer -to a dynamically generated, hidden <iframe> which is inserted into the document -but removed after the return data has been gathered.
-The server response is parsed by the browser to create the document for the IFRAME. If the -server is using JSON to send the return object, then the -Content-Type header -must be set to "text/html" in order to tell the browser to insert the text unchanged into the document body.
-Characters which are significant to an HTML parser must be sent as HTML entities, so encode -"<" as "<", "&" as "&" etc.
-The response text is retrieved from the document, and a fake XMLHttpRequest object -is created containing a responseText property in order to conform to the -requirements of event handlers and callbacks.
-Be aware that file upload packets are sent with the content type multipart/form -and some server technologies (notably JEE) may require some custom processing in order to -retrieve parameter names and parameter values from the packet content.
Config Options | Defined By | |
---|---|---|
api : Object If specified load and submit actions will be handled
-with Ext.form.Action.DirectLoad and Ext.form.Action.DirectSubmit... If specified load and submit actions will be handled
-with Ext.form.Action.DirectLoad and Ext.form.Action.DirectSubmit.
-Methods which have been imported by Ext.Direct can be specified here to load and submit
-forms.
-Such as the following:
-Load actions can use | BasicForm | |
baseParams : Object Parameters to pass with all requests. e.g. baseParams: {id: '123', foo: 'bar'}.
-Parameters are encoded as standard HT... Parameters to pass with all requests. e.g. baseParams: {id: '123', foo: 'bar'}. -Parameters are encoded as standard HTTP parameters using Ext.urlEncode. | BasicForm | |
errorReader : DataReader An Ext.data.DataReader (e.g. Ext.data.XmlReader) to be used to
-read field error messages returned from 'submit' actio... An Ext.data.DataReader (e.g. Ext.data.XmlReader) to be used to -read field error messages returned from 'submit' actions. This is optional -as there is built-in support for processing JSON. -The Records which provide messages for the invalid Fields must use the -Field name (or id) as the Record ID, and must contain a field called 'msg' -which contains the error message. -The errorReader does not have to be a full-blown implementation of a -DataReader. It simply needs to implement a read(xhr) function -which returns an Array of Records in an object with the following -structure:
| BasicForm | |
fileUpload : Boolean Set to true if this form is a file upload.
-File uploads are not performed using normal 'Ajax' techniques, that is the... Set to true if this form is a file upload.
- File uploads are not performed using normal 'Ajax' techniques, that is they are not -performed using XMLHttpRequests. Instead the form is submitted in the standard manner with the -DOM <form> element temporarily modified to have its -target set to refer -to a dynamically generated, hidden <iframe> which is inserted into the document -but removed after the return data has been gathered. -The server response is parsed by the browser to create the document for the IFRAME. If the -server is using JSON to send the return object, then the -Content-Type header -must be set to "text/html" in order to tell the browser to insert the text unchanged into the document body. -Characters which are significant to an HTML parser must be sent as HTML entities, so encode -"<" as "<", "&" as "&" etc. -The response text is retrieved from the document, and a fake XMLHttpRequest object -is created containing a responseText property in order to conform to the -requirements of event handlers and callbacks. -Be aware that file upload packets are sent with the content type multipart/form -and some server technologies (notably JEE) may require some custom processing in order to -retrieve parameter names and parameter values from the packet content. | BasicForm | |
listeners : Object A config object containing one or more event handlers to be added to this
-object during initialization. This should ... A config object containing one or more event handlers to be added to this -object during initialization. This should be a valid listeners config object as specified in the -addListener example for attaching multiple handlers at once. -DOM events from ExtJs Components -While some ExtJs Component classes export selected DOM events (e.g. "click", "mouseover" etc), this
-is usually only done when extra value can be added. For example the DataView's
-
| Observable | |
method : String The request method to use (GET or POST) for form actions if one isn't supplied in the action options. | BasicForm | |
paramOrder : Array/String A list of params to be executed server side.
-Defaults to undefined. Only used for the api
-load configuration.
-Specify... A list of params to be executed server side.
-Defaults to undefined. Only used for the Specify the params in the order in which they must be executed on the -server-side as either (1) an Array of String values, or (2) a String of params -delimited by either whitespace, comma, or pipe. For example, -any of the following would be acceptable:
| BasicForm | |
paramsAsHash : Boolean Only used for the api
-load configuration. Send parameters as a collection of named
-arguments (defaults to false). Pro... Only used for the api
-load configuration. Send parameters as a collection of named
-arguments (defaults to false). Providing a
-paramOrder nullifies this configuration. | BasicForm | |
reader : DataReader An Ext.data.DataReader (e.g. Ext.data.XmlReader) to be used to read
-data when executing 'load' actions. This is optio... An Ext.data.DataReader (e.g. Ext.data.XmlReader) to be used to read
-data when executing 'load' actions. This is optional as there is built-in
-support for processing JSON. For additional information on using an XMLReader
-see the example provided in examples/form/xml-form.html. | BasicForm | |
standardSubmit : Boolean If set to true, standard HTML form submits are used instead
-of XHR (Ajax) style form submissions. Defaults to false.
-... If set to true, standard HTML form submits are used instead -of XHR (Ajax) style form submissions. Defaults to false. -Note: When using
| BasicForm | |
timeout : Number Timeout for form actions in seconds (default is 30 seconds). | BasicForm | |
trackResetOnLoad : Boolean | BasicForm | |
url : String The URL to use for form actions if one isn't supplied in the
- doAction options . | BasicForm | |
waitTitle : String The default title to show for the waiting message box (defaults to 'Please Wait...') | BasicForm |
Property | Defined By | |
---|---|---|
items : MixedCollection A MixedCollection containing all the Ext.form.Fields in this form. | BasicForm | |
waitMsgTarget : Mixed By default wait messages are displayed with Ext.MessageBox.wait. You can target a specific
-element by passing it or i... By default wait messages are displayed with Ext.MessageBox.wait. You can target a specific
-element by passing it or its id or mask the form itself by passing in true. | BasicForm |
Method | Defined By | |
---|---|---|
BasicForm( Mixed el , Object config )
- Parameters:
| BasicForm | |
add( Field field1 , [Field field2 ], [Field etc ] )
- :
- BasicFormAdd Ext.form Components to this form's Collection. This does not result in rendering of
-the passed Component, it just... Add Ext.form Components to this form's Collection. This does not result in rendering of
-the passed Component, it just enables the form to validate Fields, and distribute values to
-Fields.
- You will not usually call this function. In order to be rendered, a Field must be added -to a Container, usually an FormPanel. -The FormPanel to which the field is added takes care of adding the Field to the BasicForm's -collection. Parameters:
| BasicForm | |
addEvents( Object|String o , string Optional. )
- :
- voidAdds the specified events to the list of events which this Observable may fire. Adds the specified events to the list of events which this Observable may fire. Parameters:
| Observable | |
addListener( String eventName , Function handler , [Object scope ], [Object options ] )
- :
- voidAppends an event handler to this object. Appends an event handler to this object. Parameters:
| Observable | |
applyIfToFields( Object values )
- :
- BasicFormCalls Ext.applyIf for all field in this form with the passed object. Calls Ext.applyIf for all field in this form with the passed object. Parameters:
| BasicForm | |
applyToFields( Object values )
- :
- BasicFormCalls Ext.apply for all fields in this form with the passed object. Calls Ext.apply for all fields in this form with the passed object. Parameters:
| BasicForm | |
cleanDestroyed()
- :
- void Removes all fields from the collection that have been destroyed. Removes all fields from the collection that have been destroyed. Parameters:
| BasicForm | |
clearInvalid()
- :
- BasicForm Clears all invalid messages in this form. Clears all invalid messages in this form. Parameters:
| BasicForm | |
doAction( String/Object actionName , [Object options ] )
- :
- BasicFormPerforms a predefined action (Ext.form.Action.Submit or
-Ext.form.Action.Load) or a custom extension of Ext.form.Actio... Performs a predefined action (Ext.form.Action.Submit or
-Ext.form.Action.Load) or a custom extension of Ext.form.Action
-to perform application-specific processing. Parameters:
| BasicForm | |
enableBubble( String/Array events )
- :
- voidEnables events fired by this Observable to bubble up an owner hierarchy by calling
-this.getBubbleTarget() if present.... Enables events fired by this Observable to bubble up an owner hierarchy by calling
- This is commonly used by Ext.Components to bubble events to owner Containers. See Ext.Component.getBubbleTarget. The default -implementation in Ext.Component returns the Component's immediate owner. But if a known target is required, this can be overridden to -access the required target more quickly. -Example:
Parameters:
| Observable | |
findField( String id )
- :
- FieldFind a Ext.form.Field in this form. Find a Ext.form.Field in this form. Parameters:
| BasicForm | |
fireEvent( String eventName , Object... args )
- :
- BooleanFires the specified event with the passed parameters (minus the event name).
-An event may be set to bubble up an Obse... Fires the specified event with the passed parameters (minus the event name). -An event may be set to bubble up an Observable parent hierarchy (See Ext.Component.getBubbleTarget) -by calling enableBubble. Parameters:
| Observable | |
getEl()
- :
- Ext.Element Get the HTML form Element Get the HTML form Element Parameters:
| BasicForm | |
getFieldValues( [Boolean dirtyOnly ] )
- :
- ObjectRetrieves the fields in the form as a set of key/value pairs, using the getValue() method.
-If multiple fields exist w... Retrieves the fields in the form as a set of key/value pairs, using the getValue() method.
-If multiple fields exist with the same name they are returned as an array. Parameters:
| BasicForm | |
getValues( [Boolean asString ] )
- :
- String/ObjectReturns the fields in this form as an object with key/value pairs as they would be submitted using a standard form su... Returns the fields in this form as an object with key/value pairs as they would be submitted using a standard form submit. -If multiple fields exist with the same name they are returned as an array. -Note: The values are collected from all enabled HTML input elements within the form, not from -the Ext Field objects. This means that all returned values are Strings (or Arrays of Strings) and that the -value can potentially be the emptyText of a field. Parameters:
| BasicForm | |
hasListener( String eventName )
- :
- BooleanChecks to see if this object has any listeners for a specified event Checks to see if this object has any listeners for a specified event Parameters:
| Observable | |
isDirty()
- :
- Boolean Returns true if any fields in this form have changed from their original values.
-Note that if this BasicForm was conf... Returns true if any fields in this form have changed from their original values. -Note that if this BasicForm was configured with trackResetOnLoad then the -Fields' original values are updated when the values are loaded by setValues -or loadRecord. Parameters:
| BasicForm | |
isValid()
- :
- Boolean Returns true if client-side validation on the form is successful. Returns true if client-side validation on the form is successful. Parameters:
| BasicForm | |
load( Object options )
- :
- BasicFormShortcut to do a load action. Shortcut to do a load action. Parameters:
| BasicForm | |
loadRecord( Record record )
- :
- BasicFormLoads an Ext.data.Record into this form by calling setValues with the
-record data.
-See also trackResetOnLoad. Loads an Ext.data.Record into this form by calling setValues with the
-record data.
-See also trackResetOnLoad. Parameters:
| BasicForm | |
markInvalid( Array/Object errors )
- :
- BasicFormMark fields in this form invalid in bulk. Mark fields in this form invalid in bulk. Parameters:
| BasicForm | |
on( String eventName , Function handler , [Object scope ], [Object options ] )
- :
- voidAppends an event handler to this object (shorthand for addListener.) Appends an event handler to this object (shorthand for addListener.) Parameters:
| Observable | |
purgeListeners()
- :
- void Removes all listeners for this object Removes all listeners for this object Parameters:
| Observable | |
relayEvents( Object o , Array events )
- :
- voidRelays selected events from the specified Observable as if the events were fired by this. Relays selected events from the specified Observable as if the events were fired by this. Parameters:
| Observable | |
remove( Field field )
- :
- BasicFormRemoves a field from the items collection (does NOT remove its markup). Removes a field from the items collection (does NOT remove its markup). Parameters:
| BasicForm | |
removeListener( String eventName , Function handler , [Object scope ] )
- :
- voidRemoves an event handler. Removes an event handler. Parameters:
| Observable | |
render()
- :
- BasicForm Iterates through the Fields which have been added to this BasicForm,
-checks them for an id attribute, and calls Ext.f... Iterates through the Fields which have been added to this BasicForm,
-checks them for an id attribute, and calls Ext.form.Field.applyToMarkup on the existing dom element with that id. Parameters:
| BasicForm | |
reset()
- :
- BasicForm Resets this form. Resets this form. Parameters:
| BasicForm | |
resumeEvents()
- :
- void Resume firing events. (see suspendEvents)
-If events were suspended using the queueSuspended parameter, then all
-event... Resume firing events. (see suspendEvents)
-If events were suspended using the queueSuspended parameter, then all
-events fired during event suspension will be sent to any listeners now. Parameters:
| Observable | |
setValues( Array/Object values )
- :
- BasicFormSet values for fields in this form in bulk. Set values for fields in this form in bulk. Parameters:
| BasicForm | |
submit( Object options )
- :
- BasicFormShortcut to do a submit action. Shortcut to do a submit action. Parameters:
| BasicForm | |
suspendEvents( Boolean queueSuspended )
- :
- voidSuspend the firing of all events. (see resumeEvents) Suspend the firing of all events. (see resumeEvents) Parameters:
| Observable | |
un( String eventName , Function handler , [Object scope ] )
- :
- voidRemoves an event handler (shorthand for removeListener.) Removes an event handler (shorthand for removeListener.) Parameters:
| Observable | |
updateRecord( Record record )
- :
- BasicFormPersists the values in this form into the passed Ext.data.Record object in a beginEdit/endEdit block. Persists the values in this form into the passed Ext.data.Record object in a beginEdit/endEdit block. Parameters:
| BasicForm |
Event | Defined By | |
---|---|---|
actioncomplete :
- ( Form this , Action action )
- Fires when an action is completed. Fires when an action is completed. Listeners will be called with the following arguments:
| BasicForm | |
actionfailed :
- ( Form this , Action action )
- Fires when an action fails. Fires when an action fails. Listeners will be called with the following arguments:
| BasicForm | |
beforeaction :
- ( Form this , Action action )
- Fires before any action is performed. Return false to cancel the action. Fires before any action is performed. Return false to cancel the action. Listeners will be called with the following arguments:
| BasicForm |