JScrollBar + JTextPane с неправильной прокруткой HTML до максимального значения

У меня есть следующая проблема в моем проекте, мне потребовалось некоторое время, чтобы выяснить, что вызывает проблему, и я могу воспроизвести ее с помощью этого простого кода, который я приложил.

Я динамически добавляю содержимое в JTextPane с помощью HTMLEditorKit. Я отключил автопрокрутку, потому что хочу управлять ею вручную (когда пользователь прокручивается вверх, чтобы остановиться, и когда событие запускается, чтобы снова активироваться).

Теперь проблема заключается в том, что когда я устанавливаю максимальное значение JScrollBar, оно становится другим, как раз в тот момент, когда содержимое вставлено в HTMLDocument. Когда я снова запускаю setValue во второй раз вручную, он прокручивается до правильного максимального значения.

Кажется, что JScrollBar не знает о правильном максимальном значении сразу после добавления в HTMLDocument и только через некоторое время (с задержкой).

С использованием

caret.setUpdatePolicy(DefaultCaret.ALWAYS_UPDATE);

это не решение, потому что оно также не работает должным образом. Он также не прокручивается до максимального значения, оставляя внизу пиксель просмотра, чего я не хочу.

Вот полный код, воспроизводящий проблему. Если вы нажмете правую кнопку (добавить и прокрутить), он вставит элемент DIV в тело. В момент достижения последней видимой строки она неправильно прокручивается до последнего максимального значения, последняя строка скрыта. Но когда вы просто нажимаете левую кнопку вручную, чтобы вызвать второй scrollToEnd(), он правильно прокручивается до максимального значения.

Код:

/*
 * To change this license header, choose License Headers in Project Properties.
 * To change this template file, choose Tools | Templates
 * and open the template in the editor.
 */
package javaapplication26;

import java.io.IOException;
import java.math.BigInteger;
import java.security.SecureRandom;
import java.util.logging.Level;
import java.util.logging.Logger;
import javax.swing.text.BadLocationException;
import javax.swing.text.DefaultCaret;
import javax.swing.text.Element;
import javax.swing.text.html.HTMLDocument;
import javax.swing.text.html.HTMLEditorKit;

public class NewJFrame extends javax.swing.JFrame {

    /**
     * Creates new form NewJFrame
     */
    public NewJFrame() {

        initComponents();

        this.setSize(500, 200);
        this.setLocationRelativeTo(null);

        this.jTextPane1.setEditorKit(new HTMLEditorKit());
        this.jTextPane1.setContentType("text/html");

        this.jTextPane1.setText("<html><body><div id=\"GLOBALDIV\"></div></body></html>");

        this.jScrollPane1.setHorizontalScrollBarPolicy(javax.swing.ScrollPaneConstants.HORIZONTAL_SCROLLBAR_NEVER);
        this.jScrollPane1.setVerticalScrollBarPolicy(javax.swing.ScrollPaneConstants.VERTICAL_SCROLLBAR_AS_NEEDED);

        DefaultCaret caret = (DefaultCaret) this.jTextPane1.getCaret();
        caret.setUpdatePolicy(DefaultCaret.NEVER_UPDATE);

        this.jScrollPane1.setAutoscrolls(false);
        this.jTextPane1.setAutoscrolls(false);
    }

    private void scrollToEnd() {

        this.jScrollPane1.getVerticalScrollBar().setValue(this.jScrollPane1.getVerticalScrollBar().getMaximum());
        //this.jTextPane1.setCaretPosition(this.jTextPane1.getDocument().getLength());
    }

    /**
     * This method is called from within the constructor to initialize the form.
     * WARNING: Do NOT modify this code. The content of this method is always
     * regenerated by the Form Editor.
     */
    @SuppressWarnings("unchecked")
    // <editor-fold defaultstate="collapsed" desc="Generated Code">                          
    private void initComponents() {

        jPanel1 = new javax.swing.JPanel();
        jScrollPane1 = new javax.swing.JScrollPane();
        jTextPane1 = new javax.swing.JTextPane();
        jPanel2 = new javax.swing.JPanel();
        jButton1 = new javax.swing.JButton();
        jButton2 = new javax.swing.JButton();

        setDefaultCloseOperation(javax.swing.WindowConstants.EXIT_ON_CLOSE);

        jPanel1.setLayout(new java.awt.BorderLayout());

        jScrollPane1.setViewportView(jTextPane1);

        jPanel1.add(jScrollPane1, java.awt.BorderLayout.CENTER);

        getContentPane().add(jPanel1, java.awt.BorderLayout.CENTER);

        jButton1.setText("Scroll to end");
        jButton1.addActionListener(new java.awt.event.ActionListener() {
            public void actionPerformed(java.awt.event.ActionEvent evt) {
                jButton1ActionPerformed(evt);
            }
        });
        jPanel2.add(jButton1);

        jButton2.setText("Add & scroll");
        jButton2.addActionListener(new java.awt.event.ActionListener() {
            public void actionPerformed(java.awt.event.ActionEvent evt) {
                jButton2ActionPerformed(evt);
            }
        });
        jPanel2.add(jButton2);

        getContentPane().add(jPanel2, java.awt.BorderLayout.PAGE_END);

        pack();
    }// </editor-fold>                        

    private void jButton2ActionPerformed(java.awt.event.ActionEvent evt) {                                         

        try {

            HTMLDocument doc = (HTMLDocument) this.jTextPane1.getDocument();
            HTMLEditorKit editorKit = (HTMLEditorKit) this.jTextPane1.getEditorKit();

            SecureRandom random = new SecureRandom();
            String htmlCode = "<div style=\"background-color: #FFFF22; height: 12px; font-size: 12;\">"+new BigInteger(64, random).toString(64)+"</div>";

            //editorKit.insertHTML(doc, doc.getLength(), htmlCode, 0, 0, null);
            Element element = doc.getElement("GLOBALDIV");

            if (element != null) {
                doc.insertBeforeEnd(element, htmlCode);
            }

            this.scrollToEnd();
        } catch (BadLocationException ex) {
            Logger.getLogger(NewJFrame.class.getName()).log(Level.SEVERE, null, ex);
        } catch (IOException ex) {
            Logger.getLogger(NewJFrame.class.getName()).log(Level.SEVERE, null, ex);
        }
    }                                        

    private void jButton1ActionPerformed(java.awt.event.ActionEvent evt) {                                         

        this.scrollToEnd();
    }                                        

    /**
     * @param args the command line arguments
     */
    public static void main(String args[]) {
        /* Set the Nimbus look and feel */
        //<editor-fold defaultstate="collapsed" desc=" Look and feel setting code (optional) ">
        /* If Nimbus (introduced in Java SE 6) is not available, stay with the default look and feel.
         * For details see http://download.oracle.com/javase/tutorial/uiswing/lookandfeel/plaf.html 
         */
        try {
            for (javax.swing.UIManager.LookAndFeelInfo info : javax.swing.UIManager.getInstalledLookAndFeels()) {
                if ("Nimbus".equals(info.getName())) {
                    javax.swing.UIManager.setLookAndFeel(info.getClassName());
                    break;
                }
            }
        } catch (ClassNotFoundException ex) {
            java.util.logging.Logger.getLogger(NewJFrame.class.getName()).log(java.util.logging.Level.SEVERE, null, ex);
        } catch (InstantiationException ex) {
            java.util.logging.Logger.getLogger(NewJFrame.class.getName()).log(java.util.logging.Level.SEVERE, null, ex);
        } catch (IllegalAccessException ex) {
            java.util.logging.Logger.getLogger(NewJFrame.class.getName()).log(java.util.logging.Level.SEVERE, null, ex);
        } catch (javax.swing.UnsupportedLookAndFeelException ex) {
            java.util.logging.Logger.getLogger(NewJFrame.class.getName()).log(java.util.logging.Level.SEVERE, null, ex);
        }
        //</editor-fold>

        /* Create and display the form */
        java.awt.EventQueue.invokeLater(new Runnable() {
            public void run() {
                new NewJFrame().setVisible(true);
            }
        });
    }

