• 追加された行はこの色です。
  • 削除された行はこの色です。
TITLE:JComboBoxの内余白
#navi(../)
*JComboBoxの内余白 [#s9f3687d]
Posted by [[terai]] at 2007-05-28
---
category: swing
folder: PaddingComboBox
title: JComboBoxの内余白
tags: [JComboBox, Border, LookAndFeel, JTextField]
author: aterai
pubdate: 2007-05-28T05:42:18+09:00
description: JComboBoxのエディタなどに内余白を設定します。
image: https://lh3.googleusercontent.com/_9Z4BYR88imo/TQTQv1E_b9I/AAAAAAAAAgE/nxvnwwFoDyU/s800/PaddingComboBox.png
---
* 概要 [#summary]
`JComboBox`のエディタなどに内余白を設定します。

#contents
#download(https://lh3.googleusercontent.com/_9Z4BYR88imo/TQTQv1E_b9I/AAAAAAAAAgE/nxvnwwFoDyU/s800/PaddingComboBox.png)

**概要 [#k7f3f4d5]
JComboBoxのエディタなどに内余白を設定します。
* サンプルコード [#sourcecode]
#code(link){{
static Border padding = BorderFactory.createEmptyBorder(0, 5, 0, 0);
// ...
DefaultComboBoxModel<String> model = new DefaultComboBoxModel<>();
model.addElement("aaaaaaaaaaaaaaaaaaaaaaaaa");
model.addElement("aaaabbb");
model.addElement("aaaabbbcc");
model.addElement("bbb1");
model.addElement("bbb12");

-&jnlp;
-&jar;
-&zip;

#screenshot

**サンプルコード [#o79d2c4d]
#code{{
Border padding = BorderFactory.createEmptyBorder(0,5,0,0);
ListCellRenderer lcr = combo.getRenderer();
((JLabel)lcr).setBorder(padding);
combo.setRenderer(lcr);
JComboBox<String> combo = new JComboBox<String>(model) {
  @Override public void updateUI() {
    setRenderer(null);
    super.updateUI();
    ListCellRenderer<? super String> lcr = getRenderer();
    setRenderer(new ListCellRenderer<String>() {
      @Override public Component getListCellRendererComponent(
          JList<? extends String> list, String value, int index,
          boolean isSelected, boolean hasFocus) {
        JLabel l = (JLabel) lcr.getListCellRendererComponent(
            list, value, index, isSelected, hasFocus);
        l.setBorder(padding);
        return l;
      }
    });
    // XXX JDK 1.7.0 ?: ((JLabel) lcr).setBorder(padding);
  }
};
}}

**解説 [#ra0eef84]
上記のサンプルでは、JComboBox に、Border((チェックボックスで、EmptyBorderとMatteBorder切り替えることで、余白などを可視化することができます))を設定したListCellRendererを設定して、ドロップダウンリストの左余白をすこし広げています。
JComboBoxが編集不可の場合、エディタ部分もこの余白が自動的に適用されます。
* 解説 [#explanation]
上記のサンプルでは、`JComboBox`に`Border`(`EmptyBorder`と`MatteBorder`を切り替え可能)を設定した`ListCellRenderer`を設定して、ドロップダウンリストの左余白をすこし広げています。`JComboBox`が編集不可の場合、エディタ部分もこの余白が自動的に適用されます。

-0:編集不可
-- ListCellRendererで余白を指定
- `0`:編集不可
-- `ListCellRenderer`で余白を指定

----
以下は、JComboBoxが編集可の場合のテストです。

-1: テキストフィールドの元Border + 任意のBorderで余白を設定
-- editor.setBorder(BorderFactory.createCompoundBorder(editor.getBorder(), padding));
-- JComboBox#getEditor()#getEditorComponent()で取得したJTextFieldに余白を指定
-- JDK 1.5 では余白を指定しても反映されない
-- JDK 1.6 では取得したJTextFieldをsetOpaque(true)としないと背景色は反映されない
- `1`: `JComboBox`が編集可 + テキストフィールドの元`Border` + 任意の`Border`で余白を設定
-- `editor.setBorder(BorderFactory.createCompoundBorder(editor.getBorder(), padding));`
-- `JComboBox#getEditor()#getEditorComponent()`で取得した`JTextField`に余白を指定
-- `JDK 1.5`では余白を指定しても反映されない
-- `JDK 1.6`では取得した`JTextFieldをsetOpaque(true)`としないと背景色は反映されない

-2: テキストフィールドの元Borderは無視して任意のBorderのみで余白を設定
-- editor.setBorder(padding);
-- JComboBox#getEditor()#getEditorComponent()で取得したJTextFieldに余白を指定
-- Metal L&F でテキストフィールドの枠が描画できない
- `2`: `JComboBox`が編集可 + テキストフィールドの元`Border`は無視して任意の`Border`のみで余白を設定
-- `editor.setBorder(padding);`
-- `JComboBox#getEditor()#getEditorComponent()`で取得した`JTextField`に余白を指定
-- `MetalLookAndFeel`でテキストフィールドの枠が描画できない

----

-3: テキストフィールドのInsets + 5ピクセル余白を設定
-- editor.setMargin(new Insets(i.top,i.left+5,i.bottom,i.right));
-- Metal, Motif, Windows L&F などでは無効
-- Nimbus L&F では有効だが、JComboBoxの高さなども変化してしまう
- `3`: `JComboBox`が編集可 + テキストフィールドの`Insets` + `5`ピクセル余白を設定
-- `editor.setMargin(new Insets(i.top,i.left+5,i.bottom,i.right));`
-- `MetalLookAndFeel`、`MotifLookAndFeel`、`WindowsLookAndFeel`などでは無効
-- `NimbusLookAndFeel`では有効だが`JComboBox`の高さなども変化してしまう

-4: テキストフィールドのMargin + 5ピクセル余白を設定
-- editor.setMargin(new Insets(m.top,m.left+5,m.bottom,m.right));
-- Metal, Motif, Windows L&F などでは無効
-- Nimbus L&F では有効
- `4`: `JComboBox`が編集可 + テキストフィールドの`Margin` + `5`ピクセル余白を設定
-- `editor.setMargin(new Insets(m.top,m.left+5,m.bottom,m.right));`
-- `MetalLookAndFeel`、`MotifLookAndFeel`、`WindowsLookAndFeel`などでは無効
-- `NimbusLookAndFeel`では有効

----

-5: JComboBoxのBorder + 任意のBorderで余白をJComboBox自身に設定
-- JComboBox#setBorder()で、元のBorderの内側に余白を指定
-- Windows, Motif L&F で有効?
-- Metal, Nimbus L&F では、JComboBoxの外側に余白が付く
- `5`: `JComboBox`が編集可 + `JComboBox`の`Border` + 任意の`Border`で余白を`JComboBox`自身に設定
-- `JComboBox#setBorder()`で元の`Border`の内側に余白を指定
-- `WindowsLookAndFeel`、`MotifLookAndFeel`で有効?
-- `MetalLookAndFeel`、`NimbusLookAndFeel`では`JComboBox`の外側に余白が付く

-6: JComboBoxのBorder + 任意のBorderで余白をJComboBox自身に設定
-- JComboBox#setBorder()で、元のBorderの外側に余白を指定
-- Windows L&F で余計な枠が表示される?
- `6`: `JComboBox`が編集可 + `JComboBox`の`Border` + 任意の`Border`で余白を`JComboBox`自身に設定
-- `JComboBox#setBorder()`で元の`Border`の外側に余白を指定
-- `WindowsLookAndFeel`で余計な枠が表示される?

----
//以下のようにエディタにMarginを指定しても無視されるようです。
//#code{{
//editor = (JTextField) combo.getEditor().getEditorComponent();
//Insets m = editor.getMargin();
//Insets margin = new Insets(m.top,m.left+10,m.bottom,m.right);
////System.out.println(margin.toString());
//editor.setMargin(margin);
//}}
//-追記
//--無視されるのは、Basic L&F系(Windows L&Fなど)で、Synth L&F系(Nimbus, GTK L&Fなど)では上記の設定は有効になる? 
//--1.6.0_10-beta-b13 では、%%Basic L&F系は%% どちらも、UIManager.put("ComboBox.padding", insets) が使用できる?

その他にも、以下のように余白を設定する方法もありますが、L&F によって対応が異なるようです。
- %%その他にも、以下のように`UIManager`で余白を設定する方法もあるが`LookAndFeel`によって対応が異なる?%% `ComboBox.padding`は無くなっている?
-- `JComboBox`が編集可能の場合は`ComboBox.editorBorder`が有効かもしれない
#code{{
UIManager.put("ComboBox.padding", insets);
// UIManager.put("ComboBox.padding", new InsetsUIResource(insets));
UIManager.put("ComboBox.editorBorder", BorderFactory.createEmptyBorder(0, 5, 0, 0));
}}

- %%上記のサンプルを余白に色無しにして`Ubuntu 7.04`(`GNOME 2.18.1`)、`JDK 1.6.0`で実行すると、以下のように表示される%%
#ref(https://lh4.googleusercontent.com/_9Z4BYR88imo/TQTQyV_2TnI/AAAAAAAAAgI/yqGoi_zqsgI/s800/PaddingComboBox1.png)

----
上記のサンプルを、余白に色無しにして、Ubuntu 7.04(GNOME 2.18.1) JDK 1.6.0 で実行すると、以下のようになります。
#screenshot(,screenshot1.png)
- `LookAndFeel`毎に`JComboBox`の余白の描画は異なるみたいなので、全部まとめて消すのは難しい?
- `BasicComboBoxUI`も、`ComboBox.buttonDarkShadow`が`ArrowButton`の三角とボタンの影に使われていて微妙
-- `BasicComboBoxUI#createArrowButton()`をオーバーライドして別途三角形アイコンを使う方がよさそう
-- コードは、[[JComboBoxのBorderを変更する>Swing/ComboBoxBorder]]に移動

**参考リンク [#w8434b1f]
-[[JComboBoxにアイコンを表示>Swing/IconComboBox]]
* 参考リンク [#reference]
- [[JComboBoxにアイコンを表示>Swing/IconComboBox]]
- [https://bugs.openjdk.org/browse/JDK-4515838 JDK-4515838 Can't change the border of a JComboBox - Java Bug System]
- [https://bugs.openjdk.org/browse/JDK-8179027 JDK-8179027 JComboBox too small under Windows LAF - Java Bug System]
-- 上記のスクリーンショットのような`WindowsLookAndFeel`で`JComboBox`の高さが小さすぎる件が修正される?

**コメント [#df84d3cd]
- なんだか、よく分からなくなってきましたorz。 -- [[terai]] &new{2008-03-11 (火) 21:38:58};
- L&F の切り替えなどを追加しました。 -- [[terai]] &new{2008-04-02 (水) 20:08:01};
* コメント [#comment]
#comment
- %%なんだか、よく分からなくなってきましたorz。%% `JDK 1.6.0_10-beta-b22`で、`BasicComboBoxUI`の`padding`にすこし修正が入っている?ようです。 -- &user(aterai); &new{2008-03-11 (火) 21:38:58};
- `LookAndFeel`の切り替えなどを追加しました。 -- &user(aterai); &new{2008-04-02 (水) 20:08:01};
- `1.7.0_06`で`Nimbus`などの`ComboBox.popupInsets`が修正? [https://bugs.openjdk.org/browse/JDK-7158712 Bug ID: 7158712 Synth Property "ComboBox.popupInsets" is ignored] -- &user(aterai); &new{2012-08-15 (水) 13:58:34};
- `Windows 7`の`LookAndFeel`、編集不可の`JComboBox`で、`((JLabel) combo.getRenderer() ).setBorder(padding);`が`JComboBox`本体に効かない(フォーカスのための`Border`のせい?)ため、セルレンダラーを作成して毎回余白を適用するように変更。このため、`Windows 7`の`LookAndFeel`では、`JComboBox`本体の点線によるフォーカス表示が無くなる。 -- &user(aterai); &new{2013-11-19 (火) 15:37:19};

#comment