/*
* JCheckBoxList.java - A list, each item can be checked or unchecked
* :tabSize=4:indentSize=4:noTabs=false:
* :folding=explicit:collapseFolds=1:
*
* Copyright (C) 2000, 2001, 2002 Slava Pestov
*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU General Public License
* as published by the Free Software Foundation; either version 2
* of the License, or any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, write to the Free Software
* Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
*/
package org.gjt.sp.jedit.gui;
//{{{ Imports
import java.awt.Component;
import java.awt.Font;
import java.util.Vector;
import java.util.List;
import java.util.ArrayList;
import javax.swing.*;
import javax.swing.table.*;
//}}}
/**
* A list where items can be selected and checked off independently.
* @since jEdit 3.2pre9
*/
public class JCheckBoxList extends JTable
{
//{{{ JCheckBoxList constructor
/**
* Creates a checkbox list with the given list of objects. The elements
* of this array can either be Entry instances, or other objects (if the
* latter, they will default to being unchecked).
*/
public JCheckBoxList(Object[] items)
{
setModel(items);
} //}}}
//{{{ JCheckBoxList constructor
/**
* Creates a checkbox list with the given list of objects. The elements
* of this vector can either be Entry instances, or other objects (if the
* latter, they will default to being unchecked).
*/
public JCheckBoxList(Vector items)
{
setModel(items);
} //}}}
//{{{ setModel() method
/**
* Sets the model to the given list of objects. The elements of this
* array can either be Entry instances, or other objects (if the
* latter, they will default to being unchecked).
*/
public void setModel(Object[] items)
{
setModel(new CheckBoxListModel(items));
init();
} //}}}
//{{{ setModel() method
/**
* Sets the model to the given list of objects. The elements of this
* vector can either be Entry instances, or other objects (if the
* latter, they will default to being unchecked).
*/
public void setModel(Vector items)
{
setModel(new CheckBoxListModel(items));
init();
} //}}}
//{{{ getCheckedValues() method
public Object[] getCheckedValues()
{
List<Object> values = new ArrayList<Object>();
CheckBoxListModel model = (CheckBoxListModel)getModel();
for(int i = 0; i < model.items.size(); i++)
{
Entry entry = model.items.get(i);
if(entry.checked && !entry.caption)
{
values.add(entry.value);
}
}
Object[] retVal = new Object[values.size()];
return values.toArray(retVal);
} //}}}
//{{{ selectAll() method
@Override
public void selectAll()
{
CheckBoxListModel model = (CheckBoxListModel)getModel();
for(int i = 0; i < model.items.size(); i++)
{
Entry entry = model.items.elementAt(i);
if(!entry.caption)
entry.checked = true;
}
model.fireTableRowsUpdated(0,model.getRowCount());
} //}}}
//{{{ getValues() method
public Entry[] getValues()
{
CheckBoxListModel model = (CheckBoxListModel)getModel();
Entry[] retVal = new Entry[model.items.size()];
model.items.copyInto(retVal);
return retVal;
} //}}}
//{{{ getSelectedValue() method
public Object getSelectedValue()
{
int row = getSelectedRow();
if(row == -1)
{
return null;
}
else
{
return getModel().getValueAt(row,1);
}
} //}}}
//{{{ getCellRenderer() method
@Override
public TableCellRenderer getCellRenderer(int row, int column)
{
if(column == 0)
{
Entry entry = ((CheckBoxListModel)getModel()).items.get(row);
if(entry.caption)
return dummy;
}
return super.getCellRenderer(row,column);
} //}}}
//{{{ Private members
private TableCellRenderer dummy;
//{{{ init() method
private void init()
{
dummy = new DummyRenderer();
getSelectionModel().setSelectionMode(ListSelectionModel
.SINGLE_SELECTION);
setShowGrid(false);
setAutoResizeMode(JTable.AUTO_RESIZE_LAST_COLUMN);
TableColumn column = getColumnModel().getColumn(0);
int checkBoxWidth = new JCheckBox().getPreferredSize().width;
column.setPreferredWidth(checkBoxWidth);
column.setMinWidth(checkBoxWidth);
column.setWidth(checkBoxWidth);
column.setMaxWidth(checkBoxWidth);
column.setResizable(false);
column = getColumnModel().getColumn(1);
column.setCellRenderer(new LabelRenderer());
} //}}}
//}}}
//{{{ Entry class
/**
* A check box list entry.
*/
public static class Entry
{
boolean checked;
boolean caption;
Object value;
public Entry(Object value)
{
this.caption = true;
this.value = value;
}
public Entry(boolean checked, Object value)
{
this.checked = checked;
this.value = value;
}
public boolean isChecked()
{
return checked;
}
public Object getValue()
{
return value;
}
} //}}}
//{{{ DummyRenderer class
private static class DummyRenderer extends DefaultTableCellRenderer
{
@Override
public Component getTableCellRendererComponent(JTable table, Object value,
boolean isSelected, boolean hasFocus, int row, int column)
{
return super.getTableCellRendererComponent(table,null /* value */,
isSelected,false /* hasFocus */,row,column);
}
} //}}}
//{{{ LabelRenderer class
private class LabelRenderer extends DefaultTableCellRenderer
{
Font plainFont, boldFont;
LabelRenderer()
{
plainFont = UIManager.getFont("Tree.font");
boldFont = plainFont.deriveFont(Font.BOLD);
}
@Override
public Component getTableCellRendererComponent(JTable table, Object value,
boolean isSelected, boolean hasFocus, int row, int column)
{
super.getTableCellRendererComponent(table,value,isSelected,
hasFocus,row,column);
Entry entry = ((CheckBoxListModel)getModel()).items.get(row);
if(entry.caption)
setFont(boldFont);
else
setFont(plainFont);
return this;
}
} //}}}
}
//{{{ CheckBoxListModel class
class CheckBoxListModel extends AbstractTableModel
{
Vector<JCheckBoxList.Entry> items;
CheckBoxListModel(Vector _items)
{
items = new Vector<JCheckBoxList.Entry>(_items.size());
for(int i = 0; i < _items.size(); i++)
{
items.add(createEntry(_items.elementAt(i)));
}
}
CheckBoxListModel(Object[] _items)
{
items = new Vector<JCheckBoxList.Entry>(_items.length);
for (Object _item : _items)
{
items.add(createEntry(_item));
}
}
private static JCheckBoxList.Entry createEntry(Object obj)
{
if(obj instanceof JCheckBoxList.Entry)
return (JCheckBoxList.Entry)obj;
else
return new JCheckBoxList.Entry(false,obj);
}
public int getRowCount()
{
return items.size();
}
public int getColumnCount()
{
return 2;
}
@Override
public String getColumnName(int col)
{
return null;
}
public Object getValueAt(int row, int col)
{
JCheckBoxList.Entry entry = items.get(row);
switch(col)
{
case 0:
return Boolean.valueOf(entry.checked);
case 1:
return entry.value;
default:
throw new InternalError();
}
}
@Override
public Class getColumnClass(int col)
{
switch(col)
{
case 0:
return Boolean.class;
case 1:
return String.class;
default:
throw new InternalError();
}
}
@Override
public boolean isCellEditable(int row, int col)
{
JCheckBoxList.Entry entry = items.get(row);
return col == 0 && !entry.caption;
}
@Override
public void setValueAt(Object value, int row, int col)
{
if(col == 0)
{
JCheckBoxList.Entry entry = items.get(row);
if(!entry.caption)
{
entry.checked = value.equals(Boolean.TRUE);
fireTableRowsUpdated(row,row);
}
}
}
} //}}}