Overview | Package | Class | Use | Tree | Deprecated | Index | Help

PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

## org.jvnet.substance.painter.decoration
Class ImageWrapperDecorationPainter

    java.lang.Object
      org.jvnet.substance.painter.decoration.ImageWrapperDecorationPainter

All Implemented Interfaces:
  SubstanceTrait, SubstanceDecorationPainter

Direct Known Subclasses:
  BrushedMetalDecorationPainter, MarbleNoiseDecorationPainter

    public abstract class ImageWrapperDecorationPainter

extends java.lang.Object
implements SubstanceDecorationPainter

Implementation of `SubstanceDecorationPainter` that uses brushed metal painting on decoration areas.

Since:
  version 4.3
Author:
  Kirill Grouchnikov

Field Summary
`protected SubstanceDecorationPainter` | `baseDecorationPainter` The base decoration painter - the colorized image tiles are painted over the painting of this painter.
`protected java.util.LinkedHashMap<java.lang.String,java.awt.Image>` | `colorizedTileMap` Map of colorized tiles.
`protected boolean` | `isPaintingSeparators` Indication whether this painter paints horizontal separators on the bottom of each component passed to `paintDecorationArea(Graphics2D, Component, DecorationAreaType, int, int, SubstanceSkin)`.
`protected java.awt.Image` | `originalTile` Contains the original (not colorized) image of this painter.
`protected float` | `textureAlpha` Alpha channel for the texture image (colorized tiles applied on top of the `baseDecorationPainter` painting).

Constructor Summary
`ImageWrapperDecorationPainter()` Creates a new image wrapper decoration painter.

Method Summary
`protected java.awt.Image` | `getColorizedTile(SubstanceColorScheme scheme)` Returns a colorized image tile.
`void` | `paintDecorationArea(java.awt.Graphics2D graphics, java.awt.Component comp, DecorationAreaType decorationAreaType, int width, int height, SubstanceSkin skin)` Paints the decoration area.
`void` | `setBaseDecorationPainter(SubstanceDecorationPainter baseDecorationPainter)` Sets the base decoration painter.
`void` | `setPaintingSeparators(boolean isPaintingSeparators)` Sets indication whether this painter paints separators.
`void` | `setTextureAlpha(float textureAlpha)` Sets the alpha channel for the image texture.
`protected void` | `tileArea(java.awt.Graphics2D g, java.awt.Component comp, SubstanceColorScheme tileScheme, int offsetTextureX, int offsetTextureY, int x, int y, int width, int height)` Tiles the specified area with colorized version of the image tile.

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

Methods inherited from interface org.jvnet.substance.api.trait.SubstanceTrait
`getDisplayName`

Field Detail

### originalTile

    protected java.awt.Image originalTile

  Contains the original (not colorized) image of this painter.

### baseDecorationPainter

    protected SubstanceDecorationPainter baseDecorationPainter

  The base decoration painter - the colorized image tiles are painted over the painting of this painter. Can be `null`.

### colorizedTileMap

    protected java.util.LinkedHashMap<java.lang.String,java.awt.Image> colorizedTileMap

  Map of colorized tiles.

### textureAlpha

    protected float textureAlpha

  Alpha channel for the texture image (colorized tiles applied on top of the `baseDecorationPainter` painting).

### isPaintingSeparators

    protected boolean isPaintingSeparators

  Indication whether this painter paints horizontal separators on the bottom of each component passed to `paintDecorationArea(Graphics2D, Component, DecorationAreaType, int, int, SubstanceSkin)`.

Constructor Detail

### ImageWrapperDecorationPainter

    public ImageWrapperDecorationPainter()

  Creates a new image wrapper decoration painter.

Method Detail

### paintDecorationArea

    public void paintDecorationArea(java.awt.Graphics2D graphics,
                                    java.awt.Component comp,
                                    DecorationAreaType decorationAreaType,
                                    int width,
                                    int height,
                                    SubstanceSkin skin)

  Description copied from interface: `SubstanceDecorationPainter`
  Paints the decoration area.

  Specified by:
    `paintDecorationArea` in interface `SubstanceDecorationPainter`
  Parameters:
    `graphics` - Graphics context.
    `comp` - Component.
    `decorationAreaType` - Decoration area type. Must not be `null`.
    `width` - Width.
    `height` - Height.
    `skin` - Skin for painting the decoration area.

### tileArea

    protected void tileArea(java.awt.Graphics2D g,
                            java.awt.Component comp,
                            SubstanceColorScheme tileScheme,
                            int offsetTextureX,
                            int offsetTextureY,
                            int x,
                            int y,
                            int width,
                            int height)

  Tiles the specified area with colorized version of the image tile. This is called after the `baseDecorationPainter` has painted the area. This method should respect the current `textureAlpha` value.

  Parameters:
    `g` - Graphic context.
    `comp` - Component.
    `tileScheme` - Theme for the tile colorization.
    `offsetTextureX` - X offset for the tiling.
    `offsetTextureY` - Y offset for the tiling.
    `x` - X coordinate of the tiling region.
    `y` - Y coordinate of the tiling region.
    `width` - Width of the tiling region.
    `height` - Height of the tiling region.

### setBaseDecorationPainter

    public void setBaseDecorationPainter(SubstanceDecorationPainter baseDecorationPainter)

  Sets the base decoration painter.

  Parameters:
    `baseDecorationPainter` - Base decoration painter.

### setTextureAlpha

    public void setTextureAlpha(float textureAlpha)

  Sets the alpha channel for the image texture.

  Parameters:
    `textureAlpha` - Alpha channel for the image texture.

### setPaintingSeparators

    public void setPaintingSeparators(boolean isPaintingSeparators)

  Sets indication whether this painter paints separators.

  Parameters:
    `isPaintingSeparators` - If `true`, this painter will paint horizontal separators on the bottom of each component passed to either `paintTitleBackground(Graphics2D, Component, DecorationAreaType, int, int, SubstanceSkin)` or `paintExtraBackground(Graphics2D, Container, Component, DecorationAreaType, int, int, SubstanceSkin)`.

### getColorizedTile

    protected java.awt.Image getColorizedTile(SubstanceColorScheme scheme)

  Returns a colorized image tile.

  Parameters:
    `scheme` - Color scheme for the colorization.
  Returns:
    Colorized tile.

Overview | Package | Class | Use | Tree | Deprecated | Index | Help

PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD