com.alee.painter.decoration.AbstractDecoration 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;

import com.alee.api.annotations.NotNull;
import com.alee.api.annotations.Nullable;
import com.alee.api.merge.behavior.OverwriteOnMerge;
import com.alee.managers.style.Bounds;
import com.alee.utils.CollectionUtils;
import com.alee.utils.ReflectUtils;
import com.alee.utils.TextUtils;
import com.alee.utils.swing.CursorType;
import com.alee.utils.xml.ListToStringConverter;
import com.thoughtworks.xstream.annotations.XStreamAsAttribute;
import com.thoughtworks.xstream.annotations.XStreamConverter;

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

/**
 * Abstract component state decoration providing basic settings.
 *
 * @param  component type
 * @param  decoration type
 * @author Mikle Garin
 */
public abstract class AbstractDecoration> implements IDecoration
{
    /**
     * Default component state ID.
     * Added to avoid default state ID being null.
     */
    public static final String defaultStateId = "default";

    /**
     * Component states this decoration is describing separated by comma.
     * Various components might use multiple states to describe their decoration.
     */
    @XStreamAsAttribute
    @XStreamConverter ( ListToStringConverter.class )
    @OverwriteOnMerge
    protected List states;

    /**
     * Whether or not this decoration should overwrite another one when merged.
     */
    @XStreamAsAttribute
    protected Boolean overwrite;

    /**
     * Whether or not decoration should be displayed.
     * This doesn't affect anything painted outside, for example by any {@link com.alee.painter.SpecificPainter}.
     * In case this decoration is used by {@link com.alee.painter.SectionPainter} this only affects section visibility.
     */
    @XStreamAsAttribute
    protected Boolean visible;

    /**
     * Decoration size.
     * It can be specified to provide fixed decoration size.
     */
    @XStreamAsAttribute
    protected Dimension size;

    /**
     * Decoration opacity.
     * This doesn't affect anything painted outside, for example by any {@link com.alee.painter.SpecificPainter}.
     * In case this decoration is used by {@link com.alee.painter.SectionPainter} this opacity is only applied to the section.
     */
    @XStreamAsAttribute
    protected Float opacity;

    /**
     * Custom component cursor for this decoration state.
     */
    @XStreamAsAttribute
    protected CursorType cursor;

    /**
     * Whether or not this decoration is applied only to a section of the component.
     * Provided explicitely by the painted using this decoration.
     */
    protected transient Boolean section;

    /**
     * Previously set cursor.
     * Saved to avoid default component cursor removal.
     */
    protected transient Cursor previousCursor;

    @Nullable
    @Override
    public String getId ()
    {
        return states != null ? TextUtils.listToString ( states, STATES_SEPARATOR ) : defaultStateId;
    }

    @Override
    public void activate ( final C c )
    {
        final Cursor customCursor = getCursor ();
        if ( customCursor != null )
        {
            previousCursor = c.getCursor ();
            c.setCursor ( customCursor );
        }
    }

    @Override
    public void deactivate ( final C c )
    {
        final Cursor customCursor = getCursor ();
        if ( customCursor != null )
        {
            c.setCursor ( previousCursor );
            previousCursor = null;
        }
    }

    @Override
    public List getStates ()
    {
        return states;
    }

    @Override
    public boolean usesState ( final String state )
    {
        // Possible enhancement: Add negation syntax usage [ #387 ]
        return states != null && states.contains ( state );
    }

    @Override
    public boolean isApplicableTo ( @NotNull final List states )
    {
        boolean applicable = true;
        if ( !CollectionUtils.isEmpty ( this.states ) )
        {
            if ( CollectionUtils.isEmpty ( states ) )
            {
                applicable = false;
            }
            else
            {
                for ( final String state : this.states )
                {
                    if ( !states.contains ( state ) )
                    {
                        applicable = false;
                        break;
                    }
                }
            }
        }
        return applicable;
    }

    @Override
    public boolean isOverwrite ()
    {
        return overwrite != null && overwrite;
    }

    @Override
    public boolean isVisible ()
    {
        return visible == null || visible;
    }

    @Override
    public boolean isSection ()
    {
        return section != null && section;
    }

    @Override
    public void setSection ( final boolean section )
    {
        this.section = section;
    }

    /**
     * Returns decoration opacity.
     *
     * @return decoration opacity
     */
    public float getOpacity ()
    {
        return opacity != null ? opacity : 1f;
    }

    /**
     * Returns custom component cursor for this decoration state or {@code null} if none provided.
     *
     * @return custom component cursor for this decoration state or {@code null} if none provided
     */
    public Cursor getCursor ()
    {
        return cursor != null ? cursor.getCursor () : null;
    }

    @Override
    public Insets getBorderInsets ( final C c )
    {
        return new Insets ( 0, 0, 0, 0 );
    }

    @Override
    public boolean contains ( final C c, final Bounds bounds, final int x, final int y )
    {
        return bounds.get ().contains ( x, y );
    }

    @Override
    public int getBaseline ( final C c, final Bounds bounds )
    {
        return -1;
    }

    @Override
    public Component.BaselineResizeBehavior getBaselineResizeBehavior ( final C c )
    {
        return Component.BaselineResizeBehavior.OTHER;
    }

    @Override
    public Dimension getPreferredSize ( final C c )
    {
        return size;
    }

    @Override
    public String toString ()
    {
        return ReflectUtils.getClassName ( this ) + " [ id=" + getId () + "; visible=" + isVisible () + " ]";
    }
}