WebShape

java.lang.Object
- com.alee.painter.decoration.shape.AbstractShape<E,D,I>
- - com.alee.painter.decoration.shape.WebShape<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
```
public class WebShape<E extends javax.swing.JComponent,D extends WebDecoration<E,D>,I extends WebShape<E,D,I>>
extends AbstractShape<E,D,I>
```
Common WebLaF component shape implementation. It provides rounded rectangular component shape. Different sides of the shape can also be clipped to visually group components.

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`protected java.lang.String`	`lines` Displayed decoration side lines.
`protected Round`	`round` Decoration corners rounding.
`protected java.lang.String`	`sides` Displayed decoration sides.

Fields inherited from class com.alee.painter.decoration.shape.AbstractShape
id

Constructor Summary

Constructors
Constructor and Description

WebShape()

Constructors
Constructor and Description
`WebShape()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`java.awt.Insets`	`getBorderInsets(E c, D d)` Returns shape borders size.
`protected GroupingLayout`	`getGroupingLayout(E c)` Returns grouping layout used to place specified component if it exists, `null` otherwise.
`protected java.lang.String`	`getLines(E c, D d)` Returns descriptor for painted component lines.
`Round`	`getRound()` Returns decoration corners rounding.
`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.
`protected java.lang.String`	`getSides(E c, D d)` Returns descriptor for painted component sides.
`StretchInfo`	`getStretchInfo(java.awt.Rectangle bounds, E c, D d)` Returns shape stretch information.
`boolean`	`isAnyLine(E c, D d)` Returns whether or not any of the side lines should be painted.
`boolean`	`isAnySide(E c, D d)` Returns whether or not any of the sides should be painted.
`boolean`	`isPaintBottom(E c, D d)` Returns whether or not bottom side should be painted.
`boolean`	`isPaintBottomLine(E c, D d)` Returns whether or not bottom side line should be painted.
`boolean`	`isPaintLeft(E c, D d)` Returns whether or not left side should be painted.
`boolean`	`isPaintLeftLine(E c, D d)` Returns whether or not left side line should be painted.
`boolean`	`isPaintRight(E c, D d)` Returns whether or not right side should be painted.
`boolean`	`isPaintRightLine(E c, D d)` Returns whether or not right side line should be painted.
`boolean`	`isPaintTop(E c, D d)` Returns whether or not top side should be painted.
`boolean`	`isPaintTopLine(E c, D d)` Returns whether or not top side line should be painted.
`boolean`	`isVisible(ShapeType type, E c, D d)` Returns whether shape is visible within component bounds.
`I`	`merge(I shape)`

Methods inherited from class com.alee.painter.decoration.shape.AbstractShape
clone, getDefaultId, getId, p

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

- Field Detail
  - round
```
@XStreamAsAttribute
protected Round round
```
    Decoration corners rounding.
  - sides
```
@XStreamAsAttribute
protected java.lang.String sides
```
    Displayed decoration sides.
  - lines
```
@XStreamAsAttribute
protected java.lang.String lines
```
    Displayed decoration side lines.
- Constructor Detail
  - WebShape
```
public WebShape()
```
- Method Detail
  - getRound
```
public Round getRound()
```
    Returns decoration corners rounding.
    
    Returns:
    
    decoration corners rounding
  - getGroupingLayout
```
protected GroupingLayout getGroupingLayout(E c)
```
    Returns grouping layout used to place specified component if it exists, null otherwise.
    
    Parameters:
    
    c - painted component
    
    Returns:
    
    grouping layout used to place specified component if it exists, null otherwise
  - getSides
```
protected java.lang.String getSides(E c,
                                    D d)
```
    Returns descriptor for painted component sides.
    
    Parameters:
    
    c - painted component
    
    d - painted decoration
    
    Returns:
    
    descriptor for painted component sides
  - isPaintTop
```
public boolean isPaintTop(E c,
                          D d)
```
    Returns whether or not top side should be painted.
    
    Parameters:
    
    c - painted component
    
    d - painted decoration
    
    Returns:
    
    true if top side should be painted, false otherwise
  - isPaintLeft
```
public boolean isPaintLeft(E c,
                           D d)
```
    Returns whether or not left side should be painted.
    
    Parameters:
    
    c - painted component
    
    d - painted decoration
    
    Returns:
    
    true if left side should be painted, false otherwise
  - isPaintBottom
