com.alee.painter.decoration.shadow

Class WebShadow<E extends javax.swing.JComponent,D extends WebDecoration<E,D>,I extends WebShadow<E,D,I>>

java.lang.Object

com.alee.painter.decoration.shadow.AbstractShadow<E,D,I>

com.alee.painter.decoration.shadow.WebShadow<E,D,I>

Type Parameters:

E - component type

D - decoration type

I - shadow type

All Implemented Interfaces:

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

public class WebShadow<E extends javax.swing.JComponent,D extends WebDecoration<E,D>,I extends WebShadow<E,D,I>>
extends AbstractShadow<E,D,I>

Basic shadow that can be painted on any shape. Shadow is generated through the ShadowFilter and saved into BufferedImage. Generated image with the shadow is usually kept in cache to optimize UI performance. One generated shadow sometimes might be reused by multiple components of different size. That happens only when IShape implementation this shadow is based on provides stretch areas. In that case NinePatchIcon is created based on the shadow image to stretch the shadow.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected static java.lang.String	separator Cache key data separator.
protected NinePatchIcon	shadowIcon Reference keeping shadow icon in memory.
protected static java.util.Map<java.lang.String,java.lang.ref.WeakReference<NinePatchIcon>>	shadowIconsCache Shadow icons cache.
protected java.awt.image.BufferedImage	shadowImage Reference keeping shadow image in memory.
protected static java.util.Map<java.lang.String,java.lang.ref.WeakReference<java.awt.image.BufferedImage>>	shadowImagesCache Shadow images cache.

Fields inherited from class com.alee.painter.decoration.shadow.AbstractShadow

color, opacity, type, width

Constructor Summary

Constructors

Constructor and Description
WebShadow()

Method Summary

Modifier and Type	Method and Description
static NinePatchIcon	createInnerShadeIcon(StretchInfo stretchInfo, java.awt.Rectangle bounds, int width, float opacity, java.awt.Color color, java.awt.Shape shape) Returns inner shadow nine-patch icon.
static java.awt.image.BufferedImage	createInnerShadeImage(java.awt.Rectangle bounds, int width, float opacity, java.awt.Color color, java.awt.Shape shape) Returns inner shadow image based on provided shape.
static NinePatchIcon	createShadeIcon(StretchInfo stretchInfo, java.awt.Rectangle bounds, int width, float opacity, java.awt.Color color, java.awt.Shape shape) Returns shadow nine-patch icon.
static java.awt.image.BufferedImage	createShadeImage(java.awt.Rectangle bounds, int width, float opacity, java.awt.Color color, java.awt.Shape shape) Returns shadow image based on provided shape.
protected NinePatchIcon	getInnerShadeIcon(StretchInfo stretchInfo, java.awt.Rectangle bounds, int width, float opacity, java.awt.Color color, java.awt.Shape shape, java.lang.Object... settings) Returns cached inner shadow icon based on provided shape.
static java.awt.image.BufferedImage	getInnerShadeImage(java.awt.Rectangle bounds, int width, float opacity, java.awt.Color color, java.awt.Shape shape, java.lang.Object... settings) Returns cached inner shadow image based on provided shape.
protected java.awt.Rectangle	getShadeBounds(ShadowType type, java.awt.Shape shape, int width) Returns bounds used for shadow image generation.
protected NinePatchIcon	getShadeIcon(StretchInfo stretchInfo, java.awt.Rectangle bounds, int width, float opacity, java.awt.Color color, java.awt.Shape shape, java.lang.Object... settings) Returns cached shadow icon based on provided shape.
static java.awt.image.BufferedImage	getShadeImage(java.awt.Rectangle bounds, int width, float opacity, java.awt.Color color, java.awt.Shape shape, java.lang.Object... settings) Returns cached shadow image based on provided shape.
void	paint(java.awt.Graphics2D g2d, java.awt.Rectangle bounds, E c, D d, java.awt.Shape shape) Paints shadow for the specified shape.

Methods inherited from class com.alee.painter.decoration.shadow.AbstractShadow

clone, getColor, getId, getOpacity, getType, getWidth, merge

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

shadowIconsCache

protected static final transient java.util.Map<java.lang.String,java.lang.ref.WeakReference<NinePatchIcon>> shadowIconsCache

Shadow icons cache.

shadowImagesCache

protected static final transient java.util.Map<java.lang.String,java.lang.ref.WeakReference<java.awt.image.BufferedImage>> shadowImagesCache

Shadow images cache.

separator

protected static final java.lang.String separator

Cache key data separator.

See Also:

Constant Field Values

shadowIcon

protected transient NinePatchIcon shadowIcon

Reference keeping shadow icon in memory.

shadowImage

protected transient java.awt.image.BufferedImage shadowImage

Reference keeping shadow image in memory.

Constructor Detail

WebShadow

public WebShadow()

