Bug 483634: add scrollX/scrollY getter on nsIDOMWindowUtils that allows avoiding a layout flush, r+sr=roc

This commit is contained in:
Gavin Sharp 2009-03-30 08:19:06 -04:00
Родитель 6f48d7e326
Коммит 4f47062f0c
4 изменённых файлов: 138 добавлений и 1 удалений

Просмотреть файл

@ -47,6 +47,8 @@
#include "nsIFocusController.h"
#include "nsIEventStateManager.h"
#include "nsIScrollableView.h"
#include "nsContentUtils.h"
#include "nsIFrame.h"
@ -569,7 +571,7 @@ nsDOMWindowUtils::ElementFromPoint(PRInt32 aX, PRInt32 aY,
{
nsCOMPtr<nsIDocument> doc(do_QueryInterface(mWindow->GetExtantDocument()));
NS_ENSURE_STATE(doc);
return doc->ElementFromPointHelper(aX, aY, aIgnoreRootScrollFrame, aFlushLayout,
aReturn);
}
@ -731,6 +733,37 @@ nsDOMWindowUtils::SuppressEventHandling(PRBool aSuppress)
} else {
doc->UnsuppressEventHandlingAndFireEvents(PR_TRUE);
}
return NS_OK;
}
NS_IMETHODIMP
nsDOMWindowUtils::GetScrollXY(PRBool aFlushLayout, PRInt32* aScrollX, PRInt32* aScrollY)
{
nsCOMPtr<nsIDocument> doc(do_QueryInterface(mWindow->GetExtantDocument()));
NS_ENSURE_STATE(doc);
if (aFlushLayout) {
doc->FlushPendingNotifications(Flush_Layout);
}
nscoord xPos = 0, yPos = 0;
nsIPresShell *presShell = doc->GetPrimaryShell();
if (presShell) {
nsIViewManager *viewManager = presShell->GetViewManager();
if (viewManager) {
nsIScrollableView *view = nsnull;
viewManager->GetRootScrollableView(&view);
if (view) {
nsresult rv = view->GetScrollPosition(xPos, yPos);
NS_ENSURE_SUCCESS(rv, rv);
}
}
}
*aScrollX = nsPresContext::AppUnitsToIntCSSPixels(xPos);
*aScrollY = nsPresContext::AppUnitsToIntCSSPixels(yPos);
return NS_OK;
}

Просмотреть файл

@ -320,4 +320,12 @@ interface nsIDOMWindowUtils : nsISupports {
* on all windows. Otherwise, enable them.
*/
void disableNonTestMouseEvents(in boolean aDisable);
/**
* Returns the scroll position of the window's currently loaded document.
*
* @param aFlushLayout flushes layout if true. Otherwise, no flush occurs.
* @see nsIDOMWindow::scrollX/Y
*/
void getScrollXY(in boolean aFlushLayout, out long aScrollX, out long aScrollY);
};

Просмотреть файл

@ -48,6 +48,7 @@ _TEST_FILES = test_offsets.html \
test_offsets.xul \
test_offsets.js \
test_domWindowUtils.html \
test_domWindowUtils_scrollXY.html \
$(NULL)
libs:: $(_TEST_FILES)

Просмотреть файл

@ -0,0 +1,95 @@
<!DOCTYPE HTML>
<html>
<head>
<title>nsIDOMWindowUtils::elementFromPoint test</title>
<script type="text/javascript" src="/MochiKit/MochiKit.js"></script>
<script type="text/javascript" src="/tests/SimpleTest/SimpleTest.js"></script>
<link rel="stylesheet" type="text/css" href="/tests/SimpleTest/test.css">
<style>
body {
/* Make room for scrolling */
}
</style>
</head>
<body id="body">
<script type="application/javascript;version=1.8">
/*
void getScrollXY(in boolean aFlushLayout, out long aScrollX, out long aScrollY);
*/
function doTests() {
testScrollXY();
testHiddenIframe();
SimpleTest.finish();
}
function testScrollXY() {
// Enable privileges so we can use nsIDOMWindowUtils interface
netscape.security.PrivilegeManager.enablePrivilege("UniversalXPConnect");
let iframe = document.getElementById("iframe");
let cwindow = iframe.contentWindow;
let domWindowUtils = cwindow.QueryInterface(Components.interfaces.nsIInterfaceRequestor)
.getInterface(Components.interfaces.nsIDOMWindowUtils);
function checkGetScrollXYState(flush, vals, testName) {
let scrollX = {}, scrollY = {};
domWindowUtils.getScrollXY(flush, scrollX, scrollY);
is(scrollX.value, vals[0], "getScrollXY x for test: " + testName);
is(scrollY.value, vals[1], "getScrollXY y for test: " + testName);
}
function checkWindowScrollState(vals, testName) {
is(cwindow.scrollX, vals[0], "scrollX for test: " + testName);
is(cwindow.scrollY, vals[1], "scrollY for test: " + testName);
}
// Check initial state (0, 0)
checkGetScrollXYState(false, [0, 0], "initial getScrollXY state");
checkGetScrollXYState(true, [0, 0], "initial getScrollXY state+flush");
checkWindowScrollState([0, 0], "initial window.scroll* state");
// scroll
cwindow.scrollTo(900, 1000);
checkGetScrollXYState(false, [900, 1000], "after scroll getScrollXY state");
checkGetScrollXYState(true, [900, 1000], "after scroll getScrollXY state+flush");
checkWindowScrollState([900, 1000], "after scroll window.scroll* state");
// ensure flush=false works
cwindow.document.body.style.width = 'auto';
cwindow.document.body.style.height = 'auto';
checkGetScrollXYState(false, [900, 1000], "didn't flush layout for getScrollXY");
checkGetScrollXYState(true, [0, 0], "flushed layout for getScrollXY");
}
function testHiddenIframe() {
let iframe = document.getElementById("hidden-iframe");
let cwindow = iframe.contentWindow;
let domWindowUtils = cwindow.QueryInterface(Components.interfaces.nsIInterfaceRequestor)
.getInterface(Components.interfaces.nsIDOMWindowUtils);
// make sure getScrollXY doesn't throw
let scrollX = {}, scrollY = {};
domWindowUtils.getScrollXY(false, scrollX, scrollY);
is(scrollX.value, 0, "scrollX is zero for display:none iframe");
is(scrollY.value, 0, "scrollY is zero for display:none iframe");
}
SimpleTest.waitForExplicitFinish();
</script>
<!-- can't run this in the test document, since it potentially runs in a
scrolling="no" test harness iframe, and that causes a failure for some
reason -->
<iframe src="data:text/html,<body style='width: 100000px; height: 100000px;'><p>top</p></body>"
id="iframe"
onload="doTests();">
</iframe>
<iframe id="hidden-iframe" style="display: none;"></iframe>
<p id="display"></p>
</body>
</html>