CODEWITHSUNDEEP
javaswing
Sai Dubbaka
Sai Dubbaka

Reputation: 621

How to propagate the mouse events to the parent container in a generic way

I have the following code written for developing a JTabbedPane "tab component". I am setting it using setTabComponentAt(index, tabComponent) in my custom tabbed pane.

package com.example.tabpane;

import java.awt.BasicStroke;
import java.awt.Color;
import java.awt.Dimension;
import java.awt.Graphics;
import java.awt.Graphics2D;
import java.awt.Insets;
import java.awt.Point;
import java.awt.Rectangle;
import java.awt.RenderingHints;
import java.awt.event.MouseAdapter;
import java.awt.event.MouseEvent;
import java.awt.event.MouseMotionAdapter;

import javax.swing.JLabel;
import javax.swing.event.EventListenerList;

import com.example.SwingUtilities;

public class TabComponent extends JLabel {
    private Point mousePointerAt;
    private Dimension crossIconDim = new Dimension(15, 15);
    private int crossIconDimLeftPadding = 5;
    private EventListenerList eventListeners = new EventListenerList();
    public TabComponent() {
        initComponent();
    }
    public TabComponent(String title) {
        super(title);   
        setOpaque(false);
        initComponent();
    }

    //You don't have to override the getSize() versions. It basically calls getWidth() and getHeight()
    //Also you should NOT override getWidth() and getHeight() because the layout managers set that properties
    //If you do the borders right/bottom edges won't be painted correctly

    @Override
    public Dimension getPreferredSize() {
        Dimension preferredSize = super.getPreferredSize();
        int width = (int)preferredSize.getWidth();
        int height = (int)preferredSize.getHeight();
        width += crossIconDim.getWidth() + crossIconDimLeftPadding;
        height = Math.max(height, (int) crossIconDim.getHeight());
        Dimension newSize = new Dimension(width, height);       
        return newSize;
    }

    @Override
    public Dimension getMinimumSize() {
        Dimension preferredSize = super.getMinimumSize();
        int width = (int)preferredSize.getWidth();
        int height = (int)preferredSize.getHeight();
        width += crossIconDim.getWidth() + crossIconDimLeftPadding;
        height = Math.max(height, (int) crossIconDim.getHeight());
        Dimension newSize = new Dimension(width, height);       
        return newSize;
    }

    @Override
    public Dimension getMaximumSize() {
        Dimension preferredSize = super.getMaximumSize();
        int width = (int)preferredSize.getWidth();
        int height = (int)preferredSize.getHeight();
        width += crossIconDim.getWidth() + crossIconDimLeftPadding;
        height = Math.max(height, (int) crossIconDim.getHeight());
        Dimension newSize = new Dimension(width, height);       
        return newSize;
    }   

    private void initComponent() {

        addMouseMotionListener(new MouseMotionAdapter() {           
            @Override
            public void mouseMoved(MouseEvent e) {
                SwingUtilities.bubbleEvent(e);
                TabComponent tab = (TabComponent) e.getComponent();
                tab.mousePointerAt = e.getPoint();
                tab.repaint();
            }
        });

        addMouseListener(new MouseAdapter() {           
            @Override
            public void mouseExited(MouseEvent e) {
                SwingUtilities.bubbleEvent(e);
                TabComponent tab = (TabComponent) e.getComponent();
                tab.mousePointerAt = null;
                tab.repaint();
            }
            @Override
            public void mouseClicked(MouseEvent e) {
                SwingUtilities.bubbleEvent(e);
                TabComponent tab = (TabComponent) e.getComponent();
                if (tab.mousePointerAt != null) {
                    int componentWidth = tab.getWidth();
                    Insets insets = tab.getInsets();
                    Point gfxXlatePoint = new Point(componentWidth - (int) crossIconDim.getWidth() - insets.right, insets.top);     
                    Rectangle paintRectangle = new Rectangle(gfxXlatePoint, crossIconDim);
                    if (mousePointerAt != null) {
                        if (paintRectangle.contains(mousePointerAt)) {
                            tab.fireTabEvent(new TabEvent(tab, TabEvent.TAB_CLOSING));
                        }
                    }
                }
            }
        });
    }

