CheckBoxJList.java

Go to the documentation of this file.

/*
 * Autopsy Forensic Browser
 *
 * Copyright 2019-2020 Basis Technology Corp.
 * Contact: carrier <at> sleuthkit <dot> org
 *
 * 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 org.sleuthkit.autopsy.guiutils;

import java.awt.BorderLayout;
import java.awt.Component;
import java.awt.event.MouseAdapter;
import java.awt.event.MouseEvent;
import javax.swing.Icon;
import javax.swing.JCheckBox;
import javax.swing.JLabel;
import javax.swing.JList;
import javax.swing.JPanel;
import javax.swing.ListCellRenderer;
import javax.swing.ListSelectionModel;

public final class CheckBoxJList<T extends CheckBoxJList.CheckboxListItem> extends JList<T> {

    private static final long serialVersionUID = 1L;

    public interface CheckboxListItem {

        boolean isChecked();

        void setChecked(boolean checked);

        String getDisplayName();

        boolean hasIcon();

        Icon getIcon();
    }

    public CheckBoxJList() {
        initalize();
    }
    
    private void initalize() {
        CellRenderer cellRenderer = new CellRenderer();
        cellRenderer.init();
        setCellRenderer(cellRenderer);
        addMouseListener(new MouseAdapter() {
            @Override
            public void mousePressed(MouseEvent e) {
                int index = locationToIndex(e.getPoint());
                if (index != -1 && isEnabled()) {
                    CheckBoxJList.CheckboxListItem element = getModel().getElementAt(index);
                    element.setChecked(!element.isChecked());
                    repaint();
                }
            }
        });
        setSelectionMode(ListSelectionModel.SINGLE_SELECTION);
    }

    class CellRenderer extends JPanel implements ListCellRenderer<CheckBoxJList.CheckboxListItem> {

        private static final long serialVersionUID = 1L;

        private final JCheckBox checkbox = new JCheckBox();
        private final JLabel label = new JLabel();

        public void init() {
            setLayout(new BorderLayout(2, 0));
            add(checkbox, BorderLayout.WEST);
            add(label, BorderLayout.CENTER);
        }

        @Override
        public Component getListCellRendererComponent(
                JList<? extends CheckBoxJList.CheckboxListItem> list, CheckBoxJList.CheckboxListItem value, int index,
                boolean isSelected, boolean cellHasFocus) {

            setBackground(list.getBackground());

            checkbox.setSelected(value.isChecked());
            checkbox.setBackground(list.getBackground());
            checkbox.setEnabled(list.isEnabled());
            checkbox.setOpaque(list.isOpaque());
            label.setText(value.getDisplayName());
            label.setEnabled(list.isEnabled());
            label.setOpaque(list.isOpaque());
            label.setBackground(list.getBackground());
            if (value.hasIcon()) {
                label.setIcon(value.getIcon());
            }

            setOpaque(list.isOpaque());
            setEnabled(list.isEnabled());
            return this;
        }
    }
}