Package: | Ext.form |
Class: | BasicForm |
Extends: | Observable |
Subclasses: | Form |
Defined In: | BasicForm.js |
Property | Defined By | |
---|---|---|
waitMsgTarget : Mixed | BasicForm | |
By default wait messages are displayed with Ext.MessageBox.wait. You can target a specific element by passing it or i... |
Method | Defined By | |
---|---|---|
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. |
Event | Defined By | |
---|---|---|
actioncomplete : ( Form this , Action action ) |
BasicForm | |
Fires when an action is completed. | ||
actionfailed : ( Form this , Action action ) |
BasicForm | |
Fires when an action fails. | ||
beforeaction : ( Form this , Action action ) |
BasicForm | |
Fires before any action is performed. Return false to cancel the action. |
Config Options | Defined By | |
---|---|---|
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. |
public Mixed waitMsgTarget
public function BasicForm( String/HTMLElement/Ext.Element el
, Object config
)
el
: String/HTMLElement/Ext.Elementconfig
: Objectpublic function add( Field field1
, [Field field2
], [Field etc
] )
field1
: Fieldfield2
: Fieldetc
: FieldBasicForm
public function addEvents( Object object
)
object
: Objectvoid
public function addListener( String eventName
, Function handler
, [Object scope
], [Object options
] )
eventName
: Stringhandler
: Functionscope
: Objectoptions
: Object
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
});
void
public function applyIfToFields( Object values
)
values
: ObjectBasicForm
public function applyToFields( Object values
)
values
: ObjectBasicForm
public function clearInvalid()
BasicForm
public function doAction( String actionName
, Object options
)
actionName
: Stringoptions
: ObjectBasicForm
public function findField( String id
)
id
: StringField
public function fireEvent( String eventName
, Object... args
)
eventName
: Stringargs
: Object...Boolean
public function getValues( Boolean asString
)
asString
: BooleanObject
public function hasListener( String eventName
)
eventName
: StringBoolean
public function isDirty()
Boolean
public function isValid()
Boolean
public function load( Object options
)
options
: ObjectBasicForm
public function loadRecord( Record record
)
record
: RecordBasicForm
public function markInvalid( Array/Object errors
)
errors
: Array/ObjectBasicForm
public function on( String eventName
, Function handler
, [Object scope
], [Object options
] )
eventName
: Stringhandler
: Functionscope
: Objectoptions
: Objectvoid
public function purgeListeners()
void
public function remove( Field field
)
field
: FieldBasicForm
public function removeListener( String eventName
, Function handler
, [Object scope
] )
eventName
: Stringhandler
: Functionscope
: Objectvoid
public function render()
BasicForm
public function reset()
BasicForm
public function setValues( Array/Object values
)
values
: Array/ObjectBasicForm
public function submit( Object options
)
options
: ObjectBasicForm
public function un( String eventName
, Function handler
, [Object scope
] )
eventName
: Stringhandler
: Functionscope
: Objectvoid
public function updateRecord( Record record
)
record
: RecordBasicForm
public event actioncomplete
this
: Formaction
: Actionpublic event actionfailed
this
: Formaction
: Actionpublic event beforeaction
this
: Formaction
: ActionbaseParams : Object
errorReader : DataReader
fileUpload : Boolean
method : String
reader : DataReader
timeout : Number
trackResetOnLoad : Boolean
url : String