+ * This class implements monitoring of AWT and Swing mouse and keyboard events. + * Each of the events is written to an output stream. + *
+ * + * @author Steffen Herbold + * @version 1.0 + */ public class JFCListener implements AWTEventListener { - final static String ENDLINE = System.getProperty("line.separator"); - - final OutputStreamWriter outputWriter; - + /** + *+ * Convenience variable. + *
+ */ + final static private String ENDLINE = System.getProperty("line.separator"); + + /** + *+ * Writer for logging events. + *
+ */ + final private OutputStreamWriter outputWriter; + public JFCListener(OutputStreamWriter outputWriter) { this.outputWriter = outputWriter; } - + + /** + *
+ * Writes all received {@link MouseEvent}s and {@link KeyEvent}s to the
+ * {@link #outputWriter}.
+ *
+ * @see java.awt.event.AWTEventListener#eventDispatched(java.awt.AWTEvent)
+ */
@Override
public void eventDispatched(AWTEvent event) {
StringBuilder builder = new StringBuilder();
-
- if( event instanceof MouseEvent ) {
+
+ if (event instanceof MouseEvent) {
MouseEvent mouseEvent = (MouseEvent) event;
- if( !isMouseMovement(event.getID()) ) {
+ if (!isMouseMovement(event.getID())) {
builder.append("
+ * Appends information about the event to a {@link StringBuilder}. + *
+ * + * @param builder + * {@link StringBuilder} where the information is appended + * @param event + * event whose information is appended + */ private void addSourceInfo(StringBuilder builder, AWTEvent event) { - builder.append(" " + ENDLINE); - if( event.getSource() instanceof JComponent ) { - JComponent source = (JComponent) event.getSource(); - builder.append(" " + ENDLINE); - for(Method method : source.getClass().getMethods() ) { - try { - if( method.getName()=="getText" ) { - String text = (String) method.invoke(source, new Object[]{}); - builder.append(" " + ENDLINE); - } - if( method.getName()=="getTitle" ) { - String title = (String) method.invoke(source, new Object[]{}); - builder.append(" " + ENDLINE); - } - } catch (IllegalArgumentException e) { - } catch (IllegalAccessException e) { - } catch (InvocationTargetException e) { - } - } - /* TODO should include info about parent - builder.append(" " + ENDLINE); - builder.append(" " + ENDLINE); - */ + builder.append(" " + ENDLINE); + if (event.getSource() instanceof Component) { + Component source = (Component) event.getSource(); + addComponentInfo(builder, source, "Source"); + addComponentInfo(builder, source.getParent(), "Parent"); } } - + + /** + *+ * Appends information about the component to the a {@link StringBuilder}. + * The prefix can be used to give further information about the component. + *
+ * + * @param builder + * {@link StringBuilder} where the information is appended + * @param component + * component whose information is appended + * @param prefix + * prefix to give further information about the component + */ + private void addComponentInfo(StringBuilder builder, Component component, + String prefix) { + builder.append(" " + ENDLINE); + for (Method method : component.getClass().getMethods()) { + try { + if (method.getName() == "getText") { + String text = (String) method.invoke(component, + new Object[] {}); + builder.append(" " + ENDLINE); + } + if (method.getName() == "getTitle") { + String title = (String) method.invoke(component, + new Object[] {}); + builder.append(" " + ENDLINE); + } + } catch (IllegalArgumentException e) { + } catch (IllegalAccessException e) { + } catch (InvocationTargetException e) { + } + } + } + + /** + *+ * Checks if the Id of an {@link AWTEvent} is a mouse movement Id. + *
+ * + * @param eventId + * id of the {@link AWTEvent} + * @return true, if the event is a mouse movement event; false otherwise + */ private boolean isMouseMovement(int eventId) { - return eventId==MouseEvent.MOUSE_MOVED || eventId==MouseEvent.MOUSE_DRAGGED || eventId==MouseEvent.MOUSE_ENTERED || eventId==MouseEvent.MOUSE_EXITED; + return eventId == MouseEvent.MOUSE_MOVED + || eventId == MouseEvent.MOUSE_DRAGGED + || eventId == MouseEvent.MOUSE_ENTERED + || eventId == MouseEvent.MOUSE_EXITED; } Index: /trunk/JFCMonitor/src/de/ugoe/cs/eventbench/jfcmonitor/Runner.java =================================================================== --- /trunk/JFCMonitor/src/de/ugoe/cs/eventbench/jfcmonitor/Runner.java (revision 270) +++ /trunk/JFCMonitor/src/de/ugoe/cs/eventbench/jfcmonitor/Runner.java (revision 271) @@ -1,20 +1,80 @@ package de.ugoe.cs.eventbench.jfcmonitor; + import java.awt.AWTEvent; import java.awt.Toolkit; import java.awt.event.AWTEventListener; +import java.io.FileWriter; +import java.io.IOException; import java.io.OutputStreamWriter; import java.util.Arrays; - +/** + *+ * Start-up class of the application. + *
+ *+ * Launches the application under test in the same JVM. + *
+ * + * @author Steffen Herbold + * @version 1.0 + */ public class Runner { - public static void main(String[] args) throws Exception { - AWTEventListener listener = new JFCListener(new OutputStreamWriter(System.out)); - - Toolkit.getDefaultToolkit().addAWTEventListener(listener, + /** + *+ * Name of the log file. + *
+ */ + private final static String logfileName = "jfcmonitor.log"; + + /** + *+ * Debugging variable. If set to true, the logging is also written to the + * console. + *
+ */ + private final static boolean stdOutputWrite = true; + + /** + *+ * Main method of the application. + *
+ * + * @param args + * the first parameter defines the Jar file that contains the + * start-up information of the application under test. The + * remaining parameters are passed on the toe application under + * test. + */ + public static void main(String[] args) { + FileWriter writer; + try { + // the writer is not closed explicitly! + writer = new FileWriter(logfileName, true); + writer.write("