[Springframework-rcp-dev] [PATCH 08/12] nacho date binding now accepts empty strings

[<mai...@ce...>]

From: Johannes Schneider <js...@ce...>

---
 .../swing/date/NachoCalendarDateFieldBinder.java   |   36 +-
 .../swing/date/NachoCalendarDateFieldBinding.java  |    4 +-
 .../form/binding/swing/date/NullableDateField.java |  652 ++++++++++++++++++++
 .../date/NachoCalendarDateFieldBinderTests.java    |    4 +-
 4 files changed, 678 insertions(+), 18 deletions(-)
 create mode 100644 spring-richclient-core/src/main/java/org/springframework/richclient/form/binding/swing/date/NullableDateField.java

diff --git a/spring-richclient-core/src/main/java/org/springframework/richclient/form/binding/swing/date/NachoCalendarDateFieldBinder.java b/spring-richclient-core/src/main/java/org/springframework/richclient/form/binding/swing/date/NachoCalendarDateFieldBinder.java
index d2f5def..24ebc2e 100644
--- a/spring-richclient-core/src/main/java/org/springframework/richclient/form/binding/swing/date/NachoCalendarDateFieldBinder.java
+++ b/spring-richclient-core/src/main/java/org/springframework/richclient/form/binding/swing/date/NachoCalendarDateFieldBinder.java
@@ -15,6 +15,17 @@
  */
 package org.springframework.richclient.form.binding.swing.date;
 
+import java.awt.Dimension;
+import java.util.Map;
+import java.util.Locale;
+import java.util.Date;
+import java.text.DateFormat;
+import java.text.FieldPosition;
+import java.text.ParsePosition;
+
+import javax.swing.JComponent;
+import javax.swing.text.DateFormatter;
+
 import net.sf.nachocalendar.components.DateField;
 import org.springframework.beans.BeanWrapper;
 import org.springframework.beans.BeanWrapperImpl;
@@ -54,8 +65,8 @@ public class NachoCalendarDateFieldBinder extends AbstractDateFieldBinder {
 	}
 
 	protected Binding doBind(JComponent control, FormModel formModel, String formPropertyPath, Map context) {
-		Assert.isTrue(control instanceof DateField, "Control must be an instance of DateField.");
-		NachoCalendarDateFieldBinding binding = new NachoCalendarDateFieldBinding((DateField) control, formModel,
+		Assert.isTrue(control instanceof NullableDateField, "Control must be an instance of DateField.");
+		NachoCalendarDateFieldBinding binding = new NachoCalendarDateFieldBinding((NullableDateField) control, formModel,
 				formPropertyPath);
 		applyContext(binding, context);
 		return binding;
@@ -83,19 +94,16 @@ public class NachoCalendarDateFieldBinder extends AbstractDateFieldBinder {
 			context.remove(SHOW_WEEKNUMBERS_KEY);
 		}
 
+		// FIXME dirty hack so the DateField has the correct height
+    return new NullableDateField(showWeekNumbers){
+      private static final long serialVersionUID = 1L;
 
-		DateField dateField = new DateField(showWeekNumbers) {
-
-			private static final long serialVersionUID = 1L;
-
-			public Dimension getPreferredSize() {
-				Dimension size = super.getPreferredSize();
-				size.height = preferredHeight;
-
-				return size;
-			}
-		};
+      public Dimension getPreferredSize() {
+        Dimension size = super.getPreferredSize();
+        size.height = preferredHeight;
 
-		return dateField;
+        return size;
+      }
+    };
 	}
 }
