Enable link clicking when wrapping topic. Style fixes.

Fixes issue 4318

Change-Id: I74e2dd9b10f59906165561563d3f383b682ad303
Reviewed-on: http://gerrit.dmdirc.com/1431
Automatic-Compile: DMDirc Local Commits <dmdirc@googlemail.com>
Reviewed-by: Chris Smith <chris@dmdirc.com>

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

@@ -1,17 +1,16 @@
 /*
- * 
  * 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
@@ -60,7 +59,6 @@ import javax.swing.text.DefaultStyledDocument;
 import javax.swing.text.SimpleAttributeSet;
 import javax.swing.text.StyleConstants;
 import javax.swing.text.StyledDocument;
-import javax.swing.text.StyledEditorKit;
 
 import net.miginfocom.swing.MigLayout;
 
@@ -84,17 +82,17 @@ public class TopicBar extends JComponent implements ActionListener,
     /** Cancel button. */
     private final JButton topicCancel;
     /** Associated channel. */
-    private Channel channel;
+    private final Channel channel;
     /** Controller. */
-    private SwingController controller;
-    /** Empty Attrib set. */
+    private final SwingController controller;
+    /** the maximum length allowed for a topic. */
+    private final int topicLengthMax;
+    /** Empty Attribute set. */
     private SimpleAttributeSet as;
     /** Foreground Colour. */
     private Color foregroundColour;
     /** Background Colour. */
     private Color backgroundColour;
-    /** the maximum length allowed for a topic. */
-    private int topicLengthMax;
     /** Error icon. */
     private final JLabel errorIcon;
 
@@ -104,18 +102,16 @@ public class TopicBar extends JComponent implements ActionListener,
      * @param channelFrame Parent channel frame
      */
     public TopicBar(final ChannelFrame channelFrame) {
+        super();
+
         this.channel = (Channel) channelFrame.getContainer();
         controller = channelFrame.getController();
         topicText = new TextPaneInputField();
         topicLengthMax = channel.getMaxTopicLength();
         errorIcon =
                 new JLabel(IconManager.getIconManager().getIcon("input-error"));
-        if (channelFrame.getContainer().getConfigManager().getOptionBool(
-                controller.getDomain(), "showfulltopic")) {
-            topicText.setEditorKit(new StyledEditorKit());
-        } else {
-            topicText.setEditorKit(new WrapEditorKit());
-        }
+        topicText.setEditorKit(new WrapEditorKit(channel.getConfigManager()
+                .getOptionBool(controller.getDomain(), "showfulltopic")));
         ((DefaultStyledDocument) topicText.getDocument()).setDocumentFilter(
                 new NewlinesDocumentFilter());
 
@@ -137,11 +133,15 @@ public class TopicBar extends JComponent implements ActionListener,
         sp.setHorizontalScrollBarPolicy(JScrollPane.HORIZONTAL_SCROLLBAR_NEVER);
         sp.setVerticalScrollBarPolicy(JScrollPane.VERTICAL_SCROLLBAR_NEVER);
 
-        setLayout(new MigLayout("fillx, ins 0, hidemode 3"));
+        setLayout(new MigLayout("fillx, ins 0, hidemode 3, pack"));
         add(sp, "growx, pushx");
         add(errorIcon, "");
         add(topicCancel, "");
         add(topicEdit, "");
+        //Fix broken layout manager
+        invalidate();
+        validate();
+        invalidate();
 
         channel.addTopicChangeListener(this);
         topicText.addActionListener(this);
@@ -156,7 +156,7 @@ public class TopicBar extends JComponent implements ActionListener,
 
             /** {@inheritDoc} */
             @Override
-            public void actionPerformed(ActionEvent e) {
+            public void actionPerformed(final ActionEvent e) {
                 commitTopicEdit();
             }
         });
@@ -169,7 +169,7 @@ public class TopicBar extends JComponent implements ActionListener,
 
             /** {@inheritDoc} */
             @Override
-            public void actionPerformed(ActionEvent e) {
+            public void actionPerformed(final ActionEvent e) {
                 cancelTopicEdit();
             }
         });