    @Override
    protected void paintComponent(Graphics g) {
        super.paintComponent(g);
        Graphics2D gfx = (Graphics2D) g.create();

        int componentWidth = getWidth();
        int ovalRadius = (int) (crossIconDim.getWidth());           
        Insets insets = getInsets();
        Point gfxXlatePoint = new Point(componentWidth - (int) crossIconDim.getWidth() - insets.right, insets.top);     
        Rectangle paintRectangle = new Rectangle(gfxXlatePoint, crossIconDim);
        gfx.translate(gfxXlatePoint.x, gfxXlatePoint.y);

        boolean mouseOverCloseCue = false;      
        if (mousePointerAt != null) {
            if (paintRectangle.contains(mousePointerAt)) {
                mouseOverCloseCue = true;
            }
        }
        gfx.setStroke(new BasicStroke(2));
        gfx.setRenderingHint(RenderingHints.KEY_ANTIALIASING, RenderingHints.VALUE_ANTIALIAS_ON);
        Insets crossIconPadding = new Insets(5, 5, 5, 5);
        if (mouseOverCloseCue) {
            gfx.setColor(new Color(0xf49f94));
            //The mouse pointer is on the x mark
            gfx.fillOval(0, 0, ovalRadius, ovalRadius);
            gfx.setColor(Color.WHITE);          
            gfx.drawLine(0 + crossIconPadding.left, 0 + crossIconPadding.top, (int)crossIconDim.getWidth() - crossIconPadding.right, (int)crossIconDim.getHeight() - crossIconPadding.bottom);
            gfx.drawLine((int)crossIconDim.getWidth() - crossIconPadding.right, 0 + crossIconPadding.top, 0 + crossIconPadding.left, (int)crossIconDim.getHeight() - crossIconPadding.bottom);
        } else {
            gfx.setColor(Color.BLACK);
            gfx.drawLine(0 + crossIconPadding.left, 0 + crossIconPadding.top, (int)crossIconDim.getWidth() - crossIconPadding.right, (int)crossIconDim.getHeight() - crossIconPadding.bottom);
            gfx.drawLine((int)crossIconDim.getWidth() - crossIconPadding.right, 0 + crossIconPadding.top, 0 + crossIconPadding.left, (int)crossIconDim.getHeight() - crossIconPadding.bottom);
        }
        gfx.dispose();
    }   

    public void addTabEventListener(TabEventListener listener) {
        eventListeners.add(TabEventListener.class, listener);
    }

    public void removeTabEventListener(TabEventListener listener) {
        eventListeners.remove(TabEventListener.class, listener);
    }

    protected void fireTabEvent(TabEvent evt) {
        Object[] listeners = eventListeners.getListeners(TabEventListener.class);
        for (int i = 0, n = listeners.length; i < n; i++) {
            ((TabEventListener) listeners[i]).handleEvent(evt);
        }
    }
}

The following code is insdie my custom JTabbedPane

package com.example.tabpane;

import java.awt.Component;

import javax.swing.JTabbedPane;

public class ClosingTabbedPane extends JTabbedPane {
    /**
     * 
     */
    private static final long serialVersionUID = 1L;

    public ClosingTabbedPane() {
    }

    @Override
    public void addTab(String title, Component component) {
        super.addTab(title, component);
        final int index = getTabCount() - 1;
        TabComponent tabLabel = new TabComponent(title);
        tabLabel.addTabEventListener(new TabEventListener() {           
            @Override
            public void handleEvent(TabEvent evt) {
                if (evt.getEventType() == TabEvent.TAB_CLOSING) {
                    ClosingTabbedPane.this.removeTabAt(index);
                }               
            }
        });
        setTabComponentAt(index, tabLabel);     
    }
}

The problem is, the tab component doesn't work because it's consuming mouse events. The TabbedPane doesn't change the tab as it's supposed to when user clicks on the tab component. I could handle that click myself and change the tab visible but I was thinking if were was another way to bubble up the event. I tried to write a generic event bubbler but it's throing StackOverflowError.

