[263] | 1 | package de.ugoe.cs.eventbench.jfcmonitor;
|
---|
| 2 |
|
---|
| 3 | import java.awt.AWTEvent;
|
---|
[271] | 4 | import java.awt.Component;
|
---|
[263] | 5 | import java.awt.event.AWTEventListener;
|
---|
[370] | 6 | import java.awt.event.FocusEvent;
|
---|
[263] | 7 | import java.awt.event.KeyEvent;
|
---|
| 8 | import java.awt.event.MouseEvent;
|
---|
[268] | 9 | import java.io.IOException;
|
---|
| 10 | import java.io.OutputStreamWriter;
|
---|
[263] | 11 |
|
---|
[347] | 12 | import de.ugoe.cs.util.StringTools;
|
---|
| 13 |
|
---|
[271] | 14 | /**
|
---|
| 15 | * <p>
|
---|
| 16 | * This class implements monitoring of AWT and Swing mouse and keyboard events.
|
---|
| 17 | * Each of the events is written to an output stream.
|
---|
| 18 | * </p>
|
---|
| 19 | *
|
---|
| 20 | * @author Steffen Herbold
|
---|
| 21 | * @version 1.0
|
---|
| 22 | */
|
---|
[263] | 23 | public class JFCListener implements AWTEventListener {
|
---|
| 24 |
|
---|
[271] | 25 | /**
|
---|
| 26 | * <p>
|
---|
| 27 | * Writer for logging events.
|
---|
| 28 | * </p>
|
---|
| 29 | */
|
---|
| 30 | final private OutputStreamWriter outputWriter;
|
---|
| 31 |
|
---|
[354] | 32 | /**
|
---|
| 33 | * <p>
|
---|
| 34 | * Constructor. Creates a new JFCListener with a given
|
---|
| 35 | * {@link OutputStreamWriter}, where the monitored information is logged.
|
---|
| 36 | * </p>
|
---|
| 37 | *
|
---|
| 38 | * @param outputWriter
|
---|
| 39 | * writer for the logged information
|
---|
| 40 | */
|
---|
[268] | 41 | public JFCListener(OutputStreamWriter outputWriter) {
|
---|
| 42 | this.outputWriter = outputWriter;
|
---|
[303] | 43 | try {
|
---|
[347] | 44 | outputWriter.write("<?xml version=\"1.0\" encoding=\"UTF-16\"?>"
|
---|
[356] | 45 | + StringTools.ENDLINE);
|
---|
| 46 | outputWriter.write("<sessions>" + StringTools.ENDLINE);
|
---|
[303] | 47 | } catch (IOException e) {
|
---|
| 48 | System.err.println("JFCMONITOR -- Failure writing to log: "
|
---|
| 49 | + e.getMessage());
|
---|
| 50 | }
|
---|
[268] | 51 | }
|
---|
[271] | 52 |
|
---|
| 53 | /**
|
---|
| 54 | * <p>
|
---|
| 55 | * Writes all received {@link MouseEvent}s and {@link KeyEvent}s to the
|
---|
| 56 | * {@link #outputWriter}.
|
---|
[296] | 57 | * </p>
|
---|
[271] | 58 | *
|
---|
| 59 | * @see java.awt.event.AWTEventListener#eventDispatched(java.awt.AWTEvent)
|
---|
| 60 | */
|
---|
[263] | 61 | @Override
|
---|
| 62 | public void eventDispatched(AWTEvent event) {
|
---|
[268] | 63 | StringBuilder builder = new StringBuilder();
|
---|
[271] | 64 |
|
---|
| 65 | if (event instanceof MouseEvent) {
|
---|
[263] | 66 | MouseEvent mouseEvent = (MouseEvent) event;
|
---|
[271] | 67 | if (!isMouseMovement(event.getID())) {
|
---|
[356] | 68 | builder.append("<event id=\"" + event.getID() + "\">" + StringTools.ENDLINE);
|
---|
[271] | 69 | builder.append(" <param name=\"X\" value=\""
|
---|
[356] | 70 | + mouseEvent.getX() + "\" />" + StringTools.ENDLINE);
|
---|
[271] | 71 | builder.append(" <param name=\"Y\" value=\""
|
---|
[356] | 72 | + mouseEvent.getY() + "\" />" + StringTools.ENDLINE);
|
---|
[271] | 73 | builder.append(" <param name=\"Button\" value=\""
|
---|
[356] | 74 | + mouseEvent.getButton() + "\" />" + StringTools.ENDLINE);
|
---|
[271] | 75 | builder.append(" <param name=\"Modifiers\" value=\""
|
---|
[356] | 76 | + mouseEvent.getModifiers() + "\" />" + StringTools.ENDLINE);
|
---|
[268] | 77 | addSourceInfo(builder, event);
|
---|
[356] | 78 | builder.append("</event>" + StringTools.ENDLINE);
|
---|
[263] | 79 | }
|
---|
| 80 | }
|
---|
[271] | 81 | if (event instanceof KeyEvent) {
|
---|
[263] | 82 | KeyEvent keyEvent = (KeyEvent) event;
|
---|
[271] | 83 | if (keyEvent.getID() == KeyEvent.KEY_TYPED) {
|
---|
[356] | 84 | builder.append("<event id=\"" + event.getID() + "\">" + StringTools.ENDLINE);
|
---|
[271] | 85 | builder.append(" <param name=\"KeyCode\" value=\""
|
---|
[356] | 86 | + keyEvent.getKeyCode() + "\" />" + StringTools.ENDLINE);
|
---|
[271] | 87 | builder.append(" <param name=\"Modifiers\" value=\""
|
---|
[356] | 88 | + keyEvent.getModifiers() + "\" />" + StringTools.ENDLINE);
|
---|
[268] | 89 | addSourceInfo(builder, event);
|
---|
[356] | 90 | builder.append("</event>" + StringTools.ENDLINE);
|
---|
[263] | 91 | }
|
---|
| 92 | }
|
---|
[370] | 93 | if (event instanceof FocusEvent) {
|
---|
| 94 | FocusEvent focusEvent = (FocusEvent) event;
|
---|
| 95 | if( focusEvent.getID() == FocusEvent.FOCUS_GAINED ) {
|
---|
| 96 | builder.append("<event id=\"" + event.getID() + "\">" + StringTools.ENDLINE);
|
---|
| 97 | addSourceInfo(builder, event);
|
---|
| 98 | builder.append("</event>" + StringTools.ENDLINE);
|
---|
| 99 | }
|
---|
| 100 | }
|
---|
[271] | 101 | if (builder.length() > 0 && outputWriter != null) {
|
---|
[268] | 102 | try {
|
---|
| 103 | outputWriter.write(builder.toString());
|
---|
| 104 | outputWriter.flush();
|
---|
| 105 | } catch (IOException e) {
|
---|
[271] | 106 | System.err.println("JFCMONITOR -- Failure writing to log: "
|
---|
| 107 | + e.getMessage());
|
---|
[268] | 108 | }
|
---|
| 109 | }
|
---|
[263] | 110 | }
|
---|
[271] | 111 |
|
---|
| 112 | /**
|
---|
| 113 | * <p>
|
---|
| 114 | * Appends information about the event to a {@link StringBuilder}.
|
---|
| 115 | * </p>
|
---|
| 116 | *
|
---|
| 117 | * @param builder
|
---|
| 118 | * {@link StringBuilder} where the information is appended
|
---|
| 119 | * @param event
|
---|
| 120 | * event whose information is appended
|
---|
| 121 | */
|
---|
[268] | 122 | private void addSourceInfo(StringBuilder builder, AWTEvent event) {
|
---|
[356] | 123 | builder.append(" <source>" + StringTools.ENDLINE);
|
---|
[277] | 124 | builder.append(" <param name=\"toString\" value=\""
|
---|
[347] | 125 | + StringTools
|
---|
| 126 | .xmlEntityReplacement(event.getSource().toString())
|
---|
[356] | 127 | + "\" />" + StringTools.ENDLINE);
|
---|
[271] | 128 | if (event.getSource() instanceof Component) {
|
---|
| 129 | Component source = (Component) event.getSource();
|
---|
[355] | 130 | JFCComponent jfcComponent = JFCComponent.find(source);
|
---|
| 131 | if (jfcComponent != null) {
|
---|
| 132 | builder.append(jfcComponent.getXML());
|
---|
| 133 | }
|
---|
[271] | 134 | }
|
---|
[356] | 135 | builder.append(" </source>" + StringTools.ENDLINE);
|
---|
[271] | 136 | }
|
---|
| 137 |
|
---|
| 138 | /**
|
---|
| 139 | * <p>
|
---|
| 140 | * Checks if the Id of an {@link AWTEvent} is a mouse movement Id.
|
---|
| 141 | * </p>
|
---|
| 142 | *
|
---|
| 143 | * @param eventId
|
---|
| 144 | * id of the {@link AWTEvent}
|
---|
| 145 | * @return true, if the event is a mouse movement event; false otherwise
|
---|
| 146 | */
|
---|
[268] | 147 | private boolean isMouseMovement(int eventId) {
|
---|
[271] | 148 | return eventId == MouseEvent.MOUSE_MOVED
|
---|
| 149 | || eventId == MouseEvent.MOUSE_DRAGGED
|
---|
| 150 | || eventId == MouseEvent.MOUSE_ENTERED
|
---|
| 151 | || eventId == MouseEvent.MOUSE_EXITED;
|
---|
[268] | 152 | }
|
---|
[263] | 153 |
|
---|
| 154 | }
|
---|