Method Detail

paint

public void paint(java.awt.Graphics2D g2d,
                  java.awt.Rectangle bounds,
                  E c,
                  D d,
                  java.awt.Shape shape)

Description copied from interface: IShadow

Paints shadow for the specified shape.

Parameters:

g2d - graphics context

bounds - painting bounds

c - painted component

d - painted decoration state

shape - background shape

getShadeBounds

protected java.awt.Rectangle getShadeBounds(ShadowType type,
                                            java.awt.Shape shape,
                                            int width)

Returns bounds used for shadow image generation.

Parameters:

type - shadow type

shape - shadow shape

width - shadow width

Returns:

bounds used for shadow image generation

getShadeIcon

protected NinePatchIcon getShadeIcon(StretchInfo stretchInfo,
                                     java.awt.Rectangle bounds,
                                     int width,
                                     float opacity,
                                     java.awt.Color color,
                                     java.awt.Shape shape,
                                     java.lang.Object... settings)

Returns cached shadow icon based on provided shape.

Parameters:

stretchInfo - shape stretch information

bounds - shadow bounds

width - shadow width

opacity - shadow opacity

color - shadow color

shape - shadow shape

settings - shape settings

Returns:

cached shadow icon based on provided shape

createShadeIcon

public static NinePatchIcon createShadeIcon(StretchInfo stretchInfo,
                                            java.awt.Rectangle bounds,
                                            int width,
                                            float opacity,
                                            java.awt.Color color,
                                            java.awt.Shape shape)

Returns shadow nine-patch icon.

Parameters:

stretchInfo - shape stretch information

bounds - shadow bounds

width - shadow width

opacity - shadow opacity

color - shadow color

shape - shadow shape

Returns:

shadow nine-patch icon

getShadeImage

public static java.awt.image.BufferedImage getShadeImage(java.awt.Rectangle bounds,
                                                         int width,
                                                         float opacity,
                                                         java.awt.Color color,
                                                         java.awt.Shape shape,
                                                         java.lang.Object... settings)

Returns cached shadow image based on provided shape.

Parameters:

bounds - shadow bounds

width - shadow width

opacity - shadow opacity

color - shadow color

shape - shadow shape

settings - shape settings

Returns:

cached shadow image based on provided shape

createShadeImage

public static java.awt.image.BufferedImage createShadeImage(java.awt.Rectangle bounds,
                                                            int width,
                                                            float opacity,
                                                            java.awt.Color color,
                                                            java.awt.Shape shape)

Returns shadow image based on provided shape.

Parameters:

bounds - shadow bounds

width - shadow width

opacity - shadow opacity

color - shadow color

shape - shadow shape

Returns:

shadow image based on provided shape

getInnerShadeIcon

protected NinePatchIcon getInnerShadeIcon(StretchInfo stretchInfo,
                                          java.awt.Rectangle bounds,
                                          int width,
                                          float opacity,
                                          java.awt.Color color,
                                          java.awt.Shape shape,
                                          java.lang.Object... settings)

Returns cached inner shadow icon based on provided shape.

Parameters:

stretchInfo - shape stretch information

bounds - shadow bounds

width - shadow width

opacity - shadow opacity

color - shadow color

shape - shadow shape

settings - shape settings

Returns:

cached inner shadow icon based on provided shape

createInnerShadeIcon

public static NinePatchIcon createInnerShadeIcon(StretchInfo stretchInfo,
                                                 java.awt.Rectangle bounds,
                                                 int width,
                                                 float opacity,
                                                 java.awt.Color color,
                                                 java.awt.Shape shape)

Returns inner shadow nine-patch icon.

Parameters:

stretchInfo - shape stretch information

bounds - shadow bounds

width - shadow width

opacity - shadow opacity

color - shadow color

shape - shadow shape

Returns:

inner shadow nine-patch icon

getInnerShadeImage

public static java.awt.image.BufferedImage getInnerShadeImage(java.awt.Rectangle bounds,
                                                              int width,
                                                              float opacity,
                                                              java.awt.Color color,
                                                              java.awt.Shape shape,
                                                              java.lang.Object... settings)

Returns cached inner shadow image based on provided shape.

Parameters:

bounds - shadow bounds

width - shadow width

opacity - shadow opacity

color - shadow color

shape - shadow shape

settings - shape settings

Returns:

cached inner shadow image based on provided shape

createInnerShadeImage

public static java.awt.image.BufferedImage createInnerShadeImage(java.awt.Rectangle bounds,
                                                                 int width,
                                                                 float opacity,
                                                                 java.awt.Color color,
                                                                 java.awt.Shape shape)

Returns inner shadow image based on provided shape.

Parameters:

bounds - shadow bounds

width - shadow width

opacity - shadow opacity

color - shadow color

shape - shadow shape

Returns:

inner shadow image based on provided shape