Swing focus

Небольшой рецепт для авторов собственных Swing компонентов.

Свои компоненты, как правило, наследуются непосредственно от JComponent. Самый простой компонент выглядит так:

JComponent comp = new JComponent(){};

Немного усложним задачу: предположим, нам нужно создать компонент, который должен получать уведомления о событиях клавиатуры. Нет ничего проще: в JComponent’е есть метод addKeyListener, который позволяет реализовать этот функционал:

class KeyAwareComponent extends JComponent implements KeyListener {

	public KeyAwareComponent() {
		addKeyListener(this);
	}

	public void keyPressed(KeyEvent e) {
		System.out.println("Key Pressed");
	}

	public void keyReleased(KeyEvent e) {}

	public void keyTyped(KeyEvent e) {}
}

Можно теперь добавить этот компонент на фрейм и порадоваться тому, как замечательно он игнорирует любые нажатия клавиш.

Проблема заключается в том, что Swing передает события клавиатуры компоненту, который в данный момент держит фокус. А JComponent по умолчанию вообще на фокус не претендует (другими словами, система передачи фокуса игнорирует этот компонент). Для полноты картины, следует заметить, что события мыши передаются в любом случае. То есть, если все взаимодействие с компонентом будет осуществляться мышью, то фокусничать не придется.

Решается проблема просто: в конструктор компонента нужно добавить еще одну строку:

class KeyAwareComponent extends JComponent implements KeyListener {

	public KeyAwareComponent() {
		addKeyListener(this);
		setFocusable(true);
	}

	...
}

Теперь компонент будет бодро отзываться на нажатия клавиш. Осталась вторая проблема: перейти на компонент можно только клавишей Tab. По умолчанию клик по компоненту не является поводом передать ему фокус. Берем в руки напильник и “доводим до готовности” код:

class KeyAwareComponent extends JComponent
	implements KeyListener, MouseListener {

	public KeyAwareComponent() {
		addKeyListener(this);
		addMouseListener(this);
		setFocusable(true);
	}

	public void keyPressed(KeyEvent e) {
		System.out.println("Key Pressed");
	}

	public void mouseClicked(MouseEvent e) {
		requestFocusInWindow();
	}

	// Тут - пустые методы, которые нас обязывают переопределить
	// интерфейсы
}

Этот метод наиболее понятен и прост. Если есть желание поэкспериментировать, можно почитать tutorial от Sun и достичь того же эффекта несколько другим способом: добавить в inputMap компонента некоторый элемент:

class KeyAwareComponent extends JComponent
	implements KeyListener {

	public KeyAwareComponent() {
		addKeyListener(this);
		getInputMap(WHEN_FOCUSED).put(
			KeyStroke.getKeyStroke(KeyEvent.VK_INSERT, 0),
			"someAction");
	}

	// Тут - пустые методы, которые нас обязывает переопределить
	// KeyListener
}

Кода существенно меньше, работает так же хорошо, как и первый метод, но не так очевидно достигает нужного результата.
Вот полезные ссылки по теме:

http://java.sun.com/docs/books/tutorial/uiswing/misc/focus.html
http://java.sun.com/docs/books/tutorial/uiswing/misc/keybinding.html