org.pushingpixels.radiance.theming.internal.painter.BackgroundPaintingUtils Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of swingset3-demos Show documentation
Demonstrating the abilities of the Swing UI Toolkit swingset2 and swingx aka swingset3
The newest version!
/*
 * Copyright (c) 2005-2021 Radiance Kirill Grouchnikov. 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 the copyright holder 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 OWNER 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.
 */
package org.pushingpixels.radiance.theming.internal.painter;

import org.pushingpixels.radiance.theming.api.RadianceThemingCortex;
import org.pushingpixels.radiance.theming.api.RadianceThemingSlices;
import org.pushingpixels.radiance.theming.api.RadianceSkin;
import org.pushingpixels.radiance.theming.internal.utils.RadianceColorUtilities;
import org.pushingpixels.radiance.theming.internal.utils.RadianceCoreUtilities;
import org.pushingpixels.radiance.theming.internal.utils.RadiancePopupContainer;
import org.pushingpixels.radiance.theming.internal.utils.WidgetUtilities;

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

/**
 * Delegate for painting filled backgrounds.
 *
 * @author Kirill Grouchnikov
 */
public class BackgroundPaintingUtils {
    /**
     * Updates the background of the specified component on the specified
     * graphic context. The background is updated only if the component is
     * opaque.
     *
     * @param g Graphic context.
     * @param c Component.
     */
    public static void updateIfOpaque(Graphics g, JComponent c) {
        if (RadianceCoreUtilities.isOpaque(c)) {
            update(g, c, false);
        }
    }

    /**
     * Updates the background of the specified component on the specified
     * graphic context. The background is not painted when the
     * force parameter is false and at least one of
     * the following conditions holds:
     * 
     * The component is in a cell renderer.
     * The component is not showing on the screen.
     * The component is in the preview mode.
     * 
     *
     * @param g     Graphic context.
     * @param c     Component.
     * @param force If true, the painting of background is enforced.
     */
    public static void update(Graphics g, JComponent c, boolean force) {
        // failsafe for LAF change
        if (!RadianceCoreUtilities.isCurrentLookAndFeel()) {
            return;
        }

        Graphics2D graphics = (Graphics2D) g.create();
        // optimization - do not call fillRect on graphics with anti-alias turned on
        graphics.setRenderingHint(RenderingHints.KEY_ANTIALIASING,
                RenderingHints.VALUE_ANTIALIAS_OFF);
        graphics.setComposite(WidgetUtilities.getAlphaComposite(c, g));

        RadianceThemingSlices.DecorationAreaType decorationType = RadianceThemingCortex.ComponentOrParentChainScope.getDecorationType(c);
        RadianceSkin skin = RadianceCoreUtilities.getSkin(c);
        boolean isShowing = c.isShowing();
        boolean showOverlays = true;
        if ((c.getParent() instanceof JPopupMenu) ||
				(c.getClass().isAnnotationPresent(RadiancePopupContainer.class))) {
            // Don't show any overlays on content in popup menus
            showOverlays = false;
        } else {
            if (c instanceof JMenuItem) {
                showOverlays = false;
                if (c instanceof JMenu) {
                    // Show overlays on top-level menu content
                    showOverlays = ((JMenu) c).isTopLevelMenu();
                }
            } else if (c instanceof JMenuBar) {
                // Show overlays on menu bar
                showOverlays = true;
            }
        }

        if (isShowing && (decorationType != RadianceThemingSlices.DecorationAreaType.NONE)
                && (skin.isRegisteredAsDecorationArea(decorationType))) {
            // use the decoration painter
            DecorationPainterUtils.paintDecorationBackground(graphics, c, force);
            if (showOverlays) {
                OverlayPainterUtils.paintOverlays(graphics, c, skin, decorationType);
			}
        } else {
            // fill the area with solid color
            Color backgr = RadianceColorUtilities
                    .getBackgroundFillColor(((c instanceof JTextComponent) || (c instanceof JSpinner))
                            ? c.getParent() : c);
            graphics.setColor(backgr);
            graphics.fillRect(0, 0, c.getWidth(), c.getHeight());

            if (isShowing) {
                if (showOverlays) {
                    // add overlays
                    OverlayPainterUtils.paintOverlays(graphics, c, skin, decorationType);
                }
            }
        }

        graphics.dispose();
    }

    /**
     * Updates the background of the specified component on the specified
     * graphic context in the specified rectangle.
     *
     * @param g         Graphic context.
     * @param c         Component.
     * @param fillColor Fill color.
     * @param rect      The rectangle to fill.
     */
    public static void fillBackground(Graphics g, JComponent c, Color fillColor, Rectangle rect) {
        // failsafe for LAF change
        if (!RadianceCoreUtilities.isCurrentLookAndFeel()) {
            return;
        }

        boolean isInCellRenderer = (SwingUtilities.getAncestorOfClass(
                CellRendererPane.class, c) != null);
        if ((!c.isShowing()) && (!isInCellRenderer)) {
            return;
        }

        Graphics2D graphics = (Graphics2D) g.create();
        graphics.setComposite(WidgetUtilities.getAlphaComposite(c, g));
        graphics.setColor(fillColor);
        graphics.fillRect(rect.x, rect.y, rect.width, rect.height);
        graphics.dispose();
    }
}