EditAnnotationPopup.java

package gui.sysadmin.annotationview;

import gui.sysadmin.strings.SysStrings;

import javax.swing.*;

import util.AnnotationDataType;

import java.awt.*;
import java.awt.event.ActionEvent;
import java.awt.event.ActionListener;
import java.awt.image.BufferedImage;
import java.net.URL;
import java.util.ArrayList;

public class EditAnnotationPopup extends JPanel {

    private static final long serialVersionUID = -626744436260839622L;
    private static final int FREETEXT_TAB = 1;
    private JPanel addCategoriesPanel;
    private JButton addButton, removeButton;
    private ButtonModel editAnnotationButtonModel;
    private JTextField nameField;
    private ArrayList<String> categories = new ArrayList<String>();
    private boolean forced = false;
    private JCheckBox forcedBox;
    private JTable table;
    private AnnotationDataType annotation;
    private ArrayList<JTextField> valueTexts = new ArrayList<JTextField>();
    private JTabbedPane optionsPane;

    public EditAnnotationPopup(JTable table) {
        this.table = table;
        // TODO: THIS IS IMPORTANT THAT WE FIX; REFACTOR POPUP AND EVERYTHING
        // PLEASE!
        if (!setAnnotation()) {
            JOptionPane.showMessageDialog(null,
                    "Please select an annotation to edit");
            this.setEnabled(false);
        } else {

            this.setLayout(new BorderLayout());
            optionsPane = new JTabbedPane();
            nameField = new JTextField();
            optionsPane.addTab("DropDownLists", buildFirstTab());
            optionsPane.addTab("Free Text", buildSecondTab());
            this.add(optionsPane, BorderLayout.CENTER);
        }
    }

    private JPanel buildSecondTab() {

        JPanel secondTab = new JPanel(new GridLayout(0, 1));

        /* Create the top panel for the second tab */
        JPanel topPanelInSecondTab = new JPanel();

        JLabel name = new JLabel("Name:");
        JTextField nameField2 = new JTextField(nameField.getDocument(),
                annotation.getName(), 0);
        nameField2.setPreferredSize(new Dimension(250, 30));
        topPanelInSecondTab.add(name);
        topPanelInSecondTab.add(nameField2);

        /* Create bottom panel for the second tab */
        JPanel botPanelInSecondTab = buildBotPanelInFirstTab();

        secondTab.add(topPanelInSecondTab);
        secondTab.add(botPanelInSecondTab);
        return secondTab;
    }

    private JScrollPane buildFirstTab() {

        JPanel firstTab = new JPanel(new BorderLayout());
        JScrollPane scrollPane = new JScrollPane(firstTab);
        scrollPane
                .setVerticalScrollBarPolicy(ScrollPaneConstants.VERTICAL_SCROLLBAR_ALWAYS);

        JPanel topPanelInFirstTab = buildTopPanelInFirstTab();
        JPanel midPanelInFirstTab = buildMidPanelInFirstTab();
        JPanel botPanelInFirstTab = buildBotPanelInFirstTab();

        /* Add all complete panels to the first tab */
        firstTab.add(topPanelInFirstTab, BorderLayout.NORTH);
        firstTab.add(midPanelInFirstTab, BorderLayout.CENTER);
        firstTab.add(botPanelInFirstTab, BorderLayout.SOUTH);

        return scrollPane;

    }

    private JPanel buildMidPanelInFirstTab() {

        JPanel midPanelInFirstTab = new JPanel(new BorderLayout());
        final JCheckBox catCheckBox = new JCheckBox("Add Categories", true);
        catCheckBox.setFocusPainted(false);

        final JPanel categoryPanel = new JPanel(new BorderLayout());

        addCategoriesPanel = new JPanel(new GridLayout(0, 1));

        JPanel baseCatPanel = createDeafultCategoryPanel(addCategoriesPanel, "");
        addCategoriesPanel.add(baseCatPanel);

        categoryPanel.add(addCategoriesPanel, BorderLayout.NORTH);

        for (String value : annotation.getValues()) {
            addAddedCategoryPanel(addCategoriesPanel, value);
        }

        ComponentTitledBorder componentBorder = createDynamicBorder(
                categoryPanel, catCheckBox);
        categoryPanel.setBorder(componentBorder);

        midPanelInFirstTab.add(categoryPanel, BorderLayout.CENTER);

        return midPanelInFirstTab;
    }

