Donate to e Foundation | Murena handsets with /e/OS | Own a part of Murena! Learn more

Commit e3e590be authored by Scott Main's avatar Scott Main Committed by Android Git Automerger
Browse files

am f655dab5: Merge "docs: add script to capture the ctrl+f key event... 

am f655dab5: Merge "docs: add script to capture the ctrl+f key event (initiates \'find\' search on the page) and expand all inherited members." into froyo

Merge commit 'f655dab5' into froyo-plus-aosp

* commit 'f655dab5':
  docs: add script to capture the ctrl+f key event (initiates 'find' search
parents d1d9f048 f655dab5

tools/droiddoc/templates/assets/android-developer-docs.js

+0 −37
Original line number Diff line number Diff line
@@ -434,43 +434,6 @@ function scrollIntoView(nav) { 
  }

}



function toggleAllInherited(linkObj, expand) {

  var a = $(linkObj);

  var table = $(a.parent().parent().parent());

  var expandos = $(".jd-expando-trigger", table);

  if ( (expand == null && a.text() == "[Expand]") || expand ) {

    expandos.each(function(i) {

      toggleInherited(this, true);

    });

    a.text("[Collapse]");

  } else if ( (expand == null && a.text() == "[Collapse]") || (expand == false) ) {

    expandos.each(function(i) {

      toggleInherited(this, false);

    });

    a.text("[Expand]");

  }

  return false;

}



function toggleAllSummaryInherited(linkObj) {

  var a = $(linkObj);

  var content = $(a.parent().parent().parent());

  var toggles = $(".toggle-all", content);

  if (a.text() == "[Expand All]") {

    toggles.each(function(i) {

      toggleAllInherited(this, true);

    });

    a.text("[Collapse All]");

  } else {

    toggles.each(function(i) {

      toggleAllInherited(this, false);

    });

    a.text("[Expand All]");

  }

  return false;

}





function changeTabLang(lang) {

  var nodes = $("#header-tabs").find("."+lang);

  for (i=0; i < nodes.length; i++) { // for each node in this language

tools/droiddoc/templates/assets/android-developer-reference.js

+116 −22
Original line number Diff line number Diff line
@@ -294,3 +294,97 @@ function init_navtree(navtree_id, toroot, root_nodes) 
      });

  }

}



/* TOGGLE INHERITED MEMBERS */



/* Toggle an inherited class (arrow toggle)

 * @param linkObj  The link that was clicked.

 * @param expand  'true' to ensure it's expanded. 'false' to ensure it's closed.

 *                'null' to simply toggle.

 */

function toggleInherited(linkObj, expand) {

    var base = linkObj.getAttribute("id");

    var list = document.getElementById(base + "-list");

    var summary = document.getElementById(base + "-summary");

    var trigger = document.getElementById(base + "-trigger");

    var a = $(linkObj);

    if ( (expand == null && a.hasClass("closed")) || expand ) {

        list.style.display = "none";

        summary.style.display = "block";

        trigger.src = toRoot + "assets/images/triangle-opened.png";

        a.removeClass("closed");

        a.addClass("opened");

    } else if ( (expand == null && a.hasClass("opened")) || (expand == false) ) {

        list.style.display = "block";

        summary.style.display = "none";

        trigger.src = toRoot + "assets/images/triangle-closed.png";

        a.removeClass("opened");

        a.addClass("closed");

    }

    return false;

}



/* Toggle all inherited classes in a single table (e.g. all inherited methods)

 * @param linkObj  The link that was clicked.

 * @param expand  'true' to ensure it's expanded. 'false' to ensure it's closed.

 *                'null' to simply toggle.

 */

function toggleAllInherited(linkObj, expand) {

  var a = $(linkObj);

  var table = $(a.parent().parent().parent()); // ugly way to get table/tbody

  var expandos = $(".jd-expando-trigger", table);

  if ( (expand == null && a.text() == "[Expand]") || expand ) {

    expandos.each(function(i) {

      toggleInherited(this, true);

    });

    a.text("[Collapse]");

  } else if ( (expand == null && a.text() == "[Collapse]") || (expand == false) ) {

    expandos.each(function(i) {

      toggleInherited(this, false);

    });

    a.text("[Expand]");

  }

  return false;

}



/* Toggle all inherited members in the class (link in the class title)

 */

function toggleAllClassInherited() {

  var a = $("#toggleAllClassInherited"); // get toggle link from class title

  var toggles = $(".toggle-all", $("#doc-content"));

  if (a.text() == "[Expand All]") {

    toggles.each(function(i) {

      toggleAllInherited(this, true);

    });

    a.text("[Collapse All]");

  } else {

    toggles.each(function(i) {

      toggleAllInherited(this, false);

    });

    a.text("[Expand All]");

  }

  return false;

}



/* Expand all inherited members in the class. Used when initiating page search */

function ensureAllInheritedExpanded() {

  var toggles = $(".toggle-all", $("#doc-content"));

  toggles.each(function(i) {

    toggleAllInherited(this, true);

  });

  $("#toggleAllClassInherited").text("[Collapse All]");

}





/* HANDLE KEY EVENTS

 * - Listen for Ctrl+F (Cmd on Mac) and expand all inherited members (to aid page search)

 */

var agent = navigator['userAgent'].toLowerCase();

var mac = agent.indexOf("macintosh") != -1;



$(document).keydown( function(e) {

var control = mac ? e.metaKey && !e.ctrlKey : e.ctrlKey; // get ctrl key

  if (control && e.which == 70) {  // 70 is "F"

    ensureAllInheritedExpanded();

  }

});
 
 No newline at end of file

tools/droiddoc/templates/class.cs

+1 −24
Original line number Diff line number Diff line
@@ -3,29 +3,6 @@ 
<html>

<?cs include:"head_tag.cs" ?>

<body class="<?cs var:class.since ?>">

<script type="text/javascript">

function toggleInherited(linkObj, expand) {

    var base = linkObj.getAttribute("id");

    var list = document.getElementById(base + "-list");

    var summary = document.getElementById(base + "-summary");

    var trigger = document.getElementById(base + "-trigger");

    var a = $(linkObj);

    if ( (expand == null && a.hasClass("closed")) || expand ) {

        list.style.display = "none";

        summary.style.display = "block";

        trigger.src = "<?cs var:toroot ?>assets/images/triangle-opened.png";

        a.removeClass("closed");

        a.addClass("opened");

    } else if ( (expand == null && a.hasClass("opened")) || (expand == false) ) {

        list.style.display = "block";

        summary.style.display = "none";

        trigger.src = "<?cs var:toroot ?>assets/images/triangle-closed.png";

        a.removeClass("opened");

        a.addClass("closed");

    }

    return false;

}

</script>

<?cs include:"header.cs" ?>



<div class="g-unit" id="doc-content">
@@ -102,7 +79,7 @@ Summary: 
  <?cs if:linkcount ?>&#124; <?cs /if ?><a href="#inhmethods">Inherited Methods</a>

<?cs /if ?>

<?cs if:inhattrs || inhconstants || inhfields || inhmethods || subcount(class.subclasses.direct) || subcount(class.subclasses.indirect) ?>

&#124; <a href="#" onclick="return toggleAllSummaryInherited(this)">[Expand All]</a>

&#124; <a href="#" onclick="return toggleAllClassInherited()" id="toggleAllClassInherited">[Expand All]</a>

<?cs /if ?>

</div><!-- end sum-details-links -->

<div class="api-level">