Added first shot with gui validation. Note: need improvement...

register-app/pom.xml

@@ -1,32 +1,12 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<project xmlns="http://maven.apache.org/POM/4.0.0"
-  xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
-  xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd">
+<?xml version="1.0" encoding="UTF-8"?><project>
   <modelVersion>4.0.0</modelVersion>
   <groupId>se.citerus</groupId>
   <artifactId>register-app</artifactId>
-  <packaging>jar</packaging>
   <name>register-app</name>
   <version>1.0-SNAPSHOT</version>
   <url>http://maven.apache.org</url>
-  <repositories>
-    <repository>
-      <id>maven2-repository.dev.java.net</id>
-      <name>Java.net Repository for Maven</name>
-      <url>http://download.java.net/maven/2/</url>
-      <layout>default</layout>
-    </repository>
-  </repositories>
-  <pluginRepositories>
-    <pluginRepository>
-      <id>maven2-repository.dev.java.net</id>
-      <name>Java.net Repository for Maven</name>
-      <url>http://download.java.net/maven/2/</url>
-    </pluginRepository>
-  </pluginRepositories>
   <build>
     <plugins>
-      <!-- Compiler -->
       <plugin>
         <artifactId>maven-compiler-plugin</artifactId>
         <configuration>
@@ -36,7 +16,6 @@
         </configuration>
       </plugin>
       <plugin>
-        <groupId>org.apache.maven.plugins</groupId>
         <artifactId>maven-jar-plugin</artifactId>
         <configuration>
           <archive>
@@ -61,6 +40,20 @@
       </plugin>
     </plugins>
   </build>
+  <repositories>
+    <repository>
+      <id>maven2-repository.dev.java.net</id>
+      <name>Java.net Repository for Maven</name>
+      <url>http://download.java.net/maven/2/</url>
+    </repository>
+  </repositories>
+  <pluginRepositories>
+    <pluginRepository>
+      <id>maven2-repository.dev.java.net</id>
+      <name>Java.net Repository for Maven</name>
+      <url>http://download.java.net/maven/2/</url>
+    </pluginRepository>
+  </pluginRepositories>
   <dependencies>
     <dependency>
       <groupId>junit</groupId>
@@ -95,72 +88,72 @@
       <classifier>ws-client</classifier>
       <exclusions>
         <exclusion>
-          <groupId>org.springframework</groupId>
           <artifactId>spring-core</artifactId>
+          <groupId>org.springframework</groupId>
         </exclusion>
         <exclusion>
-          <groupId>org.springframework</groupId>
           <artifactId>spring-webmvc</artifactId>
+          <groupId>org.springframework</groupId>
         </exclusion>
         <exclusion>
-          <groupId>org.springframework</groupId>
           <artifactId>spring-hibernate3</artifactId>
+          <groupId>org.springframework</groupId>
         </exclusion>
         <exclusion>
-          <groupId>org.springframework</groupId>
           <artifactId>spring-jdbc</artifactId>
+          <groupId>org.springframework</groupId>
         </exclusion>
         <exclusion>
-          <groupId>org.springframework</groupId>
           <artifactId>spring-aop</artifactId>
+          <groupId>org.springframework</groupId>
         </exclusion>
         <exclusion>
-          <groupId>org.springframework</groupId>
           <artifactId>spring-mock</artifactId>
+          <groupId>org.springframework</groupId>
         </exclusion>
         <exclusion>
-          <groupId>org.springframework</groupId>
           <artifactId>spring-context</artifactId>
+          <groupId>org.springframework</groupId>
         </exclusion>
         <exclusion>
-          <groupId>org.springframework</groupId>
           <artifactId>spring-beans</artifactId>
+          <groupId>org.springframework</groupId>
         </exclusion>
         <exclusion>
-          <groupId>org.hibernate</groupId>
           <artifactId>hibernate</artifactId>
+          <groupId>org.hibernate</groupId>
         </exclusion>
         <exclusion>
-          <groupId>org.hibernate</groupId>
           <artifactId>hibernate-annotations</artifactId>
