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

import com.alee.api.annotations.NotNull;
import com.alee.api.annotations.Nullable;
import com.alee.painter.decoration.IDecoration;
import com.thoughtworks.xstream.annotations.XStreamAsAttribute;

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

/**
 * Abstract shape providing some general method implementations.
 *
 * @param  component type
 * @param  decoration type
 * @param  shape type
 * @author Mikle Garin
 */
public abstract class AbstractShape, I extends AbstractShape>
        implements IShape
{
    /**
     * Shape ID.
     */
    @Nullable
    @XStreamAsAttribute
    protected String id;

    /**
     * Whether or not this shape should overwrite previous one when merged.
     */
    @Nullable
    @XStreamAsAttribute
    protected Boolean overwrite;

    @Nullable
    @Override
    public String getId ()
    {
        return id != null ? id : "shape";
    }

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

    @Override
    public void activate ( @NotNull final C c, @NotNull final D d )
    {
        /**
         * Do nothing by default.
         */
    }

    @Override
    public void deactivate ( @NotNull final C c, @NotNull final D d )
    {
        /**
         * Do nothing by default.
         */
    }

    @Override
    public boolean isVisible ( @NotNull final ShapeType type, @NotNull final Rectangle bounds, @NotNull final C c, @NotNull final D d )
    {
        return true;
    }

    @Nullable
    @Override
    public Object[] getShapeSettings ( @NotNull final Rectangle bounds, @NotNull final C c, @NotNull final D d )
    {
        return null;
    }

    @Nullable
    @Override
    public StretchInfo getStretchInfo ( @NotNull final Rectangle bounds, @NotNull final C c, @NotNull final D d )
    {
        return null;
    }
}