Swing圖層的應用——實現tooltip顯示

沒有錯是世紀前的swing。

在使用Swing的時候有個問題一直沒有解決，就是Swing自帶的tooltip不會跟隨鼠標進行移動，而且移動到邊界就會遮擋的問題。JCompoent有個createTooltip()方法，但這個方法只能改變tooltip的外觀，不能改變行為。事實上tooltip的行為和設置全都是由TooltipManager來進行，所以解決的方法只有自己擼一個類似於ToolTipManager了。

實現方法

從原來TooltipManager的實現原理來看（見Tooltipmanager源碼），它是通過三個控制出現、持續和隱藏的線程，和JPopupFactory來實現的。

ToolTipManager() {
        enterTimer = new Timer(750, new insideTimerAction());
        enterTimer.setRepeats(false);
        exitTimer = new Timer(500, new outsideTimerAction());
        exitTimer.setRepeats(false);
        insideTimer = new Timer(4000, new stillInsideTimerAction());
        insideTimer.setRepeats(false);

    // create accessibility actions 
    postTip = KeyStroke.getKeyStroke(KeyEvent.VK_F1,Event.CTRL_MASK);
    postTipAction = new Actions(Actions.SHOW);
    hideTip = KeyStroke.getKeyStroke(KeyEvent.VK_ESCAPE,0);
    hideTipAction = new Actions(Actions.HIDE);

    moveBeforeEnterListener = new MoveBeforeEnterListener();
    }

 但我向做一個輕量級別的，即只用一個控制出現的線程，彈出層我不使用JPopupFactory，用的是JComponent，使用JlayeredPane來控制圖層層疊次序。

 

實現之前

實現之前建議先了解JRootPane、JLayeredPane的相關知識。以及Java API文檔對這兩個的解釋。

Oracle官方有文檔：How to Use Root Panes、How to Use Layered Panes

概括來說，就是：一個Window（JDialog、JFrame等），窗口顯示區域是JRootPane區域，如圖，menu區域（可無）+ContentPane區域=JRootPane區域。

如果一個窗口沒有設置menu，那么ContentPane區域=JRootPane區域。

如圖，JRootPane里面有兩個兒子：GlassPane，JLayeredPane兩個圖層。GlassPane的圖層次序是0，代表頂層，JLayeredPane的次序是-1，代表底層。GlassPane默認是不顯示的。JLayeredPane也有兩個兒子：conentPane和JMenubar，其中contentPane是我們常用的圖層。而我們要做的就是再給JlayeredPane加一個兒子，把ToolTip加進去，當然你也可以加在GlassPane里面。

 

（-1：底層 0：頂層）

JRootPane.java 

public void setLayeredPane(JLayeredPane layered) {
       ......

        this.add(layeredPane, -1);
}

public void setGlassPane(Component glass) {
        ......
        this.add(glassPane, 0);
        ......
}

 

 JRootPane 的Layeredpane 和 GlassPane的初始化方法。

實現組件

1、對於默認JToolTip來說其實它就是一個JLabel，對於多行文本的顯示比較差，往往需要使用HTML標記來使用。

所以我自己實現的組件使用了JTextPane，支持html、以及多行文本形式。

2、ToolTip需要給鼠標划過的組件添加偵聽，當鼠標移除后要及時移除偵聽，我還采用了一個變量記錄上一個偵聽，防止偵聽溢出。

3、動態計算ToolTip位置，當移動到右、下邊界時會分別平移到鼠標左、上，防止遮擋。

4、使用一個線程計時，實現彈出時間，和tooltipmanager不同的是，鼠標不移開組件，Tooltip就不會消失。

 

代碼實現

PopTimingTip.java

package;

import java.awt.BorderLayout;
import java.awt.Color;
import java.awt.Component;
import java.awt.Dimension;
import java.awt.Point;
import java.awt.event.ActionEvent;
import java.awt.event.ActionListener;
import java.awt.event.MouseAdapter;
import java.awt.event.MouseEvent;

import javax.swing.JComponent;
import javax.swing.JLayeredPane;
import javax.swing.JPanel;
import javax.swing.JRootPane;
import javax.swing.JTextPane;
import javax.swing.SwingUtilities;
import javax.swing.Timer;
import javax.swing.border.LineBorder;

public class PopTimingTip extends JComponent {

    
    private JPanel mainPanel;
    private JTextPane textComponent;
    private TipListener tipListener;
    private Component tipParent;
    private int initTime = 0;
    private int lastTime = 0;
    private int vanishTime = 0;
    private JLayeredPane windowLayer;//窗口的遮罩層，不能隨便修改，只作父對象應用
    private Point constPoint = new Point(12, 5);//距離鼠標常量，防止鼠標遮擋
    private Point constPoint2 = new Point(2,2);//常量2 防止離鼠標太近，觸發mouseexit事件
    private Timer tipTimer;
    private TipTimerListener tipTimerListener;
    private static PopTimingTip popTimingTip;
    private JRootPane rootPane;//當前根面板
    private Dimension curTipSize;
    private int curConType;
    
