[Java] Swing：JTableのセルにJButtonを追加する方法について

概要

今回は、SwingのJTableのセルにJButtonを追加する方法について試してみます。

---

動作環境

・Java SE 6
・NetBeans 6.9.1
・Mac OS X 10.6

---

前提事項

・特になし

---

内容

SwingのJTableのセルにJButtonを追加するには、大まかに以下の手順が必要です。
１．JButtonのサブクラスを作成する
２．TableCellRendererを実装したクラスを作成する
３．TableCellEditorを実装したクラスを作成する
４．JTableとTableCellRenderer、TableCellEditorを関連付ける

以下、サンプルプログラムを交えて説明します。
なお、サンプルプログラムは「削除ボタンを押下したら、行を削除する」という動作をします。

１．JButtonのサブクラスを作成する
手順２、３のために、JButtonのサブクラスを作成します。
サンプルでは、以下のような実装しました。

view plainprint?

1. public class DeleteButton extends JButton {  
2.   
3.     @Override  
4.     public void updateUI() {  
5.         super.updateUI();  
6.         setFocusable(false);  
7.         setText("削除");  
8.     }  
9. }  

public class DeleteButton extends JButton {

    @Override
    public void updateUI() {
        super.updateUI();
        setFocusable(false);
        setText("削除");
    }
}

２．TableCellRendererを実装したクラスを作成する
１で作成したボタンのレンダリングに関する情報を設定します。

なお、TableCellRendererとは、JavaDocによると
「JTable のセルのレンダリングになる可能性のあるオブジェクトが要求するメソッドを定義します。」
というものです。

サンプルでは、以下のように実装しました。

view plainprint?

1. public class DeleteButtonRenderer extends DeleteButton implements TableCellRenderer {  
2.   
3.     public DeleteButtonRenderer() {  
4.         super();  
5.         setName("Table.cellRenderer");  
6.     }  
7.   
8.     public Component getTableCellRendererComponent(  
9.             JTable jtable, Object o, boolean bln, boolean bln1, int i, int i1) {  
10.         return this;  
11.     }  
12. }  

public class DeleteButtonRenderer extends DeleteButton implements TableCellRenderer {

    public DeleteButtonRenderer() {
        super();
        setName("Table.cellRenderer");
    }

    public Component getTableCellRendererComponent(
            JTable jtable, Object o, boolean bln, boolean bln1, int i, int i1) {
        return this;
    }
}

セルに表示されるコンポーネントを返却するメソッド「getTableCellRendererComponent」で
「DeleteButton」自身を返却しています。
これにより、セルに「DeleteButton」が表示されることとなります。


３．TableCellEditorを実装したクラスを作成する
JButtonがユーザの入力やイベントを受信できるようにTableCellEditorを実装します。

view plainprint?

1. public class DeleteButtonEditor extends DeleteButton implements TableCellEditor {  
2.   
3.     public DeleteButtonEditor(final JTable table) {  
4.         super();  
5.         addActionListener(new ActionListener() {  
6.   
7.             public void actionPerformed(ActionEvent ae) {  
8.                 int row = table.convertRowIndexToModel(table.getEditingRow());  
9.                 fireEditingStopped();  
10.                 ((DefaultTableModel)table.getModel()).removeRow(row);  
11.             }  
12.         });  
13.     }  
14.       
15.     public Component getTableCellEditorComponent(  
16.             JTable jtable, Object o, boolean bln, int i, int i1) {  
17.         return this;  
18.     }  
19.   
20.     public Object getCellEditorValue() {  
21.         return "";  
22.     }  
23.   
24.     public boolean isCellEditable(EventObject eo) {  
25.         return true;  
26.     }  
27.   
28.     public boolean shouldSelectCell(EventObject eo) {  
29.         return true;  
30.     }  
31.   
32.     public boolean stopCellEditing() {  
33.         fireEditingStopped();  
34.         return true;  
35.     }  
36.   
37.     public void cancelCellEditing() {  
38.         fireEditingCanceled();  
39.     }  
40.   
41.     public void addCellEditorListener(CellEditorListener cl) {  
42.         listenerList.add(CellEditorListener.class, cl);  
43.     }  
44.   
45.     public void removeCellEditorListener(CellEditorListener cl) {  
46.         listenerList.remove(CellEditorListener.class, cl);  
47.     }  
48.     public CellEditorListener[] getCellEditorListeners() {  
49.         return (CellEditorListener[])listenerList.getListeners(CellEditorListener.class);  
50.     }  
51.     protected void fireEditingStopped() {  
52.         // Guaranteed to return a non-null array  
53.         Object[] listeners = listenerList.getListenerList();  
54.         // Process the listeners last to first, notifying  
55.         // those that are interested in this event  
56.         for(int i = listeners.length-2; i>=0; i-=2) {  
57.             if(listeners[i]==CellEditorListener.class) {  
58.                 // Lazily create the event:  
59.                 if(changeEvent == null) changeEvent = new ChangeEvent(this);  
60.                 ((CellEditorListener)listeners[i+1]).editingStopped(changeEvent);  
61.             }  
62.         }  
63.     }  
64.     protected void fireEditingCanceled() {  
65.         // Guaranteed to return a non-null array  
66.         Object[] listeners = listenerList.getListenerList();  
67.         // Process the listeners last to first, notifying  
68.         // those that are interested in this event  
69.         for(int i = listeners.length-2; i>=0; i-=2) {  
70.             if(listeners[i]==CellEditorListener.class) {  
71.                 // Lazily create the event:  
72.                 if(changeEvent == null) changeEvent = new ChangeEvent(this);  
73.                 ((CellEditorListener)listeners[i+1]).editingCanceled(changeEvent);  
74.             }  
75.         }  
76.     }  
77. }  