+          <groupId>org.hibernate</groupId>
         </exclusion>
         <exclusion>
-          <groupId>org.hibernate</groupId>
           <artifactId>hibernate-commons-annotations</artifactId>
+          <groupId>org.hibernate</groupId>
         </exclusion>
         <exclusion>
-          <groupId>commons-dbcp</groupId>
           <artifactId>commons-dbcp</artifactId>
+          <groupId>commons-dbcp</groupId>
         </exclusion>
         <exclusion>
-          <groupId>hsqldb</groupId>
           <artifactId>hsqldb</artifactId>
+          <groupId>hsqldb</groupId>
         </exclusion>
         <exclusion>
-          <groupId>javax.servlet</groupId>
           <artifactId>servlet-api</artifactId>
+          <groupId>javax.servlet</groupId>
         </exclusion>
         <exclusion>
-          <groupId>taglibs</groupId>
           <artifactId>standard</artifactId>
+          <groupId>taglibs</groupId>
         </exclusion>
         <exclusion>
-          <groupId>javax.servlet</groupId>
           <artifactId>jstl</artifactId>
+          <groupId>javax.servlet</groupId>
         </exclusion>
         <exclusion>
-          <groupId>opensymphony</groupId>
           <artifactId>sitemesh</artifactId>
+          <groupId>opensymphony</groupId>
         </exclusion>
       </exclusions>
     </dependency>

register-app/src/main/java/se/citerus/registerapp/RegisterApp.java

@@ -1,5 +1,8 @@
 package se.citerus.registerapp;
 
+import java.awt.Color;
+import java.awt.Component;
+import java.awt.Dimension;
 import java.awt.event.ActionEvent;
 import java.awt.event.ActionListener;
 import java.text.SimpleDateFormat;
@@ -11,12 +14,20 @@ import javax.swing.JFormattedTextField;
 import javax.swing.JFrame;
 import javax.swing.UIManager;
 import javax.swing.WindowConstants;
+import javax.swing.border.Border;
+import javax.swing.border.CompoundBorder;
+import javax.swing.border.LineBorder;
+import javax.swing.plaf.basic.BasicBorders;
 import javax.swing.text.DefaultFormatter;
 
 import se.citerus.registerapp.service.HandlingEventService;
+import se.citerus.registerapp.validation.FormValidationDecorator;
+import se.citerus.registerapp.validation.FormValidationSwingDecorator;
+import se.citerus.registerapp.validation.MandatoryTextFieldValidator;
 
 import com.jgoodies.forms.builder.DefaultFormBuilder;
 import com.jgoodies.forms.debug.FormDebugPanel;