    /**
     * 單例外部不允許初始化
     */
    private PopTimingTip() {
        super();
        initTip();
    }
    
    public static PopTimingTip getInstance() {
        if(popTimingTip == null) {
            popTimingTip = new PopTimingTip();
        }
        return popTimingTip;
    }
    
    private void initTip() {
        this.setLayout(new BorderLayout());
        this.setOpaque(false);
        //this.setBorder(null);
        this.setVisible(false);
        textComponent = new JTextPane();
        textComponent.setContentType("text/html");
        textComponent.setBorder(new LineBorder(Color.BLACK));
        textComponent.setBackground(new Color(245, 245, 245));
        mainPanel = new JPanel(new BorderLayout());
        mainPanel.add(textComponent, BorderLayout.CENTER);
        this.add(mainPanel, BorderLayout.CENTER);
        
        tipTimerListener = new TipTimerListener();
        tipTimerListener.state = 0;
        
        tipListener = new TipListener();
        tipTimer = new Timer(0, tipTimerListener);
        tipTimer.setRepeats(false);
        
        curTipSize = new Dimension(0,0);
    }
    public void showTip() {
        this.setVisible(true);
    }
    /**
     * 為某個組件設置tip
     * @param parent 顯示tooltip的對象
     * @param text
     */
    public void showTipText(JComponent parent, String text) {
        if(parent == null) {
            return;
        }
        //如果進入了新的組件，先從舊組件中移除偵聽防止泄漏
        if(tipParent != null && tipParent != parent) {
            tipParent.removeMouseListener(tipListener);
            tipParent.removeMouseMotionListener(tipListener);
        }
        tipParent = parent;
        
        rootPane = parent.getRootPane();
        //防止異常獲取不了根面板的情況
        if(rootPane == null) {
            return;
        }
        
        JLayeredPane layerPane = rootPane.getLayeredPane();
        //先從舊面板中移除tip
        if(windowLayer != null && windowLayer != layerPane) {
            windowLayer.remove(this);
        }
        windowLayer = layerPane;
        //防止還有沒有移除偵聽的組件
        tipParent.removeMouseListener(tipListener);
        tipParent.removeMouseMotionListener(tipListener);
        layerPane.remove(this);
        //放置tip在遮罩窗口頂層
        layerPane.add(this, JLayeredPane.POPUP_LAYER);
        //窗口遮罩層添加偵聽
        tipParent.addMouseMotionListener(tipListener);
        tipParent.addMouseListener(tipListener);
        //測試偵聽器數量
        //System.out.println(tipParent.getMouseListeners().length + " " + tipParent.getMouseMotionListeners().length);
        //設置tiptext
        textComponent.setText(text);
        mainPanel.doLayout();
        //this.setPreferredSize(textComponent.getPreferredSize());
        curTipSize = textComponent.getPreferredSize();
        this.setSize(textComponent.getPreferredSize().width, textComponent.getPreferredSize().height);
    }
    
    /**
     * 初始化toolTip
     * @param contentType 0:html  1:文本類型 
     * @param initTime 鼠標進入后等待時間
     * @param lastTime 持續時間(未完成)
     * @param vanishTime 鼠標移走后消失時間(未完成)
     */
    public void setConfigure(int contentType, int initTime) {
        if(contentType == 0 && curConType != contentType) {
            textComponent.setContentType("text/html");
        } else if(contentType ==1 && curConType != contentType) {
            textComponent.setContentType("text/plain");
        }
        curConType = contentType;
        this.initTime = initTime;
        //this.vanishTime = vanishTime;
        //this.lastTime = lastTime;
    }
    /**
     * 坐標轉換，標簽跟隨鼠標移動
     */
    private void followWithMouse(MouseEvent e) {
        if(windowLayer == null) {
            return;
        }
        
        Point screenPoint = e.getLocationOnScreen();
        
        SwingUtilities.convertPointFromScreen(screenPoint, windowLayer);
        
        int newLocationX = screenPoint.x + constPoint.x;
        int newLocationY = screenPoint.y + constPoint.y;
        
        Dimension tipSize = textComponent.getPreferredSize();
        if(newLocationX + tipSize.width > rootPane.getWidth()) {
            newLocationX = screenPoint.x - tipSize.width - constPoint2.x;
        }
        if(newLocationY + tipSize.height > rootPane.getHeight()) {
            newLocationY = screenPoint.y - tipSize.height - constPoint2.y;
        }
        this.setLocation(newLocationX, newLocationY);
        //textComponent.getPreferredSize()在html初始化計算的時候有問題，重算一次
        if(!curTipSize.equals(textComponent.getPreferredSize())) {
            this.setSize(textComponent.getPreferredSize().width, textComponent.getPreferredSize().height);
        }
    }
    
