source: Dev/branches/rest-dojo-ui/client/rft/ui/Breadcrumbs.js @ 340

define([
    'dojo/_base/declare',
    'dojo/_base/array',
    'dijit/form/Button',
    'dojo/dom-class',
    'dojo/topic',
    'dijit/_WidgetBase'
    ], function(declare, baseArray, Button, domClass, topic, _WidgetBase){
        return declare('rft.ui.Breadcrumbs', [_WidgetBase], {
            _crumbs: [],
            
            _last: function(){
                return this._crumbs[this._crumbs.length-1];
            },
            _getIndexOf: function(label) {
                dojo.forEach(this._crumbs, function(crumb, index){
                    if (crumb.label == label) {
                        return index;
                    }
                }, this);
                return -1;
            },
            
            addCrumb: function(label, path) {
                this._crumbs.push({
                    label: label, 
                    path:path
                });
            },
            _removeAfter: function(index) {
                var removals = this._crumbs.slice(index+1);
                this._crumbs = this._crumbs.slice(0, index+1);
                dojo.forEach(removals, function(removal){
                    removal.widget.destroyRecursive(false); // boolean "keepDOMnode"
                }, this);
                this._highlightLast();
            },
            
            _highlightLast: function() {
                domClass.add(this._last().widget, "breadcrumbCurrent");
            },
            _unhighlightLast: function() {
                domClass.remove(this._last(), "breadcrumbCurrent");
            },
            
            _changeTo: function(label, path) {
                // TODO: Differentiate between navigating backwards and sideways/forward!
                var index = baseArray.indexOf({label:label , path:path});
                //var index = this._getIndexOf(label);  // Use this if passing path as an argument is not possible!
                if (index >= 0) this._removeAfter(index);
                this._addCrumb(label, path);
                this._createBreadcrumbs();
            },
            
            _createBreadcrumb: function(label, path) {
                return new Button({
                    baseClass: "breadcrumb",
                    label: label,
                    showlabel: true,
                    iconClass: "dijitNoIcon",
                    onClick: lang.hitch(this, function(){
                        rft.api.loadPage(path);  // TODO: fix this call!
                    })
                });
            },
            _createBreadcrumbs: function() {
                dojo.forEach(this._crumbs, function(crumb, index){
                    if (!crumb.widget) {
                        crumb.widget = this._createBreadcrumb(crumb.label, crumb.path);
                    }
                }, this);
                this._highlightLast();
            },
            startup: function() {
                // TODO: start page crumb creation?
                this._createBreadCrumbs();
                this._setupEvents();
                this.inherited(arguments);
            },
            _setupEvents: function() {
            // TODO: Bind changeTo() listener to an "onLoadPage" event exposed by rft.api!
            topic.subscribe("rft/content/goTo", this._changeTo(label, path));
            }
        });
    });
    
    /*  Breadcrumbs system, which automatically generates styled buttons in the topBar.
     *  Updates are triggered through a "changePage" subscription to "rft/connect/goTo" (method that loads pages in rft.connect.js)
     *
     * Todo: Startup() does not handle initial creation well. No initial breadcrumb is created on page load. What happens when I refresh the page, do all previous crumbs disappear?
     * Todo: Pages should have a label/name besides the path, for display in the breadcrumbs bar. Perhaps the page main title? (Generate this header dynamically?)
     * Todo: Put connect.publish("rft/content/goTo", args); call in rft/content, to trigger breadcrumbs updates
     *      This method uses path and 'args'(?) instead of label and path, change terminology accordingly?
     * Todo: breadcrumbs do not have context yet, unless we can somehow create that context from the path. Split path at "/" char, lookup label/title for each step?
     *      (See before!)
     * 
     */