Window titles are now handled by the core

Fixes issue 3996

Change-Id: I562e5db0da3af91b880cd98c9af11712750bf9f0
Reviewed-on: http://gerrit.dmdirc.com/1118
Automatic-Compile: Gregory Holmes <greg@dmdirc.com>
Reviewed-by: Gregory Holmes <greg@dmdirc.com>

src/com/dmdirc/Channel.java

@@ -96,6 +96,7 @@ public class Channel extends MessageTarget implements ConfigChangeListener {
      */
     public Channel(final Server newServer, final ChannelInfo newChannelInfo) {
         super("channel-inactive", newChannelInfo.getName(),
+                Styliser.stipControlCodes(newChannelInfo.getName()),
                 new ConfigManager(newServer.getProtocol(), newServer.getIrcd(),
                 newServer.getNetwork(), newServer.getAddress(), newChannelInfo.getName()));
 
@@ -298,7 +299,7 @@ public class Channel extends MessageTarget implements ConfigChangeListener {
             temp = temp + " - " + Styliser.stipControlCodes(channelInfo.getTopic());
         }
 
-        window.setTitle(temp);
+        setTitle(temp);
     }
 
     /**
@@ -507,7 +508,7 @@ public class Channel extends MessageTarget implements ConfigChangeListener {
         res[3] = client.getClient().getHostname();
 
         if (showColours) {
-            final Map map = client.getMap();
+            final Map<?,?> map = client.getMap();
             String prefix = null;
             Color colour;
 

src/com/dmdirc/CustomWindow.java

@@ -33,9 +33,6 @@ import com.dmdirc.ui.interfaces.Window;
  */
 public class CustomWindow extends FrameContainer {
 
-    /** This custom window's title. */
-    private final String title;
-
     /** The window used by this container. */
     private Window window;
 
@@ -51,13 +48,11 @@ public class CustomWindow extends FrameContainer {
      */
     public CustomWindow(final String name, final String title,
             final Window parent) {
-        super("custom", name, parent.getConfigManager());
+        super("custom", name, title, parent.getConfigManager());
 
-        this.title = title;
         this.parent = parent;
 
         window = Main.getUI().getWindow(this);
-        window.setTitle(title);
 
         WindowManager.addWindow(parent, window);
 
@@ -71,12 +66,9 @@ public class CustomWindow extends FrameContainer {
      * @param title The parent of this custom window
      */
     public CustomWindow(final String name, final String title) {
-        super("custom", name, IdentityManager.getGlobalConfig());
-
-        this.title = title;
+        super("custom", name, title, IdentityManager.getGlobalConfig());
 
         window = Main.getUI().getWindow(this);
-        window.setTitle(title);
 
         WindowManager.addWindow(this);
 
@@ -118,13 +110,4 @@ public class CustomWindow extends FrameContainer {
         return parent == null ? null : parent.getContainer().getServer();
     }
 
-    /**
-     * Retrieves this custom window's title.
-     *
-     * @return This custom window's title
-     */
-    public String getTitle() {
-        return title;
-    }
-
 }

src/com/dmdirc/FrameContainer.java

@@ -79,6 +79,9 @@ public abstract class FrameContainer {
     /** The name of this container. */
     private String name;
 
+    /** The title of this container. */
+    private String title;
+
     /** The transcoder to use for this container. */
     private final StringTranscoder transcoder;
     
@@ -96,12 +99,15 @@ public abstract class FrameContainer {
      * 
      * @param icon The icon to use for this container
      * @param name The name of this container
+     * @param title The title of this container
      * @param config The config manager for this container
-     * @since 0.6.3m2
+     * @since 0.6.4
      */
-    public FrameContainer(final String icon, final String name, final ConfigManager config) {
+    public FrameContainer(final String icon, final String name,
+            final String title, final ConfigManager config) {
         this.config = config;
         this.name = name;
+        this.title = title;
         this.styliser = new Styliser(this);
         this.document = new IRCDocument(this);
 
@@ -236,6 +242,32 @@ public abstract class FrameContainer {
         }
     }
 
+    /**
+     * Retrieves the title which should be used by this container's windows.
+     *
+     * @return This container's title
+     * @since 0.6.4
+     */
+    public String getTitle() {
+        return title;
+    }
+
+    /**
+     * Changes the title of this container, and notifies any
+     * {@link FrameInfoListener}s of the change.
+     *
+     * @param title The new title for this frame.
+     */
+    public void setTitle(final String title) {
+        this.title = title;
+
+        synchronized (listeners) {
+            for (FrameInfoListener listener : listeners.get(FrameInfoListener.class)) {
+                listener.titleChanged(this, name);
+            }
+        }
+    }
+
     /**
      * Closes this container (and it's associated frame).
      */

src/com/dmdirc/GlobalWindow.java

@@ -51,7 +51,7 @@ public class GlobalWindow extends WritableFrameContainer {
 
     /** Creates a new instance of GlobalWindow. */
     public GlobalWindow() {
-        super("icon", "Global", IdentityManager.getGlobalConfig());
+        super("icon", "Global", "(Global)", IdentityManager.getGlobalConfig());
 
         tabCompleter = new TabCompleter();
         tabCompleter.addEntries(TabCompletionType.COMMAND,
@@ -61,7 +61,6 @@ public class GlobalWindow extends WritableFrameContainer {
 
         window = Main.getUI().getInputWindow(this, GlobalCommandParser.getGlobalCommandParser());
 
-        window.setTitle("(Global)");
         window.getInputHandler().setTabCompleter(tabCompleter);
 
         WindowManager.addWindow(this);

src/com/dmdirc/MessageTarget.java

@@ -37,11 +37,13 @@ public abstract class MessageTarget extends WritableFrameContainer {
      * 
      * @param icon The icon to use for this target
      * @param name The name of this target
+     * @param title The title of this target
      * @param config The config manager to use for this target
-     * @since 0.6.3m2
+     * @since 0.6.4
      */
-    public MessageTarget(final String icon, final String name, final ConfigManager config) {
-        super(icon, name, config);
+    public MessageTarget(final String icon, final String name,
+            final String title, final ConfigManager config) {
+        super(icon, name, title, config);
     }
 
     /**

src/com/dmdirc/Query.java

@@ -74,6 +74,7 @@ public class Query extends MessageTarget implements PrivateActionListener,
      */
     public Query(final Server newServer, final String newHost) {
         super("query", newServer.getParser().parseHostmask(newHost)[0],
+                newServer.getParser().parseHostmask(newHost)[0],
                 newServer.getConfigManager());
 
         this.server = newServer;
@@ -133,7 +134,7 @@ public class Query extends MessageTarget implements PrivateActionListener,
             return;
         }
 
-        for (String part : splitLine(window.getTranscoder().encode(line))) {
+        for (String part : splitLine(getTranscoder().encode(line))) {
             if (!part.isEmpty()) {
                 server.getParser().sendMessage(getNickname(), part);
 
@@ -182,7 +183,7 @@ public class Query extends MessageTarget implements PrivateActionListener,
 
         if (maxLineLength >= action.length() + 2) {
             server.getParser().sendAction(getNickname(),
-                    window.getTranscoder().encode(action));
+                    getTranscoder().encode(action));
 
             doNotification("querySelfAction", CoreActionType.QUERY_SELF_ACTION,
                     server.getParser().getLocalClient(), action);
@@ -235,7 +236,7 @@ public class Query extends MessageTarget implements PrivateActionListener,
      * Updates the QueryWindow's title.
      */
     private void updateTitle() {
-        window.setTitle(getNickname());
+        setTitle(getNickname());
     }
 
     /**

src/com/dmdirc/Raw.java

@@ -53,13 +53,12 @@ public final class Raw extends WritableFrameContainer implements DataInListener,
      * @param commandParser Command parser to use
      */
     public Raw(final Server newServer, final CommandParser commandParser) {
-        super("raw", "Raw", newServer.getConfigManager());
+        super("raw", "Raw", "(Raw log)", newServer.getConfigManager());
 
         this.server = newServer;
 
         window = Main.getUI().getInputWindow(this, commandParser);
         WindowManager.addWindow(server, this);
-        window.setTitle("(Raw log)");
         window.getInputHandler().setTabCompleter(server.getTabCompleter());
 
         window.open();
@@ -135,7 +134,7 @@ public final class Raw extends WritableFrameContainer implements DataInListener,
     @Override
     public void sendLine(final String line) {
         if (!line.isEmpty()) {
-            server.sendLine(window.getTranscoder().encode(line));
+            sendLine(getTranscoder().encode(line));
         }
     }
 

src/com/dmdirc/Server.java

@@ -173,7 +173,7 @@ public class Server extends WritableFrameContainer implements ConfigChangeListen
      * @param profile The profile to use
      */
     public Server(final URI uri, final Identity profile) {
-        super("server-disconnected", uri.getHost(),
+        super("server-disconnected", uri.getHost(), uri.getHost(),
                 new ConfigManager(uri.getScheme(), "", "", uri.getHost()));
 
         this.address = uri;
@@ -1240,7 +1240,7 @@ public class Server extends WritableFrameContainer implements ConfigChangeListen
 
                 setName(Formatter.formatMessage(getConfigManager(),
                         "serverName", arguments));
-                window.setTitle(Formatter.formatMessage(getConfigManager(),
+                setTitle(Formatter.formatMessage(getConfigManager(),
                         "serverTitle", arguments));
             }
         }

src/com/dmdirc/WritableFrameContainer.java

@@ -54,11 +54,13 @@ public abstract class WritableFrameContainer extends FrameContainer {
      * 
      * @param icon The icon to use for this container
      * @param name The name of this container
+     * @param title The title of this container
      * @param config The config manager for this container
-     * @since 0.6.3m2
+     * @since 0.6.4
      */
-    public WritableFrameContainer(final String icon, final String name, final ConfigManager config) {
-        super(icon, name, config);
+    public WritableFrameContainer(final String icon, final String name,
+            final String title, final ConfigManager config) {
+        super(icon, name, title, config);
     }
     
     /**

src/com/dmdirc/interfaces/FrameInfoAdapter.java

@@ -1,46 +0,0 @@
-/*
- * Copyright (c) 2006-2010 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.FrameContainer;
-
-/**
- * An adapter for {@link FrameInfoListener}.
- *
- * @author chris
- */
-public class FrameInfoAdapter implements FrameInfoListener {
-
-    /** {@inheritDoc} */
-    @Override
-    public void iconChanged(final FrameContainer window, final String icon) {
-        // Do nothing
-    }
-
-    /** {@inheritDoc} */
-    @Override
-    public void nameChanged(final FrameContainer window, final String name) {
-        // Do nothing
-    }
-
-}

src/com/dmdirc/interfaces/FrameInfoListener.java

@@ -51,4 +51,12 @@ public interface FrameInfoListener extends EventListener {
      */
     void nameChanged(final FrameContainer window, final String name);
 
+    /**
+     * Called when a window's title is changed.
+     *
+     * @param window The window whose title changed
+     * @param title The new title for the window
+     */
+    void titleChanged(final FrameContainer window, final String title);
+
 }

src/com/dmdirc/ui/interfaces/Window.java

@@ -32,7 +32,7 @@ import com.dmdirc.ui.messages.IRCDocument;
  * by all windows. It is assumed that all windows have a main text area.
  */
 public interface Window {
-    
+
     /**
      * Formats the arguments using the Formatter, then adds the result to the
      * main text area.
@@ -43,7 +43,7 @@ public interface Window {
      */
     @Deprecated
     void addLine(String messageType, Object... args);
-    
+
     /**
      * Formats the arguments using the Formatter, then adds the result to the
      * main text area.
@@ -54,17 +54,17 @@ public interface Window {
      */
     @Deprecated
     void addLine(StringBuffer messageType, Object... args);
-    
+
     /**
      * Adds the specified raw line to the window, without using a formatter.
-     * 
+     *
      * @param line The line to be added
      * @param timestamp Whether or not to display the timestamp for this line
      * @deprecated Use corresponding methods in {@link FrameContainer} instead
      */
     @Deprecated
     void addLine(final String line, final boolean timestamp);
-    
+
     /**
      * Clears the main text area of the command window.
      *
@@ -72,97 +72,98 @@ public interface Window {
      */
     @Deprecated
     void clear();
-    
+
     /**
      * Retrieves the config manager for this command window.
      *
      * @return This window's config manager
      */
     ConfigManager getConfigManager();
-    
+
     /**
      * Retrieves the container that owns this command window.
      *
      * @return The container that owns this command window.
      */
     FrameContainer getContainer();
-    
+
     /**
      * Determines if the current window is visible.
      *
      * @return boolean visibility
      */
     boolean isVisible();
-    
+
     /**
      * Sets the visibility of this window.
-     * 
+     *
      * @param isVisible Whether the window should be visible or not
      */
     void setVisible(boolean isVisible);
-    
+
     /**
      * Retrives the current title of this window.
-     * 
+     *
      * @return This window's title
      */
     String getTitle();
-    
+
     /**
      * Determines if this frame is currently maximised.
-     * 
+     *
      * @return true if the frame is maximised, false otherwise
      */
     boolean isMaximum();
-    
+
     /**
      * Sets the title of this window.
-     * 
+     *
      * @param title The new title to be used.
+     * @deprecated Should use {@link FrameContainer#setTitle(java.lang.String)}
      */
+    @Deprecated
     void setTitle(String title);
-    
+
     /**
      * Opens this window.
      */
     void open();
-    
+
     /**
      * Restores this window.
-     * 
+     *
      * @since 0.6.3m1
      */
     void restore();
-    
-    
-    /** 
+
+    /**
      * Maximises this window.
-     * 
+     *
      * @since 0.6.3m1
      */
     void maximise();
-    
+
     /**
      * Toggles Maximise State.
-     * 
+     *
      * @since 0.6.3m1
      */
     void toggleMaximise();
-    
+
     /**
      * Minimises this window.
      */
     void minimise();
-    
+
     /**
      * Returns the transcoder that is being used by the UI.
-     * 
+     *
      * @return This window's transcoder
      * @deprecated Use {@link FrameContainer#getTranscoder()} instead
      */
     @Deprecated
     StringTranscoder getTranscoder();
-    
+
     /** Closes this window. */
     void close();
 
@@ -170,5 +171,5 @@ public interface Window {
      * Requests that this object's frame be activated.
      */
     public void activateFrame();
-    
+
 }

test/com/dmdirc/harness/TestWritableFrameContainer.java

@@ -35,7 +35,7 @@ public class TestWritableFrameContainer extends WritableFrameContainer {
     private final int lineLength;
 
     public TestWritableFrameContainer(final int lineLength, final ConfigManager cm) {
-        super("raw", "Raw", cm);
+        super("raw", "Raw", "(Raw)", cm);
 
         this.lineLength = lineLength;
     }