Swing JTree复选框行为异常：节点类型识别与状态同步问题

问题描述 #

开发Swing JTree复选框功能时遇到两个核心问题：

• 首次操作迭代时，根节点被识别为NamedVector而非CheckBoxNode，无法遍历其子复选框；
• 第二次操作迭代时，根节点变为CheckBoxNode，点击后会选中所有子复选框，但此时子项本应处于选中状态，实际需求是取消选中。

界面表现 #

• 首次操作：初始JTree结构显示异常，根节点无法被识别为复选框节点，子节点状态无法同步
• 首次点击：子节点选中状态未按预期更新
• 二次迭代与点击：根节点变为复选框，但点击后选中逻辑与需求完全相反
• 最终结果：节点选中状态不符合业务预期

代码分析与修复方案 #

核心问题根源 #

1. 节点类型混乱：混合使用NamedVector和DefaultMutableTreeNode构建树模型，导致节点类型识别错误，首次操作时根节点为NamedVector，无法适配CheckBoxNode的处理逻辑。
2. 选中状态逻辑错误：编辑器中直接使用复选框当前显示状态同步子节点，未考虑点击操作是要切换状态，而非直接复用当前状态。

修复步骤 #

1. 统一树节点模型，移除NamedVector

所有节点使用DefaultMutableTreeNode包裹CheckBoxNode，确保类型一致：

修改CheckBoxNodeTreeSample的retornaJTree方法：

public JTree retornaJTree(Map<String, List<String>> pacotesEArquivos) {
    DefaultMutableTreeNode root = new DefaultMutableTreeNode(new CheckBoxNode("Root", false));

    for (Map.Entry<String, List<String>> entry : pacotesEArquivos.entrySet()) {
        String pacote = entry.getKey();
        // 修正原代码substring(1)导致的名称截断错误
        CheckBoxNode folderNode = new CheckBoxNode(pacote, false);
        DefaultMutableTreeNode folderTreeNode = new DefaultMutableTreeNode(folderNode);
        
        List<String> nomesArquivos = entry.getValue();
        for (String nomeArquivo : nomesArquivos) {
            CheckBoxNode fileNode = new CheckBoxNode(nomeArquivo, false);
            folderTreeNode.add(new DefaultMutableTreeNode(fileNode));
        }
        
        root.add(folderTreeNode);
    }

    CheckBoxNodeRenderer renderer = new CheckBoxNodeRenderer();
    JTree tree = new JTree(root);

    tree.setVisibleRowCount(50);
    tree.setRootVisible(false);
    tree.setShowsRootHandles(true);

    tree.setCellRenderer(renderer);
    tree.setCellEditor(new CheckBoxNodeEditor(tree));
    tree.setEditable(true);

    return tree;
}

2. 修正选中状态切换逻辑

在CheckBoxNodeEditor的getTreeCellEditorComponent中，先获取节点真实选中状态，再执行切换操作：

@Override
public Component getTreeCellEditorComponent(JTree tree, Object value, boolean selected, boolean expanded,
        boolean leaf, int row) {

    Component editor = renderer.getTreeCellRendererComponent(tree, value, true, expanded, leaf, row, true);
    
    ItemListener itemListener = new ItemListener() {
        @Override
        public void itemStateChanged(ItemEvent itemEvent) {
            if (stopCellEditing()) {
                fireEditingStopped();
            }
        }
    };
    if (editor instanceof JCheckBox) {
        JCheckBox checkBox = (JCheckBox) editor;
        checkBox.removeItemListener(itemListener);
        checkBox.addItemListener(itemListener);

        DefaultMutableTreeNode node = (DefaultMutableTreeNode) value;
        Object userObject = node.getUserObject();
        if (userObject instanceof CheckBoxNode) {
            CheckBoxNode currentNode = (CheckBoxNode) userObject;
            // 切换选中状态，而非直接复用复选框当前显示状态
            boolean newSelectedState = !currentNode.isSelected();
            currentNode.setSelected(newSelectedState);

            // 同步子节点状态
            for (int i = 0; i < node.getChildCount(); i++) {
                DefaultMutableTreeNode childNode = (DefaultMutableTreeNode) node.getChildAt(i);
                Object childUserObject = childNode.getUserObject();
                if (childUserObject instanceof CheckBoxNode) {
                    CheckBoxNode childCheckBoxNode = (CheckBoxNode) childUserObject;
                    childCheckBoxNode.setSelected(newSelectedState);
                }
            }

            // 更新父节点状态
            updateParentNodes(node, newSelectedState);

            // 通知树模型更新
            ((DefaultTreeModel) tree.getModel()).nodeStructureChanged(node);
        }
    }
    return editor;
}

