InspectorGuidget

A tool to detect GUI design smells such as blob listeners in java SWING/AWT GUI listeners by raising warnings in the Eclipse Java editor.

To build the installer of InspectorGuidget:

Import this project in Eclipse (Eclipse Modeling Framework is recommended).
Generate the InspectorGuidgetXXX.jar as an eclispe plugin.
Add the generated .jar in the folder "dropin" in our eclipse folder.

To run InspectorGuidget:

Configure a project that will be analysed as an Eclipse project.
Right click on the project in the navigator view.
(Optional) Update the path in Eclipse>Preferences>InspectorGuidget to store the results.
Select InspectorGuidget and the target detection.
The corresponding results for each detection will show up at the bottom view of eclipse.
Left click on each result will open the corresponding piece of code.
(Optional) To store the results (e.g., detected GUI listeners, blob listeners) check each one in that view, this will create a txt file in that path.

An Empirical Study on GUI Listeners: Data

The sources 13 open-source Java projects:
argoUML, git clone https://github.com/cflewis/argouml, git checkout 0b6aeccaa2fd2e3e184f16bb1266edddd765be4d
cids-navigator, git clone https://github.com/cismet/cids-navigator, git checkout 3e856fa32c62c940151f812b975ae91de557d401
cids-server, git clone https://github.com/cismet/cids-server, git checkout 4cf8a4dcd05020af7282a5002b34cc1e81fe299e
cismet-gui-commons, git clone https://github.com/cismet/cismet-gui-commons/, git checkout 648b7d48bd6e5af417b90701bbb8b5791f58379c
DJ-Native-Swing, git clone https://github.com/Chrriis/DJ-Native-Swing, git checkout 3cffc438289472aaac5b79756c96e288f3ab477b
flyingsaucer, git clone https://github.com/flyingsaucerproject/flyingsaucer.git, git checkout d10728c2d5864c2a6d41ceb9f588a1ddbeacb7f2
FreeCol, git clone https://github.com/Thue/FreeCol.git, git checkout 4454e5e6960487242cb2e5a8236eb6de9ab06c30
freeplane, git clone https://github.com/freeplane/freeplane.git, git checkout 1.4.x
ganttproject, git clone https://github.com/bardsoftware/ganttproject, git checkout c4b2e4a6cc3cd96ce720b013050b919157d9b7d8
pentaho-reporting, git clone https://github.com/pentaho/pentaho-reporting.git, git checkout cff612a0b6df36dc14af66afc35cfc429209d7be
RSyntaxTextArea, git clone https://github.com/bobbylight/RSyntaxTextArea.git, git checkout d84a498dd8c2e042ced9ccde4c96ea1d54770f68
sikuli, git clone https://github.com/sikuli/sikuli.git, git checkout 80c2f3fa03d95d657e7707ce2d1f576b3512a8b2
jabref, git clone https://github.com/JabRef/jabref.git, git checkout d9ba745225f56faf878b6538bda25969a996c968

The logs resulting from our tool.
The R script used to analyse the results.

Examples of Blob Listeners GUI toolkits

Swing

public class MenuListener implements ActionListener, CaretListener {
 //...
 protected boolean selectedText;

@Override public void actionPerformed(ActionEvent e) {
  Object src = e.getSource();
  if(src instanceof JMenuItem || src instanceof JButton){
		 String cmd = e.getActionCommand();
		 if(cmd.equals("Copy")){
			 if(selectedText)
				 output.copy();
		 }else if(cmd.equals("Cut")){
			  output.cut();
		 }else if(cmd.equals("Paste")){
			 output.paste();
		 }
		 // etc.
		}
  }
  @Override public void caretUpdate(CaretEvent e){
   	selectedText = e.getDot() != e.getMark();
   	updateStateOfMenus(selectedText);	
 }
}