package com.example;

import java.awt.AWTEvent;
import java.awt.Component;
import java.awt.Container;

public class SwingUtilities {
    public static void bubbleEvent(AWTEvent event) {
        Component source = (Component) event.getSource();
        Container parent = source.getParent();
        int i = 0, deep = 10;
        while (parent != null && i < deep) {
            i++;
            System.out.println("Dispatching to the parent with i = " + i);
            parent.dispatchEvent(event);
            parent = parent.getParent();
        }
    }
}

Upvotes: 3

Views: 1461

Answers (1)

MadProgrammer
MadProgrammer

Reputation: 347204

You're thinking about this the wrong way.

  • When the mouse is over the "close" icon, you only want mouse events to trigger a "close" event
  • All other times, you want the default behavior of the tab

Instead of creating a single, all emcompassing class which tries to do both, why not create a CloseIcon class which is then contained by a TabComponent.

This way, you separate the logic and isolate the responsibility, without the need to resort to dirty hacks and work arounds to make it work

(Sorry, I butchered your code a bit)

CloseIcon

All this does is draws the close icon and responds to mouse events. When clicked, it triggers a ActionEvent (as a generic event) for other components to listen to...

public class CloseIcon extends JPanel {

    private static final Dimension CROSS_ICON_SIZE = new Dimension(15, 15);
    private static final int CROSS_ICON_INSET = 5;
    private boolean mouseInTheHouse = false;

    public CloseIcon() {
        setOpaque(false);

        addMouseListener(new MouseAdapter() {

            @Override
            public void mouseClicked(MouseEvent e) {
                fireActionPerformed();
            }

            @Override
            public void mouseEntered(MouseEvent e) {
                mouseInTheHouse = true;
            }

            @Override
            public void mouseExited(MouseEvent e) {
                mouseInTheHouse = false;
            }

        });
    }

    public void addActionListener(ActionListener listener) {
        listenerList.add(ActionListener.class, listener);
    }

    protected void fireActionPerformed() {
        ActionListener[] listeners = listenerList.getListeners(ActionListener.class);
        if (listeners.length > 0) {
            ActionEvent evt = new ActionEvent(this, ActionEvent.ACTION_PERFORMED, "Closed");
            for (ActionListener listener : listeners) {
                listener.actionPerformed(evt);
            }
        }
    }

    //You don't have to override the getSize() versions. It basically calls getWidth() and getHeight()
    //Also you should NOT override getWidth() and getHeight() because the layout managers set that properties
    //If you do the borders right/bottom edges won't be painted correctly
    @Override
    public Dimension getPreferredSize() {
        return new Dimension(CROSS_ICON_SIZE.width + CROSS_ICON_INSET, CROSS_ICON_SIZE.height);
    }

    @Override
    public Dimension getMinimumSize() {
        return getPreferredSize();
    }

    @Override
    public Dimension getMaximumSize() {
        return getPreferredSize();
    }

