header.js - Ubuntu HTML5 API

# Ubuntu HTML5 API: header.js

API Docs for: HTML-14.04-dev~bzr202

#### header.js

    /*
     * Copyright (C) 2013 Adnane Belmadiaf <daker@ubuntu.com>
     * License granted by Canonical Limited
     *
     * This file is part of ubuntu-html5-ui-toolkit.
     *
     * This package is free software; you can redistribute it and/or modify
     * it under the terms of the GNU Lesser General Public License as
     * published by the Free Software Foundation; either version 3 of the
     * License, or
     * (at your option) any later version.

     * This package is distributed in the hope that it will be useful,
     * but WITHOUT ANY WARRANTY; without even the implied warranty of
     * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
     * GNU General Public License for more details.

     * You should have received a copy of the GNU Lesser General Public
     * License along with this program. If not, see
     * <http://www.gnu.org/licenses/>.
     */

    /**
     * An Ubuntu Header wraps the general Tabs definitions and interaction in the case of a Tab
       navigation pattern or is used to display the title of the current page when using a PageStack navigation pattern.

    In the case of a Tab navigation pattern, declare the Header and its Tabs in HTML as a direct child
    of the top level MainView as a sibling to the <em>content</em> div.

    In the case of a PageStack navigation pattern, the Ubuntu Header HTML element should be present
    and can be left empty. It will be automatically updated to hold the Title of the current Page being
    visited. The value of such a title is taken from the data-title attribute of the currently visited
    Page as it is being pushed at the top of the stack (see PageStack.push()).

    ######Contained list provides Page navigation
    A contained unordered list has list items, each of which has "data-page" data attribute whose value of a Page ID that it targets. Clicking the Header/Tabs allows the user to navigate to the Pages identified by these IDs.

     * @class Header
     * @constructor
     * @namespace UbuntuUI
     * @example
          <body>
            <div data-role="mainview">

              <header data-role="header" id="headerID">
                <ul data-role="tabs">
                  <li data-role="tabitem" data-page="main">Main</li>
                  <li data-role="tabitem" data-page="two">Two</li>
                </ul>
              </header>

              <div data-role="content">
                <div data-role="tab" id="main">
                    [...]
                </div>
                <div data-role="tab" id="two">
                    [...]
                </div>
              </div>

            </div>
          </body>

          JavaScript access:
          var header = UI.header("headerID");
     */
    var Header= function (id) {
        this.id =  id;
    };

    Header.prototype = {
        /**
         * Returns the DOM element associated with the id this widget is bind to.
         * @method element
         * @return {DOMElement}
         * @example
            var myheader = UI.header("headerid").element();
         */
        element: function () {
            return document.getElementById(this.id);
        }
    };