The base class for Substance border painters is
org.pushingpixels.substance.api.painter.border.SubstanceBorderPainter.
Border painter is used to paint the outer contour of most UI components,
such as buttons, check boxes, radio buttons, progress bars, tabs,
scroll bars and others. This allows providing a consistent and pluggable
appearance to those components. In addition, it provides an external API
for applications that wish to skin custom components in a visually
consistent manner.
The
org.pushingpixels.substance.api.painter.border.SubstanceBorderPainter
interface defines the following painting method:
/**
* Paints the control border.
*
* @param g
* Graphics.
* @param c
* Component.
* @param width
* Width of a UI component.
* @param height
* Height of a UI component.
* @param contour
* Contour of a UI component.
* @param innerContour
* Inner contour of a UI component. May be ignored if the
* specific implementation paints only the outside border.
* @param borderScheme
* The border color scheme.
*/
public void paintBorder(Graphics g, Component c, int width, int height,
Shape contour, Shape innerContour, SubstanceColorScheme borderScheme);
The contour and
innerContour parameters specify
the outer and inner contour shapes to paint, while the
borderScheme specifies the Substance
color schemes to be used to compute the border colors. The internal implementation of
a specific border painter may decide to ignore the
innerContour if this are not
relevant.
For optimization purposes, the SubstanceBorderPainter
defines the following method that must be implemented by the specific border painter:
/**
* Returns boolean indication whether this border painter is painting the
* inner contours.
*
* @return <code>true</code> if this border painter is painting the inner
* contours, <code>false</code> otherwise.
*/
public boolean isPaintingInnerContour();
Note that if this method returns false, the implementation of the
paintBorder() must ignore the
innerContour parameter.
Applications that wish to provide a custom (branding) border painter
may utilize the existing StandardBorderPainter
base class. The subclass can override any one of the three base methods that compute border
colors at different vertical locations (see
get*BorderColor methods).
Most core Substance border painters extend this class. In addition,
the DelegateBorderPainter
and CompositeBorderPainter
classes can be used to combine existing border painters and tweak the
colors selected for the painting.
If you wish to use the border painter of the current skin to provide additional custom painting in your application, call:
SubstanceLookAndFeel.getCurrentSkin()
to retrieve the current skin.SubstanceSkin.getBorderPainter()
to retrieve the border painter of the current skin.SubstanceBorderPainter.paintBorder()
to paint the border on the specific graphics context.