com.github.lespaul361.commons.commonroutines.utilities.SetCursor Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of Commons-CommonRoutines Show documentation
common routines I use in my projects
There is a newer version: 1.6.0
Show newest version
/*
 * Copyright (C) 2019 Charles Hamilton
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program 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 General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see .
 */
package com.github.lespaul361.commons.commonroutines.utilities;

import java.awt.Component;
import java.awt.Cursor;
import java.awt.event.MouseAdapter;
import javax.swing.JComponent;
import javax.swing.JDialog;
import javax.swing.JFrame;
import javax.swing.RootPaneContainer;
import javax.swing.SwingUtilities;

/**
 * Helper class for common cursor changes
 * 
 * @author Charles Hamilton
 */
public class SetCursor {

    private final static MouseAdapter mouseAdapter = new MouseAdapter() {
    };

    /**
     * Sets the cursor to wait cursor and blocks mouse events
     * 
     * @param component
     *            component on frame to set the cursor
     */
    public static void setWaitCursor(JComponent component) {
	changeCursor(Cursor.WAIT_CURSOR, component, true);
    }

    /**
     * Sets the cursor to wait cursor and blocks mouse events
     * 
     * @param component
     *            JFrame to set the cursor
     */
    public static void setWaitCursor(JFrame component) {
	changeCursor(Cursor.WAIT_CURSOR, component.getGlassPane(), true);
    }

    /**
     * Sets the cursor to wait cursor and blocks mouse events
     * 
     * @param component
     *            JDialog to set the cursor
     */
    public static void setWaitCursor(JDialog component) {
	changeCursor(Cursor.WAIT_CURSOR, component.getGlassPane(), true);
    }

    /**
     * Sets the cursor to the default cursor and blocks mouse events
     * 
     * @param component
     *            JFrame to set the cursor
     */
    public static void setDefaultCursor(JFrame component) {
	changeCursor(Cursor.DEFAULT_CURSOR, component.getGlassPane(), false);
    }

    /**
     * Sets the cursor to the default cursor and blocks mouse events
     * 
     * @param component
     *            JDialog to set the cursor
     */
    public static void setDefaultCursor(JDialog component) {
	changeCursor(Cursor.DEFAULT_CURSOR, component.getGlassPane(), false);
    }

    /**
     * Sets the cursor to default cursor and allows mouse events
     * 
     * @param component
     *            component on frame to set the cursor
     */
    public static void setDefaultCursor(JComponent component) {
	changeCursor(Cursor.DEFAULT_CURSOR, component, false);
    }

    /**
     * Sets the cursor to decided cursor. If it is wait cursor then it blocks
     * mouse events
     * 
     * @param cursor
     *            integer value of cursor
     * @param component
     *            component on frame to set the cursor
     * 
     * 
     *            
     *            DEFAULT_CURSOR = 0 

     *            CROSSHAIR_CURSOR = 1 

     *            TEXT_CURSOR = 2 

     *            WAIT_CURSOR = 3 

     *            SW_RESIZE_CURSOR = 4 

     *            SE_RESIZE_CURSOR = 5 

     *            NW_RESIZE_CURSOR = 6 

     *            NE_RESIZE_CURSOR = 7 

     *            N_RESIZE_CURSOR = 8 

     *            S_RESIZE_CURSOR = 9 

     *            W_RESIZE_CURSOR = 10 

     *            E_RESIZE_CURSOR = 11 

     *            HAND_CURSOR = 12 

     *            MOVE_CURSOR = 13
     */
    public static void setCursor(int cursor, JComponent component) {
	changeCursor(cursor, component, false);
    }

    /**
     * Sets the cursor to decided cursor. If it is wait cursor or
     * stopMouseEvents is true then it blocks mouse events
     * 
     * @param cursor
     *            integer value of cursor
     * @param component
     *            component on frame to set the cursor
     * @param stopMouseEvents
     *            if true mouse events are stopped during the cursor otherwise
     *            mouse events are allowed
     * 
     *            
     *            DEFAULT_CURSOR = 0 

     *            CROSSHAIR_CURSOR = 1 

     *            TEXT_CURSOR = 2 

     *            WAIT_CURSOR = 3 

     *            SW_RESIZE_CURSOR = 4 

     *            SE_RESIZE_CURSOR = 5 

     *            NW_RESIZE_CURSOR = 6 

     *            NE_RESIZE_CURSOR = 7 

     *            N_RESIZE_CURSOR = 8 

     *            S_RESIZE_CURSOR = 9 

     *            W_RESIZE_CURSOR = 10 

     *            E_RESIZE_CURSOR = 11 

     *            HAND_CURSOR = 12 

     *            MOVE_CURSOR = 13
     */
    public static void setCursor(int cursor, JComponent component, boolean stopMouseEvents) {
	changeCursor(cursor, component, stopMouseEvents);
    }

    private static void changeCursor(int cursor, JComponent component, boolean stopMouse) {
	RootPaneContainer rcp = ((RootPaneContainer) component.getTopLevelAncestor());
	changeCursor(cursor, rcp, stopMouse);
    }

    private static void changeCursor(int cursor, RootPaneContainer rcp, boolean stopMouse) {
	Component glassPane = rcp.getGlassPane();
	changeCursor(cursor, glassPane, stopMouse);
    }

    private static void changeCursor(int cursor, Component glassPane, boolean stopMouse) {
        Runnable r = new Runnable() {

            @Override
            public void run() {
                if ((cursor == Cursor.WAIT_CURSOR) || stopMouse) {
                    glassPane.addMouseListener(mouseAdapter);
                } else {
                    glassPane.removeMouseListener(mouseAdapter);
                }
                glassPane.setVisible((cursor == Cursor.WAIT_CURSOR) || stopMouse);
                glassPane.setCursor(Cursor.getPredefinedCursor(cursor));
            }

        };
        if (!SwingUtilities.isEventDispatchThread()) {
            try {
                SwingUtilities.invokeLater(r);
            } catch (Exception e) {
            }
        } else {
            r.run();
        }
    }
}