    @Override
    protected void paintComponent(Graphics g) {
        super.paintComponent(g);
        Graphics2D gfx = (Graphics2D) g.create();

        int componentWidth = getWidth();
        int ovalRadius = (int) (CROSS_ICON_SIZE.getWidth());
        Insets insets = getInsets();
        Point gfxXlatePoint = new Point(componentWidth - (int) CROSS_ICON_SIZE.getWidth() - insets.right, insets.top);
        Rectangle paintRectangle = new Rectangle(gfxXlatePoint, CROSS_ICON_SIZE);
        gfx.translate(gfxXlatePoint.x, gfxXlatePoint.y);

        gfx.setStroke(new BasicStroke(2));
        gfx.setRenderingHint(RenderingHints.KEY_ANTIALIASING, RenderingHints.VALUE_ANTIALIAS_ON);
        Insets crossIconPadding = new Insets(5, 5, 5, 5);
        if (mouseInTheHouse) {
            gfx.setColor(new Color(0xf49f94));
            //The mouse pointer is on the x mark
            gfx.fillOval(0, 0, ovalRadius, ovalRadius);
            gfx.setColor(Color.WHITE);
            gfx.drawLine(0 + crossIconPadding.left, 0 + crossIconPadding.top, (int) CROSS_ICON_SIZE.getWidth() - crossIconPadding.right, (int) CROSS_ICON_SIZE.getHeight() - crossIconPadding.bottom);
            gfx.drawLine((int) CROSS_ICON_SIZE.getWidth() - crossIconPadding.right, 0 + crossIconPadding.top, 0 + crossIconPadding.left, (int) CROSS_ICON_SIZE.getHeight() - crossIconPadding.bottom);
        } else {
            gfx.setColor(Color.BLACK);
            gfx.drawLine(0 + crossIconPadding.left, 0 + crossIconPadding.top, (int) CROSS_ICON_SIZE.getWidth() - crossIconPadding.right, (int) CROSS_ICON_SIZE.getHeight() - crossIconPadding.bottom);
            gfx.drawLine((int) CROSS_ICON_SIZE.getWidth() - crossIconPadding.right, 0 + crossIconPadding.top, 0 + crossIconPadding.left, (int) CROSS_ICON_SIZE.getHeight() - crossIconPadding.bottom);
        }
        gfx.dispose();
    }

}

TabComponent

The TabComponent is just a JPanel with a JLabel and CloseIcon on it. The component listens to the CloseIcon for ActionEvents which it then uses to trigger a TabEvent

public class TabComponent extends JPanel {

    private CloseIcon closeIcon;

    public TabComponent(String title) {
        setLayout(new GridBagLayout());
        setOpaque(false);

        JLabel lblTitle = new JLabel(title);
        closeIcon = new CloseIcon();
        closeIcon.addActionListener(new ActionListener() {
            @Override
            public void actionPerformed(ActionEvent e) {
                fireTabEvent(new TabEvent(this));//, TabEvent.TAB_CLOSING));
            }
        });

        GridBagConstraints gbc = new GridBagConstraints();
        gbc.gridx = 0;
        gbc.gridy = 0;
        gbc.weightx = 1;
        gbc.anchor = GridBagConstraints.WEST;
        add(lblTitle, gbc);

        gbc.gridx++;
        gbc.weightx = 0;
        gbc.anchor = GridBagConstraints.NORTHEAST;
        add(closeIcon);

    }

    public void addTabEventListener(TabEventListener listener) {
        listenerList.add(TabEventListener.class, listener);
    }

    public void removeTabEventListener(TabEventListener listener) {
        listenerList.remove(TabEventListener.class, listener);
    }

    protected void fireTabEvent(TabEvent evt) {
        Object[] listeners = listenerList.getListeners(TabEventListener.class);
        for (int i = 0, n = listeners.length; i < n; i++) {
            ((TabEventListener) listeners[i]).handleEvent(evt);
        }
    }

}

Runnable example...

import java.awt.BasicStroke;
import java.awt.BorderLayout;
import java.awt.Color;
import java.awt.Component;
import java.awt.Dimension;
import java.awt.EventQueue;
import java.awt.Graphics;
import java.awt.Graphics2D;
import java.awt.GridBagConstraints;
import java.awt.GridBagLayout;
import java.awt.Insets;
import java.awt.Point;
import java.awt.Rectangle;
import java.awt.RenderingHints;
import java.awt.event.ActionEvent;
import java.awt.event.ActionListener;
import java.awt.event.MouseAdapter;
import java.awt.event.MouseEvent;
import java.util.EventListener;
import java.util.EventObject;
import javaapplication222.Test.TestPane;
import javax.swing.JFrame;
import javax.swing.JLabel;
import javax.swing.JPanel;
import javax.swing.JTabbedPane;
import javax.swing.UIManager;
import javax.swing.UnsupportedLookAndFeelException;

public class Test {

    public static void main(String[] args) {
        new Test();
    }

