bool ViewNavigationDelegate::JumpToNearestElement(EA::WebKit::JumpDirection direction, bool scrollIfElementNotFound)
{
// Note by Arpit Baldeva:
// We have a problem here. mpModalInputClient object is supposed to be used for Modal input only however the only class using this object
// is html SELECT element(implemented as a popup). But in reality, html SELECT element is NOT modal. So it is little ill-conceived.
// For example, in all the browsers, if you scroll the mouse wheel on the frame, the SELECT element disappears and the actual frame scrolls.
// For any modal input needs on a web page, the users are advised to use the Z-layer technique with Javascript/CSS - http://jqueryui.com/demos/dialog/#modal-confirmation.
// The problem we want to solve here is have the SELECT element respond to the controller input correctly(select element one by one).
// But the button event information is lost by the time we are in the EA::WebKit::View. For the foreseeable future, there is no candidate
// other than html SELECT element which is implemented as a modal popup inside EAWebKit. So inside EA::WebKit::View, we create a dummy
// button event from the Jump direction and make SELECT respond to it. If any other object starts using the modal input, this would need to be
// revisited. But then, we'll need to solve a plethora of issues. So we do minimum work here to not break other things.
IOverlayInputClient* pOverlayInputClient = mView->GetOverlayInputClient();
bool handledByOverlayInputClient = false;
if(pOverlayInputClient)
{
EA::WebKit::ButtonEvent btnEvent;
switch(direction)
{
/*
case EA::WebKit::JumpLeft:
{
btnEvent.mID = EA::WebKit::kButton0;
handledByOverlayInputClient = pOverlayInputClient->OnButtonEvent(btnEvent);
}
*/
case EA::WebKit::JumpUp:
{
btnEvent.mID = EA::WebKit::kButton1;
handledByOverlayInputClient = pOverlayInputClient->OnButtonEvent(btnEvent);
break;
}
/*
case EA::WebKit::JumpRight:
{
btnEvent.mID = EA::WebKit::kButton2;
handledByOverlayInputClient = pOverlayInputClient->OnButtonEvent(btnEvent);
}
*/
case EA::WebKit::JumpDown:
{
btnEvent.mID = EA::WebKit::kButton3;
handledByOverlayInputClient = pOverlayInputClient->OnButtonEvent(btnEvent);
break;
}
default:
// We don't return and allow any other button press to go to the main View. At the same time, we make the SELECT element lose focus.
{
pOverlayInputClient->OnFocusChangeEvent(false);
break;
}
}
}
if(handledByOverlayInputClient)
return true;
int lastX, lastY;
mView->GetCursorPosition(lastX, lastY);
// Following is a shortcut to drive navigation from a page.
switch (direction)
{
case EA::WebKit::JumpRight:
if (GetFixedString(mCachedNavigationRightId)->compare(""))
{
if (!GetFixedString(mCachedNavigationRightId)->compare("ignore"))
{
return false;
}
if (JumpToId(GetFixedString(mCachedNavigationRightId)->c_str()))
{
return true;
}
}
break;
case EA::WebKit::JumpDown:
if (GetFixedString(mCachedNavigationDownId)->compare(""))
{
if (!GetFixedString(mCachedNavigationDownId)->compare("ignore"))
{
return false;
}
if (JumpToId(GetFixedString(mCachedNavigationDownId)->c_str()))
{
return true;
}
}
break;
case EA::WebKit::JumpLeft:
if (GetFixedString(mCachedNavigationLeftId)->compare(""))
{
if (!GetFixedString(mCachedNavigationLeftId)->compare("ignore"))
{
return false;
}
if (JumpToId(GetFixedString(mCachedNavigationLeftId)->c_str()))
{
return true;
}
}
break;
case EA::WebKit::JumpUp:
if (GetFixedString(mCachedNavigationUpId)->compare(""))
{
if (!GetFixedString(mCachedNavigationUpId)->compare("ignore"))
{
return false;
}
if (JumpToId(GetFixedString(mCachedNavigationUpId)->c_str()))
{
return true;
}
}
break;
default:
EAW_FAIL_MSG("Should not have got here\n");
}
// Iterate over all the frames and find the closest element in any of all the frames.
WebCore::Frame* pFrame = mView->GetFrame();
float currentRadialDistance = FLT_MAX; // A high value to start with so that the max distance between any two elements in the surface is under it.
WebCore::Node* currentBestNode = NULL;
while(pFrame)
{
WebCore::Document* document = pFrame->document();
EAW_ASSERT(document);
if(document)
{
WebCore::FrameView* pFrameView = document->view();
WebCore::IntPoint scrollOffset;
if(pFrameView)
{
scrollOffset.setX(pFrameView->scrollOffset().width());
scrollOffset.setY(pFrameView->scrollOffset().height());
}
// We figure out the start position(It is center of the currently hovered element almost all the time but can be slightly different
// due to scroll sometimes).
mCentreX = lastX + scrollOffset.x();
mCentreY = lastY + scrollOffset.y();
DocumentNavigator navigator(mView, document, direction, WebCore::IntPoint(mCentreX, mCentreY), mBestNodeX, mBestNodeY, mBestNodeWidth, mBestNodeHeight, mJumpNavigationParams.mNavigationTheta, mJumpNavigationParams.mStrictAxesCheck, currentRadialDistance);
navigator.FindBestNode(document);
if(navigator.GetBestNode())
{
currentBestNode = navigator.GetBestNode();
currentRadialDistance = navigator.GetBestNodeRadialDistance();
}
}
pFrame = pFrame->tree()->traverseNext();
}
bool foundSomething = false;
if (currentBestNode) //We found the node to navigate. Move the cursor and we are done.
{
foundSomething = true;
MoveMouseCursorToNode(currentBestNode, false);
}
else if(scrollIfElementNotFound)// Node is not found.
{
// Based on the intended direction of movement, scroll so that some newer elements are visible.
int cursorPosBeforeScrollX, cursorPosBeforeScrollY;
mView->GetCursorPosition(cursorPosBeforeScrollX, cursorPosBeforeScrollY);
switch(direction)
{
case EA::WebKit::JumpDown:
{
ScrollOnJump(true, -120, mJumpNavigationParams.mNumLinesToAutoScroll);
break;
}
case EA::WebKit::JumpUp:
{
ScrollOnJump(true, 120, mJumpNavigationParams.mNumLinesToAutoScroll);
break;
}
case EA::WebKit::JumpRight:
{
ScrollOnJump(false, -120, mJumpNavigationParams.mNumLinesToAutoScroll);
break;
}
case EA::WebKit::JumpLeft:
{
ScrollOnJump(false, 120, mJumpNavigationParams.mNumLinesToAutoScroll);
break;
}
default:
{
EAW_ASSERT_MSG(false, "Should not reach here\n");
}
}
// We move the mouse cursor back to the location where the last best node was found. This is so that we don't end up with the cursor being in no man's land. While that may work
// for ordinary sites, it may not work well with customized pages that leverage CSS to visually indicate current position rather than a cursor graphic.
// We don't call MoveMouseCursorToNode() with last cached node as there are edge cases where we may be holding an invalid node. Using a cached frame and checking against the
// current valid frames safeguards against that.
WebCore::IntSize scrollOffset;
WebCore::Frame* pFrame1 = mView->GetFrame();
while(pFrame1)
{
if(pFrame1 == mBestNodeFrame)//Find the frame where last best node existed.
{
if(pFrame1->view())
{
scrollOffset = pFrame1->view()->scrollOffset();//We read scroll offset here as it could have changed in the switch statement above.
break;
}
}
pFrame1 = pFrame1->tree()->traverseNext();
}
int targetcursorPosAfterScrollX, targetcursorPosAfterScrollY;
targetcursorPosAfterScrollX = mBestNodeX + mBestNodeWidth / 2 - scrollOffset.width();
targetcursorPosAfterScrollY = mBestNodeY + mBestNodeHeight/ 2 - scrollOffset.height();
EA::WebKit::MouseMoveEvent moveEvent;
memset( &moveEvent, 0, sizeof(moveEvent) );
const int cursorInset = 5;// Make cursor stay inside 5 pixels from boundaries. No known issues but added this as a safety measure so that we do not lose cursor ever.
int width = mView->GetSize().mWidth;
int height = mView->GetSize().mHeight;
moveEvent.mX = Clamp( cursorInset, targetcursorPosAfterScrollX, width - cursorInset );
moveEvent.mY = Clamp( cursorInset, targetcursorPosAfterScrollY, height - cursorInset );
mView->OnMouseMoveEvent(moveEvent);
// We intentionally don't call JumpToNearestElement(direction, false) here to avoid recursion. We do it in the overloaded function above.
}
return foundSomething;
}
void ViewNavigationDelegate::MoveMouseCursorToNode(WebCore::Node* node, bool scrollIfNecessary)
{
if (node)
{
WebCore::HTMLElement* element = (WebCore::HTMLElement*)node;
WebCore::IntRect rect = element->getRect();
WebCore::IntPoint frameOffset;
WebCore::IntPoint scrollOffset;
WebCore::FrameView* pFrameView = element->document()->view(); //Can be NULL
if(pFrameView)
{
//Use move here instead of setX/setY as it results in 1 call instead of two and takes advantage that ctor sets x,y to 0.
frameOffset.move(pFrameView->x(), pFrameView->y());
scrollOffset.move(pFrameView->scrollOffset().width(), pFrameView->scrollOffset().height());
}
int width = mView->GetSize().mWidth;
int height = mView->GetSize().mHeight;
// This will be true if this function is called from anywhere except JumpToNearestElement(). This enables us to not lose the cursor during
// arbitrary jumping of elements from either code or webpage using the Navigation APIs.
if(scrollIfNecessary)
{
int cursorX, cursorY;
mView->GetCursorPosition(cursorX, cursorY);
WebCore::IntPoint targetCursorLocation(frameOffset.x()+rect.x()+rect.width()/2 - scrollOffset.x(), frameOffset.y()+rect.y()+rect.height()/2 - scrollOffset.y());
// Added 1 in all the line delta below resulting in a better visual behavior when the element happens to be at the edge.
if(targetCursorLocation.y() > height)
{
float numLinesDelta = (((targetCursorLocation.y() - cursorY)/WebCore::Scrollbar::pixelsPerLineStep())+1);
ScrollOnJump(true, -120, numLinesDelta);
}
if(targetCursorLocation.y()< 0.0f)
{
float numLinesDelta = (((cursorY - targetCursorLocation.y())/WebCore::Scrollbar::pixelsPerLineStep())+1);
ScrollOnJump(true, 120, numLinesDelta);
}
if(targetCursorLocation.x() > width)
{
float numLinesDelta = (((targetCursorLocation.x() - cursorX)/WebCore::Scrollbar::pixelsPerLineStep())+1);
ScrollOnJump(false, -120, numLinesDelta);
}
if(targetCursorLocation.x()< 0.0f)
{
float numLinesDelta = (((cursorX - targetCursorLocation.x())/WebCore::Scrollbar::pixelsPerLineStep())+1);
ScrollOnJump(false, 120, numLinesDelta);
}
// Read the scroll offset again as it may have changed.
if(pFrameView)
{
scrollOffset.setX(pFrameView->scrollOffset().width());
scrollOffset.setY(pFrameView->scrollOffset().height());
}
}
mBestNodeFrame = element->document()->frame(); //Can be NULL
mBestNodeX = frameOffset.x() + rect.x();
mBestNodeY = frameOffset.y() + rect.y();
mBestNodeWidth = rect.width();
mBestNodeHeight = rect.height();
int lastX, lastY;
mView->GetCursorPosition(lastX, lastY);
int newX = mBestNodeX + rect.width()/2 - scrollOffset.x();
int newY = mBestNodeY + rect.height()/2 - scrollOffset.y();
EA::WebKit::MouseMoveEvent moveEvent;
memset( &moveEvent, 0, sizeof(moveEvent) );
const int cursorInset = 5;// Make cursor stay inside 5 pixels from boundaries. No known issues but added this as a safety measure so that we do not lose cursor ever.
moveEvent.mX = Clamp( cursorInset, newX, width - cursorInset );
moveEvent.mY = Clamp( cursorInset, newY, height - cursorInset );
mView->OnMouseMoveEvent( moveEvent );
if(EAWebKitClient* const pClient = GetEAWebKitClient())
{
CursorMovedInfo cmInfo(mView, mView->GetUserData(), moveEvent.mX, moveEvent.mY);
pClient->CursorMoved(cmInfo);
}
UpdateCachedHints(node);
}
}