+import com.jgoodies.forms.factories.ButtonBarFactory;
 import com.jgoodies.forms.layout.FormLayout;
 
 public class RegisterApp {
@@ -33,13 +44,14 @@ public class RegisterApp {
   
   private HandlingEventService handlingEventService;
   private boolean debugUI;
+  private FormValidationDecorator validator;
 
 
 
   /////////////////////////////////////////////////////////////////////////////
   // GUI EVENT HANDLING
   /////////////////////////////////////////////////////////////////////////////
-  protected void onRegister() {
+  protected void onRegister(){
     assert handlingEventService != null : "No HandlingEventService available";
     
     handlingEventService.register(ISO8601_DATE_FORMAT.format(completionTimeField.getValue()), 
@@ -65,8 +77,13 @@ public class RegisterApp {
     initComponents();
     JComponent panel = createMainPanel();
     
+    
     frame = createFrame(panel);
     frame.pack();
+    centerOnScreen(frame);
+    
+    initValidation(frame);
+    
     frame.setVisible(true);
     
     clearForm();
@@ -91,6 +108,10 @@ public class RegisterApp {
     locationField.setText("");
     eventTypeField.setText("");
   }
+
+  public static Border getMandatoryBorder() {
+    return new CompoundBorder(new LineBorder(Color.RED), new BasicBorders.MarginBorder());
+  }
   
   private void initComponents(){
     completionTimeField = new JFormattedTextField(ISO8601_DATE_FORMAT);
@@ -102,11 +123,41 @@ public class RegisterApp {
     registerButton = new JButton("Register");
     registerButton.addActionListener(new ActionListener(){
       public void actionPerformed(ActionEvent e) {
-        onRegister();
+        if (validator.validate()){
+          onRegister();
+        }
       }
     });
   }
 
+  /**
+   * We need to do initialization of validators after the components and their parent frame has been initialized.
+   * @param frame 
+   * 
+   */
+  private void initValidation(JFrame frame){
+    validator = new FormValidationSwingDecorator(frame);
+    
+    validator.add(eventTypeField, new MandatoryTextFieldValidator("Event type can't be empty"));
+    validator.add(trackingIdField, new MandatoryTextFieldValidator("Tracking id can't be empty"));
+  }
+  
+  
+  /**
+   * Center a component on the screen.
+   * 
+   * @param component the component to be centered
+   */
+
+  public static void centerOnScreen(Component component) {
+      Dimension componentSize = component.getSize();
+      Dimension screenSize = component.getToolkit().getScreenSize();
+
+      component.setLocation(
+          (screenSize.width  - componentSize.width)  / 2,
+          (int) ((screenSize.height - componentSize.height) *0.45));
+
+  }
 
   private JFrame createFrame(JComponent panel) {
     JFrame f = new JFrame();
@@ -121,7 +172,7 @@ public class RegisterApp {
     JComponent fieldPanel = createFieldPanel();
     JComponent buttonPanel = createButtonPanel();
     
-    DefaultFormBuilder mainBuilder = createBuilder("right:pref");
+    DefaultFormBuilder mainBuilder = createBuilder("p");
     mainBuilder.append(fieldPanel);
     mainBuilder.append(buttonPanel);
     
@@ -130,16 +181,12 @@ public class RegisterApp {
 
 
   private JComponent createButtonPanel() {
-    DefaultFormBuilder builder = createBuilder("right:pref, 3dlu");
-    
-    builder.append(registerButton);
-    
-    return builder.getPanel();
+    return ButtonBarFactory.buildRightAlignedBar(registerButton);
   }
 
 
   private JComponent createFieldPanel() {
-    DefaultFormBuilder builder = createBuilder("right:pref, 3dlu, 100dlu, 3dlu, p");
+    DefaultFormBuilder builder = createBuilder("right:pref, 3dlu, 100dlu");
     
     builder.appendSeparator("Completion");
     builder.append("Completion Time", completionTimeField); builder.nextLine();

register-app/src/main/java/se/citerus/registerapp/validation/AbstractFormValidationDecorator.java

@@ -0,0 +1,39 @@
+package se.citerus.registerapp.validation;
+
+import java.awt.event.KeyEvent;
+import java.awt.event.KeyListener;
+import java.util.HashMap;
+import java.util.Map.Entry;
+
+import javax.swing.JComponent;
+
+public abstract class AbstractFormValidationDecorator implements FormValidationDecorator{
+  private HashMap<JComponent, ComponentValidator> validators = new HashMap<JComponent, ComponentValidator>();
+
+  public void add(final JComponent component, ComponentValidator validator) {
+    this.validators.put(component, validator);
+
+    component.addKeyListener(new KeyListener(){
+      public void keyPressed(KeyEvent e) {
+        undecorate(component);
+      }
+
+      public void keyReleased(KeyEvent e) {}
+      public void keyTyped(KeyEvent e) {}
+    });
+  }
+
+  public boolean validate() {
+    boolean allValidated = true;
+    for (final Entry<JComponent, ComponentValidator> entry : validators.entrySet()) {
+      if (!entry.getValue().validate(entry.getKey())){
+        decorate(entry.getKey(), entry.getValue());
+        allValidated = false;
+      }
+    }
+    return allValidated;
+  }
+  
+  public abstract void decorate(JComponent component, ComponentValidator validator);
+  public abstract void undecorate(JComponent component);
+}

register-app/src/main/java/se/citerus/registerapp/validation/AbstractValidator.java

@@ -0,0 +1,96 @@
+package se.citerus.registerapp.validation;
+
+import java.awt.Color;
+import java.awt.FlowLayout;
+import java.awt.event.KeyEvent;
+import java.awt.event.KeyListener;
+
+import javax.swing.ImageIcon;
+import javax.swing.InputVerifier;
+import javax.swing.JComponent;
+import javax.swing.JFrame;
+import javax.swing.JLabel;
+import javax.swing.JPanel;
+
+public abstract class AbstractValidator extends InputVerifier implements KeyListener{
+  private static final Color ERROR_COMPONENT_COLOR = Color.PINK;
+  private static final Color POPUP_COLOR = new Color(243, 255, 159);
+  private JPanel popup;
+  private JLabel messageLabel = new JLabel();;
+  private JLabel image = new JLabel();
+  private JFrame parent;
+  private String message;;
+
+  
+  
+  public AbstractValidator(String message) {
+    this.message = message;
+  }
+  
+  public String getMessage(){
+    return message;
+  }
+
+  public AbstractValidator(JFrame parent, JComponent c, String message) {
+    c.addKeyListener(this);
+    popup = new JPanel();
+    this.parent = parent;
+    messageLabel = new JLabel(message + " ");
+    image = new JLabel(new ImageIcon("/icon/error_16x16.png"));
+    initComponents();
+  }
+
+  /**
+   * Implement the actual validation logic in this method. The method should
+   * return false if data is invalid and true if it is valid.
+   * 
+   * @param c The JComponent to be validated.
+   * @return false if data is invalid. true if it is valid.
+   */
+  protected abstract boolean validate(JComponent c);
+
+  @Override
+  public boolean verify(JComponent component) {
+    if (!validate(component)) {
+
+//      
+//      Dimension compSize = component.getSize();
+//      Point compPos = popup.getLocation();
+//      
+//      component.setBackground(ERROR_COMPONENT_COLOR);
+//
+//      popup.setLocation(
+//          compPos.x - (int) compSize.getWidth() / 2, 
+//          compPos.y + (int) compSize.getHeight() / 2);
+      
+      parent.setGlassPane(popup);
+      component.setBackground(ERROR_COMPONENT_COLOR);
+      popup.setVisible(true);
+      return false;
+    } else {
+      component.setBackground(Color.WHITE);
+      return true;
+    }
+  }
+
+  public void keyPressed(KeyEvent e) {
+    popup.setVisible(false);    
+  }
+
+  public void keyReleased(KeyEvent e) {}
+
+  public void keyTyped(KeyEvent e) {}
+  
+  
+  private void initComponents() {
+    popup.setLayout(new FlowLayout());
+//    popup.setUndecorated(true);
+    popup.setBackground(POPUP_COLOR);
+    popup.add(image);
+    popup.add(messageLabel);
+//    popup.setOpaque(false);
+//    popup.setFocusableWindowState(false);
+  }
+
+
+}

register-app/src/main/java/se/citerus/registerapp/validation/ComponentValidator.java

@@ -0,0 +1,8 @@
+package se.citerus.registerapp.validation;
+
+import javax.swing.JComponent;
+
+public interface ComponentValidator {
+  boolean validate(JComponent c);
+  String getMessage();
+}

register-app/src/main/java/se/citerus/registerapp/validation/FormValidationDecorator.java

@@ -0,0 +1,13 @@
+package se.citerus.registerapp.validation;
+
+import javax.swing.JComponent;
+
+
+public interface FormValidationDecorator {
+
+  void add(final JComponent component, ComponentValidator validator);
+
+  boolean validate();
+
+  
+}

register-app/src/main/java/se/citerus/registerapp/validation/FormValidationSwingDecorator.java

@@ -0,0 +1,114 @@
+package se.citerus.registerapp.validation;
+
+import java.awt.Color;
+import java.awt.Dimension;
+import java.awt.FlowLayout;
+import java.awt.Point;
+import java.util.HashMap;
+
+import javax.swing.ImageIcon;
+import javax.swing.JComponent;
+import javax.swing.JFrame;
+import javax.swing.JLabel;
+import javax.swing.JPanel;
+
+public class FormValidationSwingDecorator extends AbstractFormValidationDecorator{
+
+  private static final int POPUP_Y_OFFSET = 4;
+  private static final int POPUP_X_OFFSET = 12;
+  private Color oldColor = Color.WHITE;
+  private JFrame form;
+  private String message;
+  private HashMap<JComponent, JPanel> popups = new HashMap<JComponent, JPanel>();
+  private JPanel glassPane = new JPanel();
+
+  public FormValidationSwingDecorator(JFrame form) {
+    assert form != null : "Can't decorate null frame";
+    
+    this.form = form;
+    glassPane.setOpaque(false);
+    glassPane.setVisible(false);
+    glassPane.setLayout(null);
+//    glassPane.setPreferredSize(form.getPreferredSize());
+    glassPane.setSize(form.getSize());
+    form.setGlassPane(glassPane);
+  }
+
+  public FormValidationSwingDecorator(JFrame form, String message) {
+    this(form);
+    
+    this.message = message;
+  }
+
+  private JPanel createPopupRelativeTo(JComponent component) {
+    JPanel popupPane = null;
+    
+    if (popups.containsKey(component)){
+      popupPane = popups.get(component);
+    } else {
+      popupPane = new JPanel(new FlowLayout());
+      glassPane.add(popupPane);
+      
+      popupPane.add(getIconLabel());
+      popupPane.add(getMessageLabel());
+      popupPane.setLocation(getPopupPositionRelativeTo(component));
+      popupPane.setVisible(true);
+      popupPane.setOpaque(false);
+      popupPane.validate();
+      popupPane.setSize(popupPane.getPreferredSize());
+     
+    }
+    
+    return popupPane;
+  }
+
+  private Point getPopupPositionRelativeTo(JComponent component) {
+    Point compPos = component.getLocation();
+    Dimension compDim = component.getSize();
+    Point popupPos = new Point(compPos.x + POPUP_X_OFFSET, compPos.y + compDim.height + POPUP_Y_OFFSET);
+    
+    System.out.println("Comp pos: " + compPos + " - Popup pos: " + popupPos);
+    return popupPos;
+  }
+
+  private JLabel getMessageLabel() {
+    JLabel label = new JLabel(message != null ? message : "");
+    label.setOpaque(false);
+    return label;
+  }
+
+  private JLabel getIconLabel() {
+    JLabel label = new JLabel();
+    
+    java.net.URL imageURL = this.getClass().getResource("/icon/error_16x16.png");
+    if (imageURL != null){
+      ImageIcon icon = new ImageIcon(imageURL);
+      label.setIcon(icon);
+    } else {
+      System.out.println("No icon found");
+    }
+    
+    
+    label.setOpaque(false);
+    return label;
+  }
+  
+  @Override
+  public void decorate(JComponent component, ComponentValidator validator) {
+    this.message = validator.getMessage();
+    this.oldColor = component.getBackground();
+    component.setBackground(Color.PINK);
+    popups.put(component, createPopupRelativeTo(component));
+    glassPane.setVisible(true);
+  }
+
+  @Override
+  public void undecorate(JComponent component) {
+    component.setBackground(oldColor);
+    JPanel panel = popups.get(component);
+    if (panel != null){
+      panel.setVisible(false);
+    }
+    glassPane.setVisible(false);
+  }
+}

register-app/src/main/java/se/citerus/registerapp/validation/MandatoryTextFieldValidator.java

@@ -0,0 +1,25 @@
+package se.citerus.registerapp.validation;
+
+import javax.swing.JComponent;
+import javax.swing.JTextField;
+
+public class MandatoryTextFieldValidator implements ComponentValidator {
+  private String message;
+
+  public MandatoryTextFieldValidator(String message) {
+    this.message = message;
+  }
+
+  public boolean validate(JComponent c) {
+    JTextField field = (JTextField) c;
+    
+    boolean valid = !"".equals(field.getText());
+    
+    return valid;
+  }
+
+  public String getMessage() {
+    return message;
+  }
+
+}

register-app/src/test/java/se/citerus/registerapp/validation/ValidationTest.java

@@ -0,0 +1,120 @@
+package se.citerus.registerapp.validation;
+
+import java.awt.event.ActionEvent;
+import java.awt.event.ActionListener;
+
+import javax.swing.JButton;
+import javax.swing.JComponent;
+import javax.swing.JFrame;
+import javax.swing.JTextField;
+
+import junit.framework.TestCase;
+
+public class ValidationTest extends TestCase {
+  private boolean actionPerformed;
+
+  public void testValidationScenario() throws Exception {
+    JFrame frame = new JFrame();
+    
+    final FormValidationDecorator validationDecorator = new FormValidationSwingDecorator(frame);
+    
+    JTextField field1 = new JTextField();
+    JTextField field2 = new JTextField();
+    JButton button = new JButton();
+    frame.add(field1);
+    frame.add(field2);
+    frame.add(button);
+    
+    
+    ValidatorMock validator1 = createValidator("No Way!", true);
+    validationDecorator.add(field1, validator1);
+    
+    ValidatorMock validator2 = createValidator("My Way!", true);
+    validationDecorator.add(field2, validator2);
+    
+   button.addActionListener(new ActionListener(){
+    public void actionPerformed(ActionEvent e) {
+      if (validationDecorator.validate()){
+        onAction();
+      }
+    }
+   });
+   
+   
+   
+   field1.setText("Field1");
+   field2.setText("");
+   button.doClick();
+   assertTrue("Field1 not validated", validator1.isValidated());
+   assertTrue("Field2 not validated", validator2.isValidated());
+   assertTrue("Button action not performed", actionPerformed);
+  }
+  
+  public void testValidationFailure() throws Exception {
+    JFrame frame = new JFrame();
+    final FormValidationDecorator validator = new FormValidationSwingDecorator(frame);
+    
+    JTextField field1 = new JTextField();
+    JTextField field2 = new JTextField();
+    JButton button = new JButton();
+    frame.add(field1);
+    frame.add(field2);
+    frame.add(button);
+    
+    ValidatorMock validator1 = createValidator("No Way!", true);
+    validator.add(field1, validator1);
+    
+    ValidatorMock validator2 = createValidator("My Way!", false);
+    validator.add(field2, validator2);
+    
+   button.addActionListener(new ActionListener(){
+    public void actionPerformed(ActionEvent e) {
+      if (validator.validate()){
+        onAction();
+      }
+    }
+   });
+   
+   field1.setText("Field1");
+   field2.setText("");
+   button.doClick();
+   assertTrue("Field1 not validated", validator1.isValidated());
+   assertTrue("Field2 not validated", validator2.isValidated());
+   assertFalse("Button action should not be performed", actionPerformed);
+  }
+  
+
+  private ValidatorMock createValidator(String message, boolean result) {
+    return new ValidatorMock(message, result);
+  }
+
+  protected void onAction() {
+    this.actionPerformed = true;
+    // Do some action...
+  }
+  
+  private static final class ValidatorMock implements ComponentValidator{
+    private final boolean result;
+    private boolean validated;
+    private String message;
+    
+    public ValidatorMock(String message, boolean result) {
+      this.message = message;
+      this.result = result;
+    }
+
+    public boolean validate(JComponent c) {
+      validated = true;
+      return result;
+    }
+
+    public boolean isValidated() {
+      return validated;
+    }
+
+    public String getMessage() {
+      return message;
+    }
+    
+  }
+}

register-app/startApp.sh

@@ -1,3 +1,2 @@
 #!/bin/sh
-
-java -cp target/register-app-1.0-SNAPSHOT-jar-with-dependencies.jar se.citerus.App
+java -cp target/register-app-1.0-SNAPSHOT-jar-with-dependencies.jar se.citerus.App