dom-ui settings: Enable searching for sub-pages...

chrome/browser/resources/options/options_page.js

 // Copyright (c) 2010 The Chromium Authors. All rights reserved.
 // Use of this source code is governed by a BSD-style license that can be
 // found in the LICENSE file.
 
 cr.define('options', function() {
   /////////////////////////////////////////////////////////////////////////////
   // OptionsPage class:
 
   /**
    * Base class for options page.
@@ skipping 30 matching lines @@
    * @private
    */
   OptionsPage.initialized_ = false;
 
   /**
    * Shows a registered page. This handles both top-level pages and sub-pages.
    * @param {string} pageName Page name.
    */
   OptionsPage.showPageByName = function(pageName) {
     var targetPage = this.registeredPages[pageName];
+
+    // Determine if the current top-level page is 'sticky', meaning that it
+    // shouldn't change when showing a sub-page.  This can happen for special
+    // pages like Search.
+    var topPage = this.getTopmostVisiblePage();
+    var isTopPageLocked = (topPage && topPage.sticky && targetPage.parentPage);
+
     // Notify pages if they will be hidden.
     for (var name in this.registeredPages) {
       var page = this.registeredPages[name];
+      if (!page.parentPage && isTopPageLocked)
+        continue;
       if (page.willHidePage && name != pageName &&
           !page.isAncestorOfPage(targetPage))
         page.willHidePage();
     }
 
     // Update visibilities to show only the hierarchy of the target page.
     for (var name in this.registeredPages) {
       var page = this.registeredPages[name];
+      if (!page.parentPage && isTopPageLocked)
+        continue;
       page.visible = name == pageName ||
           (document.documentElement.getAttribute('hide-menu') != 'true' &&
            page.isAncestorOfPage(targetPage));
     }
 
     // Notify pages if they were shown.
     for (var name in this.registeredPages) {
       var page = this.registeredPages[name];
-      if (name == pageName && page.didShowPage)
+      if (!page.parentPage && isTopPageLocked)
+        continue;
+      if (page.didShowPage && (name == pageName ||
+          page.isAncestorOfPage(targetPage)))
         page.didShowPage();
     }
   };
 
   /**
    * Called on load. Dispatch the URL hash to the given page's handleHash
    * function.
    * @param {string} pageName The string name of the (registered) options page.
    * @param {string} hash The value of the hash component of the URL.
    */
@@ skipping 127 matching lines @@
         OptionsPage.showPageByName(this.getAttribute('pageName'));
       }
     };
     var navbar = $('navbar');
     navbar.appendChild(pageNav);
     page.tab = pageNav;
     page.initializePage();
   };
 
   /**
+   * Fine an enclosing section for an element if it exists.
+   * @param {Element} element Element to search.
+   * @return {OptionPage} The section element, or null.
+   * @private
+   */
+  OptionsPage.findSectionForNode_ = function(node) {
+    while (node = node.parentNode) {
+      if (node.nodeType == document.ELEMENT_NODE &&
+          node.nodeName.toLowerCase() == 'section')
+        return node;
+    }
+    return null;
+  };
+
+  /**
    * Registers a new Sub tab page.
    * @param {OptionsPage} page Page to register.

[James Hawkins, 2010/12/23 01:16:29]

s/page/subPage/

[csilv, 2010/12/23 02:59:46]

Done.

+   * @param {OptionsPage} parentPage Parent page to register.

[James Hawkins, 2010/12/23 01:16:29]

'Parent page to register' ? Seems like 'Associated parent page' is more along
the correct lines.

[csilv, 2010/12/23 02:59:46]

Done.

+   * @param {Array} associatedControls Array of control elements associated with

[James Hawkins, 2010/12/23 01:16:29]

Hmm, from just reading this description, I have no idea what this third
parameter actually means/does.

[csilv, 2010/12/23 02:59:46]

Tweaked the wording, PTAL.

+   *   this page.
    */
-  OptionsPage.registerSubPage = function(subPage, parentPage) {
+  OptionsPage.registerSubPage = function(subPage,
+                                         parentPage,
+                                         associatedControls) {
     this.registeredPages[subPage.name] = subPage;
     subPage.parentPage = parentPage;
+    subPage.associatedControls = associatedControls;
+    if (associatedControls && associatedControls.length) {
+      subPage.associatedSection =
+          this.findSectionForNode_(associatedControls[0]);
+    }
     subPage.tab = undefined;
     subPage.initializePage();
   };
 
   /**
    * Registers a new Overlay page.
    * @param {OptionsPage} page Page to register, must be a class derived from
-   * OptionsPage.
+   * @param {Array} associatedControls Array of control elements associated with
+   *   this page.
    */
-  OptionsPage.registerOverlay = function(page) {
+  OptionsPage.registerOverlay = function(page,
+                                         associatedControls) {
     this.registeredOverlayPages[page.name] = page;
+    page.associatedControls = associatedControls;
+    if (associatedControls && associatedControls.length) {
+      page.associatedSection = this.findSectionForNode_(associatedControls[0]);
+    }
     page.tab = undefined;
     page.isOverlay = true;
     page.initializePage();
   };
 
   /**
    * Callback for window.onpopstate.
    * @param {Object} data State data pushed into history.
    */
   OptionsPage.setState = function(data) {
@@ skipping 69 matching lines @@
   OptionsPage.prototype = {
     __proto__: cr.EventTarget.prototype,
 
     /**
      * The parent page of this option page, or null for top-level pages.
      * @type {OptionsPage}
      */
     parentPage: null,
 
     /**
+     * The section on the parent page that is associated with this page.
+     * Can be null.
+     * @type {Element}
+     */
+    associatedSection: null,
+
+    /**
+     * An array of controls that are associated with this page.  The first
+     * control should be located on a top-level page.
+     * @type {OptionsPage}
+     */
+    associatedControls: null,
+
+    /**
      * Initializes page content.
      */
     initializePage: function() {},
 
     /**
      * Sets managed banner visibility state.
      */
     setManagedBannerVisibility: function(visible) {
       this.managed = visible;
       if (this.visible) {
@@ skipping 79 matching lines @@
       var level = 0;
       var parent = this.parentPage;
       while (parent) {
         level++;
         parent = parent.parentPage;
       }
       return level;
     },
 
     /**
+     * Checks whether the page is considered 'sticky', such that it will
+     * remain a top-level page even if sub-pages change.
+     * @return {boolean} True if this page is sticky.
+     */
+    get sticky() {
+      return false;
+    },
+
+    /**
      * Checks whether this page is an ancestor of the given page in terms of
      * subpage nesting.
      * @param {OptionsPage} page
      * @return {boolean} True if this page is nested under |page|
      */
     isAncestorOfPage: function(page) {
       var parent = page.parentPage;
       while (parent) {
         if (parent == this)
           return true;
@@ skipping 13 matching lines @@
       OptionsPage.showOverlay(hash);
     },
   };
 
   // Export
   return {
     OptionsPage: OptionsPage
   };
 
 });