Class StandardBorderPainter

java.lang.Object
org.pushingpixels.substance.api.painter.border.StandardBorderPainter
All Implemented Interfaces:
SubstanceBorderPainter, SubstanceTrait
Direct Known Subclasses:
ClassicBorderPainter, DelegateBorderPainter, FlatBorderPainter, GlassBorderPainter, SimplisticSoftBorderPainter

public class StandardBorderPainter extends Object implements SubstanceBorderPainter
The default border painter. This class is part of officially supported API.
  • Constructor Details

    • StandardBorderPainter

      public StandardBorderPainter()
  • Method Details

    • getDisplayName

      public 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.
    • isPaintingInnerContour

      public boolean isPaintingInnerContour()
      Description copied from interface: SubstanceBorderPainter
      Returns boolean indication whether this border painter is painting the inner contours.
      Specified by:
      isPaintingInnerContour in interface SubstanceBorderPainter
      Returns:
      true if this border painter is painting the inner contours, false otherwise.
    • paintBorder

      public void paintBorder(Graphics g, Component c, int width, int height, Shape contour, Shape innerContour, SubstanceColorScheme borderScheme)
      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.
      borderScheme - The border color scheme.
    • getTopBorderColor

      public Color getTopBorderColor(SubstanceColorScheme borderScheme)
      Computes the color of the top portion of the border. Override to provide different visual.
      Parameters:
      borderScheme - The border color scheme.
      Returns:
      The color of the top portion of the border.
    • getMidBorderColor

      public Color getMidBorderColor(SubstanceColorScheme borderScheme)
      Computes the color of the middle portion of the border. Override to provide different visual.
      Parameters:
      borderScheme - The border color scheme.
      Returns:
      The color of the middle portion of the border.
    • getBottomBorderColor

      public Color getBottomBorderColor(SubstanceColorScheme borderScheme)
      Computes the color of the bottom portion of the border. Override to provide different visual.
      Parameters:
      borderScheme - The border color scheme.
      Returns:
      The color of the bottom portion of the border.