com.globalmentor.swing.CheckBoxListCellRenderer Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of globalmentor-swing Show documentation
GlobalMentor Java Swing library.
The newest version!
/*
 * Copyright © 1996-2009 GlobalMentor, Inc. 
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package com.globalmentor.swing;

import javax.swing.*;
import javax.swing.border.*;

import com.globalmentor.log.Log;

import java.awt.*;
import java.io.Serializable;

/**
 * Renders an item in a list as a checkbox.
 * 
 * Based on code from DefaultListCellRenderer version 1.17 02/02/00 by Philip Milne and Hans Muller, copyright 1998-2000 Sun Microsystems, Inc.
 * 
 * @author Garret Wilson
 */
public class CheckBoxListCellRenderer extends JCheckBox implements ListCellRenderer, Serializable {

	protected static Border noFocusBorder;

	/** Default constructor. */
	public CheckBoxListCellRenderer() {
		super(); //do the default construction
		noFocusBorder = new EmptyBorder(1, 1, 1, 1);
		setOpaque(true);
		setBorder(noFocusBorder);
	}

	/**
	 * @return A renderer with the correct text for this choice.
	 * @param list The list component.
	 * @param value The value of this list item.
	 * @param index The index of this list item.
	 * @param isSelected Whether the list item is selected.
	 * @param cellHasFocus Whether the list item has the focus.
	 */
	public Component getListCellRendererComponent(final JList list, final Object value, final int index, final boolean isSelected, final boolean cellHasFocus) {
		setComponentOrientation(list.getComponentOrientation());
		setSelected(isSelected); //show whether the item is selected
		/*TODO fix
			if (value instanceof Icon) {
			    setIcon((Icon)value);
			    setText("");
			}
			else {
			    setIcon(null);
			    setText((value == null) ? "" : value.toString());
			}
				final String string=getListCellRendererString(list, value, index, isSelected, cellHasFocus);  //get the string to display TODO we have a new version of this method now
		//TODO assert the string is not null
				Debug.assert(component instanceof JLabel, "List cell renderer component not a JLabel");
				((JLabel)component).setText(string);  //set the correct text, assuming that the component is a JLabel (which is likely the implementation used by the default
				return component; //return the component, now using our custom text
		  }
		*/
		final String text = getListCellRendererString(list, value, index, isSelected, cellHasFocus); //get the string to display
		//TODO assert the string is not null
		setText(text); //set the correct text
		setEnabled(list.isEnabled());
		setFont(list.getFont());
		setBorder((cellHasFocus) ? UIManager.getBorder("List.focusCellHighlightBorder") : noFocusBorder);
		//TODO fix; setBorder() doesn't seem to work, but this method is inconsistent with the normal UI representation
		if(cellHasFocus || index == list.getLeadSelectionIndex()) { //if this cell has the focus (or it's the lead selection index), show the focus using the selection attributes
			setBackground(list.getSelectionBackground());
			setForeground(list.getSelectionForeground());
		} else {
			setBackground(list.getBackground());
			setForeground(list.getForeground());
		}
		return this; //return ourselves as the component
	}

	/**
	 * Retrieves text for a list item. This can be overridden in a derived class to return custom text for the specified value. This default version delegates to
	 * the one-parameter version.
	 * @param list The list component.
	 * @param value The value of this list item.
	 * @param index The index of this list item.
	 * @param isSelected Whether the list item is selected.
	 * @param cellHasFocus Whether the list item has the focus.
	 * @return The correct text for this list item.
	 */
	protected String getListCellRendererString(final JList list, final Object value, final int index, final boolean isSelected, final boolean cellHasFocus) {
		Log.trace("value: ", value);
		Log.trace("index: ", index);
		return getListCellRendererString(value); //delegate to the simple version
	}

	/**
	 * Retrieves text for a list item. This can be overridden in a derived class to return custom text for the specified value. This default version is called
	 * from the multi-parameter version, and returns the object's default toString() value.
	 * @param value The value of this list item.
	 * @return The correct text for this list item.
	 */
	protected String getListCellRendererString(final Object value) {
		return value.toString(); //return the string value of the object by default
	}

	/** Overridden for performance reasons. See the DefaultListCellRenderer Implementation Note. */
	public void validate() {
	}

	/** Overridden for performance reasons. See the DefaultListCellRenderer Implementation Note. */
	public void revalidate() {
	}

	/** Overridden for performance reasons. See the DefaultListCellRenderer Implementation Note. */
	public void repaint(long tm, int x, int y, int width, int height) {
	}

	/** Overridden for performance reasons. See the DefaultListCellRenderer Implementation Note. */
	public void repaint(Rectangle r) {
	}

	/** Overridden for performance reasons. See the DefaultListCellRenderer Implementation Note. */
	protected void firePropertyChange(String propertyName, Object oldValue, Object newValue) {
		// Strings get interned...
		if(propertyName == "text")
			super.firePropertyChange(propertyName, oldValue, newValue);
	}

	/** Overridden for performance reasons. See the DefaultListCellRenderer Implementation Note. */
	public void firePropertyChange(String propertyName, byte oldValue, byte newValue) {
	}

	/** Overridden for performance reasons. See the DefaultListCellRenderer Implementation Note. */
	public void firePropertyChange(String propertyName, char oldValue, char newValue) {
	}

	/** Overridden for performance reasons. See the DefaultListCellRenderer Implementation Note. */
	public void firePropertyChange(String propertyName, short oldValue, short newValue) {
	}

	/** Overridden for performance reasons. See the DefaultListCellRenderer Implementation Note. */
	public void firePropertyChange(String propertyName, int oldValue, int newValue) {
	}

	/** Overridden for performance reasons. See the DefaultListCellRenderer Implementation Note. */
	public void firePropertyChange(String propertyName, long oldValue, long newValue) {
	}

	/** Overridden for performance reasons. See the DefaultListCellRenderer Implementation Note. */
	public void firePropertyChange(String propertyName, float oldValue, float newValue) {
	}

	/** Overridden for performance reasons. See the DefaultListCellRenderer Implementation Note. */
	public void firePropertyChange(String propertyName, double oldValue, double newValue) {
	}

	/** Overridden for performance reasons. See the DefaultListCellRenderer Implementation Note. */
	public void firePropertyChange(String propertyName, boolean oldValue, boolean newValue) {
	}

	/**
	 * A subclass of CheckBoxListCellRenderer that implements UIResource. This class does not implement UIResource directly so that
	 * applications can safely override the cellRenderer property with CheckBoxListCellRenderer subclasses.
	 */
	public static class UIResource extends DefaultListCellRenderer implements javax.swing.plaf.UIResource {
	}
}