Added NotificationListeners to frame containers

git-svn-id: http://svn.dmdirc.com/trunk@2472 00569f92-eb28-0410-84fd-f71c24880f

src/com/dmdirc/FrameContainer.java

@@ -23,6 +23,7 @@
 package com.dmdirc;
 
 import com.dmdirc.config.ConfigManager;
+import com.dmdirc.interfaces.NotificationListener;
 import com.dmdirc.logger.ErrorLevel;
 import com.dmdirc.logger.Logger;
 import com.dmdirc.ui.interfaces.Window;
@@ -31,6 +32,7 @@ import java.awt.Color;
 import java.beans.PropertyVetoException;
 
 import javax.swing.Icon;
+import javax.swing.event.EventListenerList;
 
 /**
  * The frame container implements basic methods that should be present in
@@ -39,44 +41,47 @@ import javax.swing.Icon;
  * @author chris
  */
 public abstract class FrameContainer {
-    
+
     /** The colour of our frame's notifications. */
     protected Color notification = Color.BLACK;
-    
+
+    /** A list of listeners for this containers's events. */
+    protected final EventListenerList listeners = new EventListenerList();
+
     /** The icon being used for this container's frame. */
     protected Icon icon;
-    
+
     /** Instantiate new frame container. */
     public FrameContainer() {
         //Do nothing
     }
-    
+
     /**
      * Returns the internal frame associated with this object.
      *
      * @return The internal frame associated with this object
      */
     public abstract Window getFrame();
-    
+
     /**
      * Returns a string identifier for this object/its frame.
      *
      * @return String identifier
      */
     public abstract String toString();
-    
+
     /**
      * Closes this container (and it's associated frame).
      */
     public abstract void close();
-    
+
     /**
      * Returns the server instance associated with this container.
      *
      * @return the associated server connection
      */
     public abstract Server getServer();
-    
+
     /**
      * Retrieves the icon used by this container's window.
      *
@@ -85,7 +90,7 @@ public abstract class FrameContainer {
     public Icon getIcon() {
         return icon;
     }
-    
+
     /**
      * Returns the config manager for this container.
      *
@@ -98,22 +103,30 @@ public abstract class FrameContainer {
             return getServer().getConfigManager();
         }
     }
-    
+
     /**
      * Requests that this object's frame be activated.
      */
     public void activateFrame() {
         Main.getUI().getMainWindow().setActiveFrame(getFrame());
     }
-    
+
     /**
      * Clears any outstanding notifications this frame has set.
      */
     protected void clearNotification() {
+        // TODO: This should default ot something colour independent
         notification = Color.BLACK;
-        Main.getUI().getMainWindow().getFrameManager().clearNotification(this);
+
+        final Object[] listenerList = listeners.getListenerList();
+        for (int i = 0; i < listenerList.length; i += 2) {
+            if (listenerList[i] == NotificationListener.class) {
+                ((NotificationListener) listenerList[i + 1])
+                        .notificationCleared(getFrame());
+             }
+        }        
     }
-    
+
     /**
      * Sends a notification to the frame manager if this fame isn't active.
      *
@@ -121,12 +134,20 @@ public abstract class FrameContainer {
      */
     public void sendNotification(final Color colour) {
         final Window activeFrame = Main.getUI().getMainWindow().getActiveFrame();
-        if (activeFrame != null && !activeFrame.equals(getFrame())) {
+        if (activeFrame != null && !activeFrame.equals(getFrame())
+                && !colour.equals(notification)) {
             notification = colour;
-            Main.getUI().getMainWindow().getFrameManager().showNotification(this, colour);
+
+            final Object[] listenerList = listeners.getListenerList();
+            for (int i = 0; i < listenerList.length; i += 2) {
+                if (listenerList[i] == NotificationListener.class) {
+                    ((NotificationListener) listenerList[i + 1])
+                            .notificationSet(getFrame(), colour);
+                }
+            }
         }
     }
-    
+
     /**
      * Retrieves the current notification colour of this channel.
      *
@@ -135,7 +156,7 @@ public abstract class FrameContainer {
     public Color getNotification() {
         return notification;
     }
-    
+
     /**
      * Determines if the specified frame is owned by this object.
      *
@@ -145,7 +166,7 @@ public abstract class FrameContainer {
     public boolean ownsFrame(final Window target) {
         return getFrame().equals(target);
     }
-    
+
     /**
      * Invoked when our window has been opened.
      */
@@ -153,7 +174,7 @@ public abstract class FrameContainer {
         if (getServer() == null || getConfigManager() == null || getFrame() == null) {
             return;
         }
-        
+
         final boolean pref = getConfigManager().getOptionBool("ui", "maximisewindows", false);
         if (pref || Main.getUI().getMainWindow().getMaximised()) {
             try {
@@ -163,21 +184,21 @@ public abstract class FrameContainer {
             }
         }
     }
-    
+
     /**
      * Invoked when our window is closing.
      */
     public void windowClosing() {
         close();
     }
-    
+
     /**
      * Invoked when our window has been closed.
      */
     public void windowClosed() {
         // Ignore.
     }
-    
+
     /**
      * Invoked when our window is activated.
      */
@@ -185,7 +206,7 @@ public abstract class FrameContainer {
         if (getFrame() == null) {
             return;
         }
-        
+
         if (Main.getUI().getMainWindow().getMaximised()) {
             try {
                 getFrame().setMaximum(true);
@@ -195,19 +216,19 @@ public abstract class FrameContainer {
         }
         Main.getUI().getMainWindow().getFrameManager().setSelected(this);
         clearNotification();
-        
+
         if (getServer() != null) {
             getServer().setActiveFrame(this);
         }
     }
-    
+
     /**
      * Invoked when our window is deactivated.
      */
     public void windowDeactivated() {
         // Do nothing.
     }
-    
+
     /**
      * Adds a line to this container's window. If the window is null for some
      * reason, the line is silently discarded.
@@ -220,7 +241,7 @@ public abstract class FrameContainer {
             getFrame().addLine(type, args);
         }
     }
-    
+
     /**
      * Adds a line to this container's window. If the window is null for some
      * reason, the line is silently discarded.
@@ -233,5 +254,5 @@ public abstract class FrameContainer {
             getFrame().addLine(type, args);
         }
     }
-    
+
 }

src/com/dmdirc/Server.java

@@ -124,9 +124,6 @@ public final class Server extends WritableFrameContainer implements Serializable
     /** A list of outstanding invites. */
     private final List<Invite> invites = new ArrayList<Invite>();
     
-    /** A list of listeners for this server's events. */
-    private final EventListenerList listeners = new EventListenerList();
-    
     /**
      * Creates a new instance of Server.
      *

src/com/dmdirc/interfaces/InviteListener.java

@@ -24,6 +24,7 @@ package com.dmdirc.interfaces;
 
 import com.dmdirc.Invite;
 import com.dmdirc.Server;
+
 import java.util.EventListener;
 
 /**

src/com/dmdirc/interfaces/NotificationListener.java

@@ -0,0 +1,52 @@
+/*
+ * Copyright (c) 2006-2007 Chris Smith, Shane Mc Cormack, Gregory Holmes
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in
+ * all copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
+ */
+
+package com.dmdirc.interfaces;
+
+import com.dmdirc.ui.interfaces.Window;
+
+import java.awt.Color;
+import java.util.EventListener;
+
+/**
+ * Defines the methods that should be implemented by classes which wish to
+ * receive information about notification changes.
+ *
+ * @author Chris
+ */
+public interface NotificationListener extends EventListener {
+
+    /**
+     * Called when the notification colour has been changed.
+     *
+     * @param window The window whose notification has changed
+     * @param colour The new colour of the notification
+     */
+    void notificationSet(final Window window, final Color colour);
+
+    /**
+     * Called when a notification has been cleared.
+     *
+     * @param window The window whose notification has been cleared
+     */
+    void notificationCleared(final Window window);
+}