Laf-Widget client properties

Client property name

Description

Client property name for specifying that the text component contents should flip selection on ESCAPE key press. This property can be set on a single text component. The value should be either Boolean.TRUE or Boolean.FALSE.

See also

• TEXT_SELECT_ON_FOCUS client property.

Sample code

import java.awt.BorderLayout;
import java.awt.FlowLayout;
import java.awt.event.ActionEvent;
import java.awt.event.ActionListener;

import javax.swing.JCheckBox;
import javax.swing.JFrame;
import javax.swing.JPanel;
import javax.swing.JTextField;
import javax.swing.SwingUtilities;

import org.pushingpixels.lafwidget.LafWidget;
import org.pushingpixels.substance.api.SubstanceLookAndFeel;
import org.pushingpixels.substance.api.skin.BusinessBlackSteelSkin;

/**
 * Test application that shows the use of the
 * {@link LafWidget#TEXT_FLIP_SELECT_ON_ESCAPE} client property.
 * 
 * @author Kirill Grouchnikov
 * @see LafWidget#TEXT_FLIP_SELECT_ON_ESCAPE
 */
public class TextFlipSelectOnEscape extends JFrame {
  /**
   * Creates the main frame for <code>this</code> sample.
   */
  public TextFlipSelectOnEscape() {
    super("Text flip select on ESC");

    this.setLayout(new BorderLayout());

    final JTextField jtf = new JTextField("sample text");
    jtf.setColumns(20);

    JPanel main = new JPanel(new FlowLayout(FlowLayout.CENTER));
    this.add(main, BorderLayout.CENTER);
    main.add(jtf);

    JPanel controls = new JPanel(new FlowLayout(FlowLayout.RIGHT));

    final JCheckBox hasSelectOnFocus = new JCheckBox(
        "Has \"flip select on ESC\" behaviour");
    hasSelectOnFocus.addActionListener(new ActionListener() {
      public void actionPerformed(ActionEvent e) {
        jtf.putClientProperty(LafWidget.TEXT_FLIP_SELECT_ON_ESCAPE,
            hasSelectOnFocus.isSelected() ? Boolean.TRUE : null);
      }
    });

    controls.add(hasSelectOnFocus);
    this.add(controls, BorderLayout.SOUTH);

    this.setSize(400, 200);
    this.setLocationRelativeTo(null);
    this.setDefaultCloseOperation(JFrame.EXIT_ON_CLOSE);
  }

  /**
   * The main method for <code>this</code> sample. The arguments are ignored.
   * 
   * @param args
   *            Ignored.
   * @throws Exception
   *             If some exception occured. Note that there is no special
   *             treatment of exception conditions in <code>this</code> sample
   *             code.
   */
  public static void main(String[] args) throws Exception {
    JFrame.setDefaultLookAndFeelDecorated(true);
    SwingUtilities.invokeLater(new Runnable() {
      public void run() {
        SubstanceLookAndFeel.setSkin(new BusinessBlackSteelSkin());
        new TextFlipSelectOnEscape().setVisible(true);
      }
    });
  }
}

The screenshot below shows a text field when this property is set to Boolean.TRUE. Initially, a portion of text field is selected (note the location of the caret):

After pressing the ESCAPE key, the selection is cleared. Note that the caret location hasn't changed:

After pressing the ESCAPE key again, the entire contents of the text field is selected. Note that the caret location is at the end of the document: