Moobile.ViewControllerStack

Extends Moobile.ViewController

Provides a controller for managing a stack of controllers with methods to move from one view controller to another using a transition.

Initialization

Syntax:

var viewControllerStack = new Moobile.ViewControllerStack([options], [name]);

Parameters:

Name	Type	Description
options Optional	Object	The view controller stack’s options.
name Optional	String	The view controller stack’s name.

Example:

File at /templates/home-view.html:

<div class="home-view">
    <h2>Tap the button</h2>
    <div data-role="button" data-name="moo-button">Moo</div>
</div>

File at /templates/moo-view.html:

<div class="moo-view">
    <div data-role="button" data-name="back-button">Back</div>
</div>

The view controller:

var HomeViewController = new Class({

    Extends: Moobile.ViewController,

    mooButton: null,

    loadView: function() {
        this.view = Moobile.View.at('/templates/home-view.html');
    },

    viewDidLoad: function() {
        this.mooButton = this.view.getChildComponent('moo-button');
        this.mooButton.addEvent('tap', this.bound('onMooButtonTap'));
    },

    destroy: function() {
        this.mooButton.removeEvent('tap', this.bound('onMooButtonTap'));
        this.mooButton = null;
        this.parent();
    },

    onTapMeButtonTap: function(e, sender) {
        this.getViewControllerStack().pushViewController(new MooViewController(), new Moobile.ViewTransition.Slide); // shows MooViewController using a sliding transition
    }
});

var MooViewController = new Class({

    Extends: Moobile.ViewController,

    backButton: null,

    loadView: function() {
        this.view = Moobile.View.at('/templates/moo-view.html');
    },

    viewDidLoad: function() {
        this.backButton = this.view.getChildComponent('back-button');
        this.backButton.addEvent('tap', this.bound('onBackButtonTap'));
    },

    destroy: function() {
        this.backButton.removeEvent('tap', this.bound('onBackButtonTap'));
        this.backButton = null;
        this.parent();
    },

    onTapMeButtonTap: function(e, sender) {
        this.getParentViewController().popViewController(); // removes this view controller using the same slide transition
    }

});

var viewControllerStack = new Moobile.ViewControllerStack();
viewControllerStack.pushViewController(new HomeViewController); // shows HomeViewController without transitions

Methods

pushViewController(viewController, viewTransition)

Pushes a view controller at the end of the stack and present it using a specified view transition. The specified transition will be used automatically when the view controller will pop.

Parameters:

Name	Type	Description
viewController	Moobile.ViewController	The view controller.
viewTransition	Moobile.ViewTransition	The view transition.

Returns:

• Moobile.ViewControllerStack This Moobile.ViewControllerStack instance.

Example:

var viewControllerStack = new Moobile.ViewControllerStack();
viewControllerStack.pushViewController(new Moobile.ViewController, new Moobile.ViewTransition.Cubic); // shows a new view controller using a cubic transition

---

popViewController()

Removes the top view controller using the same view transition that was used to push it and destroy it.

Returns:

• Moobile.ViewControllerStack This Moobile.ViewControllerStack instance.

Example:

var viewControllerStack = new Moobile.ViewControllerStack();
viewControllerStack.pushViewController(new Moobile.ViewController, new Moobile.ViewTransition.Cubic);
viewControllerStack.popViewController(); // removes MoobileViewController using the cubic transition

---

popViewControllerUntil(viewController)

Pops view controllers until a specified view controller is reached.

Parameters:

Name	Type	Description
viewController	Moobile.ViewController	The view controller to pop to.

Returns:

• Moobile.ViewControllerStack This Moobile.ViewControllerStack instance.

Example:

var viewControllerStack = new Moobile.ViewControllerStack();
var viewControllerOne = new Moobile.ViewController();
var viewControllerTwo = new Moobile.ViewController();
var viewControllerThree = new Moobile.ViewController();
viewControllerStack.pushViewController(viewControllerOne);
viewControllerStack.pushViewController(viewControllerTwo);
viewControllerStack.pushViewController(viewControllerThree);
viewControllerStack.popViewControllerUntil(viewControllerOne); // removes viewControllerThree and viewControllerThree

---

getTopViewController()

Returns the current view controller.

Returns:

• Moobile.ViewController This Moobile.ViewControllerStack instance.

Example:

var viewControllerStack = new Moobile.ViewControllerStack();
var viewControllerOne = new Moobile.ViewController();
var viewControllerTwo = new Moobile.ViewController();
viewControllerStack.pushViewController(viewControllerOne);
viewControllerStack.pushViewController(viewControllerTwo);
viewControllerStack.getTopViewController(); // returns viewControllerTwo

---

willPushViewController(viewController)

Tells this view controller it’s about to push a view controller.

Parameters:

Name	Type	Description
viewController	Moobile.ViewController	The view controller to be pushed.

---

didPushViewController(viewController)

Tells the view controller it pushed a view controller.

Override this method to provide your own implementation.

Parameters:

Name	Type	Description
viewController	Moobile.ViewController	The pushed view controller.

---

willPopViewController(viewController)

Tells the view controller it’s about to pop a view controller.

Override this method to provide your own implementation.

Parameters:

Name	Type	Description
viewController	Moobile.ViewController	The view controller to be popped.

---

didPopViewController(viewController)

Tells the view controller it popped a view controller.

Override this method to provide your own implementation.

Parameters:

Name	Type	Description
viewController	Moobile.ViewController	The popped view controller.

Other

These methods are added to the Moobile.ViewController class:

setViewControllerStack(viewControllerStack)

Sets the view controller stack. You should rarely use this method as the Moobile.ViewController class handles it.

Parameters:

Name	Type	Description
viewControllerStack	Moobile.ViewControllerStack	The view controller stack.

Returns:

• Moobile.ViewController This Moobile.ViewController instance.

---

getViewControllerStack()

Returns the view controller stack that contains this view controller.

Returns:

• Moobile.ViewControllerStack The view controller stack or null if this view controller is not within the hierarchy of a view controller stack.

---

parentViewControllerStackWillChange(viewController)

Tells this view controller its parent view controller stack is about to change. Override this method to provide your own implementation.

Parameters:

Name	Type	Description
viewController	Moobile.ViewController	This view controller’s parent view controller.

---

parentViewControllerStackDidChange(viewController)

Tells this view controller its parent view controller stack has changed. Override this method to provide your own implementation.

Parameters:

Name	Type	Description
viewController	Moobile.ViewController	This view controller’s parent view controller.