ShadowPopupFactory.java

package com.jsql.view.swing.shadow;

/*
 * Copyright (c) 2005-2013 JGoodies Software GmbH. All Rights Reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *
 *  o Redistributions of source code must retain the above copyright notice,
 *    this list of conditions and the following disclaimer.
 *
 *  o Redistributions in binary form must reproduce the above copyright notice,
 *    this list of conditions and the following disclaimer in the documentation
 *    and/or other materials provided with the distribution.
 *
 *  o Neither the name of JGoodies Software GmbH nor the names of
 *    its contributors may be used to endorse or promote products derived
 *    from this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
 * HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */

import org.apache.commons.lang3.SystemUtils;

import javax.swing.*;
import java.awt.*;

/**
 * The JGoodies Looks implementation of {@code PopupFactory}.
 * Adds a drop shadow border to all popups except ComboBox popups.
 * It is installed by the JGoodies Plastic L&amp;F, as well as by
 * the JGoodies Windows L&amp;F during the Look&amp;Feel initialization,
 * see {link com.jgoodies.looks.plastic.PlasticLookAndFeel#initialize} and
 * {link com.jgoodies.looks.windows.WindowsLookAndFeel#initialize}.<p>
 *
 * This factory shall not be used on platforms that provide native drop shadows,
 * such as the Mac OS X. Therefore the invocation of the {@link #install()}
 * method will have no effect on such platforms.<p>
 *
 * <strong>Note:</strong> To be used in a sandbox environment, this PopupFactory
 * requires two AWT permissions: {@code createRobot} and
 * {@code readDisplayPixels}. The reason for it is, that in the case of
 * the heavy weight popups this PopupFactory uses a Robot to snapshot
 * the screen background to simulate the drop shadow effect.
 *
 * @author Karsten Lentzsch
 * @version $Revision: 1.8 $
 *
 * @see java.awt.AWTPermission
 * @see java.awt.Robot
 * @see javax.swing.Popup
 * @see javax.swing.LookAndFeel#initialize
 * @see javax.swing.LookAndFeel#uninitialize
 */
public final class ShadowPopupFactory extends PopupFactory {

    /**
     * In the case of heavy weight popups, snapshots of the screen background
     * will be stored as client properties of the popup contents' parent.
     * These snapshots will be used by the popup border to simulate the drop
     * shadow effect. The two following constants define the names of
     * these client properties.
     *
     * see com.jgoodies.looks.common.ShadowPopupBorder
     */
    public static final String PROP_HORIZONTAL_BACKGROUND = "jgoodies.hShadowBg";
    public static final String PROP_VERTICAL_BACKGROUND   = "jgoodies.vShadowBg";

    /**
     * The PopupFactory used before this PopupFactory has been installed
     * in {@code #install}. Used to restore the original state
     * in {@code #uninstall}.
     */
    private final PopupFactory storedFactory;


    // Instance Creation ******************************************************

    private ShadowPopupFactory(PopupFactory storedFactory) {
        this.storedFactory = storedFactory;
    }


    // API ********************************************************************

    /**
     * Installs the ShadowPopupFactory as the shared popup factory
     * on non-Mac platforms. Also stores the previously set factory,
     * so that it can be restored in {@code #uninstall}.<p>
     *
     * In some Mac Java environments the popup factory throws
     * a NullPointerException when we call {@code #getPopup}.<p>
     *
     * The Mac case shows that we may have problems replacing
     * non PopupFactory instances. Therefore, we should consider
     * replacing only instances of PopupFactory.
     *
     * @see #uninstall()
     */
    public static void install() {
        
        if (SystemUtils.IS_OS_MAC) {
            return;
        }

        var factory = PopupFactory.getSharedInstance();
        
        if (factory instanceof ShadowPopupFactory) {
            return;
        }

        PopupFactory.setSharedInstance(new ShadowPopupFactory(factory));
    }

    /**
     * Uninstalls the ShadowPopupFactory and restores the original
     * popup factory as the new shared popup factory.
     *
     * @see #install()
     */
    public static void uninstall() {
        
        var factory = PopupFactory.getSharedInstance();
        
        if (!(factory instanceof ShadowPopupFactory)) {
            return;
        }

        PopupFactory stored = ((ShadowPopupFactory) factory).storedFactory;
        PopupFactory.setSharedInstance(stored);
    }

