TITLE:JTextFieldにフォーカスと文字列が無い場合の表示
#navi(../)
#tags(JTextField, Focus, FocusListener)
RIGHT:Posted by &author(aterai); at 2005-11-07
* JTextFieldにフォーカスと文字列が無い場合の表示 [#m17af070]
`JTextField`にフォーカスが無く文字列が空の場合、薄い色でその説明を表示します。

#download
#ref(https://lh6.googleusercontent.com/_9Z4BYR88imo/TQTNY3BG1nI/AAAAAAAAAas/YJB5L9kNK-c/s800/GhostText.png)

** サンプルコード [#lf2627f8]
#code(link){{
class HintTextFocusListener implements FocusListener {
  Color INACTIVE_COLOR = UIManager.getColor("TextField.inactiveForeground");
  Color ORIGINAL_COLOR = UIManager.getColor("TextField.foreground");
  private final String hintMessage;
  public HintTextFocusListener(final JTextComponent tf) {
    hintMessage = tf.getText();
    tf.setForeground(INACTIVE_COLOR);
  }
  @Override public void focusGained(final FocusEvent e) {
    JTextComponent textField = (JTextComponent)e.getSource();
    String str = textField.getText();
    Color col  = textField.getForeground();
    if(hintMessage.equals(str) && INACTIVE_COLOR.equals(col)) {
      textField.setForeground(ORIGINAL_COLOR);
      textField.setText("");
    }
  }
  @Override public void focusLost(final FocusEvent e) {
    JTextComponent textField = (JTextComponent)e.getSource();
    String str = textField.getText().trim();
    if("".equals(str)) {
      textField.setForeground(INACTIVE_COLOR);
      textField.setText(hintMessage);
    }
  }
}
}}

** 解説 [#r832c3b6]
上記のサンプルでは、下の`JTextField`からフォーカスが失われた時、まだ何も入力されていない場合は、その`JTextField`の説明などを薄く表示することができるようにしています。

----
`JDK 1.7.0`以上の場合は、`JLayer`を使用して同様にヒント文字列を描画することができます。

#code{{
class PlaceholderLayerUI extends LayerUI<JTextComponent> {
  private static final Color INACTIVE = UIManager.getColor("TextField.inactiveForeground");
  private final JLabel hint;
  public PlaceholderLayerUI(String hintMessage) {
    super();
    this.hint = new JLabel(hintMessage);
    hint.setForeground(INACTIVE);
  }
  @Override public void paint(Graphics g, JComponent c) {
    super.paint(g, c);
    if (c instanceof JLayer) {
      JLayer jlayer = (JLayer) c;
      JTextComponent tc = (JTextComponent) jlayer.getView();
      if (tc.getText().length() == 0 && !tc.hasFocus()) {
        Graphics2D g2 = (Graphics2D) g.create();
        g2.setPaint(INACTIVE);
        Insets i = tc.getInsets();
        Dimension d = hint.getPreferredSize();
        SwingUtilities.paintComponent(g2, hint, tc, i.left, i.top, d.width, d.height);
        g2.dispose();
      }
      tc.repaint();
    }
  }
}
}}
** 参考リンク [#o0c01026]
- [[JTextFieldに透かし画像を表示する>Swing/WatermarkInTextField]]
- [[JPasswordFieldにヒント文字列を描画する>Swing/InputHintPasswordField]]
-- `JPasswordField`の場合は、`setText`などが使えないので、透かし画像と同じ要領で`paintComponent`をオーバーライドして文字列を描画する方法を使います。

** コメント [#h0951933]
- タイトルを変更?: `Input Hint`、`Placeholder`、`Watermark` ... -- [[aterai]] &new{2009-11-17 (火) 15:48:18};

#comment