TextField, FormattedTextField and PasswordField: select all text when a text field gains focus for the first time and selection was not set explicitly

flatlaf-core/src/main/java/com/formdev/flatlaf/FlatClientProperties.java

@@ -141,10 +141,44 @@ public interface FlatClientProperties
 	 */
 	String TABBED_PANE_TAB_HEIGHT = "JTabbedPane.tabHeight";
 
+	/**
+	 * Specifies whether all text is selected when the text component gains focus.
+	 * <p>
+	 * <strong>Component</strong> {@link javax.swing.JTextField} (and subclasses)<br>
+	 * <strong>Value type</strong> {@link java.lang.String}<br>
+	 * <strong>Allowed Values</strong> {@link #SELECT_ALL_ON_FOCUS_POLICY_NEVER},
+	 * {@link #SELECT_ALL_ON_FOCUS_POLICY_ONCE} (default) or
+	 * {@link #SELECT_ALL_ON_FOCUS_POLICY_ALWAYS}
+	 */
+	String SELECT_ALL_ON_FOCUS_POLICY = "JTextField.selectAllOnFocusPolicy";
+
+	/**
+	 * Never select all text when the text component gains focus.
+	 *
+	 * @see #SELECT_ALL_ON_FOCUS_POLICY
+	 */
+	String SELECT_ALL_ON_FOCUS_POLICY_NEVER = "never";
+
+	/**
+	 * Select all text when the text component gains focus for the first time
+	 * and selection was not modified (is at end of text).
+	 * This is the default.
+	 *
+	 * @see #SELECT_ALL_ON_FOCUS_POLICY
+	 */
+	String SELECT_ALL_ON_FOCUS_POLICY_ONCE = "once";
+
+	/**
+	 * Always select all text when the text component gains focus.
+	 *
+	 * @see #SELECT_ALL_ON_FOCUS_POLICY
+	 */
+	String SELECT_ALL_ON_FOCUS_POLICY_ALWAYS = "always";
+
 	/**
 	 * Placeholder text that is only painted if the text field is empty.
 	 * <p>
-	 * <strong>Component</strong> {@link javax.swing.JTextField} or {@link javax.swing.JComboBox}<br>
+	 * <strong>Component</strong> {@link javax.swing.JTextField} (and subclasses) or {@link javax.swing.JComboBox}<br>
 	 * <strong>Value type</strong> {@link java.lang.String}
 	 */
 	String PLACEHOLDER_TEXT = "JTextField.placeholderText";

flatlaf-core/src/main/java/com/formdev/flatlaf/ui/FlatCaret.java

@@ -0,0 +1,128 @@
+/*
+ * Copyright 2020 FormDev Software GmbH
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     https://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package com.formdev.flatlaf.ui;
+
+import static com.formdev.flatlaf.FlatClientProperties.*;
+import java.awt.EventQueue;
+import java.awt.event.FocusEvent;
+import java.awt.event.MouseEvent;
+import javax.swing.JFormattedTextField;
+import javax.swing.plaf.UIResource;
+import javax.swing.text.DefaultCaret;
+import javax.swing.text.Document;
+import javax.swing.text.JTextComponent;
+
+/**
+ * Caret that can select all text on focus gained.
+ *
+ * @author Karl Tauber
+ */
+class FlatCaret
+	extends DefaultCaret
+	implements UIResource
+{
+	private final String selectAllOnFocusPolicy;
+
+	private boolean wasFocused;
+	private boolean wasTemporaryLost;
+	private boolean isMousePressed;
+
+	FlatCaret( String selectAllOnFocusPolicy ) {
+		this.selectAllOnFocusPolicy = selectAllOnFocusPolicy;
+	}
+
+	@Override
+	public void install( JTextComponent c ) {
+		super.install( c );
+
+		// the dot and mark are lost when switching LaF
+		// --> move dot to end of text so that all text may be selected when it gains focus
+		Document doc = c.getDocument();
+		if( doc != null && getDot() == 0 && getMark() == 0 ) {
+			int length = doc.getLength();
+			if( length > 0 )
+				setDot( length );
+		}
+	}
+
+	@Override
+	public void focusGained( FocusEvent e ) {
+		if( !wasTemporaryLost && !isMousePressed )
+			selectAllOnFocusGained();
+		wasTemporaryLost = false;
+		wasFocused = true;
+
+		super.focusGained( e );
+	}
+
+	@Override
+	public void focusLost( FocusEvent e ) {
+		wasTemporaryLost = e.isTemporary();
+		super.focusLost( e );
+	}
+
+	@Override
+	public void mousePressed( MouseEvent e ) {
+		isMousePressed = true;
+		super.mousePressed( e );
+	}
+
+	@Override
+	public void mouseReleased( MouseEvent e ) {
+		isMousePressed = false;
+		super.mouseReleased( e );
+	}
+
+	private void selectAllOnFocusGained() {
+		JTextComponent c = getComponent();
+		Document doc = c.getDocument();
+		if( doc == null || !c.isEnabled() || !c.isEditable() )
+			return;
+
+		Object selectAllOnFocusPolicy = c.getClientProperty( SELECT_ALL_ON_FOCUS_POLICY );
+		if( selectAllOnFocusPolicy == null )
+			selectAllOnFocusPolicy = this.selectAllOnFocusPolicy;
+
+		if( SELECT_ALL_ON_FOCUS_POLICY_NEVER.equals( selectAllOnFocusPolicy ) )
+			return;
+
+		if( !SELECT_ALL_ON_FOCUS_POLICY_ALWAYS.equals( selectAllOnFocusPolicy ) ) {
+			// policy is "once" (or null or unknown)
+
+			// was already focused?
+			if( wasFocused )
+				return;
+
+			// check whether selection was modified before gaining focus
+			int dot = getDot();
+			int mark = getMark();
+			if( dot != mark || dot != doc.getLength() )
+				return;
+		}
+
+		// select all
+		if( c instanceof JFormattedTextField ) {
+			EventQueue.invokeLater( () -> {
+				setDot( 0 );
+				moveDot( doc.getLength() );
+			} );
+		} else {
+			setDot( 0 );
+			moveDot( doc.getLength() );
+		}
+	}
+}