```
public boolean isPaintBottom(E c,
                             D d)
```
    Returns whether or not bottom side should be painted.
    
    Parameters:
    
    c - painted component
    
    d - painted decoration
    
    Returns:
    
    true if bottom side should be painted, false otherwise
  - isPaintRight
```
public boolean isPaintRight(E c,
                            D d)
```
    Returns whether or not right side should be painted.
    
    Parameters:
    
    c - painted component
    
    d - painted decoration
    
    Returns:
    
    true if right side should be painted, false otherwise
  - isAnySide
```
public boolean isAnySide(E c,
                         D d)
```
    Returns whether or not any of the sides should be painted.
    
    Parameters:
    
    c - painted component
    
    d - painted decoration
    
    Returns:
    
    true if at least one of the sides should be painted, false otherwise
  - getLines
```
protected java.lang.String getLines(E c,
                                    D d)
```
    Returns descriptor for painted component lines.
    
    Parameters:
    
    c - painted component
    
    d - painted decoration
    
    Returns:
    
    descriptor for painted component lines
  - isPaintTopLine
```
public boolean isPaintTopLine(E c,
                              D d)
```
    Returns whether or not top side line should be painted.
    
    Parameters:
    
    c - painted component
    
    d - painted decoration
    
    Returns:
    
    true if top side line should be painted, false otherwise
  - isPaintLeftLine
```
public boolean isPaintLeftLine(E c,
                               D d)
```
    Returns whether or not left side line should be painted.
    
    Parameters:
    
    c - painted component
    
    d - painted decoration
    
    Returns:
    
    true if left side line should be painted, false otherwise
  - isPaintBottomLine
```
public boolean isPaintBottomLine(E c,
                                 D d)
```
    Returns whether or not bottom side line should be painted.
    
    Parameters:
    
    c - painted component
    
    d - painted decoration
    
    Returns:
    
    true if bottom side line should be painted, false otherwise
  - isPaintRightLine
```
public boolean isPaintRightLine(E c,
                                D d)
```
    Returns whether or not right side line should be painted.
    
    Parameters:
    
    c - painted component
    
    d - painted decoration
    
    Returns:
    
    true if right side line should be painted, false otherwise
  - isAnyLine
```
public boolean isAnyLine(E c,
                         D d)
```
    Returns whether or not any of the side lines should be painted.
    
    Parameters:
    
    c - painted component
    
    d - painted decoration
    
    Returns:
    
    true if at least one of the side lines should be painted, false otherwise
  - getBorderInsets
```
public java.awt.Insets getBorderInsets(E c,
                                       D d)
```
    Description copied from interface: IShape
    
    Returns shape borders size.
    
    Parameters:
    
    c - painted component
    
    d - painted decoration state
    
    Returns:
    
    shape borders size
  - 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 WebDecoration<E,D>,I extends WebShape<E,D,I>>
    
    Overrides:
    
    isVisible in class AbstractShape<E extends javax.swing.JComponent,D extends WebDecoration<E,D>,I extends WebShape<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
  - getShape
```
public java.awt.Shape getShape(ShapeType type,
                               java.awt.Rectangle bounds,
                               E c,
                               D d)
```
    Description copied from interface: IShape
    
    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
```
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 WebDecoration<E,D>,I extends WebShape<E,D,I>>
    
    Overrides:
    
    getShapeSettings in class AbstractShape<E extends javax.swing.JComponent,D extends WebDecoration<E,D>,I extends WebShape<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 WebDecoration<E,D>,I extends WebShape<E,D,I>>
    
    Overrides:
    
    getStretchInfo in class AbstractShape<E extends javax.swing.JComponent,D extends WebDecoration<E,D>,I extends WebShape<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 WebShape<E,D,I>>
    
    Overrides:
    
    merge in class AbstractShape<E extends javax.swing.JComponent,D extends WebDecoration<E,D>,I extends WebShape<E,D,I>>

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

Field Summary

Fields inherited from class com.alee.painter.decoration.shape.AbstractShape

Constructor Summary

Method Summary

Methods inherited from class com.alee.painter.decoration.shape.AbstractShape

Methods inherited from class java.lang.Object

Field Detail

round

sides

lines

Constructor Detail

WebShape

Method Detail

getRound

getGroupingLayout

getSides

isPaintTop

isPaintLeft

isPaintBottom

isPaintRight

isAnySide

getLines

isPaintTopLine

isPaintLeftLine

isPaintBottomLine

isPaintRightLine

isAnyLine

getBorderInsets

isVisible

getShape

getShapeSettings

getStretchInfo

merge