@@ -198,7 +198,7 @@ public class TopicBar extends JComponent implements ActionListener,
 
     /** {@inheritDoc} */
     @Override
-    public void topicChanged(final Channel channel, final Topic topic) {
+    public final void topicChanged(final Channel channel, final Topic topic) {
         UIUtilities.invokeLater(new Runnable() {
 
             /** {@inheritDoc} */
@@ -209,12 +209,11 @@ public class TopicBar extends JComponent implements ActionListener,
                 }
                 topicText.setText("");
                 if (channel.getCurrentTopic() != null) {
-                    channel.getStyliser().addStyledString((StyledDocument) topicText.
-                            getDocument(),
-                            new String[]{Styliser.CODE_HEXCOLOUR + ColourManager.
-                                getHex(
-                                foregroundColour) + channel.getCurrentTopic().
-                                getTopic(), },
+                    channel.getStyliser().addStyledString(
+                            (StyledDocument) topicText.getDocument(),
+                            new String[]{Styliser.CODE_HEXCOLOUR
+                                    + ColourManager.getHex(foregroundColour)
+                                    + channel.getCurrentTopic().getTopic(), },
                             as);
                 }
                 if (channel.getConfigManager().getOptionBool(controller.
@@ -251,6 +250,9 @@ public class TopicBar extends JComponent implements ActionListener,
         }
     }
 
+    /**
+     * Commits a topic edit to the parent channel.
+     */
     private void commitTopicEdit() {
         if ((channel.getCurrentTopic() == null && !topicText.getText().isEmpty())
                 || (channel.getCurrentTopic() != null
@@ -265,6 +267,9 @@ public class TopicBar extends JComponent implements ActionListener,
         topicCancel.setVisible(false);
     }
 
+    /**
+     * Sets the topic ready to be edited, changing attributes and focus.
+     */
     private void setupTopicEdit() {
         topicText.setVisible(false);
         topicText.setText("");
@@ -280,6 +285,9 @@ public class TopicBar extends JComponent implements ActionListener,
         topicCancel.setVisible(true);
     }
 
+    /**
+     * Cancels a topic edit, resetting focus and button states.
+     */
     private void cancelTopicEdit() {
         topicText.setFocusable(false);
         topicText.setEditable(false);
@@ -297,7 +305,7 @@ public class TopicBar extends JComponent implements ActionListener,
             if (url == null) {
                 return;
             }
-            if (url.startsWith("#")) {
+            if (url.charAt(0) == '#') {
                 channel.getServer().join(new ChannelJoinRequest(url));
             } else if (url.contains("://")) {
                 URLHandler.getURLHander().launchApp(e.getDescription());
@@ -307,6 +315,9 @@ public class TopicBar extends JComponent implements ActionListener,
         }
     }
 
+    /**
+     * Load and set colours.
+     */
     private void setColours() {
         backgroundColour = channel.getConfigManager().getOptionColour(
                 "ui", "inputbackgroundcolour", "ui", "backgroundcolour");
@@ -319,6 +330,9 @@ public class TopicBar extends JComponent implements ActionListener,
         setAttributes();
     }
 
+    /**
+     * Sets sensible attributes.
+     */
     private void setAttributes() {
         as = new SimpleAttributeSet();
         StyleConstants.setFontFamily(as, topicText.getFont().getFamily());
@@ -330,10 +344,13 @@ public class TopicBar extends JComponent implements ActionListener,
         StyleConstants.setItalic(as, false);
     }
 
+    /**
+     * Applies predefined attributes to the topic bar.
+     */
     private void applyAttributes() {
         setAttributes();
-        ((DefaultStyledDocument) topicText.getDocument()).setCharacterAttributes(
-                0, Integer.MAX_VALUE, as, true);
+        ((DefaultStyledDocument) topicText.getDocument())
+                .setCharacterAttributes(0, Integer.MAX_VALUE, as, true);
     }
 
     /**
@@ -420,14 +437,10 @@ public class TopicBar extends JComponent implements ActionListener,
 
     /** {@inheritDoc} */
     @Override
-    public void configChanged(String domain, String key) {
+    public void configChanged(final String domain, final String key) {
         if ("showfulltopic".equals(key)) {
-            if (channel.getConfigManager().getOptionBool(controller.getDomain(),
-                    "showfulltopic")) {
-                topicText.setEditorKit(new StyledEditorKit());
-            } else {
-                topicText.setEditorKit(new WrapEditorKit());
-            }
+            topicText.setEditorKit(new WrapEditorKit(channel.getConfigManager()
+                .getOptionBool(controller.getDomain(), "showfulltopic")));
             ((DefaultStyledDocument) topicText.getDocument()).setDocumentFilter(
                     new NewlinesDocumentFilter());
             topicChanged(channel, null);
@@ -482,11 +495,9 @@ public class TopicBar extends JComponent implements ActionListener,
      * @param e Mouse event
      */
     @Override
-    public void mouseClicked(MouseEvent e) {
-        if (e.getClickCount() == 2) {
-            if (!topicText.isEditable()) {
-                topicEdit.doClick();
-            }
+    public void mouseClicked(final MouseEvent e) {
+        if (e.getClickCount() == 2 && !topicText.isEditable()) {
+            topicEdit.doClick();
         }
     }
 
@@ -557,4 +568,3 @@ public class TopicBar extends JComponent implements ActionListener,
         validateTopic();
     }
 }
-       

src/com/dmdirc/addons/ui_swing/components/text/WrapEditorKit.java

@@ -31,14 +31,32 @@ import javax.swing.text.ViewFactory;
 public class WrapEditorKit extends StyledEditorKit implements MouseListener,
         MouseMotionListener {
 
+    /**
+     * 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 = 1;
     /** Wrap column factory. */
-    private ViewFactory defaultFactory = new WrapColumnFactory();
+    private final ViewFactory defaultFactory = new WrapColumnFactory();
     /** Hand cursor. */
     private static final Cursor HAND_CURSOR = new Cursor(Cursor.HAND_CURSOR);
+    /** Are we wrapping text? */
+    private final boolean wrap;
     /** Associated Component. */
     private JEditorPane editorPane;
 
+    /**
+     * Initialises a new wrapping editor kit.
+     *
+     * @param wrapping true iif the text needs to wrap
+     */
+    public WrapEditorKit(final boolean wrapping) {
+        super();
+
+        wrap = wrapping;
+    }
+
     /** {@inheritDoc} */
     @Override
     public void install(final JEditorPane c) {
@@ -60,7 +78,11 @@ public class WrapEditorKit extends StyledEditorKit implements MouseListener,
     /** {@inheritDoc} */
     @Override
     public ViewFactory getViewFactory() {
-        return defaultFactory;
+        if (wrap) {
+            return super.getViewFactory();
+        } else {
+            return defaultFactory;
+        }
     }
 
     /**
@@ -73,16 +95,14 @@ public class WrapEditorKit extends StyledEditorKit implements MouseListener,
         if (editorPane == null) {
             return;
         }
-        if (!editorPane.isEditable()) {
-            if (characterElementAt(e).getAttributes().getAttribute(
-                    IRCTextAttribute.HYPERLINK) != null
-                    || characterElementAt(e).getAttributes().getAttribute(
-                    IRCTextAttribute.CHANNEL) != null
-                    || characterElementAt(e).getAttributes().getAttribute(
-                    IRCTextAttribute.NICKNAME) != null) {
-                editorPane.setCursor(HAND_CURSOR);
-                return;
-            }
+        if (!editorPane.isEditable() && (characterElementAt(e).getAttributes()
+                .getAttribute(IRCTextAttribute.HYPERLINK) != null
+                || characterElementAt(e).getAttributes().getAttribute(
+                IRCTextAttribute.CHANNEL) != null
+                || characterElementAt(e).getAttributes().getAttribute(
+                IRCTextAttribute.NICKNAME) != null)) {
+            editorPane.setCursor(HAND_CURSOR);
+            return;
         }
         editorPane.setCursor(Cursor.getDefaultCursor());
     }
@@ -173,7 +193,7 @@ public class WrapEditorKit extends StyledEditorKit implements MouseListener,
     }
 
     /**
-     * Returns the character element for the positition of the mouse event.
+     * Returns the character element for the position of the mouse event.
      *
      * @param e Mouse event to get position from
      *