com.alee.painter.decoration.background.ImageTextureBackground 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.8
/*
 * 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.managers.icon.IconManager;
import com.alee.painter.decoration.DecorationException;
import com.alee.painter.decoration.IDecoration;
import com.alee.utils.ImageUtils;
import com.thoughtworks.xstream.annotations.XStreamAlias;
import com.thoughtworks.xstream.annotations.XStreamAsAttribute;

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

/**
 * Image texure background.
 * Fills component shape with a texture based on the specified {@link #iconId} of an {@link Icon} from {@link IconManager}.
 *
 * @param  component type
 * @param  decoration type
 * @param  background type
 * @author Mikle Garin
 * @see AbstractImageTextureBackground
 */
@XStreamAlias ( "ImageTextureBackground" )
public class ImageTextureBackground, I extends ImageTextureBackground>
        extends AbstractImageTextureBackground
{
    /**
     * Identifier of an {@link Icon} from {@link IconManager}.
     */
    @Nullable
    @XStreamAsAttribute
    protected String iconId;

    /**
     * Returns identifier of an {@link Icon} from {@link IconManager}.
     *
     * @param c {@link JComponent} that is being painted
     * @param d {@link IDecoration} state
     * @return identifier of an {@link Icon} from {@link IconManager}
     */
    @NotNull
    protected String getIconId ( @NotNull final C c, @NotNull final D d )
    {
        if ( iconId == null )
        {
            throw new DecorationException ( "Texture icon identifier must be specified" );
        }
        else if ( !IconManager.hasIcon ( iconId ) )
        {
            throw new DecorationException ( "Texture icon doesn't exist" );
        }
        return iconId;
    }

    @NotNull
    @Override
    protected BufferedImage createTextureImage ( @NotNull final C c, @NotNull final D d )
    {
        return ImageUtils.toNonNullBufferedImage ( IconManager.getIcon ( getIconId ( c, d ) ) );
    }
}