ionic-framework/src/navigation/nav-controller-base.ts

import { ComponentRef, ComponentFactoryResolver, ElementRef, EventEmitter, NgZone, ReflectiveInjector, Renderer, ViewContainerRef } from '@angular/core';

import { AnimationOptions } from '../animations/animation';
import { App } from '../components/app/app';
import { Config } from '../config/config';
import { convertToView, convertToViews, NavOptions, DIRECTION_BACK, DIRECTION_FORWARD, INIT_ZINDEX,
         TransitionResolveFn, TransitionRejectFn, TransitionInstruction, ViewState } from './nav-util';
import { setZIndex } from './nav-util';
import { DeepLinker } from './deep-linker';
import { GestureController } from '../gestures/gesture-controller';
import { isBlank, isNumber, isPresent, pascalCaseToDashCase } from '../util/util';
import { isViewController, ViewController } from './view-controller';
import { Ion } from '../components/ion';
import { Keyboard } from '../util/keyboard';
import { NavController } from './nav-controller';
import { NavParams } from './nav-params';
import { SwipeBackGesture } from './swipe-back';
import { Transition } from '../transitions/transition';
import { TransitionController } from '../transitions/transition-controller';


/**
 * @private
 * This class is for internal use only. It is not exported publicly.
 */
export class NavControllerBase extends Ion implements NavController {
  _children: any[] = [];
  _ids: number = -1;
  _init = false;
  _isPortal: boolean;
  _queue: TransitionInstruction[] = [];
  _sbEnabled: boolean;
  _sbGesture: SwipeBackGesture;
  _sbThreshold: number;
  _sbTrns: Transition;
  _trnsId: number = null;
  _trnsTm: number = 0;
  _viewport: ViewContainerRef;
  _views: ViewController[] = [];

  viewDidLoad: EventEmitter<any>;
  viewWillEnter: EventEmitter<any>;
  viewDidEnter: EventEmitter<any>;
  viewWillLeave: EventEmitter<any>;
  viewDidLeave: EventEmitter<any>;
  viewWillUnload: EventEmitter<any>;

  id: string;
  parent: any;
  config: Config;

  constructor(
    parent: any,
    public _app: App,
    config: Config,
    public _keyboard: Keyboard,
    elementRef: ElementRef,
    public _zone: NgZone,
    renderer: Renderer,
    public _cfr: ComponentFactoryResolver,
    public _gestureCtrl: GestureController,
    public _trnsCtrl: TransitionController,
    public _linker: DeepLinker
  ) {
    super(config, elementRef, renderer);

    this.parent = parent;
    this.config = config;

    this._sbEnabled = config.getBoolean('swipeBackEnabled');
    this._sbThreshold = config.getNumber('swipeBackThreshold', 40);

    this.id = 'n' + (++ctrlIds);

    this.viewDidLoad = new EventEmitter();
    this.viewWillEnter = new EventEmitter();
    this.viewDidEnter = new EventEmitter();
    this.viewWillLeave = new EventEmitter();
    this.viewDidLeave = new EventEmitter();
    this.viewWillUnload = new EventEmitter();
  }

  push(page: any, params?: any, opts?: NavOptions, done?: Function): Promise<any> {
    return this._queueTrns({
      insertStart: -1,
      insertViews: [convertToView(this._linker, page, params)],
      opts: opts,
    }, done);
  }

  insert(insertIndex: number, page: any, params?: any, opts?: NavOptions, done?: Function): Promise<any> {
    return this._queueTrns({
      insertStart: insertIndex,
      insertViews: [convertToView(this._linker, page, params)],
      opts: opts,
    }, done);
  }

  insertPages(insertIndex: number, insertPages: any[], opts?: NavOptions, done?: Function): Promise<any> {
    return this._queueTrns({
      insertStart: insertIndex,
      insertViews: convertToViews(this._linker, insertPages),
      opts: opts,
    }, done);
  }

  pop(opts?: NavOptions, done?: Function): Promise<any> {
    return this._queueTrns({
      removeStart: -1,
      removeCount: 1,
      opts: opts,
    }, done);
  }

