support different component border colors to indicate errors, warnings or custom state (set client property JComponent.outline to error, warning or any java.awt.Color)

2026-02-12 15:07:11 -06:00 · 2020-05-17 13:43:19 +02:00
parent ff545e6ecd
commit 800dbf3ba9
15 changed files with 339 additions and 7 deletions
--- a/flatlaf-core/src/main/java/com/formdev/flatlaf/FlatClientProperties.java
+++ b/flatlaf-core/src/main/java/com/formdev/flatlaf/FlatClientProperties.java
@@ -103,6 +103,34 @@ public interface FlatClientProperties
 	 */
 	String MINIMUM_HEIGHT = "JComponent.minimumHeight";

+	/**
+	 * Specifies the outline color of the component border.
+	 * <p>
+	 * <strong>Components</strong> {@link javax.swing.JButton}, {@link javax.swing.JComboBox},
+	 * {@link javax.swing.JFormattedTextField}, {@link javax.swing.JPasswordField},
+	 * {@link javax.swing.JScrollPane}, {@link javax.swing.JSpinner},
+	 * {@link javax.swing.JTextField} and {@link javax.swing.JToggleButton}<br>
+	 * <strong>Value type</strong> {@link java.lang.String} or {@link java.awt.Color} or {@link java.awt.Color}[2]<br>
+	 * <strong>Allowed Values</strong> {@link #OUTLINE_ERROR}, {@link #OUTLINE_WARNING},
+	 * any color (type {@link java.awt.Color}) or an array of two colors (type {@link java.awt.Color}[2])
+	 * where the first color is for focused state and the second for unfocused state
+	 */
+	String OUTLINE = "JComponent.outline";
+
+	/**
+	 * Paint the component border in another color (usually reddish) to indicate an error.
+	 *
+	 * @see #OUTLINE
+	 */
+	String OUTLINE_ERROR = "error";
+
+	/**
+	 * Paint the component border in another color (usually yellowish) to indicate a warning.
+	 *
+	 * @see #OUTLINE
+	 */
+	String OUTLINE_WARNING = "warning";
+
 	/**
 	 * Paint the component with round edges.
 	 * <p>
--- a/flatlaf-core/src/main/java/com/formdev/flatlaf/IntelliJTheme.java
+++ b/flatlaf-core/src/main/java/com/formdev/flatlaf/IntelliJTheme.java
@@ -467,6 +467,12 @@ public class IntelliJTheme
 		uiKeyMapping.put( "ComboBox.ArrowButton.iconColor",             "ComboBox.buttonArrowColor" );
 		uiKeyMapping.put( "ComboBox.ArrowButton.nonEditableBackground", "ComboBox.buttonBackground" );

+		// Component
+		uiKeyMapping.put( "Component.inactiveErrorFocusColor",   "Component.error.borderColor" );
+		uiKeyMapping.put( "Component.errorFocusColor",           "Component.error.focusedBorderColor" );
+		uiKeyMapping.put( "Component.inactiveWarningFocusColor", "Component.warning.borderColor" );
+		uiKeyMapping.put( "Component.warningFocusColor",         "Component.warning.focusedBorderColor" );
+
 		// Link
 		uiKeyMapping.put( "Link.activeForeground", "Component.linkColor" );

--- a/flatlaf-core/src/main/java/com/formdev/flatlaf/ui/FlatBorder.java
+++ b/flatlaf-core/src/main/java/com/formdev/flatlaf/ui/FlatBorder.java
@@ -36,6 +36,8 @@ import javax.swing.SwingUtilities;
 import javax.swing.UIManager;
 import javax.swing.plaf.basic.BasicBorders;
 import javax.swing.text.JTextComponent;
+import com.formdev.flatlaf.FlatClientProperties;
+import com.formdev.flatlaf.util.DerivedColor;

 /**
 * Border for various components (e.g. {@link javax.swing.JTextField}).
@@ -54,6 +56,12 @@ import javax.swing.text.JTextComponent;
 * @uiDefault Component.disabledBorderColor	Color
 * @uiDefault Component.focusedBorderColor	Color
 *
+ * @uiDefault Component.error.borderColor			Color
+ * @uiDefault Component.error.focusedBorderColor	Color
+ * @uiDefault Component.warning.borderColor			Color
+ * @uiDefault Component.warning.focusedBorderColor	Color
+ * @uiDefault Component.custom.borderColor			Color
+ *
 * @author Karl Tauber
 */
 public class FlatBorder
@@ -66,6 +74,12 @@ public class FlatBorder
 	protected final Color disabledBorderColor = UIManager.getColor( "Component.disabledBorderColor" );
 	protected final Color focusedBorderColor = UIManager.getColor( "Component.focusedBorderColor" );