    public Test() {
        EventQueue.invokeLater(new Runnable() {
            @Override
            public void run() {
                try {
                    UIManager.setLookAndFeel(UIManager.getSystemLookAndFeelClassName());
                } catch (ClassNotFoundException | InstantiationException | IllegalAccessException | UnsupportedLookAndFeelException ex) {
                    ex.printStackTrace();
                }

                JFrame frame = new JFrame("Testing");
                frame.setDefaultCloseOperation(JFrame.EXIT_ON_CLOSE);
                frame.add(new TestPane());
                frame.pack();
                frame.setLocationRelativeTo(null);
                frame.setVisible(true);
            }
        });
    }

    public class TestPane extends JPanel {

        public TestPane() {
            setLayout(new BorderLayout());
            ClosingTabbedPane ctp = new ClosingTabbedPane();

            ctp.addTab("Bananas", createPanel("Hello"));
            ctp.addTab("Apples", createPanel("Kanchiwa"));
            add(ctp);
        }

        protected JPanel createPanel(String msg) {

            JPanel panel = new JPanel(new GridBagLayout());
            JLabel label = new JLabel(msg);
            MouseAdapter ma = new MouseAdapter() {

                @Override
                public void mouseClicked(MouseEvent e) {
                    System.out.println("clicked");
                }

                @Override
                public void mouseEntered(MouseEvent e) {
                    System.out.println("in");
                }

                @Override
                public void mouseExited(MouseEvent e) {
                    System.out.println("out");
                }

            };
            label.addMouseListener(ma);
            label.addMouseMotionListener(ma);
            panel.add(label);

            return panel;

        }

        @Override
        public Dimension getPreferredSize() {
            return new Dimension(200, 200);
        }

    }

    public class ClosingTabbedPane extends JTabbedPane {

        /**
         *
         */
        private static final long serialVersionUID = 1L;

        public ClosingTabbedPane() {
        }

        @Override
        public void addTab(String title, Component component) {
            super.addTab(title, component);
            final int index = getTabCount() - 1;
            TabComponent tabLabel = new TabComponent(title);
            tabLabel.addTabEventListener(new TabEventListener() {
                @Override
                public void handleEvent(TabEvent evt) {
                    System.out.println("Boo");
//                  if (evt.getEventType() == TabEvent.TAB_CLOSING) {
//                      ClosingTabbedPane.this.removeTabAt(index);
//                  }
                }
            });
            setTabComponentAt(index, tabLabel);
        }
    }

    public class TabEvent extends EventObject {

        public TabEvent(Object source) {
            super(source);
        }

    }

    public interface TabEventListener extends EventListener {

        public void handleEvent(TabEvent evt);

    }

    public static class CloseIcon extends JPanel {

        private static final Dimension CROSS_ICON_SIZE = new Dimension(15, 15);
        private static final int CROSS_ICON_INSET = 5;
        private boolean mouseInTheHouse = false;

        public CloseIcon() {
            setOpaque(false);

            addMouseListener(new MouseAdapter() {

                @Override
                public void mouseClicked(MouseEvent e) {
                    fireActionPerformed();
                }

                @Override
                public void mouseEntered(MouseEvent e) {
                    mouseInTheHouse = true;
                }

                @Override
                public void mouseExited(MouseEvent e) {
                    mouseInTheHouse = false;
                }

            });
        }

        public void addActionListener(ActionListener listener) {
            listenerList.add(ActionListener.class, listener);
        }

        protected void fireActionPerformed() {
            ActionListener[] listeners = listenerList.getListeners(ActionListener.class);
            if (listeners.length > 0) {
                ActionEvent evt = new ActionEvent(this, ActionEvent.ACTION_PERFORMED, "Closed");
                for (ActionListener listener : listeners) {
                    listener.actionPerformed(evt);
                }
            }
        }

        //You don't have to override the getSize() versions. It basically calls getWidth() and getHeight()
        //Also you should NOT override getWidth() and getHeight() because the layout managers set that properties
        //If you do the borders right/bottom edges won't be painted correctly
        @Override
        public Dimension getPreferredSize() {
            return new Dimension(CROSS_ICON_SIZE.width + CROSS_ICON_INSET, CROSS_ICON_SIZE.height);
        }

