Supplies the functionality to do "actions" on forms and initialize Ext.form.Field types on existing markup.
|
BasicForm( String/HTMLElement/Ext.Element el , Object config ) |
BasicForm |
|
|
add( Field field1 , [Field field2 ], [Field etc ] ) : BasicForm |
BasicForm |
Add Ext.form components to this form. |
|
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. |
|
doAction( String actionName , Object options ) : BasicForm |
BasicForm |
Performs a predefined action (submit or load) or custom actions you define on this form. |
|
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() : BasicForm |
BasicForm |
Looks at the fields in this form, checks them for an id attribute,
and calls applyTo on the existing dom element with... |
|
reset() : BasicForm |
BasicForm |
Resets this form. |
|
setValues( Array/Object values ) : BasicForm |
BasicForm |
Set values for fields in this form in bulk. |
|
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'}. |
|
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. |
|
method : String |
BasicForm |
The request method to use (GET or POST) for form actions if one isn't supplied in the action options. |
|
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. |
add
public function add( Field field1
, [Field field2
], [Field etc
] )
Add Ext.form components to this form.
Parameters:
field1
: Fieldfield2
: Field(optional)
etc
: Field(optional)
Returns:
This method is defined by BasicForm.
addEvents
public function addEvents( Object object
)
Used to define events on this Observable
addListener
public function addListener( String eventName
, Function handler
, [Object scope
], [Object options
] )
Appends an event handler to this component
Parameters:
eventName
: StringThe type of event to listen for
handler
: FunctionThe method the event invokes
scope
: Object(optional) The scope in which to execute the handler
function. The handler function's "this" context.
options
: Object(optional) An object containing handler configuration
properties. This may contain any of the following properties:
- scope {Object} The scope in which to execute the handler function. The handler function's "this" context.
- delay {Number} The number of milliseconds to delay the invocation of the handler after te event fires.
- single {Boolean} True to add a handler to handle just the next firing of the event, and then remove itself.
- buffer {Number} Causes the handler to be scheduled to run in an Ext.util.DelayedTask delayed
by the specified number of milliseconds. If the event fires again within that time, the original
handler is not invoked, but the new handler is scheduled in its place.
Combining Options
Using the options argument, it is possible to combine different types of listeners:
A normalized, delayed, one-time listener that auto stops the event and passes a custom argument (forumId)
el.on('click', this.onClick, this, {
single: true,
delay: 100,
forumId: 4
});
Attaching multiple handlers in 1 call
The method also allows for a single argument to be passed which is a config object containing properties
which specify multiple handlers.
el.on({
'click': {
fn: this.onClick,
scope: this,
delay: 100
},
'mouseover': {
fn: this.onMouseOver,
scope: this
},
'mouseout': {
fn: this.onMouseOut,
scope: this
}
});
Or a shorthand syntax which passes the same scope object to all handlers:
el.on({
'click': this.onClick,
'mouseover': this.onMouseOver,
'mouseout': this.onMouseOut,
scope: this
});
Returns:
applyIfToFields
public function applyIfToFields( Object values
)
Calls
Ext.applyIf for all field in this form with the passed object.
This method is defined by BasicForm.
applyToFields
public function applyToFields( Object values
)
Calls
Ext.apply for all fields in this form with the passed object.
This method is defined by BasicForm.
clearInvalid
public function clearInvalid()
Clears all invalid messages in this form.
This method is defined by BasicForm.
doAction
public function doAction( String actionName
, Object options
)
Performs a predefined action (submit or load) or custom actions you define on this form.
This method is defined by BasicForm.
findField
public function findField( String id
)
Find a Ext.form.Field in this form by id, dataIndex, name or hiddenName
Parameters:
id
: StringThe value to search for
Returns:
This method is defined by BasicForm.
fireEvent
public function fireEvent( String eventName
, Object... args
)
Fires the specified event with the passed parameters (minus the event name).
getValues
public function getValues( Boolean asString
)
Returns the fields in this form as an object with key/value pairs. If multiple fields exist with the same name
they are returned as an array.
This method is defined by BasicForm.
hasListener
public function hasListener( String eventName
)
Checks to see if this object has any listeners for a specified event
isDirty
public function isDirty()
Returns true if any fields in this form have changed since their original load.
This method is defined by BasicForm.
isValid
public function isValid()
Returns true if client-side validation on the form is successful.
This method is defined by BasicForm.
load
public function load( Object options
)
Shortcut to do a load action.
This method is defined by BasicForm.
loadRecord
public function loadRecord( Record record
)
Loads an Ext.data.Record into this form.
Parameters:
record
: RecordThe record to load
Returns:
This method is defined by BasicForm.
markInvalid
public function markInvalid( Array/Object errors
)
Mark fields in this form invalid in bulk.
Parameters:
errors
: Array/ObjectEither an array in the form [{id:'fieldId', msg:'The message'},...] or an object hash of {id: msg, id2: msg2}
Returns:
This method is defined by BasicForm.
on
public function on( String eventName
, Function handler
, [Object scope
], [Object options
] )
Appends an event handler to this element (shorthand for addListener)
Parameters:
eventName
: StringThe type of event to listen for
handler
: FunctionThe method the event invokes
scope
: Object(optional) The scope in which to execute the handler
function. The handler function's "this" context.
options
: Object(optional)
Returns:
purgeListeners
public function purgeListeners()
Removes all listeners for this object
remove
public function remove( Field field
)
Removes a field from the items collection (does NOT remove its markup).
This method is defined by BasicForm.
removeListener
public function removeListener( String eventName
, Function handler
, [Object scope
] )
render
public function render()
Looks at the fields in this form, checks them for an id attribute,
and calls applyTo on the existing dom element with that id.
This method is defined by BasicForm.
reset
public function reset()
This method is defined by BasicForm.
setValues
public function setValues( Array/Object values
)
Set values for fields in this form in bulk.
Parameters:
values
: Array/ObjectEither an array in the form [{id:'fieldId', value:'foo'},...] or an object hash of {id: value, id2: value2}
Returns:
This method is defined by BasicForm.
submit
public function submit( Object options
)
Shortcut to do a submit action.
This method is defined by BasicForm.
un
public function un( String eventName
, Function handler
, [Object scope
] )
Removes a listener (shorthand for removeListener)
updateRecord
public function updateRecord( Record record
)
Persists the values in this form into the passed Ext.data.Record object in a beginEdit/endEdit block.
Parameters:
record
: RecordThe record to edit
Returns:
This method is defined by BasicForm.
baseParams
baseParams : Object
Parameters to pass with all requests. e.g. baseParams: {id: '123', foo: 'bar'}.
This config option is defined by BasicForm.
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.
This config option is defined by BasicForm.
fileUpload
fileUpload : Boolean
Set to true if this form is a file upload.
This config option is defined by BasicForm.
method
method : String
The request method to use (GET or POST) for form actions if one isn't supplied in the action options.
This config option is defined by BasicForm.
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.
This config option is defined by BasicForm.
timeout
timeout : Number
Timeout for form actions in seconds (default is 30 seconds).
This config option is defined by BasicForm.
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.
This config option is defined by BasicForm.
url
url : String
The URL to use for form actions if one isn't supplied in the action options.
This config option is defined by BasicForm.