DMDirc-Plugins/ui_swing/src/com/dmdirc/addons/ui_swing/dialogs/channelsetting/TopicPane.java

/*
 * Copyright (c) 2006-2015 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.dialogs.channelsetting;

import com.dmdirc.Topic;
import com.dmdirc.addons.ui_swing.UIUtilities;
import com.dmdirc.addons.ui_swing.components.IconManager;
import com.dmdirc.interfaces.CommandController;
import com.dmdirc.interfaces.GroupChat;
import com.dmdirc.interfaces.ui.InputWindow;
import com.dmdirc.plugins.ServiceManager;
import com.dmdirc.ui.input.TabCompleterUtils;
import com.dmdirc.ui.messages.ColourManagerFactory;

import java.awt.datatransfer.Clipboard;
import java.awt.event.ActionEvent;
import java.awt.event.ActionListener;
import java.util.Optional;

import javax.swing.JPanel;

import net.miginfocom.swing.MigLayout;

/** Topic panel. */
public class TopicPane extends JPanel implements ActionListener {

    /** A version number for this class. */
    private static final long serialVersionUID = 2;
    /** Parent group chat. */
    private final GroupChat groupChat;
    /** Channel window. */
    private final InputWindow channelWindow;
    /** Parent dialog. */
    private final ChannelSettingsDialog parent;
    /** Clipboard to copy and paste with. */
    private final Clipboard clipboard;
    /** Topic history panel. */
    private TopicHistoryPane topicHistoryPane;
    /** Topic display pane. */
    private TopicDisplayPane topicDisplayPane;

    /**
     * Creates a new instance of TopicModesPane.
     *
     * @param groupChat         Parent group chat
     * @param iconManager       Icon manager
     * @param commandController The controller to use to retrieve command information.
     * @param serviceManager    Service manager
     * @param parent            Parent dialog
     * @param channelWindow     Channel window
     * @param clipboard         Clipboard to copy and paste with
     */
    public TopicPane(final GroupChat groupChat, final IconManager iconManager,
            final CommandController commandController,
            final ServiceManager serviceManager, final ChannelSettingsDialog parent,
            final InputWindow channelWindow, final Clipboard clipboard,
            final ColourManagerFactory colourManagerFactory,
            final TabCompleterUtils tabCompleterUtils) {
        setOpaque(UIUtilities.getTabbedPaneOpaque());
        this.groupChat = groupChat;
        this.parent = parent;
        this.channelWindow = channelWindow;
        this.clipboard = clipboard;

        setVisible(false);

        removeAll();
        initTopicsPanel(iconManager, serviceManager, commandController, colourManagerFactory,
                tabCompleterUtils);
        layoutComponents();

        topicHistoryPane.addActionListener(this);

        setVisible(true);
    }

    private void initTopicsPanel(
            final IconManager iconManager,
            final ServiceManager serviceManager,
            final CommandController commandController,
            final ColourManagerFactory colourManagerFactory,
            final TabCompleterUtils tabCompleterUtils) {
        topicDisplayPane = new TopicDisplayPane(groupChat, iconManager, serviceManager, parent,
                channelWindow, clipboard, commandController, colourManagerFactory,
                tabCompleterUtils);
        topicHistoryPane = new TopicHistoryPane(groupChat);
    }

    /** Lays out the components. */
    private void layoutComponents() {
        setLayout(new MigLayout("wrap 1, fill, wmax 450"));

        add(topicDisplayPane, "grow, push");
        add(topicHistoryPane, "grow, pushy");
    }

    /** Processes the topic and changes it if necessary. */
    protected void setChangedTopic() {
        final String topic = topicDisplayPane.getTopic();
        if (!groupChat.getCurrentTopic().map(Topic::getTopic).orElse("").equals(topic)) {
            groupChat.setTopic(topic);
        }
    }

    /**
     * {@inheritDoc}.
     *
     * @param e Action event
     */
    @Override
    public void actionPerformed(final ActionEvent e) {
        if (e != null && e.getSource() == topicHistoryPane) {
            topicDisplayPane.setTopic(Optional.ofNullable(topicHistoryPane.getSelectedTopic()));
        }
    }

}