    // Variables declaration - do not modify                     
    private javax.swing.JButton jButton1;
    private javax.swing.JButton jButton2;
    private javax.swing.JPanel jPanel1;
    private javax.swing.JPanel jPanel2;
    private javax.swing.JScrollPane jScrollPane1;
    private javax.swing.JTextPane jTextPane1;
    // End of variables declaration                   
}

Эта замена кода работает, но оставляет небольшой пробел, а также неправильно прокручивает до максимального значения:

this.jTextPane1.setCaretPosition(0);
this.jTextPane1.setCaretPosition(this.jTextPane1.getDocument().getLength());

person M. H.    schedule 28.03.2017    source источник


Ответы (1)


Когда вы вставляете div в документ, модель документа немедленно обновляется. Однако JTextPane получает только уведомление о том, что он недействителен и его необходимо выложить. Это уведомление создает событие в EDT, которое обрабатывается только после завершения текущего события (вызванного нажатием кнопки).

Таким образом, в тот момент, когда вы вызываете scrollToEnd(), повторная проверка JTextPane еще не завершена, а высота текстовой панели все еще слишком мала.

Чтобы получить правильную последовательность событий, вам нужно запланировать вызов scrollToEnd() в EDT с помощью invokeLater:

SwingUtilities.invokeLater(new Runnable(){
    public void run(){
         scrollToEnd();
    }
});
person Markus Fischer    schedule 28.03.2017
comment
Большое спасибо! Кажется, это решает проблему! Это правильный способ сделать что-то подобное? Что, если я динамически добавлю много контента на панель, например, несколько строк в секунду. Разве это не взорвет все это, создавая новый Runnable для каждого scrollToEnd()? - person M. H.; 28.03.2017
comment
Правильно ли это, зависит от конкретного варианта использования. Это правильно в том смысле, что последовательность обновления модели, затем представления работает правильно. Поскольку он отделяет обновление модели от обновления представления, могут быть редкие случаи использования, когда это не работает правильно, например. когда несколько конфликтующих обновлений модели не обновляют графический интерфейс в правильном порядке. Однако это очень маловероятно, так как события EDT, выполняющие runnable, сортируются в очереди событий в том порядке, в котором они генерируются. - person Markus Fischer; 28.03.2017
comment
Что касается более высокой нагрузки, такой как несколько строк в секунду, это все еще должно быть в порядке. Создание экземпляра Runnable не требует больших затрат, так как не создает новый поток. метод run() Runnables вызывается в потоке EDT, поэтому новый поток не создается. Вы получаете новый объект для каждого invokeLater, но это приемлемо (каждое событие Swing имеет одну и ту же проблему). Если возможно, было бы, конечно, полезно объединить несколько обновлений модели в одно обновление scrollToEnd(), но это зависит от логики, создающей изменения документа. - person Markus Fischer; 28.03.2017
comment
Я думаю, что я праздновал немного слишком рано. Проблема все еще возникает, но теперь очень редко, в моем проекте, и я понятия не имею, почему. Это как-то связано с тем, что когда в строку, добавленную в HTMLDocument, добавляются изображения, возможно, вызывается слишком быстро и слишком поздно, может ли это случиться? Что-то вроде этого: java2s.com/Tutorial/Java/0240__Swing/ может логичнее или хуже? - person M. H.; 28.03.2017
comment
Добавление слушателя к модели вертикальной прокрутки, проверка того, изменилось ли maxValue (увеличивается), если больше, вызов общедоступной функции в графическом интерфейсе для прокрутки до нового максимума? - person M. H.; 28.03.2017