123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363 |
- <!DOCTYPE html>
- <html>
- <head>
- <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
- <title>The source code</title>
- <link href="../resources/prettify/prettify.css" type="text/css" rel="stylesheet" />
- <script type="text/javascript" src="../resources/prettify/prettify.js"></script>
- <style type="text/css">
- .highlight { display: block; background-color: #ddd; }
- </style>
- <script type="text/javascript">
- function highlight() {
- document.getElementById(location.hash.replace(/#/, "")).className = "highlight";
- }
- </script>
- </head>
- <body onload="prettyPrint(); highlight();">
- <pre class="prettyprint lang-js"><span id='Ext-form-Panel'>/**
- </span> * @docauthor Jason Johnston <jason@sencha.com>
- *
- * FormPanel provides a standard container for forms. It is essentially a standard {@link Ext.panel.Panel} which
- * automatically creates a {@link Ext.form.Basic BasicForm} for managing any {@link Ext.form.field.Field}
- * objects that are added as descendants of the panel. It also includes conveniences for configuring and
- * working with the BasicForm and the collection of Fields.
- *
- * # Layout
- *
- * By default, FormPanel is configured with `{@link Ext.layout.container.Anchor layout:'anchor'}` for
- * the layout of its immediate child items. This can be changed to any of the supported container layouts.
- * The layout of sub-containers is configured in {@link Ext.container.Container#layout the standard way}.
- *
- * # BasicForm
- *
- * Although **not listed** as configuration options of FormPanel, the FormPanel class accepts all
- * of the config options supported by the {@link Ext.form.Basic} class, and will pass them along to
- * the internal BasicForm when it is created.
- *
- * The following events fired by the BasicForm will be re-fired by the FormPanel and can therefore be
- * listened for on the FormPanel itself:
- *
- * - {@link Ext.form.Basic#beforeaction beforeaction}
- * - {@link Ext.form.Basic#actionfailed actionfailed}
- * - {@link Ext.form.Basic#actioncomplete actioncomplete}
- * - {@link Ext.form.Basic#validitychange validitychange}
- * - {@link Ext.form.Basic#dirtychange dirtychange}
- *
- * # Field Defaults
- *
- * The {@link #fieldDefaults} config option conveniently allows centralized configuration of default values
- * for all fields added as descendants of the FormPanel. Any config option recognized by implementations
- * of {@link Ext.form.Labelable} may be included in this object. See the {@link #fieldDefaults} documentation
- * for details of how the defaults are applied.
- *
- * # Form Validation
- *
- * With the default configuration, form fields are validated on-the-fly while the user edits their values.
- * This can be controlled on a per-field basis (or via the {@link #fieldDefaults} config) with the field
- * config properties {@link Ext.form.field.Field#validateOnChange} and {@link Ext.form.field.Base#checkChangeEvents},
- * and the FormPanel's config properties {@link #pollForChanges} and {@link #pollInterval}.
- *
- * Any component within the FormPanel can be configured with `formBind: true`. This will cause that
- * component to be automatically disabled when the form is invalid, and enabled when it is valid. This is most
- * commonly used for Button components to prevent submitting the form in an invalid state, but can be used on
- * any component type.
- *
- * For more information on form validation see the following:
- *
- * - {@link Ext.form.field.Field#validateOnChange}
- * - {@link #pollForChanges} and {@link #pollInterval}
- * - {@link Ext.form.field.VTypes}
- * - {@link Ext.form.Basic#doAction BasicForm.doAction clientValidation notes}
- *
- * # Form Submission
- *
- * By default, Ext Forms are submitted through Ajax, using {@link Ext.form.action.Action}. See the documentation for
- * {@link Ext.form.Basic} for details.
- *
- * # Example usage
- *
- * @example
- * Ext.create('Ext.form.Panel', {
- * title: 'Simple Form',
- * bodyPadding: 5,
- * width: 350,
- *
- * // The form will submit an AJAX request to this URL when submitted
- * url: 'save-form.php',
- *
- * // Fields will be arranged vertically, stretched to full width
- * layout: 'anchor',
- * defaults: {
- * anchor: '100%'
- * },
- *
- * // The fields
- * defaultType: 'textfield',
- * items: [{
- * fieldLabel: 'First Name',
- * name: 'first',
- * allowBlank: false
- * },{
- * fieldLabel: 'Last Name',
- * name: 'last',
- * allowBlank: false
- * }],
- *
- * // Reset and Submit buttons
- * buttons: [{
- * text: 'Reset',
- * handler: function() {
- * this.up('form').getForm().reset();
- * }
- * }, {
- * text: 'Submit',
- * formBind: true, //only enabled once the form is valid
- * disabled: true,
- * handler: function() {
- * var form = this.up('form').getForm();
- * if (form.isValid()) {
- * form.submit({
- * success: function(form, action) {
- * Ext.Msg.alert('Success', action.result.msg);
- * },
- * failure: function(form, action) {
- * Ext.Msg.alert('Failed', action.result.msg);
- * }
- * });
- * }
- * }
- * }],
- * renderTo: Ext.getBody()
- * });
- *
- */
- Ext.define('Ext.form.Panel', {
- extend:'Ext.panel.Panel',
- mixins: {
- fieldAncestor: 'Ext.form.FieldAncestor'
- },
- alias: 'widget.form',
- alternateClassName: ['Ext.FormPanel', 'Ext.form.FormPanel'],
- requires: ['Ext.form.Basic', 'Ext.util.TaskRunner'],
- <span id='Ext-form-Panel-cfg-pollForChanges'> /**
- </span> * @cfg {Boolean} pollForChanges
- * If set to `true`, sets up an interval task (using the {@link #pollInterval}) in which the
- * panel's fields are repeatedly checked for changes in their values. This is in addition to the normal detection
- * each field does on its own input element, and is not needed in most cases. It does, however, provide a
- * means to absolutely guarantee detection of all changes including some edge cases in some browsers which
- * do not fire native events. Defaults to `false`.
- */
- <span id='Ext-form-Panel-cfg-pollInterval'> /**
- </span> * @cfg {Number} pollInterval
- * Interval in milliseconds at which the form's fields are checked for value changes. Only used if
- * the {@link #pollForChanges} option is set to `true`. Defaults to 500 milliseconds.
- */
- <span id='Ext-form-Panel-cfg-layout'> /**
- </span> * @cfg {String} layout
- * The {@link Ext.container.Container#layout} for the form panel's immediate child items.
- * Defaults to `'anchor'`.
- */
- layout: 'anchor',
- ariaRole: 'form',
-
- basicFormConfigs: [
- 'api',
- 'baseParams',
- 'errorReader',
- 'method',
- 'paramOrder',
- 'paramsAsHash',
- 'reader',
- 'standardSubmit',
- 'timeout',
- 'trackResetOnLoad',
- 'url',
- 'waitMsgTarget',
- 'waitTitle'
- ],
- initComponent: function() {
- var me = this;
- if (me.frame) {
- me.border = false;
- }
- me.initFieldAncestor();
- me.callParent();
- me.relayEvents(me.form, [
- <span id='Ext-form-Panel-event-beforeaction'> /**
- </span> * @event beforeaction
- * @inheritdoc Ext.form.Basic#beforeaction
- */
- 'beforeaction',
- <span id='Ext-form-Panel-event-actionfailed'> /**
- </span> * @event actionfailed
- * @inheritdoc Ext.form.Basic#actionfailed
- */
- 'actionfailed',
- <span id='Ext-form-Panel-event-actioncomplete'> /**
- </span> * @event actioncomplete
- * @inheritdoc Ext.form.Basic#actioncomplete
- */
- 'actioncomplete',
- <span id='Ext-form-Panel-event-validitychange'> /**
- </span> * @event validitychange
- * @inheritdoc Ext.form.Basic#validitychange
- */
- 'validitychange',
- <span id='Ext-form-Panel-event-dirtychange'> /**
- </span> * @event dirtychange
- * @inheritdoc Ext.form.Basic#dirtychange
- */
- 'dirtychange'
- ]);
- // Start polling if configured
- if (me.pollForChanges) {
- me.startPolling(me.pollInterval || 500);
- }
- },
- initItems: function() {
- // Create the BasicForm
- var me = this;
- me.form = me.createForm();
- me.callParent();
- },
- // Initialize the BasicForm after all layouts have been completed.
- afterFirstLayout: function() {
- this.callParent();
- this.form.initialize();
- },
- <span id='Ext-form-Panel-method-createForm'> /**
- </span> * @private
- */
- createForm: function() {
- var cfg = {},
- props = this.basicFormConfigs,
- len = props.length,
- i = 0,
- prop;
-
- for (; i < len; ++i) {
- prop = props[i];
- cfg[prop] = this[prop];
- }
- return new Ext.form.Basic(this, cfg);
- },
- <span id='Ext-form-Panel-method-getForm'> /**
- </span> * Provides access to the {@link Ext.form.Basic Form} which this Panel contains.
- * @return {Ext.form.Basic} The {@link Ext.form.Basic Form} which this Panel contains.
- */
- getForm: function() {
- return this.form;
- },
- <span id='Ext-form-Panel-method-loadRecord'> /**
- </span> * Loads an {@link Ext.data.Model} into this form (internally just calls {@link Ext.form.Basic#loadRecord})
- * See also {@link Ext.form.Basic#trackResetOnLoad trackResetOnLoad}.
- * @param {Ext.data.Model} record The record to load
- * @return {Ext.form.Basic} The Ext.form.Basic attached to this FormPanel
- */
- loadRecord: function(record) {
- return this.getForm().loadRecord(record);
- },
- <span id='Ext-form-Panel-method-getRecord'> /**
- </span> * Returns the currently loaded Ext.data.Model instance if one was loaded via {@link #loadRecord}.
- * @return {Ext.data.Model} The loaded instance
- */
- getRecord: function() {
- return this.getForm().getRecord();
- },
- <span id='Ext-form-Panel-method-getValues'> /**
- </span> * Convenience function for fetching the current value of each field in the form. This is the same as calling
- * {@link Ext.form.Basic#getValues this.getForm().getValues()}.
- *
- * @inheritdoc Ext.form.Basic#getValues
- */
- getValues: function(asString, dirtyOnly, includeEmptyText, useDataValues) {
- return this.getForm().getValues(asString, dirtyOnly, includeEmptyText, useDataValues);
- },
- beforeDestroy: function() {
- this.stopPolling();
- this.form.destroy();
- this.callParent();
- },
- <span id='Ext-form-Panel-method-load'> /**
- </span> * This is a proxy for the underlying BasicForm's {@link Ext.form.Basic#load} call.
- * @param {Object} options The options to pass to the action (see {@link Ext.form.Basic#load} and
- * {@link Ext.form.Basic#doAction} for details)
- */
- load: function(options) {
- this.form.load(options);
- },
- <span id='Ext-form-Panel-method-submit'> /**
- </span> * This is a proxy for the underlying BasicForm's {@link Ext.form.Basic#submit} call.
- * @param {Object} options The options to pass to the action (see {@link Ext.form.Basic#submit} and
- * {@link Ext.form.Basic#doAction} for details)
- */
- submit: function(options) {
- this.form.submit(options);
- },
- <span id='Ext-form-Panel-method-startPolling'> /**
- </span> * Start an interval task to continuously poll all the fields in the form for changes in their
- * values. This is normally started automatically by setting the {@link #pollForChanges} config.
- * @param {Number} interval The interval in milliseconds at which the check should run.
- */
- startPolling: function(interval) {
- this.stopPolling();
- var task = new Ext.util.TaskRunner(interval);
- task.start({
- interval: 0,
- run: this.checkChange,
- scope: this
- });
- this.pollTask = task;
- },
- <span id='Ext-form-Panel-method-stopPolling'> /**
- </span> * Stop a running interval task that was started by {@link #startPolling}.
- */
- stopPolling: function() {
- var task = this.pollTask;
- if (task) {
- task.stopAll();
- delete this.pollTask;
- }
- },
- <span id='Ext-form-Panel-method-checkChange'> /**
- </span> * Forces each field within the form panel to
- * {@link Ext.form.field.Field#checkChange check if its value has changed}.
- */
- checkChange: function() {
- var fields = this.form.getFields().items,
- f,
- fLen = fields.length,
- field;
- for (f = 0; f < fLen; f++) {
- fields[f].checkChange();
- }
- }
- });
- </pre>
- </body>
- </html>
|