\ No newline at end of file
diff --git a/spring-richclient-core/src/main/java/org/springframework/richclient/form/binding/swing/date/NachoCalendarDateFieldBinding.java b/spring-richclient-core/src/main/java/org/springframework/richclient/form/binding/swing/date/NachoCalendarDateFieldBinding.java
index ffaacbf..a923803 100644
--- a/spring-richclient-core/src/main/java/org/springframework/richclient/form/binding/swing/date/NachoCalendarDateFieldBinding.java
+++ b/spring-richclient-core/src/main/java/org/springframework/richclient/form/binding/swing/date/NachoCalendarDateFieldBinding.java
@@ -33,11 +33,11 @@ import org.springframework.binding.form.FormModel;
  */
 public class NachoCalendarDateFieldBinding extends AbstractDateFieldBinding {
 
-	private final DateField dateField;
+	private final NullableDateField dateField;
 
 	private Boolean showOkCancel;
 
-	public NachoCalendarDateFieldBinding(DateField dateField, FormModel formModel, String formPropertyPath) {
+	public NachoCalendarDateFieldBinding(NullableDateField dateField, FormModel formModel, String formPropertyPath) {
 		super(formModel, formPropertyPath);
 		this.dateField = dateField;
 	}
diff --git a/spring-richclient-core/src/main/java/org/springframework/richclient/form/binding/swing/date/NullableDateField.java b/spring-richclient-core/src/main/java/org/springframework/richclient/form/binding/swing/date/NullableDateField.java
new file mode 100644
index 0000000..301baa0
--- /dev/null
+++ b/spring-richclient-core/src/main/java/org/springframework/richclient/form/binding/swing/date/NullableDateField.java
@@ -0,0 +1,652 @@
+package org.springframework.richclient.form.binding.swing.date;
+
+import net.sf.nachocalendar.components.ArrowButton;
+import net.sf.nachocalendar.components.CalendarUtils;
+import net.sf.nachocalendar.components.DatePanel;
+import net.sf.nachocalendar.components.DayRenderer;
+import net.sf.nachocalendar.components.DefaultDayRenderer;
+import net.sf.nachocalendar.components.DefaultHeaderRenderer;
+import net.sf.nachocalendar.components.HeaderRenderer;
+import net.sf.nachocalendar.model.DataModel;
+
+import javax.swing.BorderFactory;
+import javax.swing.JButton;
+import javax.swing.JDialog;
+import javax.swing.JFormattedTextField;
+import javax.swing.JOptionPane;
+import javax.swing.JPanel;
+import javax.swing.ListSelectionModel;
+import javax.swing.SwingConstants;
+import javax.swing.border.Border;
+import javax.swing.event.ChangeEvent;
+import javax.swing.event.ChangeListener;
+import javax.swing.text.DateFormatter;
+import java.awt.BorderLayout;
+import java.awt.Color;
+import java.awt.Component;
+import java.awt.Dialog;
+import java.awt.Frame;
+import java.awt.Point;
+import java.awt.event.ActionEvent;
+import java.awt.event.ActionListener;
+import java.awt.event.KeyAdapter;
+import java.awt.event.KeyEvent;
+import java.awt.event.KeyListener;
+import java.awt.event.WindowAdapter;
+import java.awt.event.WindowEvent;
+import java.beans.PropertyChangeEvent;
+import java.beans.PropertyChangeListener;
+import java.text.DateFormat;
+import java.text.ParseException;
+import java.util.Calendar;
+import java.util.Date;
+import java.util.Locale;
+
+/**
+ *
+ */
+public class NullableDateField extends JPanel implements ActionListener, PropertyChangeListener {
+  private WindowPanel windowpanel;
+  //private Date fecha;
+  private DatePanel datepanel;
+  private JFormattedTextField field;
+  private JButton button;
+  private Calendar calendar;
+  private boolean showWeekNumbers;
+  private DateFormatter formatter;
+  private boolean antiAliased;
+  private boolean printMoon;
+  private Locale locale;
+  private DateFormat dateFormat;
+  private Date baseDate;
+
+  private JFormattedTextField.AbstractFormatterFactory formatterFactory = new JFormattedTextField.AbstractFormatterFactory() {
+    public JFormattedTextField.AbstractFormatter getFormatter( JFormattedTextField tf ) {
+      return new DateFormatter( dateFormat );
+    }
+  };
+
+  /**
+   * Utility field holding list of ChangeListeners.
+   */
+  private transient java.util.ArrayList changeListenerList;
+
+  /**
+   * Holds value of property showOkCancel.
+   */
+  private boolean showOkCancel;
+
+  /**
+   * Holds value of property firstDayOfWeek.
+   */
+  private int firstDayOfWeek;
+
+  /**
+   * Holds value of property workingDays.
+   */
+  private boolean[] workingDays;
+
+  /**
+   * Creates a new instance of DateField.
+   *
+   * @param showWeekNumbers true if the week numbers must be shown
+   */
+  public NullableDateField( boolean showWeekNumbers ) {
+    //panel = new WindowPanel(parent, showWeekNumbers);
+    this.showWeekNumbers = showWeekNumbers;
+    init();
+  }
+
+  /**
+   * Constructs a default DateField.
+   */
+  public NullableDateField() {
+    this( false );
+  }
+
+  /**
+   * Constructor with a custom formatter.
+   *
+   * @param formatter formatter used for the textfield
+   */
+  public NullableDateField( DateFormatter formatter ) {
+    this.formatter = formatter;
+    init();
+  }
+
+  public NullableDateField( DateFormat dateFormat ) {
+    this.dateFormat = dateFormat;
+    init();
+  }
+
+  /**
+   * Constructor with a custom locale.
+   *
+   * @param locale Locale to use
+   */
+  public NullableDateField( Locale locale ) {
+    this.locale = locale;
+    init();
+  }
+
+  private void init() {
+    if ( locale == null ) locale = Locale.getDefault();
+    calendar = Calendar.getInstance();
+    calendar.set( Calendar.HOUR, 0 );
+    calendar.set( Calendar.MINUTE, 0 );
+    calendar.set( Calendar.MILLISECOND, 0 );
+    datepanel = new DatePanel( showWeekNumbers );
+    datepanel.setFirstDayOfWeek( firstDayOfWeek );
+    datepanel.setWorkingDays( workingDays );
+    datepanel.setSelectionMode( ListSelectionModel.SINGLE_SELECTION );
+    setRenderer( new DefaultDayRenderer() );
+    setHeaderRenderer( new DefaultHeaderRenderer() );
+    setLayout( new BorderLayout() );
+    if ( dateFormat != null ) {
+      field = new JFormattedTextField( dateFormat );
+    } else {
+      if ( formatter == null ) formatter = new DateFormatter( DateFormat.getDateInstance( DateFormat.SHORT, locale ) );
+      field = new JFormattedTextField( formatter );
+    }
+    add( field, BorderLayout.CENTER );
+    button = new ArrowButton( SwingConstants.SOUTH );
+    add( button, BorderLayout.EAST );
+    button.addActionListener( this );
+    field.setValue( new Date() );
+    field.addPropertyChangeListener( "value", this );
+    Border border = field.getBorder();
+    field.setBorder( null );
+    setBorder( border );
+
+    field.addPropertyChangeListener( new PropertyChangeListener() {
+      public void propertyChange( PropertyChangeEvent evt ) {
+        if ( "editValid".equals( evt.getPropertyName() ) && evt.getNewValue()==Boolean.FALSE ) {
+          if ( field.getText().length() == 0 ) {
+            field.setValue( null );
+          }
+        }
+
+        firePropertyChange( evt.getPropertyName(), evt.getOldValue(), evt.getNewValue() );
+      }
+    } );
+  }
+
+  private void aceptar() {
+    windowpanel.setVisible( false );
+    field.setValue( windowpanel.getDate() );
+  }
+
+  private void cancelar() {
+    windowpanel.setVisible( false );
+  }
+
+  private void createWindow() {
+    Component c = this;
+    //Dialog d = null;
+    while ( !( c instanceof Dialog ) && ( c != null ) ) {
+      c = c.getParent();
+    }
+    if ( c != null ) {
+      windowpanel = new WindowPanel( ( Dialog ) c, showWeekNumbers );
+      return;
+    }
+
+    Frame f = JOptionPane.getFrameForComponent( this );
+    windowpanel = new WindowPanel( f, showWeekNumbers );
+  }
+
+  /**
+   * Invoked when an action occurs.
+   *
+   * @param e the event fired
+   */
+  public void actionPerformed( ActionEvent e ) {
+    if ( windowpanel == null ) {
+      createWindow();
+    }
+
+    Date da = ( Date ) field.getValue();
+    if ( da == null ) {
+      da = baseDate;
+    }
+    if ( da == null ) {
+      da = calendar.getTime();
+    }
+    windowpanel.setDate( da );
+    Point p = getLocationOnScreen();
+    p.y += getHeight();
+    windowpanel.setLocation( p );
+    windowpanel.setVisible( true );
+  }
+
+  /**
+   * Sets the current Date.
+   *
+   * @param value current Date
+   */
+  public void setValue( Object value ) {
+    try {
+      field.setValue( CalendarUtils.convertToDate( value ) );
+    } catch ( ParseException e ) {
+      e.printStackTrace();
+    }
+  }
+
+  /**
+   * Returns the current Date.
+   *
+   * @return current Date
+   */
+  public Object getValue() {
+    return field.getValue();
+  }
+
+  /**
+   * Registers ChangeListener to receive events.
+   *
+   * @param listener The listener to register.
+   */
+  public synchronized void addChangeListener( ChangeListener listener ) {
+    if ( changeListenerList == null ) {
+      changeListenerList = new java.util.ArrayList();
+    }
+    changeListenerList.add( listener );
+  }
+
+  /**
+   * Removes ChangeListener from the list of listeners.
+   *
+   * @param listener The listener to remove.
+   */
+  public synchronized void removeChangeListener( ChangeListener listener ) {
+    if ( changeListenerList != null ) {
+      changeListenerList.remove( listener );
+    }
+  }
+
+  /**
+   * Notifies all registered listeners about the event.
+   *
+   * @param event The event to be fired
+   */
+  private void fireChangeListenerStateChanged( ChangeEvent event ) {
+    java.util.ArrayList list;
+    synchronized ( this ) {
+      if ( changeListenerList == null ) {
+        return;
+      }
+      list = ( java.util.ArrayList ) changeListenerList.clone();
+    }
+    for ( int i = 0; i < list.size(); i++ ) {
+      ( ( javax.swing.event.ChangeListener ) list.get( i ) ).stateChanged( event );
+    }
+  }
+
+  /**
+   * Event fired when a property changes.
+   *
+   * @param evt event fired
+   */
+  public void propertyChange( PropertyChangeEvent evt ) {
+    fireChangeListenerStateChanged( new ChangeEvent( this ) );
+  }
+
+  /**
+   * Getter for property renderer.
+   *
+   * @return Value of property renderer.
+   */
+  public DayRenderer getRenderer() {
+    return datepanel.getRenderer();
+  }
+
+  /**
+   * Setter for property renderer.
+   *
+   * @param renderer New value of property renderer.
+   */
+  public void setRenderer( DayRenderer renderer ) {
+    datepanel.setRenderer( renderer );
+  }
+
+  /**
+   * Getter for property model.
+   *
+   * @return Value of property model.
+   */
+  public DataModel getModel() {
+    return datepanel.getModel();
+  }
+
+  /**
+   * Setter for property model.
+   *
+   * @param model New value of property model.
+   */
+  public void setModel( DataModel model ) {
+    datepanel.setModel( model );
+  }
+
+  /**
+   * Getter for property headerRenderer.
+   *
+   * @return Value of property headerRenderer.
+   */
+  public HeaderRenderer getHeaderRenderer() {
+    return datepanel.getHeaderRenderer();
+  }
+
+  /**
+   * Setter for property headerRenderer.
+   *
+   * @param headerRenderer New value of property headerRenderer.
+   */
+  public void setHeaderRenderer( HeaderRenderer headerRenderer ) {
+    datepanel.setHeaderRenderer( headerRenderer );
+  }
+
+  /**
+   * Getter for property showOkCancel.
+   *
+   * @return Value of property showOkCancel.
+   */
+  public boolean getShowOkCancel() {
+    return this.showOkCancel;
+  }
+
+  /**
+   * Setter for property showOkCancel.
+   *
+   * @param showOkCancel New value of property showOkCancel.
+   */
+  public void setShowOkCancel( boolean showOkCancel ) {
+    if ( this.showOkCancel == showOkCancel ) {
+      return;
+    }
+    boolean old = this.showOkCancel;
+    this.showOkCancel = showOkCancel;
+    windowpanel = null;
+    firePropertyChange( "showOkCancel", old, showOkCancel );
+  }
+
+  /**
+   * Getter for property allowsInvalid.
+   *
+   * @return Value of property showOkCancel.
+   */
+  public boolean getAllowsInvalid() {
+    return formatter.getAllowsInvalid();
+  }
+
+  /**
+   * Setter for property allowsInvalid.
+   *
+   * @param showOkCancel New value of property showOkCancel.
+   */
+  public void setAllowsInvalid( boolean b ) {
+    boolean old = formatter.getAllowsInvalid();
+    formatter.setAllowsInvalid( b );
+    firePropertyChange( "allowsInvalid", old, b );
+  }
+
+  /**
+   * Getter for property firstDayOfWeek.
+   *
+   * @return Value of property firstDayOfWeek.
+   */
+  public int getFirstDayOfWeek() {
+    return this.firstDayOfWeek;
+  }
+
+  /**
+   * Setter for property firstDayOfWeek.
+   *
+   * @param firstDayOfWeek New value of property firstDayOfWeek.
+   */
+  public void setFirstDayOfWeek( int firstDayOfWeek ) {
+    int old = this.firstDayOfWeek;
+    if ( datepanel != null ) datepanel.setFirstDayOfWeek( firstDayOfWeek );
+    this.firstDayOfWeek = firstDayOfWeek;
+    firePropertyChange( "firstDayOfWeek", old, firstDayOfWeek );
+  }
+
+  /**
+   * Getter for property workingDays.
+   *
+   * @return Value of property workingDays.
+   */
+  public boolean[] getWorkingDays() {
+    return this.workingDays;
+  }
+
+  /**
+   * Setter for property workingDays.
+   *
+   * @param workingDays New value of property workingDays.
+   */
+  public void setWorkingDays( boolean[] workingDays ) {
+    boolean[] old = this.workingDays;
+    if ( datepanel != null ) datepanel.setWorkingDays( workingDays );
+    this.workingDays = workingDays;
+    firePropertyChange( "workingDays", old, workingDays );
+  }
+
+  /**
+   * Enables or disables the component
+   *
+   * @param enabled true for enabling
+   */
+  public void setEnabled( boolean enabled ) {
+    button.setEnabled( enabled );
+    field.setEnabled( enabled );
+    super.setEnabled( enabled );
+  }
+
+  /**
+   * Getter for enabled property
+   *
+   * @return true if it's enabled
+   */
+  public boolean isEnabled() {
+    return button.isEnabled();
+  }
+
+  /**
+   * Returns the JFormattedTextField for further customization
+   *
+   * @return the JFormattedTextField
+   */
+  public JFormattedTextField getFormattedTextField() {
+    return field;
+  }
+
+  class WindowPanel extends JDialog {
+    public WindowPanel( Frame parent, boolean showWeekNumbers ) {
+      super( parent, false );
+      init( showWeekNumbers );
+    }
+
+    public WindowPanel( Dialog parent, boolean showWeekNumbers ) {
+      super( parent, false );
+      init( showWeekNumbers );
+    }
+
+    private void init( boolean showWeekNumbers ) {
+      setUndecorated( true );
+      setFocusable( true );
+      JPanel todo = new JPanel( new BorderLayout() );
+      getContentPane().add( todo );
+      todo.add( datepanel );
+      todo.setBorder( BorderFactory.createLineBorder( Color.black ) );
+
+      if ( showOkCancel ) {
+        JPanel abajo = new JPanel();
+        todo.add( abajo, BorderLayout.SOUTH );
+        JButton ok = new JButton( "Ok" );
+        JButton cancel = new JButton( "Cancel" );
+        abajo.add( ok );
+        abajo.add( cancel );
+        getRootPane().setDefaultButton( ok );
+        ok.addActionListener( new ActionListener() {
+          public void actionPerformed( ActionEvent e ) {
+            aceptar();
+          }
+        } );
+        cancel.addActionListener( new ActionListener() {
+          public void actionPerformed( ActionEvent e ) {
+            cancelar();
+          }
+        } );
+      } else {
+        /*datepanel.addChangeListener(new ChangeListener() {
+            public void stateChanged(ChangeEvent e) {
+                aceptar();
+            }
+        });*/
+        datepanel.addActionListener( new ActionListener() {
+          public void actionPerformed( ActionEvent e ) {
+            aceptar();
+          }
+        } );
+      }
+
+      KeyListener klistener = new KeyAdapter() {
+        public void keyTyped( KeyEvent e ) {
+          if ( e.getKeyChar() == 10 ) {
+            aceptar();
+          }
+          if ( e.getKeyChar() == 27 ) {
+            cancelar();
+          }
+        }
+      };
+
+      datepanel.addKeyListener( klistener );
+      addKeyListener( klistener );
+
+
+      addWindowListener( new WindowAdapter() {
+        public void windowDeactivated( WindowEvent e ) {
+          cancelar();
+        }
+      } );
+
+
+      pack();
+    }
+
+    public Date getDate() {
+      return datepanel.getDate();
+    }
+
+    public void setDate( Date d ) {
+      datepanel.setDate( d );
+    }
+  }
+
+  /**
+   * @return Returns the antiAliased.
+   */
+  public boolean isAntiAliased() {
+    return antiAliased;
+  }
+
+  /**
+   * @param antiAliased The antiAliased to set.
+   */
+  public void setAntiAliased( boolean antiAliased ) {
+    boolean old = this.antiAliased;
+    this.antiAliased = antiAliased;
+    datepanel.setAntiAliased( antiAliased );
+    firePropertyChange( "antiAliased", old, antiAliased );
+  }
+
+  /**
+   * @return Returns the printMoon.
+   */
+  public boolean isPrintMoon() {
+    return printMoon;
+  }
+
+  /**
+   * @param printMoon The printMoon to set.
+   */
+  public void setPrintMoon( boolean printMoon ) {
+    datepanel.setPrintMoon( printMoon );
+    repaint();
+    this.printMoon = printMoon;
+  }
+
+  /**
+   * Sets the Today button visibility.
+   *
+   * @param show
+   */
+  public void setShowToday( boolean show ) {
+    datepanel.setShowToday( show );
+    repaint();
+  }
+
+  /**
+   * Returns the Today button visibility.
+   *
+   * @return
+   */
+  public boolean getShowToday() {
+    return datepanel.getShowToday();
+  }
+
+  /**
+   * Sets the today button text.
+   *
+   * @param caption
+   */
+  public void setTodayCaption( String caption ) {
+    datepanel.setTodayCaption( caption );
+  }
+
+  /**
+   * Returns the today button text.
+   *
+   * @return
+   */
+  public String getTodayCaption() {
+    return datepanel.getTodayCaption();
+  }
+
+  /**
+   * @return Returns the dateFormat.
+   */
+  public DateFormat getDateFormat() {
+    return dateFormat;
+  }
+
+  /**
+   * @param dateFormat The dateFormat to set.
+   */
+  public void setDateFormat( DateFormat dateFormat ) {
+    this.dateFormat = dateFormat;
+    field.setFormatterFactory( formatterFactory );
+  }
+
+  /**
+   * @return Returns the baseDate.
+   */
+  public Date getBaseDate() {
+    return baseDate;
+  }
+
+  /**
+   * A base date may different from "today" and will be the date
+   * shown on the Date Window when it is launched.  Basically, a user
+   * can have an empty textfield but when the window is open, it won't show
+   * today by default but whatever baseDate is.  It is backward compatible, ie
+   * if you do not have a baseDate, the window will open with "today".
+   *
+   * @param baseDate The baseDate to set.
+   */
+  public void setBaseDate( Date baseDate ) {
+    this.baseDate = baseDate;
+  }
+}
+
diff --git a/spring-richclient-core/src/test/java/org/springframework/richclient/form/binding/swing/date/NachoCalendarDateFieldBinderTests.java b/spring-richclient-core/src/test/java/org/springframework/richclient/form/binding/swing/date/NachoCalendarDateFieldBinderTests.java
index d4f5956..de49248 100644
--- a/spring-richclient-core/src/test/java/org/springframework/richclient/form/binding/swing/date/NachoCalendarDateFieldBinderTests.java
+++ b/spring-richclient-core/src/test/java/org/springframework/richclient/form/binding/swing/date/NachoCalendarDateFieldBinderTests.java
@@ -37,11 +37,11 @@ public class NachoCalendarDateFieldBinderTests extends AbstractDateFieldBindingT
 	}
 
   protected void setValue( JComponent dateField, String value ) {
-    ( ( DateField ) dateField ).getFormattedTextField().setText( value );
+    ( ( NullableDateField ) dateField ).getFormattedTextField().setText( value );
   }
 
   protected void setValue(JComponent dateField, Date date) {
-		((DateField) dateField).setValue(date);
+		((NullableDateField) dateField).setValue(date);
 	}
 
 	protected boolean isReadOnly(JComponent dateField) {
-- 
1.6.2