com.alee.painter.decoration.background.GradientBackground Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of weblaf-ui Show documentation
WebLaf is a Java Swing Look and Feel and extended components library for cross-platform applications
There is a newer version: 2.2.1
/*
 * This file is part of WebLookAndFeel library.
 *
 * WebLookAndFeel library 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.
 *
 * WebLookAndFeel library 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 WebLookAndFeel library.  If not, see .
 */

package com.alee.painter.decoration.background;

import com.alee.painter.decoration.DecorationUtils;
import com.alee.painter.decoration.IDecoration;
import com.alee.utils.CollectionUtils;
import com.alee.utils.GraphicsUtils;
import com.thoughtworks.xstream.annotations.XStreamAlias;
import com.thoughtworks.xstream.annotations.XStreamAsAttribute;
import com.thoughtworks.xstream.annotations.XStreamImplicit;

import javax.swing.*;
import java.awt.*;
import java.awt.geom.Point2D;
import java.util.List;

/**
 * Gradient background.
 * Fills component shape with a gradient using multiple colors.
 *
 * @param  component type
 * @param  decoration type
 * @param  background type
 * @author Mikle Garin
 */

@XStreamAlias ( "GradientBackground" )
public class GradientBackground, I extends GradientBackground>
        extends AbstractBackground
{
    /**
     * Gradient type.
     * {@link com.alee.painter.decoration.background.GradientType#linear} is used if it is not specified.
     */
    @XStreamAsAttribute
    protected GradientType type;

    /**
     * Bounds width/height percentage representing gradient start point.
     * Point [0,0] is used by default if this value is not specified.
     */
    @XStreamAsAttribute
    protected Point2D.Float from;

    /**
     * Bounds width/height percentage representing gradient end point.
     * Point [0,1] is used by default if this value is not specified.
     */
    @XStreamAsAttribute
    protected Point2D.Float to;

    /**
     * Gradient colors.
     * Must always be provided to properly render separator.
     */
    @XStreamImplicit ( itemFieldName = "color" )
    protected List colors;

    /**
     * Returns gradient type.
     *
     * @return gradient type
     */
    public GradientType getType ()
    {
        return type != null ? type : GradientType.linear;
    }

    /**
     * Returns bounds width/height percentage representing gradient start point.
     *
     * @return bounds width/height percentage representing gradient start point
     */
    public Point2D.Float getFrom ()
    {
        return from != null ? from : new Point2D.Float ( 0, 0 );
    }

    /**
     * Returns bounds width/height percentage representing gradient end point.
     *
     * @return bounds width/height percentage representing gradient end point
     */
    public Point2D.Float getTo ()
    {
        return to != null ? to : new Point2D.Float ( 0, 1 );
    }

    @Override
    public void paint ( final Graphics2D g2d, final Rectangle bounds, final E c, final D d, final Shape shape )
    {
        final float opacity = getOpacity ();
        if ( opacity > 0 )
        {
            final Composite oc = GraphicsUtils.setupAlphaComposite ( g2d, opacity, opacity < 1f );
            final Rectangle b = shape.getBounds ();
            final Point2D.Float from = getFrom ();
            final Point2D.Float to = getTo ();
            final int x1 = ( int ) Math.round ( b.x + b.width * from.getX () );
            final int y1 = ( int ) Math.round ( b.y + b.height * from.getY () );
            final int x2 = ( int ) Math.round ( b.x + b.width * to.getX () );
            final int y2 = ( int ) Math.round ( b.y + b.height * to.getY () );
            final Paint paint = DecorationUtils.getPaint ( getType (), colors, x1, y1, x2, y2 );
            final Paint op = GraphicsUtils.setupPaint ( g2d, paint );
            g2d.fill ( shape );
            GraphicsUtils.restorePaint ( g2d, op );
            GraphicsUtils.restoreComposite ( g2d, oc, opacity < 1f );
        }
    }

    @Override
    public I merge ( final I background )
    {
        super.merge ( background );
        if ( background.type != null )
        {
            type = background.type;
        }
        if ( background.from != null )
        {
            from = background.from;
        }
        if ( background.to != null )
        {
            to = background.to;
        }
        if ( background.colors != null )
        {
            colors = CollectionUtils.copy ( background.colors );
        }
        return ( I ) this;
    }
}