  popTo(indexOrViewCtrl: any, opts?: NavOptions, done?: Function): Promise<any> {
    const startIndex = isViewController(indexOrViewCtrl) ? this.indexOf(indexOrViewCtrl) : isNumber(indexOrViewCtrl) ? indexOrViewCtrl : -1;
    return this._queueTrns({
      removeStart: startIndex + 1,
      removeCount: -1,
      opts: opts,
    }, done);
  }

  popToRoot(opts?: NavOptions, done?: Function): Promise<any> {
    return this._queueTrns({
      removeStart: 1,
      removeCount: -1,
      opts: opts,
    }, done);
  }

  popAll() {
    let promises: any[] = [];
    for (var i = this._views.length - 1; i >= 0; i--) {
      promises.push(this.pop(null));
    }
    return Promise.all(promises);
  }

  remove(startIndex: number, removeCount: number = 1, opts?: NavOptions, done?: Function): Promise<any> {
    return this._queueTrns({
      removeStart: startIndex,
      removeCount: removeCount,
      opts: opts,
    }, done);
  }

  setRoot(pageOrViewCtrl: any, params?: any, opts?: NavOptions, done?: Function): Promise<any> {
    return this._queueTrns({
      insertStart: 0,
      insertViews: [convertToView(this._linker, pageOrViewCtrl, params)],
      removeStart: 0,
      removeCount: -1,
      opts: opts
    }, done);
  }

  setPages(pages: any[], opts?: NavOptions, done?: Function): Promise<any> {
    return this._queueTrns({
      insertStart: 0,
      insertViews: convertToViews(this._linker, pages),
      removeStart: 0,
      removeCount: -1,
      opts: opts
    }, done);
  }

  _queueTrns(ti: TransitionInstruction, done: Function): Promise<any> {
    let promise: Promise<any>;
    let resolve: Function = done;
    let reject: Function = done;

    if (done === undefined) {
      // only create a promise if a done callback wasn't provided
      // done can be a null, which avoids any functions
      promise = new Promise((res, rej) => {
        resolve = res;
        reject = rej;
      });
    }

    ti.resolve = (hasCompleted: boolean, isAsync: boolean, enteringName: string, leavingName: string, direction: string) => {
      // transition has successfully resolved
      this._trnsId = null;
      resolve && resolve(hasCompleted, isAsync, enteringName, leavingName, direction);
      this._sbCheck();

      // let's see if there's another to kick off
      this.setTransitioning(false);
      this._nextTrns();
    };

    ti.reject = (rejectReason: any, trns: Transition) => {
      // rut row raggy, something rejected this transition
      this._trnsId = null;
      this._queue.length = 0;

      while (trns) {
        if (trns.enteringView && (trns.enteringView._state !== ViewState.LOADED)) {
          // destroy the entering views and all of their hopes and dreams
          trns.enteringView._destroy(this._renderer);
        }
        if (!trns.parent) break;
      }

      if (trns) {
        this._trnsCtrl.destroy(trns.trnsId);
      }

      this._sbCheck();

      reject && reject(false, false, rejectReason);

      this.setTransitioning(false);
      this._nextTrns();
    };

    if (ti.insertViews) {
      // ensure we've got good views to insert
      ti.insertViews = ti.insertViews.filter(v => v !== null);
      if (!ti.insertViews.length) {
        ti.reject('invalid views to insert');
        return;
      }

    } else if (isPresent(ti.removeStart) && !this._views.length && !this._isPortal) {
      ti.reject('no views in the stack to be removed');
      return;
    }

    this._queue.push(ti);

    // if there isn't a transitoin already happening
    // then this will kick off this transition
    this._nextTrns();

    // promise is undefined if a done callbacks was provided
    return promise;
  }