    private void setTipState(int state) {
        tipTimer.stop();//停止上一次的任務
        if(state == 0) {//進入組件，延遲顯示
            tipTimerListener.state = 0;
            tipTimer.setInitialDelay(initTime);
            tipTimer.start();
        } else if(state == 1) {//鼠標移出，組件消失
            tipTimerListener.state = 1;
            PopTimingTip.this.setVisible(false);
        }
    }
    
    private class TipTimerListener implements ActionListener {
        int state;
        public void actionPerformed(ActionEvent e) {
            if(state == 0) {
                PopTimingTip.this.setVisible(true);
            }
        }
    }
    
    /**
     * 鼠標移除后及時清除偵聽防止偵聽器溢出
     */
    private void removeTipAndListener() {
        if(tipParent == null) {
            return;
        }
        tipParent.removeMouseListener(tipListener);
        tipParent.removeMouseMotionListener(tipListener);
        if(windowLayer != null) {
            windowLayer.remove(this);
        }
    }
    
    private class TipListener extends MouseAdapter {
        public void mouseEntered(MouseEvent e) {
            setTipState(0);
            followWithMouse(e);
        }
        
        /**
         * 鼠標移出對象時，移除對象的偵聽和ToolTip
         */
        public void mouseExited(MouseEvent e) {
            setTipState(1);
            followWithMouse(e);
            removeTipAndListener();
        }
        
        //在組件上移動時觸發
        public void mouseMoved(MouseEvent e){
            setTipState(0);
            followWithMouse(e);
        }
        
        public void mouseClicked(MouseEvent e) {
            if((e.getModifiers() & MouseEvent.BUTTON3_MASK) != 0) {//右鍵點擊，tip消失
                setTipState(1);
                followWithMouse(e);
                removeTipAndListener();
            }
        }
    }

}

 

ToolTipTest.java

 

package swingpac;

import java.awt.BorderLayout;
import java.awt.EventQueue;
import java.awt.FlowLayout;
import java.awt.event.MouseAdapter;
import java.awt.event.MouseEvent;

import javax.swing.JButton;
import javax.swing.JFrame;
import javax.swing.JPanel;
import javax.swing.border.EmptyBorder;

public class ToolTipTest extends JFrame {

    private JPanel contentPane;

    /**
     * Launch the application.
     */
    public static void main(String[] args) {
        EventQueue.invokeLater(new Runnable() {
            public void run() {
                try {
                    ToolTipTest frame = new ToolTipTest();
                    frame.setVisible(true);
                } catch (Exception e) {
                    e.printStackTrace();
                }
            }
        });
    }

    /**
     * Create the frame.
     */
    public ToolTipTest() {
        setDefaultCloseOperation(JFrame.EXIT_ON_CLOSE);
        setBounds(100, 100, 450, 300);
        contentPane = new JPanel();
        contentPane.setBorder(new EmptyBorder(5, 5, 5, 5));
        contentPane.setLayout(new BorderLayout(0, 0));
        setContentPane(contentPane);
        contentPane.setLayout(new FlowLayout());
        initTip();
    }
    
    private void initTip() {
        JButton btn = null;
        MListener m = new MListener();
        for(int i=0; i<10; i++) {
            btn = new JButton();
            btn.setName("第"+i+"個按鈕！");
            btn.setText("按鈕"+i);
            btn.addMouseListener(m);
            contentPane.add(btn);
        }
    }
    
    class MListener extends MouseAdapter {
        public void mouseEntered(MouseEvent e) {
            JButton btn = (JButton)e.getSource();
            StringBuilder sb = new StringBuilder();
            sb.append("當前進入的按鈕是：\n")
            .append(btn.getName()).append("\n")
            .append("正在進行演示自定義Tooltip！\n")
            .append("請自行查看源碼");
            
            PopTimingTip.getInstance().setConfigure(1, 300);
            PopTimingTip.getInstance().showTipText(btn, sb.toString());
        }
    }

}

 

效果演示（紅色為鼠標位置）

遇到邊界平移

總結

 利用JLayeredPane還可以做出其它組件，比如彈出層錄入等，個人感覺比Popup要輕量級，而且不會使界面失去焦點，阻塞用戶操作。