如何设置JTextPane文本时不改变父级JScrollPane滚动条位置？

问题原因 #

JTextPane调用setText()时会完全替换文档内容，触发组件视图更新，默认会让滚动条自动滚动到内容起始位置；而JTextField的setText()实现不会触发该自动滚动行为，因此两者表现不同。

解决方案 #

方法1：保存并恢复滚动条位置 #

在设置文本前后记录滚动条的当前位置，设置完成后恢复该位置，是最直接的解决方案。

修改示例代码如下：

1. 新增全局变量保存JScrollPane引用：

static JTextComponent textComponent = new JTextPane();
static JScrollPane scroller; // 全局存储滚动面板引用

2. 在main方法中初始化该变量：

scroller = createScroller();

3. 修改按钮的事件处理逻辑：

private static JButton createInsertButton() {
    JButton button = new JButton("Insert");
    button.addActionListener(e -> {
        // 保存当前滚动条位置
        int verticalPos = scroller.getVerticalScrollBar().getValue();
        int horizontalPos = scroller.getHorizontalScrollBar().getValue();
        
        textComponent.setText("Sample text");
        
        // 恢复滚动条位置
        scroller.getVerticalScrollBar().setValue(verticalPos);
        scroller.getHorizontalScrollBar().setValue(horizontalPos);
    });
    return button;
}

private static JButton createClearButton() {
    JButton button = new JButton("Clear");
    button.addActionListener(e -> {
        // 保存当前滚动条位置
        int verticalPos = scroller.getVerticalScrollBar().getValue();
        int horizontalPos = scroller.getHorizontalScrollBar().getValue();
        
        textComponent.setText(null);
        
        // 恢复滚动条位置
        scroller.getVerticalScrollBar().setValue(verticalPos);
        scroller.getHorizontalScrollBar().setValue(horizontalPos);
    });
    return button;
}

方法2：直接操作Document避免自动滚动 #

不使用setText()，直接操作JTextPane的Document对象替换内容，同时禁用视图自动滚动，适合需要精细控制文档内容的场景。

修改Insert按钮的事件处理逻辑：

private static JButton createInsertButton() {
    JButton button = new JButton("Insert");
    button.addActionListener(e -> {
        try {
            javax.swing.text.Document doc = textComponent.getDocument();
            // 临时禁用自动滚动相关的caret更新
            textComponent.setCaretUpdateEnabled(false);
            
            // 清空文档并插入新内容
            doc.remove(0, doc.getLength());
            doc.insertString(0, "Sample text", null);
            
            // 恢复caret更新（可选，根据业务需求决定）
            textComponent.setCaretUpdateEnabled(true);
        } catch (javax.swing.text.BadLocationException ex) {
            ex.printStackTrace();
        }
    });
    return button;
}

Clear按钮的逻辑可以同理修改，通过Document清空内容而非调用setText(null)。

效果验证 #

修改后运行代码，点击Insert或Clear按钮时，JScrollPane的滚动条位置会保持原有状态，不会自动跳转。

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