com.alee.managers.style.data.PainterStyle Maven / Gradle / Ivy

Go to download
/*
 * 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.managers.style.data;

import com.alee.utils.MergeUtils;
import com.thoughtworks.xstream.annotations.XStreamConverter;

import java.io.Serializable;
import java.util.Map;

/**
 * Painter style information class.
 *
 * @author Mikle Garin
 * @see How to use StyleManager
 * @see com.alee.managers.style.StyleManager
 */

@XStreamConverter ( PainterStyleConverter.class )
public final class PainterStyle implements Serializable, Cloneable
{
    /**
     * Painter ID.
     * Refers to painter type.
     * It is required since a lot of components has more than just one painter.
     */
    private String id;

    /**
     * Whether this is base component painter or not.
     */
    private boolean base;

    /**
     * Painter class canonical name.
     * Used for painter instantiation.
     */
    private String painterClass;

    /**
     * Painter properties.
     * Contains parsed painter settings.
     */
    private Map properties;

    /**
     * Constructs new painter style information.
     */
    public PainterStyle ()
    {
        super ();
    }

    /**
     * Returns painter ID.
     *
     * @return painter ID
     */
    public String getId ()
    {
        return id;
    }

    /**
     * Sets painter ID.
     *
     * @param id new painter ID
     */
    public void setId ( final String id )
    {
        this.id = id;
    }

    /**
     * Returns whether this is base component painter or not.
     *
     * @return true if this is base component painter, false otherwise
     */
    public boolean isBase ()
    {
        return base;
    }

    /**
     * Sets whether this is base component painter or not.
     *
     * @param base whether this is base component painter or not
     */
    public void setBase ( final boolean base )
    {
        this.base = base;
    }

    /**
     * Returns painter class canonical name.
     *
     * @return painter class canonical name
     */
    public String getPainterClass ()
    {
        return painterClass;
    }

    /**
     * Sets painter class canonical name.
     *
     * @param painterClass new painter class canonical name
     */
    public void setPainterClass ( final String painterClass )
    {
        this.painterClass = painterClass;
    }

    /**
     * Returns painter properties.
     *
     * @return painter properties
     */
    public Map getProperties ()
    {
        return properties;
    }

    /**
     * Sets painter properties.
     *
     * @param properties new painter properties
     */
    public void setProperties ( final Map properties )
    {
        this.properties = properties;
    }

    /**
     * Returns cloned instance of this painter style.
     *
     * @return cloned instance of this painter style
     */
    @Override
    public PainterStyle clone ()
    {
        return MergeUtils.cloneByFieldsSafely ( this );
    }
}