flatlaf-core/src/main/java/com/formdev/flatlaf/ui/FlatFormattedTextFieldUI.java

@@ -43,6 +43,7 @@ import javax.swing.plaf.ComponentUI;
  * @uiDefault Component.minimumWidth					int
  * @uiDefault Component.isIntelliJTheme					boolean
  * @uiDefault FormattedTextField.placeholderForeground	Color
+ * @uiDefault TextComponent.selectAllOnFocusPolicy		String	never, once (default) or always
  *
  * @author Karl Tauber
  */

flatlaf-core/src/main/java/com/formdev/flatlaf/ui/FlatPasswordFieldUI.java

@@ -27,6 +27,7 @@ import javax.swing.LookAndFeel;
 import javax.swing.UIManager;
 import javax.swing.plaf.ComponentUI;
 import javax.swing.plaf.basic.BasicPasswordFieldUI;
+import javax.swing.text.Caret;
 import com.formdev.flatlaf.FlatClientProperties;
 import com.formdev.flatlaf.util.SystemInfo;
 
@@ -55,6 +56,7 @@ import com.formdev.flatlaf.util.SystemInfo;
  * @uiDefault Component.minimumWidth				int
  * @uiDefault Component.isIntelliJTheme				boolean
  * @uiDefault PasswordField.placeholderForeground	Color
+ * @uiDefault TextComponent.selectAllOnFocusPolicy	String	never, once (default) or always
  *
  * @author Karl Tauber
  */
@@ -116,6 +118,11 @@ public class FlatPasswordFieldUI
 		focusListener = null;
 	}
 
+	@Override
+	protected Caret createCaret() {
+		return new FlatCaret( UIManager.getString( "TextComponent.selectAllOnFocusPolicy" ) );
+	}
+
 	@Override
 	protected void propertyChange( PropertyChangeEvent e ) {
 		super.propertyChange( e );

flatlaf-core/src/main/java/com/formdev/flatlaf/ui/FlatTextFieldUI.java

@@ -35,6 +35,7 @@ import javax.swing.UIManager;
 import javax.swing.plaf.ComponentUI;
 import javax.swing.plaf.UIResource;
 import javax.swing.plaf.basic.BasicTextFieldUI;
+import javax.swing.text.Caret;
 import javax.swing.text.JTextComponent;
 import com.formdev.flatlaf.FlatClientProperties;
 
@@ -62,6 +63,7 @@ import com.formdev.flatlaf.FlatClientProperties;
  * @uiDefault Component.minimumWidth			int
  * @uiDefault Component.isIntelliJTheme			boolean
  * @uiDefault TextField.placeholderForeground	Color
+ * @uiDefault TextComponent.selectAllOnFocusPolicy	String	never, once (default) or always
  *
  * @author Karl Tauber
  */
@@ -119,6 +121,11 @@ public class FlatTextFieldUI
 		focusListener = null;
 	}
 
+	@Override
+	protected Caret createCaret() {
+		return new FlatCaret( UIManager.getString( "TextComponent.selectAllOnFocusPolicy" ) );
+	}
+
 	@Override
 	protected void propertyChange( PropertyChangeEvent e ) {
 		super.propertyChange( e );

flatlaf-core/src/main/resources/com/formdev/flatlaf/FlatLaf.properties

@@ -407,6 +407,12 @@ TextArea.margin=@textComponentMargin
 TextArea.background=@textComponentBackground
 
 
+#---- TextComponent ----
+
+# allowed values: "never", "once" (default) or "always"
+TextComponent.selectAllOnFocusPolicy=once
+
+
 #---- TextField ----
 
 TextField.border=com.formdev.flatlaf.ui.FlatBorder