Added ActionListener support to CalendarSelect.

Author: tliebeck

src/client/extras/Application.CalendarSelect.js

@@ -3,6 +3,7 @@
  * showing the currently selected month/year.  May not contain child components.
  *
  * @cp {Date} date the selected date
+ * @sp {String} actionCommand the action command fired in action events when a date is selected
  * @sp {#Color} adjacentMonthDateBackground background color for dates in previous/next months
  * @sp {#Color} adjacentMonthDateForeground foreground color for dates in previous/next months
  * @sp {#Border} border the border wrapping the calendar
@@ -25,6 +26,8 @@
  * @sp {#Border} selectedDateBorder border of selected date
  * @sp {#FillImage} selectedDateBackgroundImage background image of selected date
  * @sp {#Color} selectedDateForeground foreground color of selected date
+ * @event action An event fired when the date selection changes.  The <code>actionCommand</code> property of the pressed
+ *        button is provided as a property.
  */
 Extras.CalendarSelect = Core.extend(Echo.Component, {
 
@@ -33,5 +36,12 @@ Extras.CalendarSelect = Core.extend(Echo.Component, {
     },
 
     /** @see Echo.Component#componentType */
-    componentType: "Extras.CalendarSelect"
-});
+    componentType: "Extras.CalendarSelect",
+    
+    /**
+     * Programmatically performs a date selection action.
+     */
+    doAction: function() {
+        this.fireEvent({type: "action", source: this, actionCommand: this.get("actionCommand")});
+    }
+ });

src/client/extras/Sync.CalendarSelect.js

@@ -1064,6 +1064,8 @@ Extras.Sync.CalendarSelect = Core.extend(Echo.Render.ComponentSync, {
         this._updateMonthYearSelection();
 
         this._storeValue();
+        
+        this.component.doAction();
     },
 
     /**

src/server-java/app/nextapp/echo/extras/app/CalendarSelect.java

@@ -30,19 +30,27 @@
 package nextapp.echo.extras.app;
 
 import java.util.Date;
+import java.util.EventListener;
 
 import nextapp.echo.app.Border;
 import nextapp.echo.app.Color;
 import nextapp.echo.app.Component;
 import nextapp.echo.app.FillImage;
+import nextapp.echo.app.event.ActionEvent;
+import nextapp.echo.app.event.ActionListener;
 
 /**
  * <code>CalendarSelect</code> component: an input component which allows selection of a single date. Displays a representation of a
  * calendar, showing the currently selected month/year. May not contain child components.
  */
 public class CalendarSelect extends Component {
 
+    public static final String ACTION_LISTENERS_CHANGED_PROPERTY = "actionListeners";
+    
+    public static final String INPUT_ACTION = "action";
+   
     public static final String DATE_CHANGED_PROPERTY = "date";
+    public static final String PROPERTY_ACTION_COMMAND = "actionCommand";
     public static final String PROPERTY_ADJACENT_MONTH_DATE_BACKGROUND = "adjacentMonthDateBackground";
     public static final String PROPERTY_ADJACENT_MONTH_DATE_FOREGROUND = "adjacentMonthDateForeground";
     public static final String PROPERTY_BORDER = "border";
@@ -87,6 +95,51 @@ public CalendarSelect(Date date) {
         this.date = date;
     }
 
+    /**
+     * Adds an <code>ActionListener</code> to the <code>CalendarSelect</code>.
+     * The <code>ActionListener</code> will be invoked each time a date is selected,
+     * either by changing month, day, or year.
+     * <p>
+     * Beware of using this listener to *enforce* date selection within a range, as 
+     * the user may intend to modify one or parameter of a date such that it may
+     * be temporarily invalid.
+     * 
+     * @param l the <code>ActionListener</code> to add
+     */
+    public void addActionListener(ActionListener l) {
+        getEventListenerList().addListener(ActionListener.class, l);
+        // Notification of action listener changes is provided due to 
+        // existence of hasActionListeners() method. 
+        firePropertyChange(ACTION_LISTENERS_CHANGED_PROPERTY, null, l);
+    }
+
+    /**
+     * Fires an action event to all listeners.
+     */
+    private void fireActionEvent() {
+        if (!hasEventListenerList()) {
+            return;
+        }
+        EventListener[] listeners = getEventListenerList().getListeners(ActionListener.class);
+        ActionEvent e = null;
+        for (int i = 0; i < listeners.length; ++i) {
+            if (e == null) {
+                e = new ActionEvent(this, (String) getRenderProperty(PROPERTY_ACTION_COMMAND));
+            } 
+            ((ActionListener) listeners[i]).actionPerformed(e);
+        }
+    }
+
+    /**
+     * Returns the action command which will be provided in 
+     * <code>ActionEvent</code>s fired by this <code>CalendarSelect</code>.
+     * 
+     * @return the action command
+     */
+    public String getActionCommand() {
+        return (String) get(PROPERTY_ACTION_COMMAND);
+    }
+        
     /**
      * Returns the background color of dates in adjacent (previous/next) months.
      * 
@@ -279,13 +332,49 @@ public Color getSelectedDateForeground() {
         return (Color) get(PROPERTY_SELECTED_DATE_FOREGROUND);
     }
 
+    /**
+     * Determines if any <code>ActionListener</code>s are registered.
+     * 
+     * @return true if any action listeners are registered
+     */
+    public boolean hasActionListeners() {
+        return hasEventListenerList() && getEventListenerList().getListenerCount(ActionListener.class) != 0;
+    }
+    
     /**
      * @see nextapp.echo.app.Component#processInput(java.lang.String, java.lang.Object)
      */
     public void processInput(String inputName, Object inputValue) {
         if (DATE_CHANGED_PROPERTY.equals(inputName)) {
             setDate((Date) inputValue);
+        } else if (INPUT_ACTION.equals(inputName)) {
+            fireActionEvent();
+        }
+    }
+    
+    /**
+     * Removes an <code>ActionListener</code> from the <code>CalendarSelect</code>.
+     * 
+     * @param l the <code>ActionListener</code> to remove
+     */
+    public void removeActionListener(ActionListener l) {
+        if (!hasEventListenerList()) {
+            return;
         }
+        getEventListenerList().removeListener(ActionListener.class, l);
+        // Notification of action listener changes is provided due to 
+        // existence of hasActionListeners() method. 
+        firePropertyChange(ACTION_LISTENERS_CHANGED_PROPERTY, l, null);
+    }
+    
+    /**
+     * Sets the action command which will be provided in
+     * <code>ActionEvent</code>s fired by this <code>CalendarSelect</code>.
+     * 
+     * @param newValue the new action command
+     */
+    public void setActionCommand(String newValue) {
+        set(PROPERTY_ACTION_COMMAND, newValue);
     }
 
     /**

src/server-java/testapp-interactive/lib/nextapp/echo/extras/testapp/testscreen/CalendarSelectTest.java

@@ -198,6 +198,25 @@ public void actionPerformed(ActionEvent e) {
             }
         });
 
+        // Listener Tests
+        
+        testControlsPane.addButton(TestControlPane.CATEGORY_LISTENERS, "Set ActionCommand", new ActionListener(){
+            public void actionPerformed(ActionEvent e) {
+                calendarSelect.setActionCommand("ActionCommand " + (int) (Math.random() * 1000));
+            }
+        });
+        
+        testControlsPane.addButton(TestControlPane.CATEGORY_LISTENERS, "Add ActionListener", new ActionListener(){
+            public void actionPerformed(ActionEvent e) {
+                calendarSelect.addActionListener(new ActionListener() {
+                    
+                    public void actionPerformed(ActionEvent e) {
+                        InteractiveApp.getApp().consoleWrite("Action event received: " + e.toString());
+                    }
+                });
+            }
+        });
+        
         addStandardIntegrationTests();
 
     }

src/server-java/webcontainer/nextapp/echo/extras/webcontainer/sync/component/CalendarSelectPeer.java

@@ -80,6 +80,11 @@ private static void addLocaleService(Locale locale, String localeCode) {
     public CalendarSelectPeer() {
         super();
         addOutputProperty(CalendarSelect.DATE_CHANGED_PROPERTY);
+        addEvent(new EventPeer(CalendarSelect.INPUT_ACTION, CalendarSelect.ACTION_LISTENERS_CHANGED_PROPERTY) {
+            public boolean hasListeners(Context context, Component c) {
+                return ((CalendarSelect) c).hasActionListeners();
+            }
+        });
     }
 
     /**