  _nextTrns(): boolean {
    // this is the framework's bread 'n butta function
    // only one transition is allowed at any given time
    if (this.isTransitioning()) {
      return false;
    }

    // there is no transition happening right now
    // get the next instruction
    const ti = this._queue.shift();
    if (!ti) {
      this.setTransitioning(false);
      return false;
    }

    this.setTransitioning(true, ACTIVE_TRANSITION_MAX_TIME);
    const viewsLength = this._views.length;
    const activeView = this.getActive();

    let enteringView: ViewController;
    let leavingView: ViewController = activeView;
    const destroyQueue: ViewController[] = [];

    const opts = ti.opts || {};
    const resolve = ti.resolve;
    const reject = ti.reject;
    let insertViews = ti.insertViews;
    ti.resolve = ti.reject = ti.opts = ti.insertViews = null;

    let enteringRequiresTransition = false;
    let leavingRequiresTransition = false;

    if (isPresent(ti.removeStart)) {
      if (ti.removeStart < 0) {
        ti.removeStart = (viewsLength - 1);
      }
      if (ti.removeCount < 0) {
        ti.removeCount = (viewsLength - ti.removeStart);
      }

      leavingRequiresTransition = (ti.removeStart + ti.removeCount === viewsLength);

      for (var i = ti.removeStart; i <= ti.removeCount; i++) {
        destroyQueue.push(this._views[i]);
      }

      for (var i = viewsLength - 1; i >= 0; i--) {
        var view = this._views[i];
        if (destroyQueue.indexOf(view) < 0 && view !== leavingView) {
          enteringView = view;
          break;
        }
      }

      // default the direction to "back"
      opts.direction = opts.direction || DIRECTION_BACK;
    }

    if (insertViews) {
      // allow -1 to be passed in to auto push it on the end
      // and clean up the index if it's larger then the size of the stack
      if (ti.insertStart < 0 || ti.insertStart > viewsLength) {
        ti.insertStart = viewsLength;
      }

      // only requires a transition if it's going at the end
      enteringRequiresTransition = (ti.insertStart === viewsLength);

      // grab the very last view of the views to be inserted
      // and initialize it as the new entering view
      enteringView = insertViews[insertViews.length - 1];

      // manually set the new view's id if an id was passed in the options
      if (isPresent(opts.id)) {
        enteringView.id = opts.id;
      }

      // add the views to the
      for (var i = 0; i < insertViews.length; i++) {
        var view = insertViews[i];

        var existingIndex = this._views.indexOf(view);
        if (existingIndex > -1) {
          // this view is already in the stack!!
          // move it to its new location
          this._views.splice(ti.insertStart + i, 0, this._views.splice(existingIndex, 1)[0]);

        } else {
          // this is a new view to add to the stack
          // create the new entering view
          view._setNav(this);

          // give this inserted view an ID
          view.id = this.id + '-' + (++this._ids);

          // insert the entering view into the correct index in the stack
          this._views.splice(ti.insertStart + i, 0, view);
        }
      }

      if (enteringRequiresTransition) {
        // default to forward if not already set
        opts.direction = opts.direction || DIRECTION_FORWARD;
      }
    }

    // if the views to be removed are in the beginning or middle
    // and there is not a view that needs to visually transition out
    // then just destroy them and don't transition anything
    for (var i = 0; i < destroyQueue.length; i++) {
      // batch all of lifecycles together
      var view = destroyQueue[i];
      if (view && view !== enteringView && view !== leavingView) {
        view._willLeave();
        this.viewWillLeave.emit(view);
        this._app.viewWillLeave.emit(view);

        view._didLeave();
        this.viewDidLeave.emit(view);
        this._app.viewDidLeave.emit(view);

        view._willUnload();
        this.viewWillUnload.emit(view);
        this._app.viewWillUnload.emit(view);
      }
    }
    for (var i = 0; i < destroyQueue.length; i++) {
      // batch all of the destroys together
      var view = destroyQueue[i];
      if (view && view !== enteringView && view !== leavingView) {
        view._destroy(this._renderer);
      }
    }
    destroyQueue.length = 0;

    if (enteringRequiresTransition || leavingRequiresTransition && enteringView !== leavingView) {
      // set which animation it should use if it wasn't set yet
      if (!opts.animation) {
        if (isPresent(ti.removeStart)) {
          opts.animation = (leavingView || enteringView).getTransitionName(opts.direction);
        } else {
          opts.animation = (enteringView || leavingView).getTransitionName(opts.direction);
        }
      }

      // huzzah! let us transition these views
      this._transition(enteringView, leavingView, opts, resolve, reject);

    } else {
      // they're inserting/removing the views somewhere in the middle or
      // beginning, so visually nothing needs to animate/transition
      // resolve immediately because there's no animation that's happening
      resolve(true, false);
    }

    return true;
  }

