com.intellij.ide.util.ChooseElementsDialog.java Source code

Introduction

Here is the source code for com.intellij.ide.util.ChooseElementsDialog.java

Source

/*
 * Copyright 2000-2009 JetBrains s.r.o.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package com.intellij.ide.util;

import com.intellij.openapi.project.Project;
import com.intellij.openapi.ui.DialogWrapper;
import com.intellij.ui.DoubleClickListener;
import com.intellij.ui.ScrollPaneFactory;
import org.jetbrains.annotations.NotNull;
import org.jetbrains.annotations.Nullable;

import javax.swing.*;
import java.awt.*;
import java.awt.event.ActionEvent;
import java.awt.event.ActionListener;
import java.awt.event.KeyEvent;
import java.awt.event.MouseEvent;
import java.util.*;
import java.util.List;

/**
 * @author nik
 */
public abstract class ChooseElementsDialog<T> extends DialogWrapper {
    protected ElementsChooser<T> myChooser;
    private String myDescription;

    public ChooseElementsDialog(Project project, Collection<? extends T> items, String title,
            final String description) {
        this(project, items, title, description, false);
    }

    public ChooseElementsDialog(Project project, Collection<? extends T> items, String title,
            final String description, boolean sort) {
        super(project, true);
        myDescription = description;
        initializeDialog(items, title, sort);
    }

    public ChooseElementsDialog(Component parent, Collection<T> items, String title) {
        this(parent, items, title, null, false);
    }

    public ChooseElementsDialog(Component parent, Collection<T> items, String title, @Nullable String description,
            final boolean sort) {
        super(parent, true);
        myDescription = description;
        initializeDialog(items, title, sort);
    }

    private void initializeDialog(final Collection<? extends T> items, final String title, boolean sort) {
        setTitle(title);
        myChooser = new ElementsChooser<T>(false) {
            @Override
            protected String getItemText(@NotNull final T item) {
                return ChooseElementsDialog.this.getItemText(item);
            }
        };
        myChooser.setColorUnmarkedElements(false);

        List<? extends T> elements = new ArrayList<T>(items);
        if (sort) {
            Collections.sort(elements, new Comparator<T>() {
                @Override
                public int compare(final T o1, final T o2) {
                    return getItemText(o1).compareToIgnoreCase(getItemText(o2));
                }
            });
        }
        setElements(elements, elements.size() > 0 ? elements.subList(0, 1) : Collections.<T>emptyList());
        myChooser.getComponent().registerKeyboardAction(new ActionListener() {
            @Override
            public void actionPerformed(ActionEvent e) {
                doOKAction();
            }
        }, KeyStroke.getKeyStroke(KeyEvent.VK_ENTER, 0), JComponent.WHEN_FOCUSED);

        new DoubleClickListener() {
            @Override
            protected boolean onDoubleClick(MouseEvent e) {
                doOKAction();
                return true;
            }
        }.installOn(myChooser.getComponent());

        init();
    }

    public List<T> showAndGetResult() {
        show();
        return getChosenElements();
    }

    protected abstract String getItemText(T item);

    @Nullable
    protected abstract Icon getItemIcon(T item);

    @NotNull
    public List<T> getChosenElements() {
        return isOK() ? myChooser.getSelectedElements() : Collections.<T>emptyList();
    }

    public void selectElements(@NotNull List<T> elements) {
        myChooser.selectElements(elements);
    }

    @Override
    public JComponent getPreferredFocusedComponent() {
        return myChooser.getComponent();
    }

    @Override
    protected JComponent createCenterPanel() {
        final JPanel panel = new JPanel(new BorderLayout());
        panel.add(ScrollPaneFactory.createScrollPane(myChooser.getComponent()), BorderLayout.CENTER);
        if (myDescription != null) {
            panel.add(new JLabel(myDescription), BorderLayout.NORTH);
        }
        return panel;
    }

    protected void setElements(final Collection<? extends T> elements,
            final Collection<? extends T> elementsToSelect) {
        myChooser.clear();
        for (final T item : elements) {
            myChooser.addElement(item, false, createElementProperties(item));
        }
        myChooser.selectElements(elementsToSelect);
    }

    private ElementsChooser.ElementProperties createElementProperties(final T item) {
        return new ElementsChooser.ElementProperties() {
            @Override
            public Icon getIcon() {
                return getItemIcon(item);
            }

            @Override
            public Color getColor() {
                return null;
            }
        };
    }
}