org.nuiton.widget.tooltip.TipWindow Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of nuiton-widgets Show documentation
Show all versions of nuiton-widgets Show documentation
Widgets graphiques utiles pour tous les développements.
/*
* 07/29/2009
*
* TipWindow.java - The actual window component representing the tool tip.
* Copyright (C) 2009 Robert Futrell
* robert_futrell at users.sourceforge.net
* http://fifesoft.com/rsyntaxtextarea
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation; either
* version 2.1 of the License, or (at your option) any later version.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the Free Software
* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA.
*/
package org.nuiton.widget.tooltip;
import static org.nuiton.i18n.I18n._;
import java.awt.BorderLayout;
import java.awt.Color;
import java.awt.Component;
import java.awt.Container;
import java.awt.Dimension;
import java.awt.Font;
import java.awt.Point;
import java.awt.Rectangle;
import java.awt.Window;
import java.awt.event.ActionEvent;
import java.awt.event.ActionListener;
import java.awt.event.KeyAdapter;
import java.awt.event.KeyEvent;
import java.awt.event.MouseAdapter;
import java.awt.event.MouseEvent;
import java.awt.event.WindowAdapter;
import java.awt.event.WindowEvent;
import javax.swing.BorderFactory;
import javax.swing.JEditorPane;
import javax.swing.JLabel;
import javax.swing.JPanel;
import javax.swing.JScrollPane;
import javax.swing.JSeparator;
import javax.swing.JWindow;
import javax.swing.SwingConstants;
import javax.swing.SwingUtilities;
import javax.swing.UIManager;
import javax.swing.event.HyperlinkEvent;
import javax.swing.event.HyperlinkListener;
import javax.swing.event.MouseInputAdapter;
import javax.swing.text.BadLocationException;
import javax.swing.text.html.HTMLDocument;
/**
* The actual tool tip component.
*
* @author Robert Futrell
* @version 1.0
*/
class TipWindow extends JWindow implements ActionListener {
private FocusableTip ft;
private JEditorPane textArea;
private String text;
private TipListener tipListener;
private HyperlinkListener userHyperlinkListener;
private static TipWindow visibleInstance;
/**
* Constructor.
*
* @param owner The parent window.
* @param msg The text of the tool tip. This can be HTML.
*/
public TipWindow(Window owner, FocusableTip ft, String msg) {
super(owner);
this.ft = ft;
this.text = msg;
tipListener = new TipListener();
JPanel cp = new JPanel(new BorderLayout());
cp.setBorder(BorderFactory.createCompoundBorder(BorderFactory
.createLineBorder(Color.BLACK), BorderFactory
.createEmptyBorder()));
cp.setBackground(TipUtil.getToolTipBackground());
textArea = new JEditorPane("text/html", msg);
TipUtil.tweakTipEditorPane(textArea);
if (ft.getImageBase()!=null) { // Base URL for images
((HTMLDocument)textArea.getDocument()).setBase(ft.getImageBase());
}
textArea.addMouseListener(tipListener);
textArea.addHyperlinkListener(new HyperlinkListener() {
public void hyperlinkUpdate(HyperlinkEvent e) {
if (e.getEventType()==HyperlinkEvent.EventType.ACTIVATED) {
TipWindow.this.ft.possiblyDisposeOfTipWindow();
}
}
});
cp.add(textArea);
setFocusableWindowState(false);
setContentPane(cp);
setBottomPanel(); // Must do after setContentPane()
pack();
// InputMap/ActionMap combo doesn't work for JWindows (even when
// using the JWindow's JRootPane), so we'll resort to KeyListener
KeyAdapter ka = new KeyAdapter() {
public void keyPressed(KeyEvent e) {
if (e.getKeyCode()==KeyEvent.VK_ESCAPE) {
TipWindow.this.ft.possiblyDisposeOfTipWindow();
}
}
};
addKeyListener(ka);
textArea.addKeyListener(ka);
// Ensure only 1 TipWindow is ever visible. If the caller does what
// they're supposed to and only creates these on the EDT, the
// synchronization isn't necessary, but we'll be extra safe.
synchronized (TipWindow.class) {
if (visibleInstance!=null) {
visibleInstance.dispose();
}
visibleInstance = this;
}
}
public void actionPerformed(ActionEvent e) {
if (!getFocusableWindowState()) {
setFocusableWindowState(true);
setBottomPanel();
textArea.removeMouseListener(tipListener);
pack();
addWindowFocusListener(new WindowAdapter() {
public void windowLostFocus(WindowEvent e) {
ft.possiblyDisposeOfTipWindow();
}
});
ft.removeListeners();
if (e==null) { // Didn't get here via our mouseover timer
requestFocus();
}
}
}
/**
* Disposes of this window.
*/
public void dispose() {
//System.out.println("[DEBUG]: Disposing...");
Container cp = getContentPane();
for (int i=0; inull means "no listener."
*/
public void setHyperlinkListener(HyperlinkListener listener) {
// We've added a separate listener, so remove only the user's.
if (userHyperlinkListener!=null) {
textArea.removeHyperlinkListener(userHyperlinkListener);
}
userHyperlinkListener = listener;
if (userHyperlinkListener!=null) {
textArea.addHyperlinkListener(userHyperlinkListener);
}
}
/**
* Listens for events in this window.
*/
private class TipListener extends MouseAdapter {
public TipListener() {
}
public void mousePressed(MouseEvent e) {
actionPerformed(null); // Manually create "real" window
}
public void mouseExited(MouseEvent e) {
// Since we registered this listener on the child components of
// the JWindow, not the JWindow iteself, we have to be careful.
Component source = (Component)e.getSource();
Point p = e.getPoint();
SwingUtilities.convertPointToScreen(p, source);
if (!TipWindow.this.getBounds().contains(p)) {
ft.possiblyDisposeOfTipWindow();
}
}
}
}