|
Form( Object config ) |
Form |
|
|
add( Field field1 , [Field field2 ], [Field etc. ] ) : Form |
Form |
Add Ext.form components to the current open container (e.g. column, fieldset, etc.). Fields added via this method
ca... |
|
addButton( String/Object config , Function handler , [Object scope ] ) : Ext.Button |
Form |
Adds a button to the footer of the form - this must be called before the form is rendered. |
|
addEvents( Object object ) : void |
Observable |
Used to define events on this Observable |
|
addListener( String eventName , Function handler , [Object scope ], [Object options ] ) : void |
Observable |
Appends an event handler to this component |
|
applyIfToFields( Object values ) : BasicForm |
BasicForm |
Calls Ext.applyIf for all field in this form with the passed object. |
|
applyToFields( Object values ) : BasicForm |
BasicForm |
Calls Ext.apply for all fields in this form with the passed object. |
|
clearInvalid() : BasicForm |
BasicForm |
Clears all invalid messages in this form. |
|
column( Object config , [Field field1 ], [Field field2 ], [Field etc ] ) : Column |
Form |
Opens a new Ext.form.Column container in the layout stack. If fields are passed after the config, the
fields are adde... |
|
container( Object config , [Field field1 ], [Field field2 ], [Field etc ] ) : Layout |
Form |
Opens a new Ext.form.Layout container in the layout stack. If fields are passed after the config, the
fields are adde... |
|
doAction( String actionName , [Object options ] ) : BasicForm |
BasicForm |
Performs a predefined action (submit or load) or custom actions you define on this form. |
|
end() : Form |
Form |
Closes the current open container |
|
fieldset( Object config , [Field field1 ], [Field field2 ], [Field etc ] ) : FieldSet |
Form |
Opens a new Ext.form.FieldSet container in the layout stack. If fields are passed after the config, the
fields are ad... |
|
findField( String id ) : Field |
BasicForm |
Find a Ext.form.Field in this form by id, dataIndex, name or hiddenName |
|
fireEvent( String eventName , Object... args ) : Boolean |
Observable |
Fires the specified event with the passed parameters (minus the event name). |
|
getValues( Boolean asString ) : Object |
BasicForm |
Returns the fields in this form as an object with key/value pairs. If multiple fields exist with the same name
they a... |
|
hasListener( String eventName ) : Boolean |
Observable |
Checks to see if this object has any listeners for a specified event |
|
isDirty() : Boolean |
BasicForm |
Returns true if any fields in this form have changed since their original load. |
|
isValid() : Boolean |
BasicForm |
Returns true if client-side validation on the form is successful. |
|
load( Object options ) : BasicForm |
BasicForm |
Shortcut to do a load action. |
|
loadRecord( Record record ) : BasicForm |
BasicForm |
Loads an Ext.data.Record into this form. |
|
markInvalid( Array/Object errors ) : BasicForm |
BasicForm |
Mark fields in this form invalid in bulk. |
|
on( String eventName , Function handler , [Object scope ], [Object options ] ) : void |
Observable |
Appends an event handler to this element (shorthand for addListener) |
|
purgeListeners() : void |
Observable |
Removes all listeners for this object |
|
remove( Field field ) : BasicForm |
BasicForm |
Removes a field from the items collection (does NOT remove its markup). |
|
removeListener( String eventName , Function handler , [Object scope ] ) : void |
Observable |
Removes a listener |
|
render( String/HTMLElement/Element container ) : Form |
Form |
Render this form into the passed container. This should only be called once! |
|
reset() : BasicForm |
BasicForm |
Resets this form. |
|
setValues( Array/Object values ) : BasicForm |
BasicForm |
Set values for fields in this form in bulk. |
|
start( Object container ) : Form |
Form |
Opens the passed container in the layout stack. The container can be any Ext.form.Layout or subclass. |
|
startMonitoring() : void |
Form |
Starts monitoring of the valid state of this form. Usually this is done by passing the config
option "monitorValid" |
|
stopMonitoring() : void |
Form |
Stops monitoring of the valid state of this form |
|
submit( Object options ) : BasicForm |
BasicForm |
Shortcut to do a submit action. |
|
un( String eventName , Function handler , [Object scope ] ) : void |
Observable |
Removes a listener (shorthand for removeListener) |
|
updateRecord( Record record ) : BasicForm |
BasicForm |
Persists the values in this form into the passed Ext.data.Record object in a beginEdit/endEdit block. |
|
baseParams : Object |
BasicForm |
Parameters to pass with all requests. e.g. baseParams: {id: '123', foo: 'bar'}. |
|
buttonAlign : String |
Form |
Valid values are "left," "center" and "right" (defaults to "center") |
|
errorReader : DataReader |
BasicForm |
An Ext.data.DataReader (e.g. Ext.data.XmlReader) to be used to read data when reading validation errors on "submit" a... |
|
fileUpload : Boolean |
BasicForm |
Set to true if this form is a file upload. |
|
itemCls : String |
Form |
A css class to apply to the x-form-item of fields. This property cascades to child containers. |
|
labelAlign : String |
Form |
Valid values are "left," "top" and "right" (defaults to "left"). This property cascades to child containers if not set. |
|
labelWidth : Number |
Form |
The width of labels. This property cascades to child containers. |
|
method : String |
BasicForm |
The request method to use (GET or POST) for form actions if one isn't supplied in the action options. |
|
minButtonWidth : Number |
Form |
Minimum width of all buttons in pixels (defaults to 75) |
|
monitorPoll : Number |
Form |
The milliseconds to poll valid state, ignored if monitorValid is not true (defaults to 200) |
|
monitorValid : Boolean |
Form |
If true the form monitors its valid state client-side and fires a looping event with that state. This is required to ... |
|
reader : DataReader |
BasicForm |
An Ext.data.DataReader (e.g. Ext.data.XmlReader) to be used to read data when executing "load" actions. This is optio... |
|
timeout : Number |
BasicForm |
Timeout for form actions in seconds (default is 30 seconds). |
|
trackResetOnLoad : Boolean |
BasicForm |
If set to true, form.reset() resets to the last loaded or setValues() data instead of when the form was first created. |
|
url : String |
BasicForm |
The URL to use for form actions if one isn't supplied in the action options. |
baseParams
baseParams : Object
Parameters to pass with all requests. e.g. baseParams: {id: '123', foo: 'bar'}.
buttonAlign
buttonAlign : String
Valid values are "left," "center" and "right" (defaults to "center")
This config option is defined by Form.
errorReader
errorReader : DataReader
An Ext.data.DataReader (e.g.
Ext.data.XmlReader) to be used to read data when reading validation errors on "submit" actions. This is completely optional as there is built-in support for processing JSON.
fileUpload
fileUpload : Boolean
Set to true if this form is a file upload.
itemCls
itemCls : String
A css class to apply to the x-form-item of fields. This property cascades to child containers.
This config option is defined by Form.
labelAlign
labelAlign : String
Valid values are "left," "top" and "right" (defaults to "left"). This property cascades to child containers if not set.
This config option is defined by Form.
labelWidth
labelWidth : Number
The width of labels. This property cascades to child containers.
This config option is defined by Form.
method
method : String
The request method to use (GET or POST) for form actions if one isn't supplied in the action options.
minButtonWidth
minButtonWidth : Number
Minimum width of all buttons in pixels (defaults to 75)
This config option is defined by Form.
monitorPoll
monitorPoll : Number
The milliseconds to poll valid state, ignored if monitorValid is not true (defaults to 200)
This config option is defined by Form.
monitorValid
monitorValid : Boolean
If true the form monitors its valid state client-side and fires a looping event with that state. This is required to bind buttons to the valid state using the config value formBind:true on the button.
This config option is defined by Form.
reader
reader : DataReader
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.
timeout
timeout : Number
Timeout for form actions in seconds (default is 30 seconds).
trackResetOnLoad
trackResetOnLoad : Boolean
If set to true, form.reset() resets to the last loaded or setValues() data instead of when the form was first created.
url
url : String
The URL to use for form actions if one isn't supplied in the action options.