  _transition(enteringView: ViewController, leavingView: ViewController, opts: NavOptions, resolve: TransitionResolveFn, reject: TransitionRejectFn): void {
    // figure out if this transition is the root one or a
    // child of a parent nav that has the root transition
    this._trnsId = this._trnsCtrl.getRootTrnsId(this);
    if (this._trnsId === null) {
      // this is the root transition, meaning all child navs and their views
      // should be added as a child transition to this one
      this._trnsId = this._trnsCtrl.nextId();
    }

    // create the transition options
    const animationOpts: AnimationOptions = {
      animation: opts.animation,
      direction: opts.direction,
      duration: (opts.animate === false ? 0 : opts.duration),
      easing: opts.easing,
      isRTL: this.config.platform.isRTL(),
      ev: opts.ev,
    };

    // create the transition animation from the TransitionController
    // this will either create the root transition, or add it as a child transition
    const trns = this._trnsCtrl.get(this._trnsId, enteringView, leavingView, animationOpts);

    // ensure any swipeback transitions are cleared out
    this._sbTrns && this._sbTrns.destroy();

    if (trns.parent) {
      // this is important for later to know if there
      // are any more child tests to check for
      trns.parent.hasChildTrns = true;

    } else {
      // this is the root transition
      if (opts.progressAnimation) {
        this._sbTrns = trns;
      }
    }

    trns.registerStart(() => {
      this._trnsStart(trns, enteringView, leavingView, opts, resolve);
      if (trns.parent) {
        trns.parent.start();
      }
    });

    if (enteringView && isBlank(enteringView._state)) {
      // render the entering view, and all child navs and views
      // ******** DOM WRITE ****************
      this._viewInit(trns, enteringView, opts);
    }

    // views have been initialized, now let's test
    // to see if the transition is even allowed or not
    const shouldContinue = this._viewTest(trns, enteringView, leavingView, opts, resolve, reject);
    if (shouldContinue) {
      // synchronous and all tests passed! let's continue
      this._postViewInit(trns, enteringView, leavingView, opts, resolve);
    }
  }

  /**
   * DOM WRITE
   */
  _viewInit(trns: Transition, enteringView: ViewController, opts: NavOptions) {
    // entering view has not been initialized yet
    const componentProviders = ReflectiveInjector.resolve([
      { provide: NavController, useValue: this },
      { provide: ViewController, useValue: enteringView },
      { provide: NavParams, useValue: enteringView.getNavParams() }
    ]);
    const componentFactory = this._cfr.resolveComponentFactory(enteringView.component);
    const childInjector = ReflectiveInjector.fromResolvedProviders(componentProviders, this._viewport.parentInjector);

    // create ComponentRef and set it to the entering view
    enteringView.init(componentFactory.create(childInjector, []));
    enteringView._state = ViewState.INITIALIZED;
  }

  _viewTest(trns: Transition, enteringView: ViewController, leavingView: ViewController, opts: NavOptions, resolve: TransitionResolveFn, reject: TransitionRejectFn): boolean {
    const promises: Promise<any>[] = [];

    if (leavingView) {
      const leavingTestResult = leavingView._lifecycleTest('Leave');

      if (isPresent(leavingTestResult) && leavingTestResult !== true) {
        if (leavingTestResult instanceof Promise) {
          // async promise
          promises.push(leavingTestResult);

        } else {
          // synchronous reject
          reject((leavingTestResult !== false ? leavingTestResult :  `ionViewCanLeave rejected`), trns);
          return false;
        }
      }
    }

    if (enteringView) {
      const enteringTestResult = enteringView._lifecycleTest('Enter');

      if (isPresent(enteringTestResult) && enteringTestResult !== true) {
        if (enteringTestResult instanceof Promise) {
          // async promise
          promises.push(enteringTestResult);

        } else {
          // synchronous reject
          reject((enteringTestResult !== false ? enteringTestResult :  `ionViewCanEnter rejected`), trns);
          return false;
        }
      }
    }

    if (promises.length) {
      // darn, async promises, gotta wait for them to resolve
      Promise.all(promises).then(() => {
        // all promises resolved! let's continue
        this._postViewInit(trns, enteringView, leavingView, opts, resolve);

      }, (rejectReason: any) => {
        // darn, one of the promises was rejected!!
        reject(rejectReason, trns);

      }).catch((rejectReason) => {
        // idk, who knows
        reject(rejectReason, trns);
      });

      return false;
    }

    // synchronous and all tests passed! let's move on already
    return true;
  }

