Add UI support for typing labels

Change-Id: Ib3a6830eccc07b8f84aaf65ef12ca9b9eeb0c651
Fixes-Issue: CLIENT-291
Reviewed-on: http://gerrit.dmdirc.com/2131
Automatic-Compile: DMDirc Build Manager
Reviewed-by: Greg Holmes <greg@dmdirc.com>

src/com/dmdirc/addons/ui_swing/components/TypingLabel.java

@@ -0,0 +1,133 @@
+/*
+ * Copyright (c) 2006-2011 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.addons.ui_swing.components;
+
+import com.dmdirc.FrameContainer;
+import com.dmdirc.addons.ui_swing.UIUtilities;
+import com.dmdirc.interfaces.ConfigChangeListener;
+import com.dmdirc.interfaces.FrameCloseListener;
+import com.dmdirc.interfaces.FrameComponentChangeListener;
+import com.dmdirc.ui.core.components.WindowComponent;
+
+import javax.swing.JLabel;
+
+/**
+ * Simple panel to show when a user is typing.
+ */
+public class TypingLabel extends JLabel implements ConfigChangeListener,
+        FrameComponentChangeListener, FrameCloseListener {
+
+    /**
+     * A version number for this class. It should be changed whenever the class
+     * structure is changed (or anything else that would prevent serialized
+     * objects being unserialized with the new class).
+     */
+    private static final long serialVersionUID = 2;
+    /** typingindicator string for compiler optimisation. */
+    private static final String CONFIG_KEY = "typingindicator";
+    /** Whether or not to show the typing indicator. */
+    private boolean useTypingIndicator;
+    /** Parent frame container. */
+    private final FrameContainer container;
+
+    /**
+     * Creates a new typing label for the specified container.
+     *
+     * @param container Parent frame container
+     */
+    public TypingLabel(final FrameContainer container) {
+        super("[Typing...]");
+
+        this.container = container;
+
+        container.getConfigManager().addChangeListener("ui", CONFIG_KEY,
+                this);
+        setVisible(false);
+        useTypingIndicator = container.getConfigManager().getOptionBool("ui",
+                CONFIG_KEY);
+
+        if (container.getComponents().contains(WindowComponent.TYPING_INDICATOR.getIdentifier())) {
+            setVisible(true);
+        }
+
+        container.addComponentListener(this);
+        container.addCloseListener(this);
+    }
+
+    /** {@inheritDoc} */
+    @Override
+    public void configChanged(final String domain, final String key) {
+        useTypingIndicator = container.getConfigManager()
+                .getOptionBool("ui", CONFIG_KEY);
+        if (!useTypingIndicator) {
+            UIUtilities.invokeLater(new Runnable() {
+
+                /** {@inheritDoc} */
+                @Override
+                public void run() {
+                    setVisible(false);
+                }
+            });
+        }
+    }
+
+    /** {@inheritDoc} */
+    @Override
+    public void windowClosing(final FrameContainer window) {
+        if (container != null) {
+            container.removeComponentListener(this);
+        }
+    }
+
+    @Override
+    public void componentAdded(final FrameContainer container, final String component) {
+        if (WindowComponent.TYPING_INDICATOR.getIdentifier().equals(component)) {
+            UIUtilities.invokeLater(new Runnable() {
+
+                    /** {@inheritDoc} */
+                    @Override
+                    public void run() {
+                        if (useTypingIndicator) {
+                            setVisible(true);
+                        }
+                    }
+            });
+        }
+    }
+
+    @Override
+    public void componentRemoved(final FrameContainer container, final String component) {
+        if (WindowComponent.TYPING_INDICATOR.getIdentifier().equals(component)) {
+            UIUtilities.invokeLater(new Runnable() {
+
+                    /** {@inheritDoc} */
+                    @Override
+                    public void run() {
+                        if (useTypingIndicator) {
+                            setVisible(false);
+                        }
+                    }
+            });
+        }
+    }
+}

src/com/dmdirc/addons/ui_swing/components/frames/InputTextFrame.java

@@ -30,6 +30,7 @@ import com.dmdirc.addons.ui_swing.actions.CutAction;
 import com.dmdirc.addons.ui_swing.actions.InputFieldCopyAction;
 import com.dmdirc.addons.ui_swing.actions.InputTextFramePasteAction;
 import com.dmdirc.addons.ui_swing.components.AwayLabel;
+import com.dmdirc.addons.ui_swing.components.TypingLabel;
 import com.dmdirc.addons.ui_swing.components.inputfields.SwingInputField;
 import com.dmdirc.addons.ui_swing.components.inputfields.SwingInputHandler;
 import com.dmdirc.addons.ui_swing.dialogs.paste.PasteDialog;
@@ -79,6 +80,8 @@ public abstract class InputTextFrame extends TextFrame implements InputWindow,
     protected JPopupMenu nickPopup;
     /** Away label. */
     private AwayLabel awayLabel;
+    /** Typing indicator label. */
+    private TypingLabel typingLabel;
 
     /**
      * Creates a new instance of InputFrame.
@@ -139,8 +142,10 @@ public abstract class InputTextFrame extends TextFrame implements InputWindow,
         inputPanel = new JPanel(new BorderLayout(
                 (int) PlatformDefaults.getUnitValueX("related").getValue(),
                 (int) PlatformDefaults.getUnitValueX("related").getValue()));
+
         inputPanel.add(awayLabel, BorderLayout.LINE_START);
         inputPanel.add(inputField, BorderLayout.CENTER);
+        inputPanel.add(typingLabel, BorderLayout.LINE_END);
 
         initInputField();
     }
@@ -156,6 +161,7 @@ public abstract class InputTextFrame extends TextFrame implements InputWindow,
         inputFieldPopup.setLightWeightPopupEnabled(true);
 
         awayLabel = new AwayLabel(getContainer());
+        typingLabel = new TypingLabel(getContainer());
     }
 
     /**