com.alee.painter.decoration.IDecoration Maven / Gradle / Ivy

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;

import com.alee.api.Identifiable;
import com.alee.api.Mergeable;
import com.alee.managers.style.PainterShapeProvider;

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

/**
 * Base interface for component state decorations.
 *
 * @param  component type
 * @param  decoration type
 * @author Mikle Garin
 */

public interface IDecoration>
        extends Serializable, Cloneable, Mergeable, Identifiable, PainterShapeProvider
{
    /**
     * States separator.
     */
    public static final String STATES_SEPARATOR = ",";

    /**
     * Returns component states this decoration is describing.
     *
     * @return component states this decoration is describing
     */
    public List getStates ();

    /**
     * Returns whether or not this decoration state provides any visible decoration.
     *
     * @return true if this decoration state provides any visible decoration, false otherwise
     */
    public boolean isVisible ();

    /**
     * Returns whether or not this decoration is applied only to a section of the component.
     *
     * @return true if this decoration is applied only to a section of the component, false otherwise
     */
    public boolean isSection ();

    /**
     * Sets whether or not this decoration is applied only to a section of the component.
     *
     * @param section whether or not this decoration is applied only to a section of the component
     */
    public void setSection ( boolean section );

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

    /**
     * Paints component decoration.
     *
     * @param g2d    graphics context
     * @param bounds painting bounds
     * @param c      painted component
     */
    public void paint ( Graphics2D g2d, Rectangle bounds, E c );

    /**
     * Returns decoration preferred size.
     * It is taken into account when decoration preferred size is being calculated.
     *
     * @return decoration preferred size
     */
    public Dimension getPreferredSize ();
}