Source: media/views/frame.js

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
/**
 * wp.media.view.Frame
 *
 * A frame is a composite view consisting of one or more regions and one or more
 * states.
 *
 * @memberOf wp.media.view
 *
 * @see wp.media.controller.State
 * @see wp.media.controller.Region
 *
 * @class
 * @augments wp.media.View
 * @augments wp.Backbone.View
 * @augments Backbone.View
 * @mixes wp.media.controller.StateMachine
 */
var Frame = wp.media.View.extend(/** @lends wp.media.view.Frame.prototype */{
    initialize: function() {
        _.defaults( this.options, {
            mode: [ 'select' ]
        });
        this._createRegions();
        this._createStates();
        this._createModes();
    },

    _createRegions: function() {
        // Clone the regions array.
        this.regions = this.regions ? this.regions.slice() : [];

        // Initialize regions.
        _.each( this.regions, function( region ) {
            this[ region ] = new wp.media.controller.Region({
                view:     this,
                id:       region,
                selector: '.media-frame-' + region
            });
        }, this );
    },
    /**
     * Create the frame's states.
     *
     * @see wp.media.controller.State
     * @see wp.media.controller.StateMachine
     *
     * @fires wp.media.controller.State#ready
     */
    _createStates: function() {
        // Create the default `states` collection.
        this.states = new Backbone.Collection( null, {
            model: wp.media.controller.State
        });

        // Ensure states have a reference to the frame.
        this.states.on( 'add', function( model ) {
            model.frame = this;
            model.trigger('ready');
        }, this );

        if ( this.options.states ) {
            this.states.add( this.options.states );
        }
    },

    /**
     * A frame can be in a mode or multiple modes at one time.
     *
     * For example, the manage media frame can be in the `Bulk Select` or `Edit` mode.
     */
    _createModes: function() {
        // Store active "modes" that the frame is in. Unrelated to region modes.
        this.activeModes = new Backbone.Collection();
        this.activeModes.on( 'add remove reset', _.bind( this.triggerModeEvents, this ) );

        _.each( this.options.mode, function( mode ) {
            this.activateMode( mode );
        }, this );
    },
    /**
     * Reset all states on the frame to their defaults.
     *
     * @return {wp.media.view.Frame} Returns itself to allow chaining.
     */
    reset: function() {
        this.states.invoke( 'trigger', 'reset' );
        return this;
    },
    /**
     * Map activeMode collection events to the frame.
     */
    triggerModeEvents: function( model, collection, options ) {
        var collectionEvent,
            modeEventMap = {
                add: 'activate',
                remove: 'deactivate'
            },
            eventToTrigger;
        // Probably a better way to do this.
        _.each( options, function( value, key ) {
            if ( value ) {
                collectionEvent = key;
            }
        } );

        if ( ! _.has( modeEventMap, collectionEvent ) ) {
            return;
        }

        eventToTrigger = model.get('id') + ':' + modeEventMap[collectionEvent];
        this.trigger( eventToTrigger );
    },
    /**
     * Activate a mode on the frame.
     *
     * @param string mode Mode ID.
     * @return {this} Returns itself to allow chaining.
     */
    activateMode: function( mode ) {
        // Bail if the mode is already active.
        if ( this.isModeActive( mode ) ) {
            return;
        }
        this.activeModes.add( [ { id: mode } ] );
        // Add a CSS class to the frame so elements can be styled for the mode.
        this.$el.addClass( 'mode-' + mode );

        return this;
    },
    /**
     * Deactivate a mode on the frame.
     *
     * @param string mode Mode ID.
     * @return {this} Returns itself to allow chaining.
     */
    deactivateMode: function( mode ) {
        // Bail if the mode isn't active.
        if ( ! this.isModeActive( mode ) ) {
            return this;
        }
        this.activeModes.remove( this.activeModes.where( { id: mode } ) );
        this.$el.removeClass( 'mode-' + mode );
        /**
         * Frame mode deactivation event.
         *
         * @event wp.media.view.Frame#{mode}:deactivate
         */
        this.trigger( mode + ':deactivate' );

        return this;
    },
    /**
     * Check if a mode is enabled on the frame.
     *
     * @param  string mode Mode ID.
     * @return bool
     */
    isModeActive: function( mode ) {
        return Boolean( this.activeModes.where( { id: mode } ).length );
    }
});

// Make the `Frame` a `StateMachine`.
_.extend( Frame.prototype, wp.media.controller.StateMachine.prototype );

module.exports = Frame;