public void actionPerformed(ActionEvent event) {
   if(event.getSource() == view.moveDown) {
      //...
   } else if(event.getSource() == view.moveLeft) {
      //...
   } else if(event.getSource() == view.moveRight) {
      //...
   } else if(event.getSource() == view.moveUp) {
      //...
   } else if(event.getSource() == view.zoomIn) {
      //...
   } else if(event.getSource() == view.zoomOut) {
      //...
   }
}

public void actionPerformed(ActionEvent evt) {
   Object target = evt.getSource();
   if (target instanceof JButton) {
      //...
   } else if (target instanceof JTextField) {
      //...
   } else if (target instanceof JCheckBox) {
      //...
   } else if (target instanceof JComboBox) {
      //...
   }
}

SWT

public class SelectionEventListener extends AbstractListener implements Listener {
	private int selectMethod;
	
	@Override public void handleEvent(Event event) {
		if (event.type == SWT.MouseDown){
			handleMouse(event);
			return;
		}
		if (!checkCreate(event)) return;
		AbstractAction action = null;

		if (event.widget instanceof MenuItem){
			action = new SimpleSelectionAction(event.type);
			
		} else if (event.widget instanceof ToolItem){
			System.out.println("tool");
			
		} else if (event.widget instanceof Text){
			System.out.println("text");
			
		} else if (event.widget instanceof Button){
			action = new SimpleSelectionAction(event.type);
			action.setShell(((Button) event.widget).getShell());

		} else if (event.widget instanceof Tree){
			StringBuilder sb = new StringBuilder();
			Tree tr = (Tree) event.widget;
			System.out.println("tree");
			//do not handle events of workbench window 
			
			if ((!(tr.getShell() == PlatformUI.getWorkbench().getActiveWorkbenchWindow().getShell())) ||
					selectMethod == 3){
				System.out.println("the shell "+tr.getShell());
				TreeItem[] items = ((Tree) event.widget).getSelection();

				for (TreeItem item : items){
					//System.out.println("tree item "+ item.toString());
					sb.append(item.getText());
					TreeItem selected = item;

					while(selected.getParentItem() != null){
						TreeItem parentIt = selected.getParentItem();
						//System.out.println(parentIt);
						sb.insert(0, "/");
						sb.insert(0, parentIt.getText());
						selected = parentIt;
					}
				}
				System.out.println(sb.toString());
				action = new SelectionAction(event.type);
				action.process(event);
				interactionHistory.addInteraction(action);
			}
			return;
		}
		
		else if (event.widget instanceof Table){
			System.out.println("table");
			if (event.detail == SWT.CHECK)
				System.out.println("check");
			String type = event.type == SWT.DefaultSelection ? SelectionAction.DEFAULT_SELECT : SelectionAction.ITEM_SELECT;
			action = new SelectionAction(event.type);
			((SelectionAction) action).addPart(DeliasUtils.getActivePartTitle());
		}
        ...

source cache

    @Override
    public void handleEvent(Event event) {
        if (!(event.widget instanceof Button)){
            return;
        }
        Button b = (Button) event.widget;
        if (b.getText().equals(addButtonText)) {
            add();
        } else if (b.getText().equalsIgnoreCase(removeButtonText)) {
            remove();
        }
    }

source cache

GWT

	@Override
	public void onClick(ClickEvent event) {
		if (event.getSource() == clearDatastoreButton) {
			clearDatastore();
		} else if (event.getSource() == populateDatastoreButton) {
			populateDatastore();
		} else if (event.getSource() == getPopulateDatastoreCountButton) {
			getPopulateDatastoreCount();
		} else if (event.getSource() == refreshEditModeOn) {
			refreshEditMode(true);
		} else if (event.getSource() == refreshEditModeOff) {
			refreshEditMode(false);
		} else if (event.getSource() == emailOpenedTree) {
			emailOpenedTree();
		} else if (event.getSource() == showOpenedTree) {
			showOpenedTree();
		}
	}

source cache

ttben/InspectorGuidget

InspectorGuidget

An Empirical Study on GUI Listeners: Data

Examples of Blob Listeners GUI toolkits

Swing

SWT

GWT