|
| | BasicForm( Mixed el, Object config )
+ | 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:field1 : Fieldfield2 : Field(optional) etc : Field(optional)
Returns: | BasicForm |
| | addEvents( Object|String o, string Optional. )
- :
+collection.Parameters:field1 : Fieldfield2 : Field(optional) etc : Field(optional)
Returns: | 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. | Observable |
| | addListener( String eventName, Function handler, [Object scope], [Object options] )
- :
+Usage:this.addEvents('storeloaded', 'storecleared');
Returns: | 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:eventName : StringThe name of the event to listen for. handler : FunctionThe method the event invokes. scope : Object(optional) The scope (this reference) in which the handler function is executed.
If omitted, defaults to the object which fired the event. options : Object(optional) An object containing handler configuration.
properties. This may contain any of the following properties:
@@ -255,15 +255,15 @@ Or a shorthand syntax:
'mouseover' : this.onMouseOver,
'mouseout' : this.onMouseOut,
scope: this
-});
Returns: | 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. | 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. | BasicForm |
| | clearInvalid()
- :
- BasicFormClears all invalid messages in this form. Clears all invalid messages in this form. | BasicForm |
| | doAction( String/Object actionName, [Object options] )
- :
- BasicFormPerforms a predefined action (Ext.form.Action.Submit or
+}); Returns: | 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. | 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. | BasicForm |
| | clearInvalid()
+ :
+ BasicFormClears all invalid messages in this form. Clears all invalid messages in this form. | 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:actionName : String/ObjectThe name of the predefined action type,
@@ -308,9 +308,9 @@ callback functions (The this reference for the callback functions). clientValidation : Boolean Submit Action only.
Determines whether a Form's fields are validated in a final call to
isValid prior to submission. Set to false
-to prevent this. If undefined, pre-submission field validation is performed.
Returns: | BasicForm |
| | enableBubble( String/Array events )
- :
- voidEnables events fired by this Observable to bubble up an owner hierarchy by calling
+to prevent this. If undefined, pre-submission field validation is performed. | 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.getBubbleTarget() if present. There is no implementation in the Observable base class.
This is commonly used by Ext.Components to bubble events to owner Containers. See Ext.Component.getBubbleTarget. The default
@@ -342,71 +342,71 @@ access the required target more quickly.
myForm.header.setStyle( 'color', 'red');
}
}
-}); | Observable |
| | findField( String id )
- :
+}); | Observable |
| | findField( String id )
+ :
FieldFind a Ext.form.Field in this form. | BasicForm |
| | fireEvent( String eventName, Object... args )
- :
- Boolean | 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... | Observable |
| | getEl()
- :
- Ext.ElementGet the HTML form Element Get the HTML form Element | BasicForm |
| | getFieldValues( [Boolean dirtyOnly] )
- :
- ObjectRetrieves the fields in the form as a set of key/value pairs, using the getValue() method.
+by calling enableBubble. | Observable |
| | getEl()
+ :
+ Ext.ElementGet the HTML form Element Get the HTML form Element | 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:Returns:ObjectThe values in the form
| BasicForm |
| | getValues( [Boolean asString] )
- :
+If multiple fields exist with the same name they are returned as an array.Parameters:Returns:ObjectThe values in the form
| 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. | 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 | Observable |
| | isDirty()
- :
- BooleanReturns true if any fields in this form have changed from their original values.
+value can potentially be the emptyText of a field. | 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 | Observable |
| | isDirty()
+ :
+ BooleanReturns 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. | BasicForm |
| | isValid()
- :
- BooleanReturns true if client-side validation on the form is successful. Returns true if client-side validation on the form is successful. | BasicForm |
| | load( Object options )
- :
- BasicFormShortcut to do a load action. Shortcut to do a load action. Parameters:options : ObjectThe options to pass to the action (see doAction for details)
Returns: | BasicForm |
| | loadRecord( Record record )
- :
- BasicFormLoads an Ext.data.Record into this form by calling setValues with the
-record data.
+or loadRecord. | BasicForm |
| | isValid()
+ :
+ BooleanReturns true if client-side validation on the form is successful. Returns true if client-side validation on the form is successful. | BasicForm |
| | load( Object options )
+ :
+ BasicFormShortcut to do a load action. Shortcut to do a load action. Parameters:options : ObjectThe options to pass to the action (see doAction for details)
Returns: | BasicForm |
| | loadRecord( Record record )
+ :
+ BasicFormLoads an Ext.data.Record into this form by calling setValues with the
+record data.
See also trackResetOnLoad. | BasicForm |
| | markInvalid( Array/Object errors )
- :
- BasicFormMark fields in this form invalid in bulk. 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: | BasicForm |
| | on( String eventName, Function handler, [Object scope], [Object options] )
- :
+See also trackResetOnLoad.Parameters:record : RecordThe record to load
Returns: | BasicForm |
| | markInvalid( Array/Object errors )
+ :
+ BasicFormMark fields in this form invalid in bulk. 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: | 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:eventName : StringThe type of event to listen for handler : FunctionThe method the event invokes scope : Object(optional) The scope (this reference) in which the handler function is executed.
-If omitted, defaults to the object which fired the event. options : Object(optional) An object containing handler configuration.
Returns: | Observable |
| | purgeListeners()
- :
- voidRemoves all listeners for this object Removes all listeners for this object | 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. | 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). | BasicForm |
| | removeListener( String eventName, Function handler, [Object scope] )
- :
- voidRemoves an event handler. Removes an event handler. | Observable |
| | render()
- :
- BasicFormIterates through the Fields which have been added to this BasicForm,
+If omitted, defaults to the object which fired the event. options : Object(optional) An object containing handler configuration. Returns: | Observable |
| | purgeListeners()
+ :
+ voidRemoves all listeners for this object Removes all listeners for this object | 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. | 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). | BasicForm |
| | removeListener( String eventName, Function handler, [Object scope] )
+ :
+ voidRemoves an event handler. Removes an event handler. | Observable |
| | render()
+ :
+ BasicFormIterates 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. | BasicForm |
| | reset()
- :
- BasicForm | BasicForm |
| | resumeEvents()
- :
- voidResume firing events. (see suspendEvents)
-If events were suspended using the queueSuspended parameter, then all
+checks them for an id attribute, and calls Ext.form.Field.applyToMarkup on the existing dom element with that id. | BasicForm |
| | reset()
+ :
+ BasicForm | BasicForm |
| | resumeEvents()
+ :
+ voidResume 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. | Observable |
| | setValues( Array/Object values )
- :
+events fired during event suspension will be sent to any listeners now. | Observable |
| | setValues( Array/Object values )
+ :
BasicFormSet values for fields in this form in bulk. Set values for fields in this form in bulk. Parameters:values : Array/ObjectEither an array in the form: [{id:'clientName', value:'Fred. Olsen Lines'},
{id:'portOfLoading', value:'FXT'},
{id:'portOfDischarge', value:'OSL'} ]
@@ -414,8 +414,8 @@ or an object hash of the form: {
clientName: 'Fred. Olsen Lines',
portOfLoading: 'FXT',
portOfDischarge: 'OSL'
-}
Returns: | BasicForm |
| | submit( Object options )
- :
+}Returns: | BasicForm |
| | submit( Object options )
+ :
BasicFormShortcut to do a submit action. Shortcut to do a submit action. Parameters:options : ObjectThe options to pass to the action (see doAction for details).
Note: this is ignored when using the standardSubmit option.
The following code: myFormPanel.getForm().submit({
@@ -447,17 +447,17 @@ would process the following server response for a successful submission:{
"success":false, // note this is Boolean, not string
"msg":"You do not have permission to perform this operation"
-}
Returns: | BasicForm |
| | suspendEvents( Boolean queueSuspended )
- :
+}Returns: | BasicForm |
| | suspendEvents( Boolean queueSuspended )
+ :
voidSuspend the firing of all events. (see resumeEvents) Suspend the firing of all events. (see resumeEvents) Parameters:queueSuspended : BooleanPass as true to queue up suspended events to be fired
-after the resumeEvents call instead of discarding all suspended events;
Returns: | Observable |
| | un( String eventName, Function handler, [Object scope] )
- :
- voidRemoves an event handler (shorthand for removeListener.) | 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:record : RecordThe record to edit
Returns: | BasicForm |