Skip to main content

JComboBox with Disabled Items

Recently, I was working on a project in Java and needed to have a combo box, but with certain items in the list disabled (e.g. gray and non-selectable). At first, I simply set a custom renderer for the combo box which checked if the item was disabled. That, however, did not prevent the items from being selected. Thus, I set about to find a viable solution. There are plenty of solutions out there, but none seemed to work exactly the way I wanted. In the end, I ended up subclassing JComboBox to provide the functionality of disabling individual items. Here is my result, in under 100 lines:

import java.awt.Component;
import java.util.ArrayList;

import javax.swing.JComboBox;
import javax.swing.JList;
import javax.swing.plaf.basic.BasicComboBoxRenderer;

public class PartialDisableComboBox extends JComboBox {
 private static final long serialVersionUID = -1690671707274328126L;
 
 private ArrayList<boolean> itemsState = new ArrayList<boolean>();
 
 public PartialDisableComboBox() {
  super();
  this.setRenderer(new BasicComboBoxRenderer() {
   private static final long serialVersionUID = -2774241371293899669L;
   @Override
   public Component getListCellRendererComponent(JList list, Object value, 
     int index, boolean isSelected, boolean cellHasFocus) {
    Component c = super.getListCellRendererComponent(list, value, index, isSelected, cellHasFocus);
    boolean disabled = index >= 0 && index < itemsState.size() && !itemsState.get(index);
    c.setEnabled(!disabled);
    c.setFocusable(!disabled);
    return c;
   }
  });
 }
 
 @Override
 public void addItem(Object item) {
  this.addItem(item, true);
 }
 
 public void addItem(Object item, boolean enabled) {
  super.addItem(item);
  itemsState.add(enabled);
 }
 
 @Override
 public void insertItemAt(Object item, int index) {
  this.insertItemAt(item, index, true);
 }

 public void insertItemAt(Object item, int index, boolean enabled) {
  super.insertItemAt(item, index);
  itemsState.add(index, enabled);
 }
 
 @Override
 public void removeAllItems() {
  super.removeAllItems();
  itemsState.clear();
 }
 
 @Override
 public void removeItemAt(int index) {
  if (index < 0 || index >= itemsState.size()) throw new IllegalArgumentException("Item Index out of Bounds!");
  super.removeItemAt(index);
  itemsState.remove(index);
 }
 
 @Override
 public void removeItem(Object item) {
  for (int q = 0; q < this.getItemCount(); q++) {
   if (this.getItemAt(q) == item) itemsState.remove(q);
  }
  super.removeItem(item);
 }
 
 @Override
 public void setSelectedIndex(int index) {
  if (index < 0 || index >= itemsState.size()) throw new IllegalArgumentException("Item Index out of Bounds!");
  if (itemsState.get(index)) super.setSelectedIndex(index);
 }
 
 public void setItemEnabled(int index, boolean enabled) {
  if (index < 0 || index >= itemsState.size()) throw new IllegalArgumentException("Item Index out of Bounds!");
  itemsState.set(index, enabled);
 }
 
 public boolean isItemEnabled(int index) {
  if (index < 0 || index >= itemsState.size()) throw new IllegalArgumentException("Item Index out of Bounds!");
  return itemsState.get(index);
 }
}

As you can see, most of the code is pretty straightforward, adding and removing elements from the JComboBox and the list of item states. The custom renderer is still used to provide the L&F for the disabled items, but the key to having the disabled items non-selectable is the setSelectedIndex(int) method. There are also plenty of index range checks thrown in there, especially in the custom renderer, as the combo box calls that method with index = -1 when rendering the combo box in its "closed" state (without the dropdown).

Of course, I want give credit to some other blogs that helped lay the groundwork and point me in the right direction, but unfortunately I don't remember their names. If I find them again, I'll be sure to include them in this post.

As always, please let me know if you find this useful, or if you find any bugs or possible improvements.

Comments

  1. This comment has been removed by the author.

    ReplyDelete
  2. This is working great (just had to make a quick change from boolean to Boolean for private ArrayList (maybe a Java7 thing?). Just what I needed. Thanks.

    ReplyDelete

Post a Comment

Popular posts from this blog

Linux on XPS 15 9550/9560 with TB16 Dock [Update:3/29]

Finally got a laptop to replace my fat tower at work - Dell XPS 15 9560. I was allowed to choose which one I wanted and chose the XPS for its Linux support since Dell ships developer edition XPS's running Ubuntu so I figured Linux support would be better than other manufacturers. At first they got me the model with the 4K screen but my monitors are 2K and multi-dpi support in Linux is virtually non-existent and even hi-dpi support on its own is pretty terrible. So I got it exchanged for the model with the regular 1080p screen (which happened to also be the updated 9560 model), which works much better. I'm very glad to report that pretty much everything works, including the TB16 desktop dock, with just a bit of settings tweaking. This post is to help anybody considering getting this setup or looking for help getting things working. For now, I am running Kubuntu 16.04 with KDE Neon installed. List of things I explicitly tested and work: WiFi, Bluetooth Thunderbolt charging

My Views on Code Indentation

I have read many, many articles about the whole tab vs. space indentation thing. Personally, I don't necessarily agree with most of them. They will require the coder to use a specific indentation size and stick with it, even forcing that on other coders. First off, let me outline my method for indenting code. Then I will explain the reasons and advantages/disadvantages. When I indent code, I will use tabs, but only at the beginning of a line. To align something in the rest of the line, I will use spaces. If a line spills to the next line(s), I will indent that line two tabs further. Rationale: Tabs Why tabs? First off, they're compact in the file (1 byte each). This is really insignificant with current disk sizes, but still. If you indent in spaces, then your file will be larger (unless you indent with one space). Another advantage of tabs is that a tab is a tab. It doesn't specify by how many spaces the code is indented, but rather by how many tabs it is indente

Generating PDFs in Rails with Prawn and Prawnto

There are several different PDF generation libraries available for Rails apps. Some of these are PDF::Writer, Prawn, Ruport, RGhost, and FlyingSaucer (for JRuby). First off, Ruport is basically a higher-level API for PDF::Writer. FlyingSaucer is only for JRuby (because JRuby allows for loading of Java classes). Not having any experience with RGhost, I can't exactly write a guide for using it. So now it's basically between Prawn and PDF::Writer, unless there's another library I haven't hear of. However, to my dismay, there is not UTF-8 support in PDF::Writer. So Prawn ends up being the PDF generation library of choice. One thing to keep in mind is that Prawn and Prawnto are beta-stage (sometimes even alpha) libraries, so some code hacking is going to be necessary. Also note the Prawnto is not maintained or tested by the Prawn developers, so there's no guarantee that it'll work with future versions (especially since Prawnto's developer has been "below t