org.apache.batik.gvt.event.AWTEventDispatcher Maven / Gradle / Ivy
/*
Licensed to the Apache Software Foundation (ASF) under one or more
contributor license agreements. See the NOTICE file distributed with
this work for additional information regarding copyright ownership.
The ASF licenses this file to You 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.gvt.event;
import java.awt.Point;
import java.awt.Toolkit;
import java.awt.event.InputEvent;
import java.awt.event.KeyEvent;
import java.awt.event.KeyListener;
import java.awt.event.MouseEvent;
import java.awt.event.MouseListener;
import java.awt.event.MouseWheelEvent;
import java.awt.event.MouseWheelListener;
import java.awt.event.MouseMotionListener;
import java.awt.geom.AffineTransform;
import java.awt.geom.NoninvertibleTransformException;
import java.awt.geom.Point2D;
import java.lang.reflect.Array;
import java.util.EventListener;
import java.util.EventObject;
import java.util.LinkedList;
import java.util.List;
import javax.swing.event.EventListenerList;
import org.apache.batik.gvt.GraphicsNode;
/**
* An EventDispatcher implementation based on AWT events.
*
* Mouse events are dispatched to their "containing" node (the
* GraphicsNode corresponding to the mouse event coordinate). Searches
* for containment are performed from the EventDispatcher's "root"
* node.
*
* @author Bill Haneman
* @author Christophe Jolif
* @author Thierry Kormann
* @version $Id: AWTEventDispatcher.java 1831615 2018-05-15 09:50:53Z ssteiner $
*/
public class AWTEventDispatcher
implements EventDispatcher,
MouseListener,
MouseMotionListener,
MouseWheelListener,
KeyListener {
/**
* The root GraphicsNode as determined by setRootNode().
*/
protected GraphicsNode root;
/**
* The base AffineTransform for InputEvent-to-GraphicsNodeEvent
* coordinates as determined by setBaseTransform().
*/
protected AffineTransform baseTransform;
/**
* The global listener list.
*/
protected EventListenerList glisteners;
/**
* The lastest node which has been targeted by an event.
*/
protected GraphicsNode lastHit;
/**
* The current GraphicsNode targeted by an key events.
*/
protected GraphicsNode currentKeyEventTarget;
/**
* These are used to queue events while a rendering event
* is in progress.
*/
protected List eventQueue = new LinkedList();
protected boolean eventDispatchEnabled = true;
protected int eventQueueMaxSize = MAX_QUEUE_SIZE;
/**
* default max size of the event queue.
*/
static final int MAX_QUEUE_SIZE = 10;
private int nodeIncrementEventID = KeyEvent.KEY_PRESSED;
private int nodeIncrementEventCode = KeyEvent.VK_TAB;
private int nodeIncrementEventModifiers = 0;
private int nodeDecrementEventID = KeyEvent.KEY_PRESSED;
private int nodeDecrementEventCode = KeyEvent.VK_TAB;
private int nodeDecrementEventModifiers = InputEvent.SHIFT_DOWN_MASK;
/**
* Constructs a new event dispatcher.
*/
public AWTEventDispatcher() {
}
/**
* Sets the root node for MouseEvent dispatch containment searches
* and field selections.
* @param root the root node
*/
public void setRootNode(GraphicsNode root) {
if (this.root != root)
eventQueue.clear(); // new root so clear 'old' events.
this.root = root;
}
/**
* Returns the root node for MouseEvent dispatch containment
* searches and field selections.
*/
public GraphicsNode getRootNode() {
return root;
}
/**
* Sets the base transform applied to MouseEvent coordinates prior
* to dispatch.
* @param t the affine transform
*/
public void setBaseTransform(AffineTransform t) {
if ((baseTransform != t) &&
((baseTransform == null) || (!baseTransform.equals(t))))
// new Display transform so events are not where user
// thinks they were.
eventQueue.clear();
baseTransform = t;
}
/**
* Returns the base transform applied to MouseEvent coordinates prior
* to dispatch.
*/
public AffineTransform getBaseTransform() {
return new AffineTransform(baseTransform);
}
//
// AWT listeners wrapper
//
/**
* Dispatches the specified AWT mouse event down to the GVT tree.
* The mouse event is mutated to a GraphicsNodeMouseEvent.
* @param evt the mouse event to propagate
*/
public void mousePressed(MouseEvent evt) {
dispatchEvent(evt);
}
/**
* Dispatches the specified AWT mouse event down to the GVT tree.
* The mouse event is mutated to a GraphicsNodeMouseEvent.
* @param evt the mouse event to propagate
*/
public void mouseReleased(MouseEvent evt) {
dispatchEvent(evt);
}
/**
* Dispatches the specified AWT mouse event down to the GVT tree.
* The mouse event is mutated to a GraphicsNodeMouseEvent.
* @param evt the mouse event to propagate
*/
public void mouseEntered(MouseEvent evt) {
dispatchEvent(evt);
}
/**
* Dispatches the specified AWT mouse event down to the GVT tree.
* The mouse event is mutated to a GraphicsNodeMouseEvent.
* @param evt the mouse event to propagate
*/
public void mouseExited(MouseEvent evt) {
dispatchEvent(evt);
}
/**
* Dispatches the specified AWT mouse event down to the GVT tree.
* The mouse event is mutated to a GraphicsNodeMouseEvent.
* @param evt the mouse event to propagate
*/
public void mouseClicked(MouseEvent evt) {
dispatchEvent(evt);
}
/**
* Dispatches the specified AWT mouse event down to the GVT tree.
* The mouse event is mutated to a GraphicsNodeMouseEvent.
* @param evt the mouse event to propagate
*/
public void mouseMoved(MouseEvent evt) {
dispatchEvent(evt);
}
/**
* Dispatches the specified AWT mouse event down to the GVT tree.
* The mouse event is mutated to a GraphicsNodeMouseEvent.
* @param evt the mouse event to propagate
*/
public void mouseDragged(MouseEvent evt) {
dispatchEvent(evt);
}
/**
* Dispatches the specified AWT mouse wheel event down to the GVT tree.
* The mouse wheel event is mutated to a GraphicsNodeMouseWheelEvent.
* @param evt the mouse event to propagate
*/
public void mouseWheelMoved(MouseWheelEvent evt) {
dispatchEvent(evt);
}
/**
* Dispatches the specified AWT key event down to the GVT tree.
* The mouse event is mutated to a GraphicsNodeKeyEvent.
* @param evt the key event to propagate
*/
public void keyPressed(KeyEvent evt) {
dispatchEvent(evt);
}
/**
* Dispatches the specified AWT key event down to the GVT tree.
* The mouse event is mutated to a GraphicsNodeKeyEvent.
* @param evt the key event to propagate
*/
public void keyReleased(KeyEvent evt) {
dispatchEvent(evt);
}
/**
* Dispatches the specified AWT key event down to the GVT tree.
* The mouse event is mutated to a GraphicsNodeKeyEvent.
* @param evt the key event to propagate
*/
public void keyTyped(KeyEvent evt) {
dispatchEvent(evt);
}
//
// Global GVT listeners support
//
/**
* Adds the specified 'global' GraphicsNodeMouseListener which is
* notified of all MouseEvents dispatched.
* @param l the listener to add
*/
public void addGraphicsNodeMouseListener(GraphicsNodeMouseListener l) {
if (glisteners == null) {
glisteners = new EventListenerList();
}
glisteners.add(GraphicsNodeMouseListener.class, l);
}
/**
* Removes the specified 'global' GraphicsNodeMouseListener which is
* notified of all MouseEvents dispatched.
* @param l the listener to remove
*/
public void removeGraphicsNodeMouseListener(GraphicsNodeMouseListener l) {
if (glisteners != null) {
glisteners.remove(GraphicsNodeMouseListener.class, l);
}
}
/**
* Adds the specified 'global' GraphicsNodeMouseWheelListener which is
* notified of all MouseWheelEvents dispatched.
* @param l the listener to add
*/
public void addGraphicsNodeMouseWheelListener
(GraphicsNodeMouseWheelListener l) {
if (glisteners == null) {
glisteners = new EventListenerList();
}
glisteners.add(GraphicsNodeMouseWheelListener.class, l);
}
/**
* Removes the specified 'global' GraphicsNodeMouseWheelListener which is
* notified of all MouseWheelEvents dispatched.
* @param l the listener to remove
*/
public void removeGraphicsNodeMouseWheelListener
(GraphicsNodeMouseWheelListener l) {
if (glisteners != null) {
glisteners.remove(GraphicsNodeMouseWheelListener.class, l);
}
}
/**
* Adds the specified 'global' GraphicsNodeKeyListener which is
* notified of all KeyEvents dispatched.
* @param l the listener to add
*/
public void addGraphicsNodeKeyListener(GraphicsNodeKeyListener l) {
if (glisteners == null) {
glisteners = new EventListenerList();
}
glisteners.add(GraphicsNodeKeyListener.class, l);
}
/**
* Removes the specified 'global' GraphicsNodeKeyListener which is
* notified of all KeyEvents dispatched.
* @param l the listener to remove
*/
public void removeGraphicsNodeKeyListener(GraphicsNodeKeyListener l) {
if (glisteners != null) {
glisteners.remove(GraphicsNodeKeyListener.class, l);
}
}
/**
* Returns an array of listeners that were added to this event
* dispatcher and of the specified type.
* @param listenerType the type of the listeners to return
*/
public EventListener [] getListeners(Class listenerType) {
// TODO the listeners should be cached per class in a map.
// this list is build again and again in mouse-event-handling...
// note: the cache must be flushed when the gListeners is modified
Object array =
Array.newInstance(listenerType,
glisteners.getListenerCount(listenerType));
Object[] pairElements = glisteners.getListenerList();
for (int i = 0, j = 0;i < pairElements.length-1; i+=2) {
if (pairElements[i].equals(listenerType)) {
Array.set(array, j, pairElements[i+1]);
++j;
}
}
return (EventListener[]) array;
}
//
// Event dispatch implementation
//
public void setEventDispatchEnabled(boolean b) {
eventDispatchEnabled = b;
if (eventDispatchEnabled) {
// Dispatch any queued events.
while (eventQueue.size() > 0) {
EventObject evt = (EventObject)eventQueue.remove(0);
dispatchEvent(evt);
}
}
}
public void setEventQueueMaxSize(int n) {
eventQueueMaxSize = n;
if (n == 0) eventQueue.clear();
// the current size is larger than the new size: shrink
while(eventQueue.size() > eventQueueMaxSize)
eventQueue.remove(0);
}
/**
* Dispatches the specified AWT event.
* @param evt the event to dispatch
*/
public void dispatchEvent(EventObject evt) {
if (root == null) // No root do not store anything.
return;
if (!eventDispatchEnabled) {
if (eventQueueMaxSize > 0) {
eventQueue.add(evt);
while (eventQueue.size() > eventQueueMaxSize)
// Limit how many events we queue - don't want
// user waiting forever for them to clear.
eventQueue.remove(0);
}
return;
}
if (evt instanceof MouseWheelEvent) {
dispatchMouseWheelEvent((MouseWheelEvent) evt);
} else if (evt instanceof MouseEvent) {
dispatchMouseEvent((MouseEvent) evt);
} else if (evt instanceof KeyEvent) {
InputEvent e = (InputEvent)evt;
if (isNodeIncrementEvent(e)) {
incrementKeyTarget();
} else if (isNodeDecrementEvent(e)) {
decrementKeyTarget();
} else {
dispatchKeyEvent((KeyEvent) evt);
}
}
}
/**
* Returns a bitmask representing the state of the key locks.
*/
protected int getCurrentLockState() {
Toolkit t = Toolkit.getDefaultToolkit();
int lockState = 0;
try {
if (t.getLockingKeyState(KeyEvent.VK_KANA_LOCK)) {
lockState++;
}
} catch (UnsupportedOperationException ex) {
}
lockState <<= 1;
try {
if (t.getLockingKeyState(KeyEvent.VK_SCROLL_LOCK)) {
lockState++;
}
} catch (UnsupportedOperationException ex) {
}
lockState <<= 1;
try {
if (t.getLockingKeyState(KeyEvent.VK_NUM_LOCK)) {
lockState++;
}
} catch (UnsupportedOperationException ex) {
}
lockState <<= 1;
try {
if (t.getLockingKeyState(KeyEvent.VK_CAPS_LOCK)) {
lockState++;
}
} catch (UnsupportedOperationException ex) {
}
return lockState;
}
/**
* Dispatches the specified AWT key event.
* @param evt the key event to dispatch
*/
protected void dispatchKeyEvent(KeyEvent evt) {
currentKeyEventTarget = lastHit;
GraphicsNode target =
currentKeyEventTarget == null ? root : currentKeyEventTarget;
processKeyEvent
(new GraphicsNodeKeyEvent(target,
evt.getID(),
evt.getWhen(),
evt.getModifiersEx(),
getCurrentLockState(),
evt.getKeyCode(),
evt.getKeyChar(),
evt.getKeyLocation()));
}
/**
* Dispatches the specified AWT mouse event.
* @param evt the mouse event to dispatch
*/
protected void dispatchMouseEvent(MouseEvent evt) {
GraphicsNodeMouseEvent gvtevt;
Point2D p = new Point2D.Float(evt.getX(), evt.getY());
Point2D gnp = p;
if (baseTransform != null) {
gnp = baseTransform.transform(p, null);
}
GraphicsNode node = root.nodeHitAt(gnp);
if (node != null) {
try {
node.getGlobalTransform().createInverse().transform(gnp, gnp);
} catch (NoninvertibleTransformException ex) {
}
}
// If the receiving node has changed, send a notification
// check if we enter a new node
Point screenPos;
if (!evt.getComponent().isShowing()) {
screenPos = new Point(0,0);
} else {
screenPos = evt.getComponent().getLocationOnScreen();
screenPos.x += evt.getX();
screenPos.y += evt.getY();
}
int currentLockState = getCurrentLockState();
if (lastHit != node) {
// post a MOUSE_EXITED event
if (lastHit != null) {
gvtevt = new GraphicsNodeMouseEvent(lastHit,
MouseEvent.
MOUSE_EXITED,
evt.getWhen(),
evt.getModifiersEx(),
currentLockState,
evt.getButton(),
(float)gnp.getX(),
(float)gnp.getY(),
(int)Math.floor(p.getX()), // evt.getX() ??
(int)Math.floor(p.getY()), // evt.getY() ??
screenPos.x,
screenPos.y,
evt.getClickCount(),
node);
processMouseEvent(gvtevt);
// lastHit.processMouseEvent(gvtevt);
}
// post a MOUSE_ENTERED event
if (node != null) {
gvtevt = new GraphicsNodeMouseEvent(node,
MouseEvent.
MOUSE_ENTERED,
evt.getWhen(),
evt.getModifiersEx(),
currentLockState,
evt.getButton(),
(float)gnp.getX(),
(float)gnp.getY(),
(int)Math.floor(p.getX()),
(int)Math.floor(p.getY()),
screenPos.x,
screenPos.y,
evt.getClickCount(),
lastHit);
processMouseEvent(gvtevt);
// node.processMouseEvent(gvtevt);
}
}
// In all cases, dispatch the original event
if (node != null) {
gvtevt = new GraphicsNodeMouseEvent(node,
evt.getID(),
evt.getWhen(),
evt.getModifiersEx(),
currentLockState,
evt.getButton(),
(float)gnp.getX(),
(float)gnp.getY(),
(int)Math.floor(p.getX()),
(int)Math.floor(p.getY()),
screenPos.x,
screenPos.y,
evt.getClickCount(),
null);
// node.processMouseEvent(gvtevt);
processMouseEvent(gvtevt);
} else {
// this is a deselect event, dispatch it to the root
gvtevt = new GraphicsNodeMouseEvent(root,
evt.getID(),
evt.getWhen(),
evt.getModifiersEx(),
currentLockState,
evt.getButton(),
(float)gnp.getX(),
(float)gnp.getY(),
(int)Math.floor(p.getX()),
(int)Math.floor(p.getY()),
screenPos.x,
screenPos.y,
evt.getClickCount(),
null);
processMouseEvent(gvtevt);
}
lastHit = node;
}
/**
* Dispatches the specified AWT mouse wheel event.
* @param evt the mouse wheel event to dispatch
*/
protected void dispatchMouseWheelEvent(MouseWheelEvent evt) {
if (lastHit != null) {
processMouseWheelEvent
(new GraphicsNodeMouseWheelEvent(lastHit,
evt.getID(),
evt.getWhen(),
evt.getModifiersEx(),
getCurrentLockState(),
evt.getWheelRotation()));
}
}
/**
* Processes the specified event by firing the 'global' listeners
* attached to this event dispatcher.
* @param evt the event to process
*/
protected void processMouseEvent(GraphicsNodeMouseEvent evt) {
if (glisteners != null) {
GraphicsNodeMouseListener[] listeners =
(GraphicsNodeMouseListener[])
getListeners(GraphicsNodeMouseListener.class);
switch (evt.getID()) {
case GraphicsNodeMouseEvent.MOUSE_MOVED:
for (GraphicsNodeMouseListener listener6 : listeners) {
listener6.mouseMoved(evt);
}
break;
case GraphicsNodeMouseEvent.MOUSE_DRAGGED:
for (GraphicsNodeMouseListener listener5 : listeners) {
listener5.mouseDragged(evt);
}
break;
case GraphicsNodeMouseEvent.MOUSE_ENTERED:
for (GraphicsNodeMouseListener listener4 : listeners) {
listener4.mouseEntered(evt);
}
break;
case GraphicsNodeMouseEvent.MOUSE_EXITED:
for (GraphicsNodeMouseListener listener3 : listeners) {
listener3.mouseExited(evt);
}
break;
case GraphicsNodeMouseEvent.MOUSE_CLICKED:
for (GraphicsNodeMouseListener listener2 : listeners) {
listener2.mouseClicked(evt);
}
break;
case GraphicsNodeMouseEvent.MOUSE_PRESSED:
for (GraphicsNodeMouseListener listener1 : listeners) {
listener1.mousePressed(evt);
}
break;
case GraphicsNodeMouseEvent.MOUSE_RELEASED:
for (GraphicsNodeMouseListener listener : listeners) {
listener.mouseReleased(evt);
}
break;
default:
throw new IllegalArgumentException("Unknown Mouse Event type: "+evt.getID());
}
}
}
/**
* Processes the specified event by firing the 'global' listeners
* attached to this event dispatcher.
* @param evt the event to process
*/
protected void processMouseWheelEvent(GraphicsNodeMouseWheelEvent evt) {
if (glisteners != null) {
GraphicsNodeMouseWheelListener[] listeners =
(GraphicsNodeMouseWheelListener[])
getListeners(GraphicsNodeMouseWheelListener.class);
for (GraphicsNodeMouseWheelListener listener : listeners) {
listener.mouseWheelMoved(evt);
}
}
}
/**
* Dispatches a graphics node key event to by firing the 'global'
* listeners attached to this event dispatcher.
*
* @param evt the evt to dispatch
*/
public void processKeyEvent(GraphicsNodeKeyEvent evt) {
if ((glisteners != null)) {
GraphicsNodeKeyListener[] listeners =
(GraphicsNodeKeyListener[])
getListeners(GraphicsNodeKeyListener.class);
switch (evt.getID()) {
case GraphicsNodeKeyEvent.KEY_PRESSED:
for (GraphicsNodeKeyListener listener2 : listeners) {
listener2.keyPressed(evt);
}
break;
case GraphicsNodeKeyEvent.KEY_RELEASED:
for (GraphicsNodeKeyListener listener1 : listeners) {
listener1.keyReleased(evt);
}
break;
case GraphicsNodeKeyEvent.KEY_TYPED:
for (GraphicsNodeKeyListener listener : listeners) {
listener.keyTyped(evt);
}
break;
default:
throw new IllegalArgumentException("Unknown Key Event type: "+evt.getID());
}
}
evt.consume();
}
private void incrementKeyTarget() {
// FIXME TODO: Not implemented.
throw new UnsupportedOperationException("Increment not implemented.");
}
private void decrementKeyTarget() {
// FIXME TODO: Not implemented.
throw new UnsupportedOperationException("Decrement not implemented.");
}
/**
* Associates all InputEvents of type e.getID()
* with "incrementing" of the currently selected GraphicsNode.
*/
public void setNodeIncrementEvent(InputEvent e) {
nodeIncrementEventID = e.getID();
if (e instanceof KeyEvent) {
nodeIncrementEventCode = ((KeyEvent) e).getKeyCode();
}
nodeIncrementEventModifiers = e.getModifiersEx();
}
/**
* Associates all InputEvents of type e.getID()
* with "decrementing" of the currently selected GraphicsNode.
* The notion of "currently selected" GraphicsNode is used
* for dispatching KeyEvents.
*/
public void setNodeDecrementEvent(InputEvent e) {
nodeDecrementEventID = e.getID();
if (e instanceof KeyEvent) {
nodeDecrementEventCode = ((KeyEvent) e).getKeyCode();
}
nodeDecrementEventModifiers = e.getModifiersEx();
}
/**
* Returns true if the input event e is a node increment event,
* false otherwise.
* @param e the input event
*/
protected boolean isNodeIncrementEvent(InputEvent e) {
if (e.getID() != nodeIncrementEventID) {
// not an incrementEvent: false
return false;
}
if (e instanceof KeyEvent) {
if (((KeyEvent) e).getKeyCode() != nodeIncrementEventCode) {
// it was a KeyEvent, but not a nodeIncrementEventCode : false
return false;
}
}
// here: it was not a KeyEvent at all OR a KeyEvent with nodeIncrementEventCode
if ((e.getModifiersEx() & nodeIncrementEventModifiers) == 0) {
// no nodeIncrementEventModifiers were set: false
return false;
}
// this is the only path to success...
return true;
}
/**
* Returns true if the input event e is a node decrement event,
* false otherwise.
*/
protected boolean isNodeDecrementEvent(InputEvent e) {
if (e.getID() != nodeDecrementEventID) {
// not an nodeDecrementEvent: false
return false;
}
if (e instanceof KeyEvent) {
if (((KeyEvent) e).getKeyCode() != nodeDecrementEventCode) {
// it was a KeyEvent, but not a nodeDecrementEventCode : false
return false;
}
}
// here: it was not a KeyEvent at all OR a KeyEvent with nodeIncrementEventCode
if ((e.getModifiersEx() & nodeDecrementEventModifiers) == 0) {
// no nodeDecrementEventModifiers were set: false
return false;
}
// this is the only path to success...
return true;
}
/**
* Returns whether the meta key is down according to the given modifiers
* bitfield.
*/
protected static boolean isMetaDown(int modifiers) {
return (modifiers & GraphicsNodeInputEvent.META_MASK) != 0;
}
}