com.alee.painter.decoration.shape

Class AbstractShape<E extends javax.swing.JComponent,D extends IDecoration<E,D>,I extends AbstractShape<E,D,I>>

java.lang.Object

com.alee.painter.decoration.shape.AbstractShape<E,D,I>

Type Parameters:

E - component type

D - decoration type

I - shape type

All Implemented Interfaces:

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

Direct Known Subclasses:

ArrowShape, EllipseShape, WebShape

public abstract class AbstractShape<E extends javax.swing.JComponent,D extends IDecoration<E,D>,I extends AbstractShape<E,D,I>>
extends java.lang.Object
implements IShape<E,D,I>

Abstract shape providing some general method implementations.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.String	id Shape ID.

Constructor Summary

Constructors

Constructor and Description
AbstractShape()

Method Summary

Modifier and Type	Method and Description
I	clone()
protected java.lang.String	getDefaultId() Returns default shape ID.
java.lang.String	getId()
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.
I	merge(I shape)
protected java.awt.Point	p(int x, int y) Returns point for the specified coordinates.

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.alee.painter.decoration.shape.IShape

getBorderInsets, getShape

Field Detail

id

@XStreamAsAttribute
protected java.lang.String id

Shape ID.

Constructor Detail

AbstractShape

public AbstractShape()

Method Detail

getId

public java.lang.String getId()

Specified by:

getId in interface com.alee.api.Identifiable

getDefaultId

protected java.lang.String getDefaultId()

Returns default shape ID.

Returns:

default shape ID

isVisible

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

Description copied from interface: IShape

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

Specified by:

isVisible in interface IShape<E extends javax.swing.JComponent,D extends IDecoration<E,D>,I extends AbstractShape<E,D,I>>

Parameters:

type - checked shape type

c - painted component

d - painted decoration state

Returns:

true if shape is visible within component bounds, false otherwise

getShapeSettings

public java.lang.Object[] getShapeSettings(java.awt.Rectangle bounds,
                                           E c,
                                           D d)

Description copied from interface: IShape

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.

Specified by:

getShapeSettings in interface IShape<E extends javax.swing.JComponent,D extends IDecoration<E,D>,I extends AbstractShape<E,D,I>>

Parameters:

bounds - painting bounds

c - painted component

d - painted decoration state

Returns:

shape settings used to cache the shape itself

getStretchInfo

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

Description copied from interface: IShape

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.

Specified by:

getStretchInfo in interface IShape<E extends javax.swing.JComponent,D extends IDecoration<E,D>,I extends AbstractShape<E,D,I>>

Parameters:

bounds - painting bounds

c - painted component

d - painted decoration state

Returns:

shape stretch information

merge

public I merge(I shape)

Specified by:

merge in interface com.alee.api.Mergeable<I extends AbstractShape<E,D,I>>

clone

public I clone()

Overrides:

clone in class java.lang.Object

p

protected java.awt.Point p(int x,
                           int y)

Returns point for the specified coordinates.

Parameters:

x - X coordinate

y - Y coordinate

Returns:

point for the specified coordinates