+	protected final Color errorBorderColor = UIManager.getColor( "Component.error.borderColor" );
+	protected final Color errorFocusedBorderColor = UIManager.getColor( "Component.error.focusedBorderColor" );
+	protected final Color warningBorderColor = UIManager.getColor( "Component.warning.borderColor" );
+	protected final Color warningFocusedBorderColor = UIManager.getColor( "Component.warning.focusedBorderColor" );
+	protected final Color customBorderColor = UIManager.getColor( "Component.custom.borderColor" );
+
 	@Override
 	public void paintBorder( Component c, Graphics g, int x, int y, int width, int height ) {
 		Graphics2D g2 = (Graphics2D) g.create();
@@ -76,22 +90,48 @@ public class FlatBorder
 			float focusWidth = isCellEditor ? 0 : scale( (float) getFocusWidth( c ) );
 			float borderWidth = scale( (float) getBorderWidth( c ) );
 			float arc = isCellEditor ? 0 : scale( (float) getArc( c ) );
+			Color outlineColor = getOutlineColor( c );

-			if( isFocused( c ) ) {
+			if( outlineColor != null || isFocused( c ) ) {
 				float innerFocusWidth = !(c instanceof JScrollPane) ? this.innerFocusWidth : 0;

-				g2.setColor( getFocusColor( c ) );
+				g2.setColor( (outlineColor != null) ? outlineColor : getFocusColor( c ) );
 				FlatUIUtils.paintComponentOuterBorder( g2, x, y, width, height, focusWidth,
 					scale( (float) getLineWidth( c ) ) + scale( innerFocusWidth ), arc );
 			}

-			g2.setPaint( getBorderColor( c ) );
+			g2.setPaint( (outlineColor != null) ? outlineColor : getBorderColor( c ) );
 			FlatUIUtils.paintComponentBorder( g2, x, y, width, height, focusWidth, borderWidth, arc );
 		} finally {
 			g2.dispose();
 		}
 	}

+	protected Color getOutlineColor( Component c ) {
+		if( !(c instanceof JComponent) )
+			return null;
+
+		Object outline = ((JComponent)c).getClientProperty( FlatClientProperties.OUTLINE );
+		if( outline instanceof String ) {
+			switch( (String) outline ) {
+				case FlatClientProperties.OUTLINE_ERROR:
+					return isFocused( c ) ? errorFocusedBorderColor : errorBorderColor;
+
+				case FlatClientProperties.OUTLINE_WARNING:
+					return isFocused( c ) ? warningFocusedBorderColor : warningBorderColor;
+			}
+		} else if( outline instanceof Color ) {
+			Color color = (Color) outline;
+			// use color functions to compute color for unfocused state
+			if( !isFocused( c ) && customBorderColor instanceof DerivedColor )
+				color = ((DerivedColor)customBorderColor).derive( color );
+			return color;
+		} else if( outline instanceof Color[] && ((Color[])outline).length >= 2 )
+			return ((Color[])outline)[isFocused( c ) ? 0 : 1];
+
+		return null;
+	}
+
 	protected Color getFocusColor( Component c ) {
 		return focusColor;
 	}
--- a/flatlaf-core/src/main/resources/com/formdev/flatlaf/FlatDarkLaf.properties
+++ b/flatlaf-core/src/main/resources/com/formdev/flatlaf/FlatDarkLaf.properties
@@ -130,6 +130,12 @@ Component.focusColor=#3d6185
 Component.linkColor=#589df6
 Component.grayFilter=-20,-70,100

+Component.error.borderColor=desaturate($Component.error.focusedBorderColor,25%)
+Component.error.focusedBorderColor=#8b3c3c
+Component.warning.borderColor=darken(desaturate($Component.warning.focusedBorderColor,20%),10%)
+Component.warning.focusedBorderColor=#ac7920
+Component.custom.borderColor=desaturate(#f00,50%,relative derived)
+

 #---- Desktop ----

--- a/flatlaf-core/src/main/resources/com/formdev/flatlaf/FlatLightLaf.properties
+++ b/flatlaf-core/src/main/resources/com/formdev/flatlaf/FlatLightLaf.properties
@@ -132,6 +132,12 @@ Component.focusColor=#97c3f3
 Component.linkColor=#2470B3
 Component.grayFilter=25,-25,100

+Component.error.borderColor=lighten(desaturate($Component.error.focusedBorderColor,20%),25%)
+Component.error.focusedBorderColor=#e53e4d
+Component.warning.borderColor=lighten(saturate($Component.warning.focusedBorderColor,25%),20%)
+Component.warning.focusedBorderColor=#e2a53a
+Component.custom.borderColor=lighten(desaturate(#f00,20%,derived),25%,derived)
+

 #---- Desktop ----