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.border
Class NullBorderPainter

    java.lang.Object
      org.jvnet.substance.painter.border.NullBorderPainter

All Implemented Interfaces:
  SubstanceTrait, SubstanceBorderPainter

    public class NullBorderPainter

extends java.lang.Object
implements SubstanceBorderPainter

Empty implementation of `SubstanceBorderPainter` which doesn't paint any border. This is useful for migration of custom gradient painters which, until version 4.0, were used to paint both the control background and the control border. Starting from version 4.0, the borders are painted by the currently installed border painter, and as such, a custom gradient painter that paints a border will be overriden by the current border painter. To allow easier migration (splitting the old custom gradient painter into a custom gradient painter and a custom border painter, you can use this implementation that will not override the custom border.

Author:
  Kirill Grouchnikov

Constructor Summary
`NullBorderPainter()`

Method Summary
`java.lang.String` | `getDisplayName()` Returns the display name of `this` trait.
`void` | `paintBorder(java.awt.Graphics g, java.awt.Component c, int width, int height, java.awt.Shape contour, java.awt.Shape innerContour, SubstanceColorScheme colorScheme1, SubstanceColorScheme colorScheme2, float cyclePos, boolean useCyclePosAsInterpolation)`
Paints the control border.

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

Constructor Detail

### NullBorderPainter

    public NullBorderPainter()

Method Detail

### getDisplayName

    public java.lang.String getDisplayName()

  Description copied from interface: `SubstanceTrait`
  Returns the display name of `this` trait. This method is part of officially supported API.

  Specified by:
    `getDisplayName` in interface `SubstanceTrait`
  Returns:
    The display name of `this` trait.

### paintBorder

    public void paintBorder(java.awt.Graphics g,
                            java.awt.Component c,
                            int width,
                            int height,
                            java.awt.Shape contour,
                            java.awt.Shape innerContour,
                            SubstanceColorScheme colorScheme1,
                            SubstanceColorScheme colorScheme2,
                            float cyclePos,
                            boolean useCyclePosAsInterpolation)

  Description copied from interface: `SubstanceBorderPainter`
  Paints the control border.

  Specified by:
    `paintBorder` in interface `SubstanceBorderPainter`
  Parameters:
    `g` - Graphics.
    `c` - Component.
    `width` - Width of a UI component.
    `height` - Height of a UI component.
    `contour` - Contour of a UI component.
    `innerContour` - Inner contour of a UI component. May be ignored if the specific implementation paints only the outside border.
    `colorScheme1` - The first color scheme.
    `colorScheme2` - The second color scheme.
    `cyclePos` - Cycle position. Is used for rollover and pulsation effects. Must be in 0..10 range.
    `useCyclePosAsInterpolation` - Indicates the algorithm to use for computing various colors. If `true`, the `cyclePos` is used to interpolate colors between different color components of both color schemes. If `false`, the `cyclePos` is used to interpolate colors between different color components of the first color scheme.

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

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