  _postViewInit(trns: Transition, enteringView: ViewController, leavingView: ViewController, opts: NavOptions, resolve: TransitionResolveFn): void {
    // passed both the enter and leave tests
    if (enteringView && enteringView._state === ViewState.INITIALIZED) {
      // render the entering component in the DOM
      // this would also render new child navs/views
      // which may have their very own async canEnter/Leave tests
      // ******** DOM WRITE ****************
      this._viewInsert(enteringView, enteringView._cmp, this._viewport);
    }

    if (!trns.hasChildTrns) {
      // lowest level transition, so kick it off and let it bubble up to start all of them
      trns.start();
    }
  }

  _viewInsert(view: ViewController, componentRef: ComponentRef<any>, viewport: ViewContainerRef) {
    // successfully finished loading the entering view
    // fire off the "loaded" lifecycle events
    view._didLoad();
    this.viewDidLoad.emit(view);
    this._app.viewDidLoad.emit(view);

    // render the component ref instance to the DOM
    // ******** DOM WRITE ****************
    viewport.insert(componentRef.hostView, viewport.length);
    view._state = ViewState.PRE_RENDERED;

    // the ElementRef of the actual ion-page created
    const pageElement = componentRef.location.nativeElement;

    if (view._cssClass) {
      // ******** DOM WRITE ****************
      this._renderer.setElementClass(pageElement, view._cssClass, true);
    }

    // auto-add page css className created from component JS class name
    // ******** DOM WRITE ****************
    const cssClassName = pascalCaseToDashCase(view.component.name);
    this._renderer.setElementClass(pageElement, cssClassName, true);

    componentRef.changeDetectorRef.detectChanges();
  }

  _trnsStart(trns: Transition, enteringView: ViewController, leavingView: ViewController, opts: NavOptions, resolve: TransitionResolveFn) {
    this._trnsId = null;

    // set the correct zIndex for the entering and leaving views
    // ******** DOM WRITE ****************
    setZIndex(this, enteringView, leavingView, opts.direction, this._renderer);

    // always ensure the entering view is viewable
    // ******** DOM WRITE ****************
    enteringView && enteringView._domShow(true, this._renderer);

    if (leavingView) {
      // always ensure the leaving view is viewable
      // ******** DOM WRITE ****************
      leavingView._domShow(true, this._renderer);
    }

    // initialize the transition
    trns.init();

    if ((!this._init && this._views.length === 1 && !this._isPortal) || this.config.get('animate') === false) {
      // the initial load shouldn't animate, unless it's a portal
      opts.animate = false;
    }
    if (opts.animate === false) {
      // if it was somehow set to not animation, then make the duration zero
      trns.duration(0);
    }

    // create a callback that needs to run within zone
    // that will fire off the willEnter/Leave lifecycle events at the right time
    trns.beforeAddRead(() => {
      this._zone.run(this._viewsWillLifecycles.bind(this, enteringView, leavingView));
    });

    // create a callback for when the animation is done
    trns.onFinish(() => {
      // transition animation has ended
      this._zone.run(this._trnsFinish.bind(this, trns, opts, resolve));
    });

    // get the set duration of this transition
    const duration = trns.getDuration();

    // set that this nav is actively transitioning
    this.setTransitioning(true, duration);

    if (!trns.parent) {
      // this is the top most, or only active transition, so disable the app
      // add XXms to the duration the app is disabled when the keyboard is open

      if (duration > DISABLE_APP_MINIMUM_DURATION) {
        // if this transition has a duration and this is the root transition
        // then set that the app is actively disabled
        this._app.setEnabled(false, duration);
      }

      // cool, let's do this, start the transition
      if (opts.progressAnimation) {
        // this is a swipe to go back, just get the transition progress ready
        // kick off the swipe animation start
        trns.progressStart();

      } else {
        // only the top level transition should actually start "play"
        // kick it off and let it play through
        // ******** DOM WRITE ****************
        trns.play();
      }
    }
  }

