import {Compiler, ElementRef, Injector, bind, NgZone} from 'angular2/angular2'; import {DynamicComponentLoader} from 'angular2/src/core/compiler/dynamic_component_loader'; import {AppViewManager} from 'angular2/src/core/compiler/view_manager'; import {Ion} from '../ion'; import {IonicConfig} from '../../config/config'; import {IonicApp} from '../app/app'; import {ViewItem} from './view-item'; import {NavController} from '../nav/nav-controller'; import {PaneController} from '../nav/pane'; import {Transition} from '../../transitions/transition'; import {SwipeBackGesture} from './swipe-back'; import * as util from 'ionic/util'; /** * TODO */ export class ViewController extends Ion { constructor( parentViewCtrl: ViewController, injector: Injector, elementRef: ElementRef, zone: NgZone ) { let config = injector.get(IonicConfig); super(elementRef, config); this.parent = parentViewCtrl; this.compiler = injector.get(Compiler); this.loader = injector.get(DynamicComponentLoader); this.viewMngr = injector.get(AppViewManager); this.app = injector.get(IonicApp); this.config = config; this.zone = zone; this.items = []; this.panes = new PaneController(this); this._sbTrans = null; this.sbEnabled = config.setting('swipeBackEnabled') || false; this.sbThreshold = config.setting('swipeBackThreshold') || 40 this.id = ++ctrlIds; this._ids = -1; this.zIndexes = -1; // build a new injector for child ViewItems to use this.bindings = Injector.resolve([ bind(ViewController).toValue(this), bind(NavController).toValue(new NavController(this)) ]); } /** * TODO * @param {TODO} componentType TODO * @param {TODO} [params={}] TODO * @param {TODO} [opts={}] TODO * @returns {Promise} TODO */ push(componentType, params = {}, opts = {}) { if (!componentType || !this.app.isEnabled()) { return Promise.reject(); } if (typeof componentType !== 'function') { throw 'Loading component must be a component class, not "' + componentType.toString() + '"'; } let resolve; let promise = new Promise(res => { resolve = res; }); // do not animate if this is the first in the stack if (!this.items.length) { opts.animation = 'none'; } // default the direction to "forward" opts.direction = opts.direction || 'forward'; // the active item is going to be the leaving one (if one exists) let leavingItem = this.getActive() || new ViewItem(); leavingItem.shouldCache = (util.isBoolean(opts.cacheLeavingItem) ? opts.cacheLeavingItem : true); leavingItem.shouldDestroy = !leavingItem.shouldCache; if (leavingItem.shouldDestroy) { leavingItem.willUnload(); } // create a new ViewItem let enteringItem = new ViewItem(this, componentType, params); // add the item to the stack this.add(enteringItem); if (this.router) { // notify router of the state change this.router.stateChange('push', enteringItem, params); } // start the transition this.transition(enteringItem, leavingItem, opts, () => { resolve(); }); return promise; } /** * TODO * @param {TODO} [opts={}] TODO * @returns {Promise} TODO */ pop(opts = {}) { if (!this.app.isEnabled() || !this.canGoBack()) { return Promise.reject(); } let resolve; let promise = new Promise(res => { resolve = res; }); // default the direction to "back" opts.direction = opts.direction || 'back'; // get the active item and set that it is staged to be leaving // was probably the one popped from the stack let leavingItem = this.getActive() || new ViewItem(); leavingItem.shouldCache = (util.isBoolean(opts.cacheLeavingItem) ? opts.cacheLeavingItem : false); leavingItem.shouldDestroy = !leavingItem.shouldCache; if (leavingItem.shouldDestroy) { leavingItem.willUnload(); } // the entering item is now the new last item // Note: we might not have an entering item if this is the // only item on the history stack. let enteringItem = this.getPrevious(leavingItem); if (enteringItem) { if (this.router) { // notify router of the state change this.router.stateChange('pop', enteringItem); } // start the transition this.transition(enteringItem, leavingItem, opts, () => { // transition completed, destroy the leaving item resolve(); }); } else { this._transComplete(); resolve(); } return promise; } /** * Set the item stack to reflect the given component classes. * @param {TODO} components TODO * @param {TODO} [opts={}] TODO * @returns {Promise} TODO */ setItems(components, opts = {}) { if (!components || !components.length) { return Promise.resolve(); } // if animate has not been set then default to false opts.animate = opts.animate || false; // ensure leaving items are not cached, and should be destroyed opts.cacheLeavingItem = false; // get the items to auto remove without having to do a transiton for each // the last item (the currently active one) will do a normal transition out if (this.items.length > 1) { let autoRemoveItems = this.items.slice(0, this.items.length - 1); for (let i = 0; i < autoRemoveItems.length; i++) { autoRemoveItems[i].shouldDestroy = true; autoRemoveItems[i].shouldCache = false; autoRemoveItems[i].willUnload(); } } let componentObj = null; let componentType = null; let viewItem = null; // create the ViewItems that go before the new active ViewItem in the stack // but the previous views won't should render yet if (components.length > 1) { let newBeforeItems = components.slice(0, components.length - 1); for (let j = 0; j < newBeforeItems.length; j++) { componentObj = newBeforeItems[j]; if (componentObj) { // could be an object with a componentType property, or it is a componentType componentType = componentObj.componentType || componentObj; viewItem = new ViewItem(this, componentType, componentObj.params); viewItem.state = CACHED_STATE; viewItem.shouldDestroy = false; viewItem.shouldCache = false; // add the item to the stack this.add(viewItem); } } } // get the component that will become the active item // it'll be the last one in the given components array componentObj = components[ components.length - 1 ]; componentType = componentObj.componentType || componentObj; // transition the leaving and entering return this.push(componentType, componentObj.params, opts); } /** * TODO * @param {TODO} componentType TODO * @param {TODO} [params={}] TODO * @param {TODO} [opts={}] TODO * @returns {Promise} TODO */ setRoot(componentType, params = {}, opts = {}) { return this.setItems([{ componentType, params }], opts); } /** * TODO * @param {TODO} enteringItem TODO * @param {TODO} leavingItem TODO * @param {TODO} opts TODO * @param {Function} callback TODO * @returns {any} TODO */ transition(enteringItem, leavingItem, opts, callback) { if (!enteringItem || enteringItem === leavingItem) { return callback(); } if (opts.animate === false) { opts.animation = 'none'; } else if (!opts.animation) { opts.animation = this.config.setting('viewTransition'); } opts.animate = (opts.animation !== 'none'); // wait for the new item to complete setup enteringItem.stage(() => { this.zone.runOutsideAngular(() => { enteringItem.shouldDestroy = false; enteringItem.shouldCache = false; enteringItem.willEnter(); leavingItem.willLeave(); // set that the new item pushed on the stack is staged to be entering/leaving // staged state is important for the transition to find the correct item enteringItem.state = STAGED_ENTERING_STATE; leavingItem.state = STAGED_LEAVING_STATE; // init the transition animation let transAnimation = Transition.create(this, opts); if (!opts.animate) { // force it to not animate the elements, just apply the "to" styles transAnimation.duration(0); } let duration = transAnimation.duration(); if (duration > 64) { // block any clicks during the transition and provide a // fallback to remove the clickblock if something goes wrong this.app.setEnabled(false, duration); } // start the transition transAnimation.play().then(() => { // transition has completed, update each item's state enteringItem.state = ACTIVE_STATE; leavingItem.state = CACHED_STATE; // dispose any items that shouldn't stay around transAnimation.dispose(); enteringItem.didEnter(); leavingItem.didLeave(); // all done! this.zone.run(() => { this._transComplete(); callback(); }); }); }); }); } /** * TODO */ swipeBackStart() { if (!this.app.isEnabled() || !this.canSwipeBack()) { return; } // disables the app during the transition this.app.setEnabled(false); // default the direction to "back" let opts = { direction: 'back' }; // get the active item and set that it is staged to be leaving // was probably the one popped from the stack let leavingItem = this.getActive() || new ViewItem(); leavingItem.shouldDestroy = true; leavingItem.shouldCache = false; leavingItem.willLeave(); leavingItem.willUnload(); // the entering item is now the new last item let enteringItem = this.getPrevious(leavingItem); enteringItem.shouldDestroy = false; enteringItem.shouldCache = false; enteringItem.willEnter(); // wait for the new item to complete setup enteringItem.stage(() => { this.zone.runOutsideAngular(() => { // set that the new item pushed on the stack is staged to be entering/leaving // staged state is important for the transition to find the correct item enteringItem.state = STAGED_ENTERING_STATE; leavingItem.state = STAGED_LEAVING_STATE; // init the swipe back transition animation this._sbTrans = Transition.create(this, opts); this._sbTrans.easing('linear').progressStart(); }); }); } /** * TODO * @param {TODO} progress TODO */ swipeBackProgress(value) { if (this._sbTrans) { // continue to disable the app while actively dragging this.app.setEnabled(false, 4000); // set the transition animation's progress this._sbTrans.progress(value); } } /** * @private * @param {TODO} completeSwipeBack Should the swipe back complete or not. * @param {number} rate How fast it closes */ swipeBackFinish(completeSwipeBack, rate) { if (!this._sbTrans) return; // disables the app during the transition this.app.setEnabled(false); this._sbTrans.progressFinish(completeSwipeBack, rate).then(() => { this.zone.run(() => { // find the items that were entering and leaving let enteringItem = this.getStagedEnteringItem(); let leavingItem = this.getStagedLeavingItem(); if (enteringItem && leavingItem) { // finish up the animation if (completeSwipeBack) { // swipe back has completed navigating back // update each item's state enteringItem.state = ACTIVE_STATE; leavingItem.state = CACHED_STATE; enteringItem.didEnter(); leavingItem.didLeave(); if (this.router) { // notify router of the pop state change this.router.stateChange('pop', enteringItem); } } else { // cancelled the swipe back, they didn't end up going back // return items to their original state leavingItem.state = ACTIVE_STATE; enteringItem.state = CACHED_STATE; leavingItem.willEnter(); leavingItem.didEnter(); enteringItem.didLeave(); leavingItem.shouldDestroy = false; enteringItem.shouldDestroy = false; } } // empty out and dispose the swipe back transition animation this._sbTrans && this._sbTrans.dispose(); this._sbTrans = null; // all done! this._transComplete(); }); }); } _runSwipeBack() { if (this.canSwipeBack()) { // it is possible to swipe back if (this.sbGesture) { // this is already an active gesture, don't create another one return; } let opts = { edge: 'left', threshold: this.sbThreshold }; this.sbGesture = new SwipeBackGesture(this.getNativeElement(), opts, this); console.debug('SwipeBackGesture listen'); this.sbGesture.listen(); } else if (this.sbGesture) { // it is not possible to swipe back and there is an // active sbGesture, so unlisten it console.debug('SwipeBackGesture unlisten'); this.sbGesture.unlisten(); this.sbGesture = null; } } /** * TODO * @param {TODO} val TODO * @returns {TODO} TODO */ isSwipeBackEnabled(val) { if (arguments.length) { this.sbEnabled = !!val; } return this.sbEnabled; } /** * If it's possible to use swipe back or not. If it's not possible * to go back, or swipe back is not enable then this will return false. * If it is possible to go back, and swipe back is enabled, then this * will return true. * @returns {boolean} */ canSwipeBack() { return (this.sbEnabled && this.canGoBack()); } /** * Returns `true` if there's a valid previous view that we can pop back to. * Otherwise returns false. * @returns {boolean} */ canGoBack() { let activeItem = this.getActive(); if (activeItem) { return activeItem.enableBack(); } return false; } /** * @private */ _transComplete() { let destroys = []; this.items.forEach(item => { if (item) { if (item.shouldDestroy) { destroys.push(item); } else if (item.state === CACHED_STATE && item.shouldCache) { item.shouldCache = false; } } }); destroys.forEach(item => { this.remove(item); item.destroy(); }); // allow clicks again, but still set an enable time // meaning nothing with this view controller can happen for XXms this.app.setEnabled(true); if (this.items.length === 1) { this.elementRef.nativeElement.classList.add('has-views'); } this._runSwipeBack(); } /** * TODO * @returns {TODO} TODO */ getActive() { for (let i = 0, ii = this.items.length; i < ii; i++) { if (this.items[i].state === ACTIVE_STATE) { return this.items[i]; } } return null; } /** * TODO * @param {TODO} instance TODO * @returns {TODO} TODO */ getByInstance(instance) { if (instance) { for (let i = 0, ii = this.items.length; i < ii; i++) { if (this.items[i].instance === instance) { return this.items[i]; } } } return null; } /** * TODO * @param {TODO} index TODO * @returns {TODO} TODO */ getByIndex(index) { if (index < this.items.length && index > -1) { return this.items[index]; } return null; } /** * TODO * @param {TODO} item TODO * @returns {TODO} TODO */ getPrevious(item) { if (item) { return this.items[ this.items.indexOf(item) - 1 ]; } return null; } /** * TODO * @returns {TODO} TODO */ getStagedEnteringItem() { for (let i = 0, ii = this.items.length; i < ii; i++) { if (this.items[i].state === STAGED_ENTERING_STATE) { return this.items[i]; } } return null; } /** * TODO * @returns {TODO} TODO */ getStagedLeavingItem() { for (let i = 0, ii = this.items.length; i < ii; i++) { if (this.items[i].state === STAGED_LEAVING_STATE) { return this.items[i]; } } return null; } /** * TODO * @param {TODO} nbContainer TODO * @returns {TODO} TODO */ navbarViewContainer(nbContainer) { if (nbContainer) { this._nbContainer = nbContainer; } if (this._nbContainer) { return this._nbContainer; } if (this.parent) { return this.parent.navbarViewContainer(); } } /** * TODO * @returns {TODO} TODO */ anchorElementRef() { if (arguments.length) { this._anchorER = arguments[0]; } return this._anchorER; } /** * TODO * @returns {TODO} TODO */ anchorViewContainerRef() { if (arguments.length) { this._anchorVC = arguments[0]; } return this._anchorVC; } /** * TODO * @returns {TODO} TODO */ childNavbar() { if (arguments.length) { this._childNavbar = arguments[0]; } return this._childNavbar; } /** * TODO * @param {TODO} item TODO * @returns {TODO} TODO */ add(item) { item.id = this.id + '-' + (++this._ids); this.items.push(item); } /** * TODO * @param {TODO} itemOrIndex TODO * @returns {TODO} TODO */ remove(itemOrIndex) { util.array.remove(this.items, itemOrIndex); } /** * First view item in this view controller's stack. This would * not return an item which is about to be destroyed. * @returns {TODO} TODO */ first() { for (let i = 0, l = this.items.length; i < l; i++) { if (!this.items[i].shouldDestroy) { return this.items[i]; } } return null; } /** * Last view item in this view controller's stack. This would * not return an item which is about to be destroyed. * @returns {TODO} TODO */ last() { for (let i = this.items.length - 1; i >= 0; i--) { if (!this.items[i].shouldDestroy) { return this.items[i]; } } return null; } /** * TODO * @param {TODO} item TODO * @returns {TODO} TODO */ indexOf(item) { return this.items.indexOf(item); } /** * Number of sibling view items in the view controller. This does * not include items which are about to be destroyed. * @returns {TODO} TODO */ length() { let len = 0; for (let i = 0, l = this.items.length; i < l; i++) { if (!this.items[i].shouldDestroy) { len++; } } return len; } /** * TODO * @returns {TODO} TODO */ instances() { let instances = []; for (let item of this.items) { if (item.instance) { instances.push(item.instance); } } return instances; } /** * TODO * @param {TODO} item TODO * @returns {TODO} TODO */ isActive(item) { return (item && item.state === ACTIVE_STATE); } /** * TODO * @param {TODO} item TODO * @returns {TODO} TODO */ isStagedEntering(item) { return (item && item.state === STAGED_ENTERING_STATE); } /** * TODO * @param {TODO} router TODO */ registerRouter(router) { this.router = router; } } const ACTIVE_STATE = 1; const CACHED_STATE = 2; const STAGED_ENTERING_STATE = 3; const STAGED_LEAVING_STATE = 4; let ctrlIds = -1;