ComboBoxEditorにJLayerを設定してプレースホルダ文字列を表示する

Summary

JComboBoxのComboBoxEditorにJLayerを設定し、そのテキストが空の場合はプレースホルダ文字列を表示します。

Screenshot

Download

• Runnable JAR example.jar
• Source code src.zip
• Repository GitHub

Source Code Examples

combo2.setEditor(new BasicComboBoxEditor() {
  private Component editorComponent;

  @Override public Component getEditorComponent() {
    editorComponent = Optional.ofNullable(editorComponent)
        .orElseGet(() -> {
          JTextComponent tc = (JTextComponent) super.getEditorComponent();
          return new JLayer<>(tc, new PlaceholderLayerUI<>("- Select type -"));
        });
    return editorComponent;
  }
});
combo2.setBorder(BorderFactory.createCompoundBorder(
    combo2.getBorder(),
    BorderFactory.createEmptyBorder(0, 2, 0, 0)));

Description

• 上:
  • デフォルトの編集可能なJComboBox
  • 編集可能なJComboBoxの場合は、JComboBoxでアイテムが選択されていない場合のプレースホルダ文字列を設定するのようにセルレンダラーを使用したプレースホルダ文字列の表示は不可
• 下:
  • 編集可能に設定したJComboBoxにプレースホルダ文字列を表示するJLayerでラップしたJTextFieldを生成するComboBoxEditorを設定
  • BasicComboBoxEditor#getEditorComponent()はエディタとしてComponentを返すためJLayerでラップしたJTextFieldを使用可能
    • BasicComboBoxEditor#createEditorComponent()はJTextFieldを返すため、こちらをオーバーライドする場合はJTextFieldにフォーカスと文字列が無い場合の表示などのようにFocusListenerを使用する必要がある
  • WindowsLookAndFeelでエディタの内余白が適用されない場合がある？ためJComboBox本体の縁を変更
    • このため、他のLookAndFeelに切り替えると縁や内余白がおかしくなる

Reference

• JComboBoxでアイテムが選択されていない場合のプレースホルダ文字列を設定する
• ComboBoxEditorにJLayerを設定し入力の妥当性を表示する

Comment