• 追加された行はこの色です。
  • 削除された行はこの色です。
#navi(../)
*JComboBoxにJSeparatorを挿入 [#xfede4a1]
>編集者:[[Terai Atsuhiro>terai]]~
作成日:2005-08-29~
更新日:&lastmod;
---
category: swing
folder: ComboBoxSeparator
title: JComboBoxにJSeparatorを挿入
tags: [JComboBox, JSeparator, ListCellRenderer, ItemListener, ActionMap, InputMap]
author: aterai
pubdate: 2005-08-29T00:43:58+09:00
description: JComboBoxに選択できないJSeparatorを挿入します。
image: https://lh3.googleusercontent.com/_9Z4BYR88imo/TQTJt9fH4ZI/AAAAAAAAAU0/c9vovQi9Jvo/s800/ComboBoxSeparator.png
---
* 概要 [#summary]
`JComboBox`に選択できない`JSeparator`を挿入します。

#contents
#download(https://lh3.googleusercontent.com/_9Z4BYR88imo/TQTJt9fH4ZI/AAAAAAAAAU0/c9vovQi9Jvo/s800/ComboBoxSeparator.png)

**概要 [#r7a518c4]
JComboBoxに選択できないJSeparatorを挿入します。
* サンプルコード [#sourcecode]
#code(link){{
JComboBox<Object> combo = new JComboBox<>();
combo.setRenderer(new DefaultListCellRenderer() {
  @Override public Component getListCellRendererComponent(
      JList list, Object value, int index, boolean isSelected, boolean cellHasFocus) {
    if (value instanceof JSeparator) {
      return (Component) value;
    } else {
      return super.getListCellRendererComponent(
          list, value, index, isSelected, cellHasFocus);
    }
  }
});
DefaultComboBoxModel model = new DefaultComboBoxModel() {
  @Override public void setSelectedItem(Object o) {
    if (o instanceof JSeparator) {
      return;
    }
    super.setSelectedItem(o);
  }
};
model.addElement("aaaaa");
model.addElement(new JSeparator());
model.addElement("bbbbb");
combo.setModel(model);
}}

http://terai.xrea.jp/swing/comboboxseparator/screenshot.png
* 解説 [#explanation]
- `ListCellRenderer`
-- `JSeparator`が選択された場合は、セル描画`Component`として`JSeparator`を返す`ListCellRenderer`を設定
- `DefaultComboBoxModel`
-- `JSeparator`が選択された場合は何もしないよう、`setSelectedItem`メソッドをオーバーライド

**サンプルコード [#gc9aec18]
 final ListCellRenderer lcr = combobox.getRenderer();
 combobox.setRenderer(new ListCellRenderer() {
   public Component getListCellRendererComponent(JList list, Object value,
                     int index, boolean isSelected, boolean cellHasFocus) {
     if(value instanceof JSeparator) {
       return (JSeparator)value;
     }else{
       return (JLabel)lcr.getListCellRendererComponent(
                   list,value,index,isSelected,cellHasFocus);
     }
   }
 });
 DefaultComboBoxModel model = new DefaultComboBoxModel() {
   public void setSelectedItem(Object anObject) {
     if(!(anObject instanceof JSeparator)) {
       super.setSelectedItem(anObject);
     }
   }
 };
 model.addElement("aaaa");
 model.addElement(new JSeparator());
 model.addElement("bbb1");
 combobox.setModel(model);
----
- `DefaultComboBoxModel#setSelectedItem`メソッドをオーバーライドする代わりに、以下のように`JSeparator`が選択された場合はひとつ前の`Item`に戻すような`ItemListener`を追加しても同様
#code{{
combobox.addItemListener(new ItemListener() {
  private Object prev;
  @Override public void itemStateChanged(ItemEvent e) {
    if (e.getStateChange() == ItemEvent.SELECTED) {
      Object obj = e.getItem();
      if (obj instanceof JSeparator) {
        if (prev == null) {
          prev = combobox.getItemAt(0);
        }
        combobox.setSelectedItem(prev);
      } else {
        prev = obj;
      }
    }
  }
});
}}

-[[サンプルを起動>http://terai.xrea.jp/swing/comboboxseparator/sample.jnlp]]
-[[jarファイル>http://terai.xrea.jp/swing/comboboxseparator/sample.jar]]
-[[ソース>http://terai.xrea.jp/swing/comboboxseparator/src.zip]]
**解説 [#ha026ab6]
-ListCellRenderer
--JSeparatorが選択された場合は、JSeparatorにキャストして返すようなListCellRendererを設定しています。
- KBD{Up}KBD{Down}キーでの選択状態移動を可能にする(`JSeparator`なら飛ばす)場合は、以下のようなキーストロークのアクションを設定する必要がある
#code{{
Action up = new AbstractAction() {
  @Override public void actionPerformed(ActionEvent e) {
    int index = combobox.getSelectedIndex();
    if (index == 0) {
      return;
    }
    Object o = combobox.getItemAt(index - 1);
    if (o instanceof JSeparator) {
      combobox.setSelectedIndex(index - 2);
    } else {
      combobox.setSelectedIndex(index - 1);
    }
  }
};
Action down = new AbstractAction() {
  @Override public void actionPerformed(ActionEvent e) {
    int index = combobox.getSelectedIndex();
    if (index == combobox.getItemCount() - 1) {
      return;
    }
    Object o = combobox.getItemAt(index + 1);
    if (o instanceof JSeparator) {
      combobox.setSelectedIndex(index + 2);
    } else {
      combobox.setSelectedIndex(index + 1);
    }
  }
};
ActionMap am = combobox.getActionMap();
am.put("selectPrevious3", up);
am.put("selectNext3", down);
InputMap im = combobox.getInputMap(JComponent.WHEN_ANCESTOR_OF_FOCUSED_COMPONENT);
im.put(KeyStroke.getKeyStroke(KeyEvent.VK_UP, 0), "selectPrevious3");
im.put(KeyStroke.getKeyStroke(KeyEvent.VK_KP_UP, 0), "selectPrevious3");
im.put(KeyStroke.getKeyStroke(KeyEvent.VK_DOWN, 0), "selectNext3");
im.put(KeyStroke.getKeyStroke(KeyEvent.VK_KP_DOWN, 0), "selectNext3");
}}

-DefaultComboBoxModel
--JSeparatorが選択された場合は何もしないよう、setSelectedItemメソッドをオーバーライドしています。
* 参考リンク [#reference]
- [[JComboBoxのアイテムをBorderで修飾してグループ分け>Swing/BorderSeparator]]

DefaultComboBoxModel#setSelectedItemメソッドをオーバーライドする代わりに、以下のようにJSeparatorが選択された場合はひとつ前のItemに戻すようなItemListenerを追加しても同様になります。
 combobox.addItemListener(new ItemListener() {
   private Object prev;
   public void itemStateChanged(ItemEvent e) {
     if(e.getStateChange()==ItemEvent.SELECTED) {
       Object obj = e.getItem();
       if(obj instanceof JSeparator) {
         if(prev==null) prev = combobox.getItemAt(0);
         combobox.setSelectedItem(prev);
       }else{
         prev = obj;
       }
     }
   }
 });
* コメント [#comment]
#comment
- KBD{Up}KBD{Down}キーでの選択状態移動に対応しました。 -- &user(aterai); &new{2007-08-10 (金) 18:54:05};

[[プログラム板 Java低速GUI Swing 3>http://pc8.2ch.net/test/read.cgi/tech/1121700954/]]の229さんのアイデアのように、MatteBorderを使ってJSeparatorをItemとして追加しない方法もあります。
 public class MainPanel extends JPanel{
   private final JComboBox combobox = new JComboBox();
   public MainPanel() {
     final JSeparator sep = new JSeparator();
     final ListCellRenderer lcr = combobox.getRenderer();
     combobox.setRenderer(new ListCellRenderer() {
     public Component getListCellRendererComponent(
                    JList list, Object value, int index,
                    boolean isSelected, boolean cellHasFocus) {
       MyItem item = (MyItem)value;
       JLabel label = (JLabel)lcr.getListCellRendererComponent(
                         list,item,index,isSelected,cellHasFocus);
       if(item.hasSeparator()) {
         label.setBorder(
                BorderFactory.createMatteBorder(1,0,0,0,Color.gray));
         }else{
           label.setBorder(BorderFactory.createEmptyBorder());
         }
         return label;
       }
     });
     DefaultComboBoxModel model = new DefaultComboBoxModel();
     model.addElement(new MyItem("aaaa"));
     model.addElement(new MyItem("eeeeeeeee", true));
     model.addElement(new MyItem("bbb12"));
     combobox.setModel(model);
     
     setLayout(new BoxLayout(this, BoxLayout.Y_AXIS));
     add(new JTextField());
     add(Box.createVerticalStrut(5));
     add(combobox);
     add(Box.createRigidArea(new Dimension(320,5)));
     setBorder(BorderFactory.createEmptyBorder(5,5,0,5));
   }
   class MyItem{
     private final String  item;
     private final boolean flag;
     public MyItem(String str) {
       this(str,false);
     }
     public MyItem(String str, boolean flg) {
       item = str;
       flag = flg;
     }
     public String toString() {
       return item;
     }
     public boolean hasSeparator() {
       return flag;
     }
   }
 以下省略

//**参考リンク
**コメント [#v07260fb]
#comment