        @Override
        public Dimension getMinimumSize() {
            return getPreferredSize();
        }

        @Override
        public Dimension getMaximumSize() {
            return getPreferredSize();
        }

        @Override
        protected void paintComponent(Graphics g) {
            super.paintComponent(g);
            Graphics2D gfx = (Graphics2D) g.create();

            int componentWidth = getWidth();
            int ovalRadius = (int) (CROSS_ICON_SIZE.getWidth());
            Insets insets = getInsets();
            Point gfxXlatePoint = new Point(componentWidth - (int) CROSS_ICON_SIZE.getWidth() - insets.right, insets.top);
            Rectangle paintRectangle = new Rectangle(gfxXlatePoint, CROSS_ICON_SIZE);
            gfx.translate(gfxXlatePoint.x, gfxXlatePoint.y);

            gfx.setStroke(new BasicStroke(2));
            gfx.setRenderingHint(RenderingHints.KEY_ANTIALIASING, RenderingHints.VALUE_ANTIALIAS_ON);
            Insets crossIconPadding = new Insets(5, 5, 5, 5);
            if (mouseInTheHouse) {
                gfx.setColor(new Color(0xf49f94));
                //The mouse pointer is on the x mark
                gfx.fillOval(0, 0, ovalRadius, ovalRadius);
                gfx.setColor(Color.WHITE);
                gfx.drawLine(0 + crossIconPadding.left, 0 + crossIconPadding.top, (int) CROSS_ICON_SIZE.getWidth() - crossIconPadding.right, (int) CROSS_ICON_SIZE.getHeight() - crossIconPadding.bottom);
                gfx.drawLine((int) CROSS_ICON_SIZE.getWidth() - crossIconPadding.right, 0 + crossIconPadding.top, 0 + crossIconPadding.left, (int) CROSS_ICON_SIZE.getHeight() - crossIconPadding.bottom);
            } else {
                gfx.setColor(Color.BLACK);
                gfx.drawLine(0 + crossIconPadding.left, 0 + crossIconPadding.top, (int) CROSS_ICON_SIZE.getWidth() - crossIconPadding.right, (int) CROSS_ICON_SIZE.getHeight() - crossIconPadding.bottom);
                gfx.drawLine((int) CROSS_ICON_SIZE.getWidth() - crossIconPadding.right, 0 + crossIconPadding.top, 0 + crossIconPadding.left, (int) CROSS_ICON_SIZE.getHeight() - crossIconPadding.bottom);
            }
            gfx.dispose();
        }

    }

    public class TabComponent extends JPanel {

        private CloseIcon closeIcon;

        public TabComponent(String title) {
            setLayout(new GridBagLayout());
            setOpaque(false);

            JLabel lblTitle = new JLabel(title);
            closeIcon = new CloseIcon();
            closeIcon.addActionListener(new ActionListener() {
                @Override
                public void actionPerformed(ActionEvent e) {
                    fireTabEvent(new TabEvent(this));//, TabEvent.TAB_CLOSING));
                }
            });

            GridBagConstraints gbc = new GridBagConstraints();
            gbc.gridx = 0;
            gbc.gridy = 0;
            gbc.weightx = 1;
            gbc.anchor = GridBagConstraints.WEST;
            add(lblTitle, gbc);

            gbc.gridx++;
            gbc.weightx = 0;
            gbc.anchor = GridBagConstraints.NORTHEAST;
            add(closeIcon);

        }

        public void addTabEventListener(TabEventListener listener) {
            listenerList.add(TabEventListener.class, listener);
        }

        public void removeTabEventListener(TabEventListener listener) {
            listenerList.remove(TabEventListener.class, listener);
        }

        protected void fireTabEvent(TabEvent evt) {
            Object[] listeners = listenerList.getListeners(TabEventListener.class);
            for (int i = 0, n = listeners.length; i < n; i++) {
                ((TabEventListener) listeners[i]).handleEvent(evt);
            }
        }

    }
}

Upvotes: 2

Related Questions