  _viewsWillLifecycles(enteringView: ViewController, leavingView: ViewController) {
    // call each view's lifecycle events
    if (enteringView) {
      enteringView._willEnter();
      this.viewWillEnter.emit(enteringView);
      this._app.viewWillEnter.emit(enteringView);
    }

    if (leavingView) {
      leavingView._willLeave();
      this.viewWillLeave.emit(leavingView);
      this._app.viewWillLeave.emit(leavingView);
    }
  }

  _trnsFinish(trns: Transition, opts: NavOptions, resolve: TransitionResolveFn) {
    const hasCompleted = trns.hasCompleted;

    // mainly for testing
    let enteringName: string;
    let leavingName: string;

    if (hasCompleted) {
      // transition has completed (went from 0 to 1)
      if (trns.enteringView) {
        enteringName = trns.enteringView.name;
        trns.enteringView._didEnter();
        this.viewDidEnter.emit(trns.enteringView);
        this._app.viewDidEnter.emit(trns.enteringView);
      }

      if (trns.leavingView) {
        leavingName = trns.leavingView.name;
        trns.leavingView._didLeave();
        this.viewDidLeave.emit(trns.leavingView);
        this._app.viewDidLeave.emit(trns.leavingView);
      }

      this._cleanup(trns.enteringView);
    }

    if (!trns.parent) {
      // this is the root transition
      // it's save to destroy this transition
      this._trnsCtrl.destroy(trns.trnsId);

      // it's safe to enable the app again
      this._app.setEnabled(true);

      if (opts.updateUrl !== false) {
        // notify deep linker of the nav change
        // if a direction was provided and should update url
        this._linker.navChange(opts.direction);
      }

      if (opts.keyboardClose !== false && this._keyboard.isOpen()) {
        // the keyboard is still open!
        // no problem, let's just close for them
        this._keyboard.close();
      }
    }

    // congrats, we did it!
    resolve(hasCompleted, true, enteringName, leavingName, opts.direction);
  }

  /**
   * DOM WRITE
   */
  _cleanup(activeView: ViewController) {
    // ok, cleanup time!! Destroy all of the views that are
    // INACTIVE and come after the active view
    const activeViewIndex = this.indexOf(activeView);

    let reorderZIndexes = false;
    for (var i = this._views.length - 1; i >= 0; i--) {
      var view = this._views[i];
      if (i > activeViewIndex) {
        // this view comes after the active view
        // let's unload it
        view._willUnload();
        this.viewWillUnload.emit(view);
        this._app.viewWillUnload.emit(view);
        view._destroy(this._renderer);

      } else if (i < activeViewIndex && !this._isPortal) {
        // this view comes before the active view
        // and it is not a portal then ensure it is hidden
        view._domShow(false, this._renderer);
      }
      if (view._zIndex <= 0) {
        reorderZIndexes = true;
      }
    }

    if (!this._isPortal) {
      if (reorderZIndexes) {
        this._views.forEach(view => {
          // ******** DOM WRITE ****************
          view._setZIndex(view._zIndex + INIT_ZINDEX + 1, this._renderer);
        });
      }
    }
  }

  getActiveChildNav(): any {
    return this._children[this._children.length - 1];
  }

  registerChildNav(nav: any) {
    this._children.push(nav);
  }

  unregisterChildNav(nav: any) {
    const index = this._children.indexOf(nav);
    if (index > -1) {
      this._children.splice(index, 1);
    }
  }

  destroy() {
    for (var i = this._views.length - 1; i >= 0; i--) {
      this._views[i]._willUnload();
      this._views[i]._destroy(this._renderer);
    }
    this._views.length = 0;

    this._sbGesture && this._sbGesture.destroy();
    this._sbTrns && this._sbTrns.destroy();
    this._sbGesture = this._sbTrns = null;

    if (this.parent && this.parent.unregisterChildNav) {
      this.parent.unregisterChildNav(this);
    }
  }

  swipeBackStart() {
    if (this.isTransitioning() || this._queue.length > 0) return;

    // default the direction to "back";
    const opts: NavOptions = {
      direction: DIRECTION_BACK,
      progressAnimation: true
    };

    this._queueTrns({
      removeStart: -1,
      removeCount: 1,
      opts: opts,
    }, null);

  }

