com.alee.painter.decoration.shape.IShape 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 is a Java Swing Look and Feel and extended components library for cross-platform applications
There is a newer version: 2.2.1
/*
 * 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.Identifiable;
import com.alee.api.Mergeable;
import com.alee.painter.decoration.IDecoration;

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

/**
 * Customizable component shape interface.
 *
 * @param  component type
 * @param  decoration type
 * @param  shape type
 * @author Mikle Garin
 */

public interface IShape, I extends IShape>
        extends Serializable, Cloneable, Mergeable, Identifiable
{
    /**
     * todo 1. Method `isGroupAvailable` to check whether or not this shape can be grouped
     */

    /**
     * Returns shape borders size.
     *
     * @param c painted component
     * @param d painted decoration state
     * @return shape borders size
     */
    public Insets getBorderInsets ( E c, D d );

    /**
     * Returns whether shape is visible within component bounds.
     * This method is required to optimize painting operations.
     *
     * @param type checked shape type
     * @param c    painted component
     * @param d    painted decoration state
     * @return true if shape is visible within component bounds, false otherwise
     */
    public boolean isVisible ( ShapeType type, E c, D d );

    /**
     * Returns shape provided for shade painting.
     * It is usually similar to background shape but slightly larger.
     *
     * @param type   requested shape type
     * @param bounds painting bounds
     * @param c      painted component
     * @param d      painted decoration state
     * @return component shape of the specified type
     */
    public Shape getShape ( ShapeType type, Rectangle bounds, E c, D d );

    /**
     * Returns exclusive shape settings used to cache the shape itself.
     * There is no need to return bounds provided while shape is generated or parameters from other decoration parts.
     * This information might be useful outside the shape to implement proper caching of data generated based on this shape.
     *
     * @param bounds painting bounds
     * @param c      painted component
     * @param d      painted decoration state
     * @return shape settings used to cache the shape itself
     */
    public Object[] getShapeSettings ( final Rectangle bounds, final E c, final D d );

    /**
     * Returns shape stretch information.
     * If this method returns something that is not {@code null} shape is stretchable horizontally and/or vertically.
     * That information might be extremely useful for painting optimization, but it is not necessary to implement this method.
     * 
     * As an example - WebLaF uses this information to optimize (reduce amount of) shade images generation.
     * Since generating even a small shade requires a good chunk of memory and processing time it is necessary.
     *
     * @param bounds painting bounds
     * @param c      painted component
     * @param d      painted decoration state
     * @return shape stretch information
     */
    public StretchInfo getStretchInfo ( Rectangle bounds, E c, D d );
}