public class DeleteButtonEditor extends DeleteButton implements TableCellEditor {

    public DeleteButtonEditor(final JTable table) {
        super();
        addActionListener(new ActionListener() {

            public void actionPerformed(ActionEvent ae) {
                int row = table.convertRowIndexToModel(table.getEditingRow());
                fireEditingStopped();
                ((DefaultTableModel)table.getModel()).removeRow(row);
            }
        });
    }
    
    public Component getTableCellEditorComponent(
            JTable jtable, Object o, boolean bln, int i, int i1) {
        return this;
    }

    public Object getCellEditorValue() {
        return "";
    }

    public boolean isCellEditable(EventObject eo) {
        return true;
    }

    public boolean shouldSelectCell(EventObject eo) {
        return true;
    }

    public boolean stopCellEditing() {
        fireEditingStopped();
        return true;
    }

    public void cancelCellEditing() {
        fireEditingCanceled();
    }

    public void addCellEditorListener(CellEditorListener cl) {
        listenerList.add(CellEditorListener.class, cl);
    }

    public void removeCellEditorListener(CellEditorListener cl) {
        listenerList.remove(CellEditorListener.class, cl);
    }
    public CellEditorListener[] getCellEditorListeners() {
        return (CellEditorListener[])listenerList.getListeners(CellEditorListener.class);
    }
    protected void fireEditingStopped() {
        // Guaranteed to return a non-null array
        Object[] listeners = listenerList.getListenerList();
        // Process the listeners last to first, notifying
        // those that are interested in this event
        for(int i = listeners.length-2; i>=0; i-=2) {
            if(listeners[i]==CellEditorListener.class) {
                // Lazily create the event:
                if(changeEvent == null) changeEvent = new ChangeEvent(this);
                ((CellEditorListener)listeners[i+1]).editingStopped(changeEvent);
            }
        }
    }
    protected void fireEditingCanceled() {
        // Guaranteed to return a non-null array
        Object[] listeners = listenerList.getListenerList();
        // Process the listeners last to first, notifying
        // those that are interested in this event
        for(int i = listeners.length-2; i>=0; i-=2) {
            if(listeners[i]==CellEditorListener.class) {
                // Lazily create the event:
                if(changeEvent == null) changeEvent = new ChangeEvent(this);
                ((CellEditorListener)listeners[i+1]).editingCanceled(changeEvent);
            }
        }
    }
}

DeleteButtonEditorのコンストラクタで、ボタン押下時のイベントを設定しています。
また、イベントを受信する必要があるため、isCellEditable、shouldSelectCellで「true」を返却しています。
fireEditingStopped、fireEditingCanceledはAbstractCellEditorクラスよりコピーしたものを使用しています。
こちらのメソッドはセルの編集の終了、キャンセルを感知し他のオブジェクトに通知するため使用されます。

４．JTableとTableCellRenderer、TableCellEditorを関連付ける
JTableに２、３で作成したオブジェクトを関連付けます。

関連付けの方法は、以下の通りです。
4.1.NetBeansのデザインビューを開き、テーブルを選択します。
4.2.右クリックし、表の内容を選択します。
4.3.列タブを選択し、ボタンを表示したい列を選択し、エディターの横のボタンをクリックします。

プルダウンでカスタムコードを選択し、以下のコードを入力します。
DeleteButtonEditorの引数には、JTableの変数名を指定します。

view plainprint?

1. new widets.DeleteButtonEditor(jTable1)  

new widets.DeleteButtonEditor(jTable1)

※2011/05/20 追記
BeanBindingを使用しテーブルセルの設定を実施した場合、型が「null」となります。
nullのままだと、エディターがうまく動作しないため、何か適当な値を設定して下さい。

4.4.レンダラの横のボタンを押下し、レンダラを設定します。

プルダウンでカスタムコードを選択し、以下のコードを入力します。

view plainprint?

1. new widets.DeleteButtonRenderer()  

new widets.DeleteButtonRenderer()

以上、で設定が完了です。

---

テスト

作成したプログラムが想定通り動作するか、検証します。

起動直後の画面は以下のようになりました。
ボタンがセルに表示されています。

削除ボタンを押下したら、行が削除されました。
実装内容が想定通り反映されました。

---

参考情報

この記事は以下を参考にさせて頂きました。
・JTableのセルにJButtonを追加して行削除