Package org.pushingpixels.substance.api.painter.border

Class CompositeBorderPainter

java.lang.Object

org.pushingpixels.substance.api.painter.border.CompositeBorderPainter

All Implemented Interfaces:

SubstanceBorderPainter, SubstanceTrait

public class CompositeBorderPainter
extends java.lang.Object
implements SubstanceBorderPainter

Composite border painter that delegates the painting of outer and inner contours.

Constructor Summary

Constructors

Constructor	Description
CompositeBorderPainter(java.lang.String displayName, SubstanceBorderPainter outer, SubstanceBorderPainter inner)	Creates a new composite border painter.

Method Summary

Modifier and Type	Method	Description
java.lang.String	getDisplayName()	Returns the display name of this trait.
java.awt.Color	getRepresentativeColor(SubstanceColorScheme borderScheme)
boolean	isPaintingInnerContour()	Returns boolean indication whether this border painter is painting the inner contours.
void	paintBorder(java.awt.Graphics g, java.awt.Component c, float width, float height, java.awt.Shape contour, java.awt.Shape innerContour, SubstanceColorScheme borderScheme)	Paints the control border.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

CompositeBorderPainter

public CompositeBorderPainter(java.lang.String displayName,
                              SubstanceBorderPainter outer,
                              SubstanceBorderPainter inner)

Creates a new composite border painter.

Parameters:

displayName - Display name.

outer - Delegate painter for painting the outer contours.

inner - Delegate painter for painting the inner contrours.

Method Detail

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(java.awt.Graphics g,
                        java.awt.Component c,
                        float width,
                        float height,
                        java.awt.Shape contour,
                        java.awt.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.

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.

getRepresentativeColor

public java.awt.Color getRepresentativeColor(SubstanceColorScheme borderScheme)

Specified by:

getRepresentativeColor in interface SubstanceBorderPainter