* * Note: this class assumes that the target component is of type JComponent.
* Note: this implementation is stateful, it can't be shared across different * instances of a target component.
* * * @author Jeanette Winzenburg */ public abstract class RolloverProducer implements MouseListener, MouseMotionListener, ComponentListener { @SuppressWarnings("unused") private static final Logger LOG = Logger.getLogger(RolloverProducer.class .getName()); /** * Key for client property mapped from mouse-triggered action. * Note that the actual mouse-event which results in setting the property * depends on the implementation of the concrete RolloverProducer. */ public static final String CLICKED_KEY = "swingx.clicked"; /** Key for client property mapped from rollover events */ public static final String ROLLOVER_KEY = "swingx.rollover"; // public static final String PRESSED_KEY = "swingx.pressed"; /** * Installs all listeners, as required. * * @param component target to install required listeners on, must * not be null. */ public void install(JComponent component) { component.addMouseListener(this); component.addMouseMotionListener(this); component.addComponentListener(this); } /** * Removes all listeners. * * @param component target component to uninstall required listeners from, * must not be null */ public void release(JComponent component) { component.removeMouseListener(this); component.removeMouseMotionListener(this); component.removeComponentListener(this); } //----------------- mouseListener /** * Implemented to map to client property clicked and fire always. */ public void mouseReleased(MouseEvent e) { updateRollover(e, CLICKED_KEY, true); } /** * Implemented to map to client property rollover and fire only if client * coordinate changed. */ public void mouseEntered(MouseEvent e) { // LOG.info("" + e); updateRollover(e, ROLLOVER_KEY, false); } /** * Implemented to remove client properties rollover and clicked. if the * source is a JComponent. Does nothing otherwise. */ public void mouseExited(MouseEvent e) { // screenLocation = null; // LOG.info("" + e); // if (((JComponent) e.getComponent()).getMousePosition(true) != null) { // updateRollover(e, ROLLOVER_KEY, false); // } else { // } ((JComponent) e.getSource()).putClientProperty(ROLLOVER_KEY, null); ((JComponent) e.getSource()).putClientProperty(CLICKED_KEY, null); } /** * Implemented to do nothing. */ public void mouseClicked(MouseEvent e) { } /** * Implemented to do nothing. */ public void mousePressed(MouseEvent e) { } // ---------------- MouseMotionListener /** * Implemented to do nothing. * PENDING JW: probably should do something? Mapped coordinates will be out of synch * after a drag. */ public void mouseDragged(MouseEvent e) { } /** * Implemented to map to client property rollover and fire only if client * coordinate changed. */ public void mouseMoved(MouseEvent e) { updateRollover(e, ROLLOVER_KEY, false); } //---------------- ComponentListener @Override public void componentShown(ComponentEvent e) { } @Override public void componentResized(ComponentEvent e) { updateRollover(e); } @Override public void componentMoved(ComponentEvent e) { updateRollover(e); } /** * @param e */ private void updateRollover(ComponentEvent e) { Point componentLocation = e.getComponent().getMousePosition(); if (componentLocation == null) { componentLocation = new Point(-1, -1); } // LOG.info("" + componentLocation + " / " + e); updateRolloverPoint((JComponent) e.getComponent(), componentLocation); updateClientProperty((JComponent) e.getComponent(), ROLLOVER_KEY, true); } @Override public void componentHidden(ComponentEvent e) { } //---------------- mapping methods /** * Controls the mapping of the given mouse event to a client property. This * implementation first calls updateRolloverPoint to convert the mouse coordinates. * Then calls updateClientProperty to actually set the client property in the * * @param e the MouseEvent to map to client coordinates * @param property the client property to map to * @param fireAlways a flag indicating whether a client event should be fired if unchanged. * * @see #updateRolloverPoint(JComponent, Point) * @see #updateClientProperty(JComponent, String, boolean) */ protected void updateRollover(MouseEvent e, String property, boolean fireAlways) { updateRolloverPoint((JComponent) e.getComponent(), e.getPoint()); updateClientProperty((JComponent) e.getComponent(), property, fireAlways); } /** Current mouse location in client coordinates. */ protected Point rollover = new Point(-1, -1); /** * Sets the given client property to the value of current mouse location in * client coordinates. If fireAlways, the property is force to fire a change. * * @param component the target component * @param property the client property to set * @param fireAlways a flag indicating whether a client property * should be forced to fire an event. */ protected void updateClientProperty(JComponent component, String property, boolean fireAlways) { if (fireAlways) { // fix Issue #864-swingx: force propertyChangeEvent component.putClientProperty(property, null); component.putClientProperty(property, new Point(rollover)); } else { Point p = (Point) component.getClientProperty(property); if (p == null || (rollover.x != p.x) || (rollover.y != p.y)) { component.putClientProperty(property, new Point(rollover)); } } } /** * Subclasses must implement to map the given mouse coordinates into * appropriate client coordinates. The result must be stored in the * rollover field. * * @param component the target component which received a mouse event * @param mousePoint the mouse position of the event, coordinates are * component pixels */ protected abstract void updateRolloverPoint(JComponent component, Point mousePoint); }