com.alee.painter.decoration.background.PresetTextureBackground 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 UI components

There is a newer version: 1.2.14

/*
 * 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.api.annotations.NotNull;
import com.alee.api.annotations.Nullable;
import com.alee.painter.decoration.DecorationException;
import com.alee.painter.decoration.IDecoration;
import com.thoughtworks.xstream.annotations.XStreamAlias;
import com.thoughtworks.xstream.annotations.XStreamAsAttribute;

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

/**
 * Preset texure background.
 * Fills component shape with a texture based on the specified {@link #preset}.
 *
 * @param  component type
 * @param  decoration type
 * @param  background type
 * @author Mikle Garin
 * @see AbstractImageTextureBackground
 */
@XStreamAlias ( "PresetTextureBackground" )
public class PresetTextureBackground, I extends PresetTextureBackground>
        extends AbstractImageTextureBackground
{
    /**
     * Preset {@link TextureType}.
     */
    @Nullable
    @XStreamAsAttribute
    protected TextureType preset;

    /**
     * Returns preset {@link TextureType}.
     *
     * @param c {@link JComponent} that is being painted
     * @param d {@link IDecoration} state
     * @return preset {@link TextureType}
     */
    @NotNull
    protected TextureType getPreset ( @NotNull final C c, @NotNull final D d )
    {
        if ( preset == null || preset == TextureType.none )
        {
            throw new DecorationException ( "Texture preset must be specified" );
        }
        return preset;
    }

    @NotNull
    @Override
    protected BufferedImage createTextureImage ( @NotNull final C c, @NotNull final D d )
    {
        return getPreset ( c, d ).getTexture ();
    }
}