WebDecoration

java.lang.Object
- com.alee.painter.decoration.AbstractDecoration<E,I>
- - com.alee.painter.decoration.WebDecoration<E,I>

Type Parameters:

E - component type

I - decoration type

All Implemented Interfaces:

com.alee.api.Identifiable, com.alee.api.Mergeable<I>, PainterShapeProvider<E>, IDecoration<E,I>, java.io.Serializable, java.lang.Cloneable
```
public class WebDecoration<E extends javax.swing.JComponent,I extends WebDecoration<E,I>>
extends AbstractDecoration<E,I>
```
Configurable decoration state used for most WebLaF components. It provides basic elements required to paint component parts.

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`protected java.util.List<IBackground>`	`background` Optional decoration backgrounds.
`protected java.util.List<IBorder>`	`borders` Optional decoration border.
`protected java.util.List<IContent>`	`contents` Optional decoration contents.
`protected java.util.List<IContentLayout>`	`layout` Optional decoration contents layout.
`protected java.util.List<IShadow>`	`shades` Optional decoration shades.
`protected java.util.List<IShape>`	`shapes` Decoration shape.

Fields inherited from class com.alee.painter.decoration.AbstractDecoration
defaultStateId, opacity, section, size, states, visible

Fields inherited from interface com.alee.painter.decoration.IDecoration
STATES_SEPARATOR

Constructor Summary

Constructors
Constructor and Description

WebDecoration()

Constructors
Constructor and Description
`WebDecoration()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`java.util.List<IBackground>`	`getBackgrounds()` Returns decoration backgrounds.
`IBorder`	`getBorder()` Returns decoration border.
`java.awt.Insets`	`getBorderInsets(E c)` Returns decoration borders size.
`float`	`getBorderWidth()` Returns border width.
`java.util.List<IContent>`	`getContents()` Returns decoration contents.
`IContentLayout`	`getLayout()` Returns decoration contents layout.
`IShadow`	`getShade(ShadowType type)` Returns shade of the specified type.
`int`	`getShadeWidth(ShadowType type)` Returns width of the shade with the specified type.
`IShape`	`getShape()` Returns decoration shape.
`I`	`merge(I decoration)`
`void`	`paint(java.awt.Graphics2D g2d, java.awt.Rectangle bounds, E c)` Paints component decoration.
`java.awt.Shape`	`provideShape(E component, java.awt.Rectangle bounds)` Returns painted component shape.

Methods inherited from class com.alee.painter.decoration.AbstractDecoration
clone, getId, getOpacity, getPreferredSize, getStates, isSection, isVisible, setSection, toString

Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - shapes
```
protected java.util.List<IShape> shapes
```
    Decoration shape. It defines the shape of the decoration shade, border, background and might be used for other decoration elements. Implicit list is only used to provide convenient XML descriptor for this field, only one shape can be provided at a time.
    
    See Also:
    
    IShape, AbstractShape
  - shades
```
protected java.util.List<IShadow> shades
```
    Optional decoration shades. Maximum two different shades could be provided at the same time - outer and inner.
    
    See Also:
    
    IShadow, AbstractShadow
  - borders
```
protected java.util.List<IBorder> borders
```
    Optional decoration border. Implicit list is used to provide convenient XML descriptor for this field. Right now only single border can be used per decoration instance, but that might change in future.
    
    See Also:
    
    IBorder, AbstractBorder
  - background
```
protected java.util.List<IBackground> background
```
    Optional decoration backgrounds. Multiple backgrounds can be used per decoration instance. Though it is not reasonable to use backgrounds which will fully overlap eachother.
    
    See Also:
    
    IBackground, AbstractBackground
  - layout
```
protected java.util.List<IContentLayout> layout
```
    Optional decoration contents layout. You can only provide single layout per decoration instance. Implicit list is only used to provide convenient XML descriptor for this field.
    
    See Also:
    
    IContentLayout
  - contents
```
protected java.util.List<IContent> contents
```
    Optional decoration contents. It can be anything contained within the decoration or placed on top of the decoration. Contents are placed based on either layout, if one was provided, or their own bounds setting.
    
    See Also:
    
    IContent, AbstractContent
- Constructor Detail
  - WebDecoration
```
public WebDecoration()
```
- Method Detail
  - getShape
```
public IShape getShape()
```
    Returns decoration shape.
    
    Returns:
    
    decoration shape
  - getShade
```
public IShadow getShade(ShadowType type)
```
    Returns shade of the specified type.
    
    Parameters:
    
    type - shade type
    
    Returns:
    
    shade of the specified type
  - getShadeWidth
```
public int getShadeWidth(ShadowType type)
```
    Returns width of the shade with the specified type.
    
    Parameters:
    
    type - shade type
    
    Returns:
    
    width of the shade with the specified type
  - getBorder
```
public IBorder getBorder()
```
    Returns decoration border.
    
    Returns:
    
    decoration border
  - getBorderWidth
```
public float getBorderWidth()
```
    Returns border width.
    
    Returns:
    
    border width
  - getBackgrounds
```
public java.util.List<IBackground> getBackgrounds()
```
    Returns decoration backgrounds.
    
    Returns:
    
    decoration backgrounds
  - getLayout
```
public IContentLayout getLayout()
```
    Returns decoration contents layout.
    
    Returns:
    
    decoration contents layout
  - getContents
```
public java.util.List<IContent> getContents()
```
    Returns decoration contents.
    
    Returns:
    
    decoration contents
  - getBorderInsets
```
public java.awt.Insets getBorderInsets(E c)
```
    Description copied from interface: IDecoration
    
    Returns decoration borders size.
    
    Parameters:
    
    c - painted component
    
    Returns:
    
    decoration borders size
  - provideShape
```
public java.awt.Shape provideShape(E component,
                                   java.awt.Rectangle bounds)
```
    Description copied from interface: PainterShapeProvider
    
    Returns painted component shape.
    
    Parameters:
    
    component - component to process
    
    bounds - bounds for painter visual data
    
    Returns:
    
    painted component shape
  - paint
```
public void paint(java.awt.Graphics2D g2d,
                  java.awt.Rectangle bounds,
                  E c)
```
    Description copied from interface: IDecoration
    
    Paints component decoration.
    
    Parameters:
    
    g2d - graphics context
    
    bounds - painting bounds
    
    c - painted component
  - merge
```
public I merge(I decoration)
```
    Specified by:
    
    merge in interface com.alee.api.Mergeable<I extends WebDecoration<E,I>>
    
    Overrides:
    
    merge in class AbstractDecoration<E extends javax.swing.JComponent,I extends WebDecoration<E,I>>

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

Field Summary

Fields inherited from class com.alee.painter.decoration.AbstractDecoration

Fields inherited from interface com.alee.painter.decoration.IDecoration

Constructor Summary

Method Summary

Methods inherited from class com.alee.painter.decoration.AbstractDecoration

Methods inherited from class java.lang.Object

Field Detail

shapes

shades

borders

background

layout

contents

Constructor Detail

WebDecoration

Method Detail

getShape

getShade

getShadeWidth

getBorder

getBorderWidth

getBackgrounds

getLayout

getContents

getBorderInsets

provideShape

paint

merge