com.alee.managers.style.XmlSkin 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;

import com.alee.api.annotations.NotNull;
import com.alee.api.annotations.Nullable;
import com.alee.api.resource.Resource;
import com.alee.managers.icon.set.IconSet;
import com.alee.managers.style.data.ComponentStyle;
import com.alee.managers.style.data.SkinInfo;
import com.alee.utils.XmlUtils;

import javax.swing.*;
import java.util.List;

/**
 * This skin is used by StyleManager for cases when skin settings are stored within XML.
 * To use it simply specify XML location relative to your skin class or provide SkinInfo object.
 * All settings and painters will be loaded and applied by this skin automatically when it is used.
 *
 * @author Mikle Garin
 * @see How to use StyleManager
 * @see StyleManager
 * @see AbstractSkin
 * @see Skin
 * @see SkinInfo
 */
public class XmlSkin extends AbstractSkin
{
    /**
     * Complete information about this skin.
     */
    @NotNull
    protected final SkinInfo skinInfo;

    /**
     * Constructs new {@link XmlSkin}.
     *
     * @param resource extension {@link Resource}
     */
    public XmlSkin ( @NotNull final Resource resource )
    {
        this ( ( SkinInfo ) XmlUtils.fromXML ( resource ) );
    }

    /**
     * Constructs new xml-based skin.
     *
     * @param skinInfo skin information
     */
    public XmlSkin ( @NotNull final SkinInfo skinInfo )
    {
        this.skinInfo = skinInfo;
    }

    /**
     * Returns skin information.
     *
     * @return skin information
     */
    @NotNull
    public SkinInfo getSkinInfo ()
    {
        return skinInfo;
    }

    @NotNull
    @Override
    public String getId ()
    {
        return skinInfo.getId ();
    }

    @Nullable
    @Override
    public Icon getIcon ()
    {
        return skinInfo.getIcon ();
    }

    @Nullable
    @Override
    public String getTitle ()
    {
        return skinInfo.getTitle ();
    }

    @Nullable
    @Override
    public String getDescription ()
    {
        return skinInfo.getDescription ();
    }

    @Nullable
    @Override
    public String getAuthor ()
    {
        return skinInfo.getAuthor ();
    }

    @NotNull
    @Override
    public List getSupportedSystems ()
    {
        return skinInfo.getSupportedSystemsList ();
    }

    @NotNull
    @Override
    public String getSkinClass ()
    {
        return skinInfo.getSkinClass ();
    }

    @Override
    public void install ()
    {
        skinInfo.install ();
    }

    @Override
    public void uninstall ()
    {
        skinInfo.uninstall ();
    }

    @Override
    public boolean applyExtension ( @NotNull final SkinExtension extension )
    {
        return skinInfo.applyExtension ( extension );
    }

    @NotNull
    @Override
    public List getIconSets ()
    {
        return skinInfo.getIconSets ();
    }

    @Override
    public ComponentStyle getStyle ( @NotNull final JComponent component )
    {
        return skinInfo.getStyle ( component );
    }

    @NotNull
    @Override
    public String toString ()
    {
        return skinInfo.toString ();
    }
}