com.alee.painter.decoration.shape

Interface IShape<E extends javax.swing.JComponent,D extends IDecoration<E,D>,I extends IShape<E,D,I>>

Type Parameters:

E - component type

D - decoration type

I - shape type

All Superinterfaces:

java.lang.Cloneable, com.alee.api.Identifiable, com.alee.api.Mergeable<I>, java.io.Serializable

All Known Implementing Classes:

AbstractShape, ArrowShape, EllipseShape, WebShape

public interface IShape<E extends javax.swing.JComponent,D extends IDecoration<E,D>,I extends IShape<E,D,I>>
extends java.io.Serializable, java.lang.Cloneable, com.alee.api.Mergeable<I>, com.alee.api.Identifiable

Customizable component shape interface.

Method Summary

Modifier and Type	Method and Description
java.awt.Insets	getBorderInsets(E c, D d) Returns shape borders size.
java.awt.Shape	getShape(ShapeType type, java.awt.Rectangle bounds, E c, D d) Returns shape provided for shade painting.
java.lang.Object[]	getShapeSettings(java.awt.Rectangle bounds, E c, D d) Returns exclusive shape settings used to cache the shape itself.
StretchInfo	getStretchInfo(java.awt.Rectangle bounds, E c, D d) Returns shape stretch information.
boolean	isVisible(ShapeType type, E c, D d) Returns whether shape is visible within component bounds.

Methods inherited from interface com.alee.api.Mergeable

merge

Methods inherited from interface com.alee.api.Identifiable

getId

Method Detail

getBorderInsets

java.awt.Insets getBorderInsets(E c,
                                D d)

Returns shape borders size.

Parameters:

c - painted component

d - painted decoration state

Returns:

shape borders size

isVisible

boolean isVisible(ShapeType type,
                  E c,
                  D d)

Returns whether shape is visible within component bounds. This method is required to optimize painting operations.

Parameters:

type - checked shape type

c - painted component

d - painted decoration state

Returns:

true if shape is visible within component bounds, false otherwise

getShape

java.awt.Shape getShape(ShapeType type,
                        java.awt.Rectangle bounds,
                        E c,
                        D d)

Returns shape provided for shade painting. It is usually similar to background shape but slightly larger.

Parameters:

type - requested shape type

bounds - painting bounds

c - painted component

d - painted decoration state

Returns:

component shape of the specified type

getShapeSettings

java.lang.Object[] getShapeSettings(java.awt.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.

Parameters:

bounds - painting bounds

c - painted component

d - painted decoration state

Returns:

shape settings used to cache the shape itself

getStretchInfo

StretchInfo getStretchInfo(java.awt.Rectangle bounds,
                           E c,
                           D d)

Returns shape stretch information. If this method returns something that is not 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.

Parameters:

bounds - painting bounds

c - painted component

d - painted decoration state

Returns:

shape stretch information