JComboBox显示非选项数组内只读文本及渲染器异常问题

需求是实现一个只读状态的JComboBox，用来展示数据库中保存的历史选中文本，而这个文本不在JComboBox当前的String[]选项集合里。原本用cb.setSelectedItem()方法没法实现，因为这个方法要求设置的文本必须属于选项数组。尝试自定义ItemRenderer后，界面初始能显示目标文本Java1，但选择其他选项时，JComboBox还是显示Java1，出现异常。

原代码 #

import javax.swing.*;
import java.awt.*;
import java.awt.event.ActionEvent;
import java.awt.event.ActionListener;

public class ComboxBoxDemo implements ActionListener {

JFrame f;
JLabel label;
JTextField txtField;
JButton loadBtn;
JComboBox cb;

ComboxBoxDemo() {
    String languages[] = { "C", "C++", "C#", "Java", "PHP" };
    f = new JFrame("ComboBox Example");

    txtField = new JTextField(20);
    cb = new JComboBox(languages);
    loadBtn = new JButton("Load");
    loadBtn.addActionListener(this);

    f.add(txtField);
    f.add(cb);
    f.add(loadBtn);
    f.setLayout(new FlowLayout());
    f.setSize(350, 350);
    f.setVisible(true);

}

public static void main(String[] args) {
    new ComboxBoxDemo();
}

public static String getProgramingByName(String text) {
    // 此处为从数据库获取历史文本的逻辑
    return "Java1"; // 不在选项数组中的文本
}

@Override
public void actionPerformed(ActionEvent e) {
    if (loadBtn == e.getSource()) {
        String text = txtField.getText();
        if (text != null) {
            String lang = getProgramingByName(text);
            cb.setSelectedItem(lang);
        }
    }
}
}

尝试的自定义渲染器代码 #

cb.setRenderer(new ItemRenderer());

class ItemRenderer extends BasicComboBoxRenderer {
    public Component getListCellRendererComponent(JList list, Object value, int index, boolean isSelected,
            boolean cellHasFocus) {
        super.getListCellRendererComponent(list, value, index, isSelected, cellHasFocus);

        System.out.println( "\n Index :"+index + " Value :"+value);
    
        String items = (String) value;

        if (index == -1) {
            setText(ComboxBoxDemo.getProgramingByName("test"));
        } else {
            setText(items);
        }
        return this;
    }
}

问题原因 #

自定义渲染器里硬编码调用getProgramingByName("test")，当index == -1（对应下拉框的顶部显示区域）时，不管当前选中的实际值是什么，都强制显示固定的"Java1"，导致选择其他选项后显示异常。

解决方案 #

步骤1：添加状态变量存储自定义文本 #

在主类中添加成员变量，用来保存从数据库获取的历史文本，避免渲染器硬编码固定值：

private String customSelectedText;

步骤2：修改渲染器逻辑 #

渲染器根据customSelectedText的存在情况和当前渲染的位置，动态决定显示内容：

class ItemRenderer extends BasicComboBoxRenderer {
    @Override
    public Component getListCellRendererComponent(JList list, Object value, int index, boolean isSelected, boolean cellHasFocus) {
        super.getListCellRendererComponent(list, value, index, isSelected, cellHasFocus);

        // 下拉框顶部显示区域优先使用自定义文本
        if (index == -1 && customSelectedText != null) {
            setText(customSelectedText);
        } else {
            setText(value != null ? value.toString() : "");
        }
        return this;
    }
}

步骤3：设置JComboBox为只读 #

通过禁用组件确保用户无法修改选中项：

cb.setEnabled(false);

步骤4：更新加载按钮的逻辑 #

点击加载按钮时，将获取到的历史文本赋值给customSelectedText，并触发组件重绘更新显示：

@Override
public void actionPerformed(ActionEvent e) {
    if (loadBtn == e.getSource()) {
        String text = txtField.getText();
        if (text != null && !text.isEmpty()) {
            customSelectedText = getProgramingByName(text);
            cb.repaint();
        }
    }
}

修改后的完整代码 #

import javax.swing.*;
import java.awt.*;
import java.awt.event.ActionEvent;
import java.awt.event.ActionListener;

public class ComboxBoxDemo implements ActionListener {
    JFrame f;
    JTextField txtField;
    JButton loadBtn;
    JComboBox cb;
    private String customSelectedText; // 存储从数据库获取的历史文本

    ComboxBoxDemo() {
        String languages[] = { "C", "C++", "C#", "Java", "PHP" };
        f = new JFrame("ComboBox Example");

        txtField = new JTextField(20);
        cb = new JComboBox(languages);
        loadBtn = new JButton("Load");
        loadBtn.addActionListener(this);

        // 设置自定义渲染器
        cb.setRenderer(new ItemRenderer());
        // 设置为只读，禁止用户交互
        cb.setEnabled(false);

        f.add(txtField);
        f.add(cb);
        f.add(loadBtn);
        f.setLayout(new FlowLayout());
        f.setSize(350, 350);
        f.setVisible(true);
    }

    public static void main(String[] args) {
        new ComboxBoxDemo();
    }

    public static String getProgramingByName(String text) {
        // 替换为实际从数据库获取历史文本的逻辑
        return "Java1"; // 不在选项数组中的文本
    }

    @Override
    public void actionPerformed(ActionEvent e) {
        if (loadBtn == e.getSource()) {
            String text = txtField.getText();
            if (text != null && !text.isEmpty()) {
                customSelectedText = getProgramingByName(text);
                // 触发渲染器更新显示
                cb.repaint();
            }
        }
    }

    class ItemRenderer extends BasicComboBoxRenderer {
        @Override
        public Component getListCellRendererComponent(JList list, Object value, int index, boolean isSelected, boolean cellHasFocus) {
            super.getListCellRendererComponent(list, value, index, isSelected, cellHasFocus);

            // 处理下拉框顶部显示区域
            if (index == -1 && customSelectedText != null) {
                setText(customSelectedText);
            } else {
                setText(value != null ? value.toString() : "");
            }
            return this;
        }
    }
}

说明 #

• customSelectedText变量用来保存从数据库获取的历史文本，渲染器会根据这个变量动态调整显示内容。
• 通过cb.setEnabled(false)禁用JComboBox，确保用户无法通过下拉选择修改显示内容，只能通过加载按钮更新。
• 渲染器区分了下拉列表项（index >=0）和顶部显示区域（index=-1）的显示逻辑，避免显示异常。

内容的提问来源于stack exchange，提问作者user21528347