/*
Copyright 2002-2003 The Apache Software Foundation
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/
package org.apache.batik.bridge;
import org.w3c.dom.Document;
import org.w3c.dom.Element;
import org.w3c.dom.events.DocumentEvent;
import org.w3c.dom.events.Event;
import org.w3c.dom.events.EventListener;
import org.w3c.dom.events.EventTarget;
import org.w3c.dom.events.MouseEvent;
import org.w3c.dom.events.UIEvent;
/**
* A class that manages focus on elements.
*
* @author <a href="mailto:Thierry.Kormann@sophia.inria.fr">Thierry Kormann</a>
* @version $Id: FocusManager.java,v 1.7 2004/08/18 07:12:31 vhardy Exp $
*/
public class FocusManager {
/**
* The element that has the focus so far.
*/
protected EventTarget lastFocusEventTarget;
/**
* The document.
*/
protected Document document;
/**
* The EventListener that tracks 'mouseclick' events.
*/
protected EventListener mouseclickListener;
/**
* The EventListener that tracks 'DOMFocusIn' events.
*/
protected EventListener domFocusInListener;
/**
* The EventListener that tracks 'DOMFocusOut' events.
*/
protected EventListener domFocusOutListener;
/**
* The EventListener that tracks 'mouseover' events.
*/
protected EventListener mouseoverListener;
/**
* The EventListener that tracks 'mouseout' events.
*/
protected EventListener mouseoutListener;
/**
* Constructs a new <tt>FocusManager</tt> for the specified document.
*
* @param doc the document
*/
public FocusManager(Document doc) {
document = doc;
EventTarget target = (EventTarget)doc;
mouseclickListener = new MouseClickTacker();
target.addEventListener("click", mouseclickListener, true);
mouseoverListener = new MouseOverTacker();
target.addEventListener("mouseover", mouseoverListener, true);
mouseoutListener = new MouseOutTacker();
target.addEventListener("mouseout", mouseoutListener, true);
domFocusInListener = new DOMFocusInTracker();
target.addEventListener("DOMFocusIn", domFocusInListener, true);
domFocusOutListener = new DOMFocusOutTracker();
target.addEventListener("DOMFocusOut", domFocusOutListener, true);
}
/**
* Returns the current element that has the focus or null if any.
*/
public EventTarget getCurrentEventTarget() {
return lastFocusEventTarget;
}
/**
* Removes all listeners attached to the document and that manage focus.
*/
public void dispose() {
if (document == null) return;
EventTarget target = (EventTarget)document;
target.removeEventListener("click", mouseclickListener, true);
target.removeEventListener("mouseover", mouseoverListener, true);
target.removeEventListener("mouseout", mouseoutListener, true);
target.removeEventListener("DOMFocusIn", domFocusInListener, true);
target.removeEventListener("DOMFocusOut", domFocusOutListener, true);
lastFocusEventTarget = null;
document = null;
}
/**
* The class that is responsible for tracking 'mouseclick' changes.
*/
protected class MouseClickTacker implements EventListener {
public void handleEvent(Event evt) {
MouseEvent mevt = (MouseEvent)evt;
fireDOMActivateEvent(evt.getTarget(), mevt.getDetail());
}
}
/**
* The class that is responsible for tracking 'DOMFocusIn' changes.
*/
protected class DOMFocusInTracker implements EventListener {
public void handleEvent(Event evt) {
if (lastFocusEventTarget != null &&
lastFocusEventTarget != evt.getTarget()) {
fireDOMFocusOutEvent(lastFocusEventTarget);
}
lastFocusEventTarget = evt.getTarget();
}
}
/**
* The class that is responsible for tracking 'DOMFocusOut' changes.
*/
protected class DOMFocusOutTracker implements EventListener {
public void handleEvent(Event evt) {
lastFocusEventTarget = null;
}
}
/**
* The class that is responsible to update the focus according to
* 'mouseover' event.
*/
protected class MouseOverTacker implements EventListener {
public void handleEvent(Event evt) {
EventTarget target = evt.getTarget();
fireDOMFocusInEvent(target);
}
}
/**
* The class that is responsible to update the focus according to
* 'mouseout' event.
*/
protected class MouseOutTacker implements EventListener {
public void handleEvent(Event evt) {
EventTarget target = evt.getTarget();
fireDOMFocusOutEvent(target);
}
}
/**
* Fires a 'DOMFocusIn' event to the specified target.
*
* @param target the event target
*/
protected void fireDOMFocusInEvent(EventTarget target) {
DocumentEvent docEvt =
(DocumentEvent)((Element)target).getOwnerDocument();
UIEvent uiEvt = (UIEvent)docEvt.createEvent("UIEvents");
uiEvt.initUIEvent("DOMFocusIn", true, false, null, 0);
target.dispatchEvent(uiEvt);
}
/**
* Fires a 'DOMFocusOut' event to the specified target.
*
* @param target the event target
*/
protected void fireDOMFocusOutEvent(EventTarget target) {
DocumentEvent docEvt =
(DocumentEvent)((Element)target).getOwnerDocument();
UIEvent uiEvt = (UIEvent)docEvt.createEvent("UIEvents");
uiEvt.initUIEvent("DOMFocusOut", true, false, null, 0);
target.dispatchEvent(uiEvt);
}
/**
* Fires a 'DOMActivate' event to the specified target.
*
* @param target the event target
* @param detailArg the detailArg parameter of the event
*/
protected void fireDOMActivateEvent(EventTarget target, int detailArg) {
DocumentEvent docEvt =
(DocumentEvent)((Element)target).getOwnerDocument();
UIEvent uiEvt = (UIEvent)docEvt.createEvent("UIEvents");
uiEvt.initUIEvent("DOMActivate", true, true, null, detailArg);
target.dispatchEvent(uiEvt);
}
}