    private JPanel createDeafultCategoryPanel(final JPanel addCategoriesPanel,
            String value) {
        JPanel baseCatPanel = new JPanel();

        JLabel categorylabel = new JLabel("Category:");
        JTextField annotationTextField = new JTextField();
        annotationTextField.setName("textField");
        valueTexts.add(annotationTextField);
        annotationTextField.setText(value);
        annotationTextField.setPreferredSize(new Dimension(200, 30));

        baseCatPanel.add(categorylabel);
        baseCatPanel.add(annotationTextField);

        createAddCategoryButton(addCategoriesPanel, baseCatPanel,
                annotationTextField);
        return baseCatPanel;
    }

    private void createAddCategoryButton(final JPanel categoryHolderPanel,
            JPanel baseCatPanel, final JTextField annotationTextField) {

        URL imageUrl = getClass().getResource("/icons/plus.png");
        ImageIcon addIcon = new ImageIcon(imageUrl);
        addIcon = new ImageIcon(addIcon.getImage().getScaledInstance(20, 20,
                BufferedImage.SCALE_SMOOTH));
        addButton = new JButton("");

        addButton.setBorderPainted(false);
        addButton.setContentAreaFilled(false);

        addButton.setIcon(addIcon);

        addButton.addActionListener(new ActionListener() {

            @Override
            public void actionPerformed(ActionEvent e) {
                if (!annotationTextField.getText().equals("")) {
                    addAddedCategoryPanel(categoryHolderPanel,
                            annotationTextField);
                }
            }

        });
        baseCatPanel.add(addButton);
    }

    private void createRemoveCategoryButton(final JPanel categoryPanel) {
        URL imageUrl = getClass().getResource("/icons/minus.png");
        ImageIcon removeIcon = new ImageIcon(imageUrl);
        removeIcon = new ImageIcon(removeIcon.getImage().getScaledInstance(15,
                15, BufferedImage.SCALE_SMOOTH));
        removeButton = new JButton("");

        removeButton.setBorderPainted(false);
        removeButton.setContentAreaFilled(false);

        removeButton.setIcon(removeIcon);
        categoryPanel.add(removeButton);
    }

    /**
     * Sets the local value for the annotation variable
     */
    private boolean setAnnotation() {
        if (table.getSelectedRow() != -1) {
            int row = table.getSelectedRow();
            row = table.convertRowIndexToModel(row);
            int col = 3;
            annotation = (AnnotationDataType) table.getModel().getValueAt(row,
                    col);
            return true;
        } else {
            return false;
        }
    }

    private JPanel buildBotPanelInFirstTab() {
        JPanel botPanelInFirstTab = new JPanel();
        JLabel forced = new JLabel("Forced Annotation:");
        forcedBox = new JCheckBox("Yes");
        forcedBox.setSelected(annotation.isForced());
        forcedBox.addActionListener(new ActionListener() {

            @Override
            public void actionPerformed(ActionEvent e) {
                switchForced();

            }
        });
        // JPanel checkboxPanel = createCheckBoxPanel();
        botPanelInFirstTab.add(forced);
        // botPanelInFirstTab.add(checkboxPanel);
        botPanelInFirstTab.add(forcedBox);
        buildEditAnnotationButton(botPanelInFirstTab);

        return botPanelInFirstTab;
    }

    protected void switchForced() {
        forced = (forced == true) ? false : true;
    }

    private void buildEditAnnotationButton(JPanel botPanelInFirstTab) {

        JButton editAnnotationButton = new JButton(
                SysStrings.ANNOTATIONS_MODIFY);

        if (editAnnotationButtonModel == null) {
            editAnnotationButtonModel = editAnnotationButton.getModel();
        } else {
            editAnnotationButton.setModel(editAnnotationButtonModel);
        }
        editAnnotationButtonModel
                .setActionCommand(SysStrings.ANNOTATIONS_MODIFY);
        botPanelInFirstTab.add(editAnnotationButton);
    }

    private JPanel buildTopPanelInFirstTab() {
        JPanel topPanelInFirstTab = new JPanel(new BorderLayout());
        JLabel name = new JLabel("Name:");

        // nameField = new JTextField();
        nameField.setPreferredSize(new Dimension(250, 30));

        JPanel nameFieldPanel = new JPanel();
        nameFieldPanel.add(name);
        nameFieldPanel.add(nameField);

        topPanelInFirstTab.add(nameFieldPanel);
        JLabel infoLabel = new JLabel(
                "Not adding any categories will result in a Yes/No/Unknown annotation");
        topPanelInFirstTab.add(infoLabel, BorderLayout.SOUTH);
        return topPanelInFirstTab;
    }