3. 修复渲染器节点类型判断逻辑

确保渲染器正确识别所有DefaultMutableTreeNode中的CheckBoxNode：

@Override
public Component getTreeCellRendererComponent(JTree tree, Object value, boolean selected, boolean expanded,
        boolean leaf, int row, boolean hasFocus) {

    Component returnValue;
    
    leafRenderer.setEnabled(tree.isEnabled());
    if (selected) {
        leafRenderer.setForeground(selectionForeground);
        leafRenderer.setBackground(selectionBackground);
    } else {
        leafRenderer.setForeground(textForeground);
        leafRenderer.setBackground(textBackground);
    }

    // 统一处理所有节点类型
    if (value instanceof DefaultMutableTreeNode) {
        DefaultMutableTreeNode treeNode = (DefaultMutableTreeNode) value;
        Object userObject = treeNode.getUserObject();
        if (userObject instanceof CheckBoxNode) {
            CheckBoxNode node = (CheckBoxNode) userObject;
            leafRenderer.setText(node.getText());
            leafRenderer.setSelected(node.isSelected());
        } else {
            leafRenderer.setText(tree.convertValueToText(value, selected, expanded, leaf, row, false));
            leafRenderer.setSelected(false);
        }
    } else {
        leafRenderer.setText(tree.convertValueToText(value, selected, expanded, leaf, row, false));
        leafRenderer.setSelected(false);
    }
    
    returnValue = leafRenderer;
    return returnValue;
}

4. 修正JanelaPrincipal的节点数据收集逻辑

原代码只收集叶子节点，导致文件夹结构丢失，修正后正确收集文件夹与文件的对应关系：

private void initialize() {
    frame = new JFrame();
    frame.setBounds(100, 100, 400, 400);
    frame.setDefaultCloseOperation(JFrame.EXIT_ON_CLOSE);
    frame.getContentPane().setLayout(new BorderLayout());

    DefaultMutableTreeNode root = new DefaultMutableTreeNode("Root");

    DefaultMutableTreeNode folder1 = new DefaultMutableTreeNode("Folder 1");
    DefaultMutableTreeNode folder2 = new DefaultMutableTreeNode("Folder 2");

    DefaultMutableTreeNode file1 = new DefaultMutableTreeNode("File 1");
    DefaultMutableTreeNode file2 = new DefaultMutableTreeNode("File 2");
    DefaultMutableTreeNode file3 = new DefaultMutableTreeNode("File 3");

    root.add(folder1);
    root.add(folder2);

    folder1.add(file1);
    folder2.add(file2);
    folder2.add(file3);

    Map<String, List<String>> pacotesEArquivos = new HashMap<>();
    
    // 遍历文件夹节点，收集每个文件夹下的文件
    Enumeration<?> enumeration = root.children();
    while (enumeration.hasMoreElements()) {
        DefaultMutableTreeNode folderNode = (DefaultMutableTreeNode) enumeration.nextElement();
        List<String> files = new ArrayList<>();
        Enumeration<?> fileEnum = folderNode.children();
        while (fileEnum.hasMoreElements()) {
            DefaultMutableTreeNode fileNode = (DefaultMutableTreeNode) fileEnum.nextElement();
            files.add(fileNode.toString());
        }
        pacotesEArquivos.put(folderNode.toString(), files);
    }

    tree = new CheckBoxNodeTreeSample().retornaJTree(pacotesEArquivos);
    JScrollPane scrollPane = new JScrollPane(tree);
    frame.getContentPane().add(scrollPane, BorderLayout.CENTER);
}

5. 移除无用类

删除不再需要的NamedVector类。

修复效果 #

• 所有节点统一为DefaultMutableTreeNode包裹CheckBoxNode，首次操作即可正确识别节点类型，子复选框遍历正常；
• 点击复选框时正确切换选中状态，父节点根据子节点状态自动更新，子节点跟随父节点状态同步，完全符合需求。

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