  swipeBackProgress(stepValue: number) {
    if (this._sbTrns && this._sbGesture) {
      // continue to disable the app while actively dragging
      this._app.setEnabled(false, ACTIVE_TRANSITION_MAX_TIME);
      this.setTransitioning(true, ACTIVE_TRANSITION_MAX_TIME);

      // set the transition animation's progress
      this._sbTrns.progressStep(stepValue);
    }
  }

  swipeBackEnd(shouldComplete: boolean, currentStepValue: number) {
    if (this._sbTrns && this._sbGesture) {
      // the swipe back gesture has ended
      this._sbTrns.progressEnd(shouldComplete, currentStepValue);
    }
  }

  _sbCheck() {
    if (this._sbEnabled && !this._isPortal) {
      // this nav controller can have swipe to go back

      if (!this._sbGesture) {
        // create the swipe back gesture if we haven't already
        const opts = {
          edge: 'left',
          threshold: this._sbThreshold
        };
        this._sbGesture = new SwipeBackGesture(this.getNativeElement(), opts, this, this._gestureCtrl);
      }

      if (this.canSwipeBack()) {
        // it is be possible to swipe back
        if (!this._sbGesture.isListening) {
          this._zone.runOutsideAngular(() => {
            // start listening if it's not already
            console.debug('swipeBack gesture, listen');
            this._sbGesture.listen();
          });
        }

      } else if (this._sbGesture.isListening) {
        // it should not be possible to swipe back
        // but the gesture is still listening
        console.debug('swipeBack gesture, unlisten');
        this._sbGesture.unlisten();
      }
    }
  }

  canSwipeBack(): boolean {
    return (this._sbEnabled &&
           !this._children.length &&
           !this.isTransitioning() &&
            this._app.isEnabled() &&
            this.canGoBack());
  }

  canGoBack(): boolean {
    const activeView = this.getActive();
    return !!(activeView && activeView.enableBack()) || false;
  }

  isTransitioning(): boolean {
    // using a timestamp instead of boolean incase something goes wrong
    return (this._trnsTm > Date.now());
  }

  setTransitioning(isTransitioning: boolean, durationPadding: number = 2000) {
    this._trnsTm = (isTransitioning ? Date.now() + durationPadding : 0);
  }

  getActive() {
    return this._views[this._views.length - 1];
  }

  isActive(view: ViewController) {
    return (view === this.getActive());
  }

  getByIndex(index: number): ViewController {
    return this._views[index];
  }

  getPrevious(view?: ViewController): ViewController {
    // returns the view controller which is before the given view controller.
    if (!view) {
      view = this.getActive();
    }
    return this._views[this.indexOf(view) - 1];
  }

  first(): ViewController {
    // returns the first view controller in this nav controller's stack.
    return this._views[0];
  }

  last(): ViewController {
    // returns the last page in this nav controller's stack.
    return this._views[this._views.length - 1];
  }

  indexOf(view: ViewController): number {
    // returns the index number of the given view controller.
    return this._views.indexOf(view);
  }

  length(): number {
    return this._views.length;
  }

  isSwipeBackEnabled(): boolean {
    return this._sbEnabled;
  }

  dismissPageChangeViews() {
    for (var i = 0; i < this._views.length; i++) {
      var view = this._views[i];
      if (view.data && view.data.dismissOnPageChange) {
        view.dismiss();
      }
    }
  }

  setViewport(val: ViewContainerRef) {
    this._viewport = val;
  }


  /**
   * @private
   * DEPRECATED: Please use app.getRootNav() instead
   */
  get rootNav(): NavController {
    // deprecated 07-14-2016 beta.11
    console.warn('nav.rootNav() has been deprecated, please use app.getRootNav() instead');
    return this._app.getRootNav();
  }

  /**
   * @private
   * DEPRECATED: Please use inject the overlays controller and use the present method on the instance instead.
   */
  present(): Promise<any> {
    // deprecated warning: added beta.11 2016-06-27
    console.warn('nav.present() has been deprecated.\n' +
                 'Please inject the overlay\'s controller and use the present method on the instance instead.');
    return Promise.resolve();
  }

}

let ctrlIds = -1;

const DISABLE_APP_MINIMUM_DURATION = 64;
const ACTIVE_TRANSITION_MAX_TIME = 5000;