    private ComponentTitledBorder createDynamicBorder(
            final JPanel categoryPanel, final JCheckBox catCheckBox) {

        ComponentTitledBorder componentBorder = new ComponentTitledBorder(
                catCheckBox, categoryPanel, BorderFactory.createEtchedBorder());

        catCheckBox.addActionListener(new ActionListener() {
            public void actionPerformed(ActionEvent e) {
                setBorderEnabled(categoryPanel, catCheckBox);
            }
        });

        return componentBorder;
    }

    private void setBorderEnabled(final JPanel categoryPanel,
            final JCheckBox catCheckBox) {
        boolean enable = catCheckBox.isSelected();
        Component components[] = categoryPanel.getComponents();
        for (int i = 0; i < components.length; i++) {
            Component component = components[i];
            component.setEnabled(enable);
            if (component instanceof JPanel) {
                setBorderEnabled((JPanel) component, catCheckBox);
            }
        }
    }

    public void addAddedCategoryPanel(JPanel categoryHolderPanel,
            JTextField annotationTextField) {

        JPanel newCategoryPanel = new JPanel();
        JLabel categoryLabel = new JLabel("Category:");
        final JTextField textField = new JTextField();
        textField.setText(annotationTextField.getText());
        textField.setEditable(false);
        textField.setPreferredSize(new Dimension(200, 30));
        textField.setName("textField");
        newCategoryPanel.add(categoryLabel);
        newCategoryPanel.add(textField);

        // categories.add(textField.getText());
        valueTexts.add(textField);

        createRemoveCategoryButton(newCategoryPanel);
        categoryHolderPanel.add(newCategoryPanel);
        annotationTextField.setText("");
        repaint();
    }

    private void addAddedCategoryPanel(JPanel categoryHolderPanel, String value) {
        JPanel newCategoryPanel = new JPanel();
        JLabel categoryLabel = new JLabel("Category:");
        final JTextField textField = new JTextField();
        textField.setText(value);
        textField.setEditable(true);
        textField.setPreferredSize(new Dimension(200, 30));
        textField.setName("textField");
        valueTexts.add(textField);
        newCategoryPanel.add(categoryLabel);
        newCategoryPanel.add(textField);

        // categories.add(textField.getText());

        createRemoveCategoryButton(newCategoryPanel);
        categoryHolderPanel.add(newCategoryPanel);
        repaint();
    }

    public String getNewAnnotationName() {
        return nameField.getText();
    }

    public Boolean getNewAnnotationForcedValue() {
        return forced;
    }

    public String[] getNewAnnotationCategories() {

        ArrayList<String> categories = new ArrayList<String>();

        // TODO: make a model for popup? this should not be in a pure view
        // class.

        // TODO: also, I fear we will have to do something really ugly here to
        // to get the top "un-plussed" field to be included when pressing modify

        if (optionsPane.getSelectedIndex() == FREETEXT_TAB) {
            return new String[] { "freetext" };
        }

        synchronized (valueTexts) {
            categories = new ArrayList<>();
            for (JTextField field : valueTexts) {
                if (!field.getText().isEmpty()) {
//                    System.out.println(field.getText());
                    categories.add(field.getText());
                }
            }
            if (isCategoriesEmpty(categories)) {
                categories.clear();
                categories.add("Yes");
                categories.add("No");
                categories.add("Unknown");
            }
        }

        return categories.toArray(new String[categories.size()]);
    }

    private boolean isCategoriesEmpty(ArrayList<String> categories) {
        for (String s : categories) {
            if (!s.isEmpty()) {
                return false;
            }
        }

        return true;
    }

    public void closeWindow() {
        JFrame frame = (JFrame) SwingUtilities
                .getWindowAncestor(addCategoriesPanel); // UGLY?!?
        frame.setVisible(false);
    }

    public void addEditAnnotationListener(ActionListener listener) {

        editAnnotationButtonModel.addActionListener(listener);
    }

    public AnnotationDataType getAnnotation() {
        return annotation;
    }

}