自定义Swing的JList组件中的显示内容

本人在做项目时，想要在JList的每一项中都显示一个进度条，搜索了很多文章和论坛，都没有查到所需的资料。遂查阅Oracle的API文档和源代码的一些实现细节，自己实现了这一功能。下面是一些总结和记录，以防日后忘记。

如有错误或任何不同观点欢迎批评指出。

先上一张最终结果的图片，本人对色彩一窍不通，关于配色难看的问题请大佬手下留情 ：）

在源码实现中，JList的每一项（cell）如何显示，是通过一个cell renderer来确定的，它实现了ListCellRenderer接口；JList默认使用的DefaultListCellRenderer，它实现了上述接口，并继承了JLabel类，即将传入的每一项渲染成一个Jlabel来显示。

因而默认情况下可以向JList传入字符串数组（或Icon图标），它们被渲染成一组JLabel显示，但若传入其他类型的对象，就会被调用toString()用来构造JLabel，从而显示的是一串表示对象信息的字符串，无法到达预期的效果。

可以通过自定义实现ListCellRenderer接口的类，覆盖getListCellRendererComponent()方法，来渲染所需的对象类型的显示方式。

下面是一个在JList显示JProcess的例子。

// JProcessCellRender.java
public class JProcessCellRender extends JProgressBar implements ListCellRenderer<Object> {
    public JProcessCellRender() {
        super();
        setOpaque(true);
        setBorder(getNoFocusBorder());
        setName("List.JProcessCellRender");
    }

    /**
     * @param list，持有该render的JList对象
     * @param value，JList中的每一项，即JList<AType>中的AType类型的对象，它是通过调用list.getModel().getElementAt(index)方法获得的
     * @param index，项的索引
     * @param isSelected，该项是否被选中
     * @param cellHasFocus，该项是否获得焦点
     */
    @Override
    public Component getListCellRendererComponent(JList<?> list, Object value, int index, boolean isSelected, boolean cellHasFocus) {
        // 设置一些其他属性，如边框样式、被选中时样式等
        SetOtherProperties(list, index, isSelected, cellHasFocus);

        MyTask mainTask = (MyTask) value;
        int cur = mainTask.getCur();
        int total = mainTask.getTotal();
        setMinimum(0);
        setMaximum(total);
        setValue(cur);
        String text = String.valueOf(cur * 100 / total) + "%";
        setStringPainted(true);
        setString(text);

        return this;
    }

    // DefaultListCellRenderer的部分实现
    private void SetOtherProperties(JList<?> list, int index, boolean isSelected, boolean cellHasFocus) {
        setComponentOrientation(list.getComponentOrientation());
        if (isSelected) {
            setBackground(new Color(156, 156, 156));
            setForeground(new Color(255, 128, 128));
        }
        else {
            setBackground(new Color(192, 192, 192));
            setForeground(new Color(128, 128, 255));
        }
        setEnabled(list.isEnabled());
        setFont(list.getFont());
        Border border = null;
        if (cellHasFocus) {
            if (isSelected) {
                border = DefaultLookup.getBorder(this, ui, "List.focusSelectedCellHighlightBorder");
            }
            if (border == null) {
                border = DefaultLookup.getBorder(this, ui, "List.focusCellHighlightBorder");
            }
        } else {
            border = getNoFocusBorder();
        }
        setBorder(border);
    }

    // DefaultListCellRenderer的实现
    private Border getNoFocusBorder() {
        Border border = DefaultLookup.getBorder(this, ui, "List.cellNoFocusBorder");
        if (System.getSecurityManager() != null) {
            if (border != null) return border;
            return SAFE_NO_FOCUS_BORDER;
        } else {
            if (border != null &&
                    (noFocusBorder == null ||
                            noFocusBorder == DEFAULT_NO_FOCUS_BORDER)) {
                return border;
            }
            return noFocusBorder;
        }
    }
    // DefaultListCellRenderer的实现
    private static final Border SAFE_NO_FOCUS_BORDER = new EmptyBorder(1, 1, 1, 1);
    private static final Border DEFAULT_NO_FOCUS_BORDER = new EmptyBorder(1, 1, 1, 1);
    protected static Border noFocusBorder = DEFAULT_NO_FOCUS_BORDER;
}

class MyTask {
    private int mCur;
    private int mTotal;
    public MyTask(int cur, int total) { mCur = cur; mTotal = total; }
    public int getTotal() { return mTotal; }
    public int getCur() { return mCur; }
}

• 上述例子中主要展示的是getListCellRendererComponent()方法的自定义方式；其他的一些方法如SetOtherProperties()设置属性等可以自定义实现，也并不是必须的，这里是为了方便而直接copy的DefaultListCellRenderer的部分实现。

一个使用的例子如下。

// MyUI.java
public class MyUI extends JFrame {
    public MyUI() {
        MyTask[] mts = new MyTask[10];
        for (int i = 0; i < 10; ++i) {
            mts[i] = new MyTask(i, 9);
        }
        JList<MyTask> myList = new JList<>(mts);
        myList.setCellRenderer(new JProcessCellRender());

        JScrollPane jScrollPane = new JScrollPane();
        jScrollPane.getViewport().setView(myList);
        add(jScrollPane, BorderLayout.CENTER);
    }

    public static void main(String[] args) {
        MyUI myUI = new MyUI();
        myUI.setDefaultCloseOperation(JFrame.EXIT_ON_CLOSE);
        myUI.setTitle("Excel Bloonow");
        myUI.setSize(400, 240);
        myUI.setVisible(true);
    }
}

最终的结果图片展示在了开头。

本文地址：https://blog.csdn.net/weixin_44030017/article/details/107597101