com.alee.painter.decoration.IDecoration Maven / Gradle / Ivy
/*
* 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 component type
* @param decoration type
* @author Mikle Garin
*/
public interface IDecoration>
extends Identifiable, PainterShapeProvider, Overwriting, Cloneable, Serializable
{
/**
* States separator.
*/
public static final String STATES_SEPARATOR = ",";
/**
* Called upon decoration activation.
*
* @param c painted component
*/
public void activate ( C c );
/**
* Called upon decoration deactivation.
*
* @param c painted component
*/
public void deactivate ( C c );
/**
* Returns component states this decoration is describing.
*
* @return component states this decoration is describing
*/
public List getStates ();
/**
* Returns whether this decoration is associated with specified state.
*
* @param state decoration state
* @return true if this decoration is associated with specified state, false otherwise
*/
public boolean usesState ( String state );
/**
* Returns whether this decoration is applicable to the specified states.
*
* @param states decoration states
* @return true if this decoration is applicable to the specified states, false otherwise
*/
public boolean isApplicableTo ( List states );
/**
* Returns whether or not this decoration state provides any visible decoration parts.
* This method doesn't count content in, so even if content exists decoration might not be visible.
*
* @return true if this decoration state provides any visible decoration parts, 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 ( C c );
/**
* Returns whether or not decoration has its own content.
* todo This method is only useful until all content painting is moved inside the decorations
*
* @return true if decoration has its own content, false otherwise
*/
public boolean hasContent ();
/**
* Returns whether or not specified (x,y) location is contained within the shape of the component.
*
* @param c {@link JComponent}
* @param bounds bounds to check
* @param x X coordinate
* @param y Y coordinate
* @return {@code true} if specified (x,y) location is contained within the shape of the component, {@code false} otherwise
*/
public boolean contains ( C c, Bounds bounds, int x, int y );
/**
* Returns decoration baseline within the specified bounds, measured from the top of the bounds.
* A return value less than {@code 0} indicates this decoration does not have a reasonable baseline.
*
* @param c aligned {@link JComponent}
* @param bounds bounds to get the baseline for
* @return decoration baseline within the specified bounds, measured from the top of the bounds
*/
public int getBaseline ( C c, Bounds bounds );
/**
* Returns enum indicating how the baseline of the decoration changes as the size changes.
*
* @param c aligned component
* @return enum indicating how the baseline of the decoration changes as the size changes
*/
public Component.BaselineResizeBehavior getBaselineResizeBehavior ( C c );
/**
* Paints component decoration.
*
* @param g2d graphics context
* @param c painted component
* @param bounds painting bounds
*/
public void paint ( Graphics2D g2d, C c, Bounds bounds );
/**
* Returns decoration preferred size.
* It is taken into account when decoration preferred size is being calculated.
*
* @param c painted component
* @return decoration preferred size
*/
public Dimension getPreferredSize ( C c );
}