6e184ae6625fb991fd9c75a37b451142421b99c9
[yaffs-website] / web / core / modules / quickedit / js / models / AppModel.es6.js
1 /**
2  * @file
3  * A Backbone Model for the state of the in-place editing application.
4  *
5  * @see Drupal.quickedit.AppView
6  */
7
8 (function(Backbone, Drupal) {
9   /**
10    * @constructor
11    *
12    * @augments Backbone.Model
13    */
14   Drupal.quickedit.AppModel = Backbone.Model.extend(
15     /** @lends Drupal.quickedit.AppModel# */ {
16       /**
17        * @type {object}
18        *
19        * @prop {Drupal.quickedit.FieldModel} highlightedField
20        * @prop {Drupal.quickedit.FieldModel} activeField
21        * @prop {Drupal.dialog~dialogDefinition} activeModal
22        */
23       defaults: /** @lends Drupal.quickedit.AppModel# */ {
24         /**
25          * The currently state='highlighted' Drupal.quickedit.FieldModel, if any.
26          *
27          * @type {Drupal.quickedit.FieldModel}
28          *
29          * @see Drupal.quickedit.FieldModel.states
30          */
31         highlightedField: null,
32
33         /**
34          * The currently state = 'active' Drupal.quickedit.FieldModel, if any.
35          *
36          * @type {Drupal.quickedit.FieldModel}
37          *
38          * @see Drupal.quickedit.FieldModel.states
39          */
40         activeField: null,
41
42         /**
43          * Reference to a {@link Drupal.dialog} instance if a state change
44          * requires confirmation.
45          *
46          * @type {Drupal.dialog~dialogDefinition}
47          */
48         activeModal: null,
49       },
50     },
51   );
52 })(Backbone, Drupal);