com.alee.extended.canvas.WebCanvas 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
The newest version!
/*
 * 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.extended.canvas;

import com.alee.extended.WebComponent;
import com.alee.managers.style.StyleId;
import com.alee.managers.style.StyleManager;
import com.alee.painter.decoration.AbstractDecorationPainter;
import com.alee.painter.decoration.Stateful;
import com.alee.utils.ArrayUtils;
import com.alee.utils.CollectionUtils;

import java.util.ArrayList;
import java.util.Collection;
import java.util.List;

/**
 * Simple canvas implementation.
 * Unlike {@link java.awt.Canvas} it is based on {@link javax.swing.JComponent} and supports customizable UI and painter.
 *
 * Component itself doesn't contain any customizable data so any custom painter can be easily provided for it.
 * It exists to prevent creation of multiple helper components for various small UI elements performing simple tasks.
 *
 * This component should never be used with a non-Web UIs as it might cause an unexpected behavior.
 * You could still use that component even if WebLaF is not your application LaF as this component will use Web-UI in any case.
 *
 * @author Mikle Garin
 * @see CanvasDescriptor
 * @see WCanvasUI
 * @see WebCanvasUI
 * @see ICanvasPainter
 * @see CanvasPainter
 * @see WebComponent
 */
public class WebCanvas extends WebComponent implements Stateful
{
    /**
     * Custom {@link WebCanvas} states.
     */
    protected List states;

    /**
     * Constructs new {@link WebCanvas}.
     */
    public WebCanvas ()
    {
        this ( StyleId.auto );
    }

    /**
     * Constructs new {@link WebCanvas}.
     *
     * @param states custom {@link WebCanvas} states
     */
    public WebCanvas ( final String... states )
    {
        this ( StyleId.auto, states );
    }

    /**
     * Constructs new {@link WebCanvas}.
     *
     * @param id     style ID
     * @param states custom {@link WebCanvas} states
     */
    public WebCanvas ( final StyleId id, final String... states )
    {
        super ();
        this.states = new ArrayList ( 1 );
        addStates ( states );
        updateUI ();
        setStyleId ( id );
    }

    @Override
    public StyleId getDefaultStyleId ()
    {
        return StyleId.canvas;
    }

    /**
     * Returns custom {@link WebCanvas} states.
     *
     * @return custom {@link WebCanvas} states
     */
    @Override
    public List getStates ()
    {
        return new ArrayList ( states );
    }

    /**
     * Sets custom {@link WebCanvas} states.
     *
     * @param states custom {@link WebCanvas} states
     */
    public void setStates ( final List states )
    {
        if ( !CollectionUtils.equals ( this.states, states, false ) )
        {
            final List old = CollectionUtils.copy ( this.states );
            this.states = states;
            fireStatesChanged ( old, this.states );
        }
    }

    /**
     * Adds custom {@link WebCanvas} states.
     *
     * @param states custom {@link WebCanvas} states to add
     */
    public void addStates ( final String... states )
    {
        if ( ArrayUtils.notEmpty ( states ) )
        {
            final List old = CollectionUtils.copy ( this.states );
            CollectionUtils.addUniqueNonNull ( this.states, states );
            fireStatesChanged ( old, this.states );
        }
    }

    /**
     * Adds custom {@link WebCanvas} states.
     *
     * @param states custom {@link WebCanvas} states to add
     */
    public void addStates ( final Collection states )
    {
        if ( ArrayUtils.notEmpty ( states ) )
        {
            final List old = CollectionUtils.copy ( this.states );
            CollectionUtils.addUniqueNonNull ( this.states, states );
            fireStatesChanged ( old, this.states );
        }
    }

    /**
     * Removes custom {@link WebCanvas} states.
     *
     * @param states custom {@link WebCanvas} states to remove
     */
    public void removeStates ( final String... states )
    {
        if ( ArrayUtils.notEmpty ( states ) )
        {
            final List old = CollectionUtils.copy ( this.states );
            CollectionUtils.removeAll ( this.states, states );
            fireStatesChanged ( old, this.states );
        }
    }

    /**
     * Removes custom {@link WebCanvas} states.
     *
     * @param states custom {@link WebCanvas} states to remove
     */
    public void removeStates ( final Collection states )
    {
        if ( ArrayUtils.notEmpty ( states ) )
        {
            final List old = CollectionUtils.copy ( this.states );
            CollectionUtils.removeAll ( this.states, states );
            fireStatesChanged ( old, this.states );
        }
    }

    /**
     * Updates {@link WebCanvas} decoration states.
     *
     * @param oldStates previous custom {@link WebCanvas} states
     * @param newStates current custom {@link WebCanvas} states
     */
    public void fireStatesChanged ( final List oldStates, final List newStates )
    {
        firePropertyChange ( AbstractDecorationPainter.DECORATION_STATES_PROPERTY, oldStates, newStates );
    }

    /**
     * Returns the look and feel (LaF) object that renders this component.
     *
     * @return the {@link WCanvasUI} object that renders this component
     */
    public WCanvasUI getUI ()
    {
        return ( WCanvasUI ) ui;
    }

    /**
     * Sets the LaF object that renders this component.
     *
     * @param ui {@link WCanvasUI}
     */
    public void setUI ( final WCanvasUI ui )
    {
        super.setUI ( ui );
    }

    @Override
    public void updateUI ()
    {
        StyleManager.getDescriptor ( this ).updateUI ( this );
    }

    @Override
    public String getUIClassID ()
    {
        return StyleManager.getDescriptor ( this ).getUIClassId ();
    }
}