org.pushingpixels.substance.api.painter.overlay.TopShadowOverlayPainter Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of radiance-substance Show documentation
Substance look-and-feel
There is a newer version: 4.5.0
/*
 * Copyright (c) 2005-2019 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.substance.api.painter.overlay;

import org.pushingpixels.substance.api.SubstanceSkin;
import org.pushingpixels.substance.api.SubstanceSlices.DecorationAreaType;
import org.pushingpixels.substance.internal.utils.SubstanceColorUtilities;
import org.pushingpixels.substance.internal.utils.SubstanceCoreUtilities;

import javax.swing.*;
import java.awt.*;
import java.util.HashMap;
import java.util.Map;

/**
 * Overlay painter that paints a few pixel-high drop shadow at the top edge of
 * the relevant decoration area. This class is part of officially supported API.
 *
 * @author Kirill Grouchnikov
 */
public final class TopShadowOverlayPainter implements SubstanceOverlayPainter {
    /**
     * Singleton instance.
     */
    private static Map MAP = new HashMap<>();

    private static final int DEFAULT_SHADOW_START_ALPHA = 160;
    private static final int MIN_SHADOW_START_ALPHA = 32;

    private int startAlpha = DEFAULT_SHADOW_START_ALPHA;

    /**
     * Returns the single instance of this class.
     *
     * @return Single instance of this class.
     */
    @Deprecated
    public synchronized static TopShadowOverlayPainter getInstance() {
        return getInstance(100);
    }

    /**
     * Returns an instance of top shadow overlay painter with the requested strength.
     *
     * @param strength Drop shadow strength. Must be in [0..100] range.
     * @return Top shadow overlay painter with the requested strength.
     */
    public synchronized static TopShadowOverlayPainter getInstance(int strength) {
        if ((strength < 0) || (strength > 100)) {
            throw new IllegalArgumentException("Strength must be in [0..100] range");
        }
        if (!MAP.containsKey(strength)) {
            TopShadowOverlayPainter painter = new TopShadowOverlayPainter();
            painter.startAlpha = MIN_SHADOW_START_ALPHA +
                    (DEFAULT_SHADOW_START_ALPHA - MIN_SHADOW_START_ALPHA) * strength / 100;
            MAP.put(strength, painter);
        }
        return MAP.get(strength);
    }

    /**
     * Private constructor to enforce that {@link #getInstance(int)} is the only
     * way an application can get an instance of this class.
     */
    private TopShadowOverlayPainter() {
    }

    @Override
    public void paintOverlay(Graphics2D graphics, Component comp,
            DecorationAreaType decorationAreaType, int width, int height,
            SubstanceSkin skin) {
        Color shadowColor = SubstanceColorUtilities.deriveByBrightness(
                SubstanceColorUtilities.getBackgroundFillColor(comp), -0.4f);

        // need to handle components "embedded" in other components
        Component topMostWithSameDecorationAreaType = SubstanceCoreUtilities
                .getTopMostParentWithDecorationAreaType(comp, decorationAreaType);
        Point inTopMost = SwingUtilities.convertPoint(comp, new Point(0, 0),
                topMostWithSameDecorationAreaType);
        int dy = inTopMost.y;

        Graphics2D g2d = (Graphics2D) graphics.create();
        g2d.translate(0, -dy);
        g2d.setPaint(new GradientPaint(
                0, 0, SubstanceColorUtilities.getAlphaColor(shadowColor, this.startAlpha),
                0, 4, SubstanceColorUtilities.getAlphaColor(shadowColor, 16)));
        g2d.fillRect(0, 0, comp.getWidth(), 4);
        g2d.dispose();
    }

    @Override
    public String getDisplayName() {
        return "Top Shadow";
    }

}