Add events for various frame events.

Change-Id: I0fed39b3e4a199a4b87d3b2e182d1c674ac4c072
Reviewed-on: http://gerrit.dmdirc.com/3755
Reviewed-by: Chris Smith <chris@dmdirc.com>
Automatic-Compile: DMDirc Build Manager

src/com/dmdirc/FrameContainer.java

@@ -24,9 +24,14 @@ package com.dmdirc;
 
 import com.dmdirc.commandparser.parsers.CommandParser;
 import com.dmdirc.events.ClientLineAddedEvent;
+import com.dmdirc.events.FrameClosingEvent;
+import com.dmdirc.events.FrameComponentAddedEvent;
+import com.dmdirc.events.FrameComponentRemovedEvent;
 import com.dmdirc.events.FrameIconChangedEvent;
 import com.dmdirc.events.FrameNameChangedEvent;
 import com.dmdirc.events.FrameTitleChangedEvent;
+import com.dmdirc.events.NotificationClearedEvent;
+import com.dmdirc.events.NotificationSetEvent;
 import com.dmdirc.interfaces.Connection;
 import com.dmdirc.interfaces.FrameCloseListener;
 import com.dmdirc.interfaces.FrameComponentChangeListener;
@@ -351,6 +356,7 @@ public abstract class FrameContainer {
     public void addComponent(final String component) {
         components.add(component);
 
+        eventBus.publishAsync(new FrameComponentAddedEvent(this, component));
         for (FrameComponentChangeListener listener
                 : listeners.get(FrameComponentChangeListener.class)) {
             listener.componentAdded(this, component);
@@ -366,6 +372,7 @@ public abstract class FrameContainer {
     public void removeComponent(final String component) {
         components.remove(component);
 
+        eventBus.publishAsync(new FrameComponentRemovedEvent(this, component));
         for (FrameComponentChangeListener listener
                 : listeners.get(FrameComponentChangeListener.class)) {
             listener.componentRemoved(this, component);
@@ -378,6 +385,7 @@ public abstract class FrameContainer {
     public void close() {
         eventBusManager.disconnect();
 
+        eventBus.publishAsync(new FrameClosingEvent(this));
         for (FrameCloseListener listener : listeners.get(FrameCloseListener.class)) {
             listener.windowClosing(this);
             listeners.remove(FrameCloseListener.class, listener);
@@ -433,6 +441,7 @@ public abstract class FrameContainer {
      */
     public void clearNotification() {
         notification = Optional.absent();
+        eventBus.publishAsync(new NotificationClearedEvent(this));
         listeners.getCallable(NotificationListener.class).notificationCleared(this);
     }
 
@@ -444,6 +453,7 @@ public abstract class FrameContainer {
     public void sendNotification(final Colour colour) {
         if (!notification.isPresent() || !colour.equals(notification.get())) {
             notification = Optional.of(colour);
+            eventBus.publishAsync(new NotificationSetEvent(this, colour));
             listeners.getCallable(NotificationListener.class).notificationSet(this, colour);
         }
     }
@@ -548,6 +558,7 @@ public abstract class FrameContainer {
      *
      * @param listener The listener to be added
      */
+    @Deprecated
     public void addCloseListener(final FrameCloseListener listener) {
         listeners.add(FrameCloseListener.class, listener);
     }
@@ -558,6 +569,7 @@ public abstract class FrameContainer {
      * @since 0.6.5
      * @param listener The listener to be removed
      */
+    @Deprecated
     public void removeCloseListener(final FrameCloseListener listener) {
         listeners.remove(FrameCloseListener.class, listener);
     }
@@ -568,6 +580,7 @@ public abstract class FrameContainer {
      * @since 0.6.6
      * @param listener The listener to be added
      */
+    @Deprecated
     public void addComponentListener(final FrameComponentChangeListener listener) {
         listeners.add(FrameComponentChangeListener.class, listener);
     }
@@ -578,6 +591,7 @@ public abstract class FrameContainer {
      * @since 0.6.6
      * @param listener The listener to be removed
      */
+    @Deprecated
     public void removeComponentListener(final FrameComponentChangeListener listener) {
         listeners.remove(FrameComponentChangeListener.class, listener);
     }
@@ -587,6 +601,7 @@ public abstract class FrameContainer {
      *
      * @param listener The listener to inform of notification events.
      */
+    @Deprecated
     public void addNotificationListener(final NotificationListener listener) {
         listeners.add(NotificationListener.class, listener);
     }
@@ -596,6 +611,7 @@ public abstract class FrameContainer {
      *
      * @param listener The listener to be removed.
      */
+    @Deprecated
     public void removeNotificationListener(final NotificationListener listener) {
         listeners.remove(NotificationListener.class, listener);
     }

src/com/dmdirc/events/FrameClosingEvent.java

@@ -0,0 +1,35 @@
+/*
+ * Copyright (c) 2006-2014 DMDirc Developers
+ *
+ * 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.events;
+
+import com.dmdirc.FrameContainer;
+
+/**
+ * Fired when a window is closed in the client.
+ */
+public class FrameClosingEvent extends FrameEvent {
+
+    public FrameClosingEvent(final FrameContainer container) {
+        super(container);
+    }
+}

src/com/dmdirc/events/FrameComponentAddedEvent.java

@@ -0,0 +1,35 @@
+/*
+ * Copyright (c) 2006-2014 DMDirc Developers
+ *
+ * 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.events;
+
+import com.dmdirc.FrameContainer;
+
+/**
+ * Fired when a frame component is added.
+ */
+public class FrameComponentAddedEvent extends FrameComponentEvent {
+
+    public FrameComponentAddedEvent(final FrameContainer container, final String component) {
+        super(container, component);
+    }
+}

src/com/dmdirc/events/FrameComponentEvent.java

@@ -0,0 +1,47 @@
+/*
+ * Copyright (c) 2006-2014 DMDirc Developers
+ *
+ * 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.events;
+
+import com.dmdirc.FrameContainer;
+
+/**
+ * Base class for frame component events.
+ */
+public abstract class FrameComponentEvent {
+
+    private final FrameContainer container;
+    private final String component;
+
+    public FrameComponentEvent(final FrameContainer container, final String component) {
+        this.container = container;
+        this.component = component;
+    }
+
+    public FrameContainer getContainer() {
+        return container;
+    }
+
+    public String getComponent() {
+        return component;
+    }
+}

src/com/dmdirc/events/FrameComponentRemovedEvent.java

@@ -0,0 +1,35 @@
+/*
+ * Copyright (c) 2006-2014 DMDirc Developers
+ *
+ * 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.events;
+
+import com.dmdirc.FrameContainer;
+
+/**
+ * Fired when a frame component is removed.
+ */
+public class FrameComponentRemovedEvent extends FrameComponentEvent {
+
+    public FrameComponentRemovedEvent(final FrameContainer container, final String component) {
+        super(container, component);
+    }
+}

src/com/dmdirc/events/FrameEvent.java

@@ -0,0 +1,41 @@
+/*
+ * Copyright (c) 2006-2014 DMDirc Developers
+ *
+ * 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.events;
+
+import com.dmdirc.FrameContainer;
+
+/**
+ * Base class for window related events in the client.
+ */
+public abstract class FrameEvent extends DMDircEvent {
+
+    private final FrameContainer container;
+
+    public FrameEvent(final FrameContainer container) {
+        this.container = container;
+    }
+
+    public FrameContainer getContainer() {
+        return container;
+    }
+}

src/com/dmdirc/events/NotificationClearedEvent.java

@@ -0,0 +1,35 @@
+/*
+ * Copyright (c) 2006-2014 DMDirc Developers
+ *
+ * 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.events;
+
+import com.dmdirc.FrameContainer;
+
+/**
+ * Fired when a notification has been cleared.
+ */
+public class NotificationClearedEvent extends NotificationEvent {
+
+    public NotificationClearedEvent(final FrameContainer container) {
+        super(container);
+    }
+}

src/com/dmdirc/events/NotificationEvent.java

@@ -0,0 +1,41 @@
+/*
+ * Copyright (c) 2006-2014 DMDirc Developers
+ *
+ * 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.events;
+
+import com.dmdirc.FrameContainer;
+
+/**
+ * Base class for notification events in the client.
+ */
+public abstract class NotificationEvent extends DMDircEvent {
+
+    private final FrameContainer window;
+
+    public NotificationEvent(final FrameContainer window) {
+        this.window = window;
+    }
+
+    public FrameContainer getWindow() {
+        return window;
+    }
+}

src/com/dmdirc/events/NotificationSetEvent.java

@@ -0,0 +1,43 @@
+/*
+ * Copyright (c) 2006-2014 DMDirc Developers
+ *
+ * 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.events;
+
+import com.dmdirc.FrameContainer;
+import com.dmdirc.ui.Colour;
+
+/**
+ * Fired when the notification colour has been changed.
+ */
+public class NotificationSetEvent extends NotificationEvent {
+
+    private final Colour colour;
+
+    public NotificationSetEvent(final FrameContainer container, final Colour colour) {
+        super(container);
+        this.colour = colour;
+    }
+
+    public Colour getColour() {
+        return colour;
+    }
+}

src/com/dmdirc/interfaces/FrameCloseListener.java

@@ -29,7 +29,10 @@ import com.dmdirc.FrameContainer;
  * of a {@link FrameContainer}.
  *
  * @since 0.6.5
+ *
+ * @deprecated @see com.dmdirc.events.WindowClosingEvent
  */
+@Deprecated
 public interface FrameCloseListener {
 
     /**

src/com/dmdirc/interfaces/FrameComponentChangeListener.java

@@ -29,6 +29,7 @@ import com.dmdirc.FrameContainer;
  *
  * @since 0.6.6
  */
+@Deprecated
 public interface FrameComponentChangeListener {
 
     /**

src/com/dmdirc/interfaces/NotificationListener.java

@@ -31,6 +31,7 @@ import java.util.EventListener;
  * Defines the methods that should be implemented by classes which wish to receive information about
  * notification changes.
  */
+@Deprecated
 public interface NotificationListener extends EventListener {
 
     /**