    /**
     * Creates a {@code Popup} for the Component {@code owner}
     * containing the Component {@code contents}. In addition to
     * the superclass behavior, we try to return a Popup that has a drop shadow,
     * if popup drop shadows are active - as returned by
     * {@code Options#isPopupDropShadowActive}.<p>
     *
     * {@code owner} is used to determine which {@code Window} the new
     * {@code Popup} will parent the {@code Component} the
     * {@code Popup} creates to. A null {@code owner} implies there
     * is no valid parent. {@code x} and
     * {@code y} specify the preferred initial location to place
     * the {@code Popup} at. Based on screen size, or other parameters,
     * the {@code Popup} may not display at {@code x} and
     * {@code y}.<p>
     *
     * We invoke the super {@code #getPopup}, not the one in the
     * stored factory, because the popup type is set in this instance,
     * not in the stored one.
     *
     * @param owner    Component mouse coordinates are relative to, may be null
     * @param contents Contents of the Popup
     * @param x        Initial x screen coordinate
     * @param y        Initial y screen coordinate
     * @return Popup containing Contents
     * //@ throws IllegalArgumentException if contents is null
     *
     * //@ see Options#isPopupDropShadowActive()
     */
    @Override
    public Popup getPopup(Component owner, Component contents, int x, int y) {
        
        var popup = super.getPopup(owner, contents, x, y);
        
        return ShadowPopup.getInstance(owner, contents, x, y, popup);
    }
}








Active mutators

CONDITIONALS_BOUNDARY
EMPTY_RETURNS
FALSE_RETURNS
INCREMENTS
INVERT_NEGS
MATH
NEGATE_CONDITIONALS
NULL_RETURNS
PRIMITIVE_RETURNS
TRUE_RETURNS
VOID_METHOD_CALLS

Tests examined

Report generated by PIT 1.16.1

