fa46d31ac2
Added some comments, renamed controller variable in markup Removed edit references from BrowseController
115 lines
4.7 KiB
JavaScript
115 lines
4.7 KiB
JavaScript
/*****************************************************************************
|
|
* Open MCT Web, Copyright (c) 2014-2015, United States Government
|
|
* as represented by the Administrator of the National Aeronautics and Space
|
|
* Administration. All rights reserved.
|
|
*
|
|
* Open MCT Web is licensed under the Apache License, Version 2.0 (the
|
|
* "License"); you may not use this file except in compliance with the License.
|
|
* You may obtain a copy of the License at
|
|
* http://www.apache.org/licenses/LICENSE-2.0.
|
|
*
|
|
* Unless required by applicable law or agreed to in writing, software
|
|
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
|
|
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
|
|
* License for the specific language governing permissions and limitations
|
|
* under the License.
|
|
*
|
|
* Open MCT Web includes source code licensed under additional open source
|
|
* licenses. See the Open Source Licenses file (LICENSES.md) included with
|
|
* this source code distribution or the Licensing information page available
|
|
* at runtime from the About dialog for additional information.
|
|
*****************************************************************************/
|
|
/*global define,Promise*/
|
|
|
|
/**
|
|
* Module defining NavigationService. Created by vwoeltje on 11/10/14.
|
|
*/
|
|
define(
|
|
[],
|
|
function () {
|
|
"use strict";
|
|
|
|
/**
|
|
* The navigation service maintains the application's current
|
|
* navigation state, and allows listening for changes thereto.
|
|
* @memberof platform/commonUI/browse
|
|
* @constructor
|
|
*/
|
|
function NavigationService() {
|
|
this.navigated = undefined;
|
|
this.callbacks = {};
|
|
}
|
|
|
|
/**
|
|
* Get the current navigation state.
|
|
* @returns {DomainObject} the object that is navigated-to
|
|
*/
|
|
NavigationService.prototype.getNavigation = function () {
|
|
return this.navigated;
|
|
};
|
|
|
|
/**
|
|
* Set the current navigation state. This will invoke listeners.
|
|
* Changing the navigation state will be blocked if any of the
|
|
* 'before' navigation state change listeners return 'false'.
|
|
* @param {DomainObject} domainObject the domain object to navigate to
|
|
*/
|
|
NavigationService.prototype.setNavigation = function (value) {
|
|
var canNavigate = true;
|
|
if (this.navigated !== value) {
|
|
canNavigate = (this.callbacks['before'] || [])
|
|
.reduce(function (previous, callback) {
|
|
//Check whether the callback returned a value of
|
|
// 'false' indicating that navigation should not
|
|
// continue. All other return values will allow
|
|
// navigation to continue
|
|
return (callback(value)!==false) && previous;
|
|
}, true);
|
|
if (canNavigate) {
|
|
this.navigated = value;
|
|
this.callbacks['after'].forEach(function (callback) {
|
|
callback(value);
|
|
});
|
|
}
|
|
}
|
|
return canNavigate;
|
|
};
|
|
|
|
/**
|
|
* Listen for changes in navigation. The passed callback will
|
|
* be invoked with the new domain object of navigation when
|
|
* this changes. Callbacks can be registered to listen to pre or
|
|
* post-navigation events. The event to listen to is specified using
|
|
* the event parameter. In the case of pre-navigation events
|
|
* returning a false value will prevent the navigation event from
|
|
* going ahead.
|
|
* @param {function} callback the callback to invoke when
|
|
* navigation state changes
|
|
* @param {string} [event=after] the navigation event to listen to.
|
|
* One of 'before' or 'after'.
|
|
*/
|
|
NavigationService.prototype.addListener = function (callback, event) {
|
|
event = event || 'after';
|
|
this.callbacks[event] = this.callbacks[event] || [];
|
|
this.callbacks[event].push(callback);
|
|
};
|
|
|
|
/**
|
|
* Stop listening for changes in navigation state.
|
|
* @param {function} callback the callback which should
|
|
* no longer be invoked when navigation state
|
|
* changes
|
|
* @param {string} [event=after] the navigation event that the
|
|
* callback is registered to. One of 'before' or 'after'.
|
|
*/
|
|
NavigationService.prototype.removeListener = function (callback, event) {
|
|
event = event || 'after';
|
|
this.callbacks[event] = this.callbacks[event].filter(function (cb) {
|
|
return cb !== callback;
|
|
});
|
|
};
|
|
|
|
return NavigationService;
|
|
}
|
|
);
|