1		package com.jsql.view.swing.shadow;
2
3		/*
4		* Copyright (c) 2005-2013 JGoodies Software GmbH. All Rights Reserved.
5		*
6		* Redistribution and use in source and binary forms, with or without
7		* modification, are permitted provided that the following conditions are met:
8		*
9		* o Redistributions of source code must retain the above copyright notice,
10		* this list of conditions and the following disclaimer.
11		*
12		* o Redistributions in binary form must reproduce the above copyright notice,
13		* this list of conditions and the following disclaimer in the documentation
14		* and/or other materials provided with the distribution.
15		*
16		* o Neither the name of JGoodies Software GmbH nor the names of
17		* its contributors may be used to endorse or promote products derived
18		* from this software without specific prior written permission.
19		*
20		* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
21		* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
22		* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
23		* A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
24		* HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
25		* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
26		* LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
27		* DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
28		* THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
29		* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
30		* OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
31		*/
32
33		import org.apache.commons.lang3.SystemUtils;
34
35		import javax.swing.*;
36		import java.awt.*;
37
38		/**
39		* The JGoodies Looks implementation of {@code PopupFactory}.
40		* Adds a drop shadow border to all popups except ComboBox popups.
41		* It is installed by the JGoodies Plastic L&F, as well as by
42		* the JGoodies Windows L&F during the Look&Feel initialization,
43		* see {link com.jgoodies.looks.plastic.PlasticLookAndFeel#initialize} and
44		* {link com.jgoodies.looks.windows.WindowsLookAndFeel#initialize}.<p>
45		*
46		* This factory shall not be used on platforms that provide native drop shadows,
47		* such as the Mac OS X. Therefore the invocation of the {@link #install()}
48		* method will have no effect on such platforms.<p>
49		*
50		* <strong>Note:</strong> To be used in a sandbox environment, this PopupFactory
51		* requires two AWT permissions: {@code createRobot} and
52		* {@code readDisplayPixels}. The reason for it is, that in the case of
53		* the heavy weight popups this PopupFactory uses a Robot to snapshot
54		* the screen background to simulate the drop shadow effect.
55		*
56		* @author Karsten Lentzsch
57		* @version $Revision: 1.8 $
58		*
59		* @see java.awt.AWTPermission
60		* @see java.awt.Robot
61		* @see javax.swing.Popup
62		* @see javax.swing.LookAndFeel#initialize
63		* @see javax.swing.LookAndFeel#uninitialize
64		*/
65		public final class ShadowPopupFactory extends PopupFactory {
66
67		/**
68		* In the case of heavy weight popups, snapshots of the screen background
69		* will be stored as client properties of the popup contents' parent.
70		* These snapshots will be used by the popup border to simulate the drop
71		* shadow effect. The two following constants define the names of
72		* these client properties.
73		*
74		* see com.jgoodies.looks.common.ShadowPopupBorder
75		*/
76		public static final String PROP_HORIZONTAL_BACKGROUND = "jgoodies.hShadowBg";
77		public static final String PROP_VERTICAL_BACKGROUND = "jgoodies.vShadowBg";
78
79		/**
80		* The PopupFactory used before this PopupFactory has been installed
81		* in {@code #install}. Used to restore the original state
82		* in {@code #uninstall}.
83		*/
84		private final PopupFactory storedFactory;
85
86
87		// Instance Creation ******************************************************
88
89		private ShadowPopupFactory(PopupFactory storedFactory) {
90		this.storedFactory = storedFactory;
91		}
92
93
94		// API ********************************************************************
95
96		/**
97		* Installs the ShadowPopupFactory as the shared popup factory
98		* on non-Mac platforms. Also stores the previously set factory,
99		* so that it can be restored in {@code #uninstall}.<p>
100		*
101		* In some Mac Java environments the popup factory throws
102		* a NullPointerException when we call {@code #getPopup}.<p>
103		*
104		* The Mac case shows that we may have problems replacing
105		* non PopupFactory instances. Therefore, we should consider
106		* replacing only instances of PopupFactory.
107		*
108		* @see #uninstall()
109		*/
110		public static void install() {
111
112	1 1. install : negated conditional → NO_COVERAGE	if (SystemUtils.IS_OS_MAC) {
113		return;
114		}
115
116		var factory = PopupFactory.getSharedInstance();
117
118	1 1. install : negated conditional → NO_COVERAGE	if (factory instanceof ShadowPopupFactory) {
119		return;
120		}
121
122	1 1. install : removed call to javax/swing/PopupFactory::setSharedInstance → NO_COVERAGE	PopupFactory.setSharedInstance(new ShadowPopupFactory(factory));
123		}
124
125		/**
126		* Uninstalls the ShadowPopupFactory and restores the original
127		* popup factory as the new shared popup factory.
128		*
129		* @see #install()
130		*/
131		public static void uninstall() {
132
133		var factory = PopupFactory.getSharedInstance();
134
135	1 1. uninstall : negated conditional → NO_COVERAGE	if (!(factory instanceof ShadowPopupFactory)) {
136		return;
137		}
138
139		PopupFactory stored = ((ShadowPopupFactory) factory).storedFactory;
140	1 1. uninstall : removed call to javax/swing/PopupFactory::setSharedInstance → NO_COVERAGE	PopupFactory.setSharedInstance(stored);
141		}
142
143		/**
144		* Creates a {@code Popup} for the Component {@code owner}
145		* containing the Component {@code contents}. In addition to
146		* the superclass behavior, we try to return a Popup that has a drop shadow,
147		* if popup drop shadows are active - as returned by
148		* {@code Options#isPopupDropShadowActive}.<p>
149		*
150		* {@code owner} is used to determine which {@code Window} the new
151		* {@code Popup} will parent the {@code Component} the
152		* {@code Popup} creates to. A null {@code owner} implies there
153		* is no valid parent. {@code x} and
154		* {@code y} specify the preferred initial location to place
155		* the {@code Popup} at. Based on screen size, or other parameters,
156		* the {@code Popup} may not display at {@code x} and
157		* {@code y}.<p>
158		*
159		* We invoke the super {@code #getPopup}, not the one in the
160		* stored factory, because the popup type is set in this instance,
161		* not in the stored one.
162		*
163		* @param owner Component mouse coordinates are relative to, may be null
164		* @param contents Contents of the Popup
165		* @param x Initial x screen coordinate
166		* @param y Initial y screen coordinate
167		* @return Popup containing Contents
168		* //@ throws IllegalArgumentException if contents is null
169		*
170		* //@ see Options#isPopupDropShadowActive()
171		*/
172		@Override
173		public Popup getPopup(Component owner, Component contents, int x, int y) {
174
175		var popup = super.getPopup(owner, contents, x, y);
176
177	1 1. getPopup : replaced return value with null for com/jsql/view/swing/shadow/ShadowPopupFactory::getPopup → NO_COVERAGE	return ShadowPopup.getInstance(owner, contents, x, y, popup);
178		}
179		}
		Mutations
112		1.1 Location : install Killed by : none negated conditional → NO_COVERAGE
118		1.1 Location : install Killed by : none negated conditional → NO_COVERAGE
122		1.1 Location : install Killed by : none removed call to javax/swing/PopupFactory::setSharedInstance → NO_COVERAGE
135		1.1 Location : uninstall Killed by : none negated conditional → NO_COVERAGE
140		1.1 Location : uninstall Killed by : none removed call to javax/swing/PopupFactory::setSharedInstance → NO_COVERAGE
177		1.1 Location : getPopup Killed by : none replaced return value with null for com/jsql/view/swing/shadow/ShadowPopupFactory::getPopup → NO_COVERAGE

ShadowPopupFactory.java

Mutations

Active mutators

Tests examined