com.globalmentor.swing.ListPanel 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 java.awt.*;
import java.util.List;

import javax.swing.*;

import com.globalmentor.awt.BasicGridBagLayout;

/**
 * Panel that contains a list and buttons for selecting and unselecting all items.
 * 
 * In order to create and edit items, an edit strategy must be set (besides setting the list to be editable using {@link ListPanel#setEditable(boolean)}. Actual
 * modification of the list will only be performed if the list uses a list model that implements either {@link DefaultListModel} or {@link List}.
 * 
 * 
 * Bound properties:
 * 
 * 
 * {@link Editable#EDITABLE_PROPERTY} ({@link Boolean})
 * Indicates the editable status has changed.
 * 
 * @param  The type of each element in the list.
 * @author Garret Wilson
 * @see List
 * @see DefaultListModel
 * @see ListEditStrategy
 */
public class ListPanel extends ContentPanel implements Editable {

	protected final JToolBar buttonToolBar;
	protected final JButton selectAllButton;
	protected final JButton selectNoneButton;
	protected final JToolBar.Separator editSeparator;
	protected final JButton addButton;
	protected final JButton deleteButton;
	protected final JButton editButton;
	protected final JToolBar.Separator moveSeparator;
	protected final JButton moveUpButton;
	protected final JButton moveDownButton;

	/** The edit strategy for editing items in the list, or null if there is no edit strategy. */
	private final ListEditStrategy editStrategy;

	/** @return The strategy for editing items in the list, or null if there is no edit strategy. */
	public ListEditStrategy getEditStrategy() {
		return editStrategy;
	}

	/**
	 * Sets the edit strategy object
	 * @param editStrategy The edit strategy for editing items in the list, or null if there is no edit strategy.
	 */
	//TODO del if not needed		public void setEditStrategy(final ListEditStrategy editStrategy) {this.editStrategy=editStrategy;}	//TODO make sure we unregister the old list strategy first by removing all listeners to the list

	/** The list this panel represents. */
	private final JList list;

	/** @return The list this panel represents. */
	protected JList getList() {
		return list;
	}

	/** Whether the items in the list can be edited. */
	private boolean editable;

	/** @return Whether the items in the list can be edited. */
	public boolean isEditable() {
		return editable;
	}

	/**
	 * Sets whether the items in the list can be edited. This defaults to false. This is a bound property.
	 * @param newEditable true if the list can be edited.
	 */
	public void setEditable(final boolean newEditable) {
		final boolean oldEditable = editable; //get the old value
		if(oldEditable != newEditable) { //if the value is really changing
			editable = newEditable; //update the value				
			firePropertyChange(EDITABLE_PROPERTY, new Boolean(oldEditable), new Boolean(newEditable)); //show that the property has changed
			updateStatus(); //update the status
		}
	}

	/**
	 * List constructor that only allows selection.
	 * @param list The list component, which will be wrapped in a scroll pane.
	 * @see JScrollPane
	 */
	public ListPanel(final JList list) {
		this(list, new ListEditStrategy(list) { //TODO find out why we can't create an anonymous instance of a specific genericized type

					protected Object createItem() throws InstantiationException, IllegalAccessException {
						throw new AssertionError("This list cannot create items."); //TODO fix with a better exception
					}

					protected Object editItem(Object item) {
						throw new AssertionError("This list cannot edit items."); //TODO fix with a better exception
					}
				});
	}

	/**
	 * List and edit strategy constructor.
	 * @param list The list component, which will be wrapped in a scroll pane.
	 * @param editStrategy The edit strategy for editing items in the list.
	 * @see JScrollPane
	 */
	public ListPanel(final JList list, final ListEditStrategy editStrategy) {
		super(new JScrollPane(list), false); //construct the panel with the list as the content component, but don't initialize the panel
		this.list = list; //save the list we were given
		this.editStrategy = editStrategy; //save the edit strategy
		buttonToolBar = new JToolBar(JToolBar.VERTICAL);
		selectAllButton = new JButton(editStrategy.getSelectAllAction());
		selectNoneButton = new JButton(editStrategy.getSelectNoneAction());
		editSeparator = ToolBars.createToolBarSeparator(buttonToolBar);
		addButton = new JButton(editStrategy.getAddAction());
		deleteButton = new JButton(editStrategy.getDeleteAction());
		editButton = new JButton(editStrategy.getEditAction());
		moveSeparator = ToolBars.createToolBarSeparator(buttonToolBar);
		moveUpButton = new JButton(editStrategy.getMoveUpAction());
		moveDownButton = new JButton(editStrategy.getMoveDownAction());
		editable = false; //default to not being editable
		initialize(); //initialize the panel
	}

	/** Initializes the user interface. */
	public void initializeUI() {
		super.initializeUI(); //do the default user interface initialization
		final BasicGridBagLayout buttonPanelLayout = new BasicGridBagLayout();
		buttonToolBar.setFloatable(false);
		buttonToolBar.add(selectAllButton);
		buttonToolBar.add(selectNoneButton);
		buttonToolBar.add(editSeparator);
		buttonToolBar.add(addButton);
		buttonToolBar.add(deleteButton);
		buttonToolBar.add(editButton);
		buttonToolBar.add(moveSeparator);
		buttonToolBar.add(moveUpButton);
		buttonToolBar.add(moveDownButton);
		add(buttonToolBar, BorderLayout.LINE_END);
	}

	/**
	 * Updates the states of the actions, including enabled/disabled status, proxied actions, etc.
	 */
	public void updateStatus() {
		super.updateStatus(); //do the default updating
		final int selectionMode = getList().getSelectionMode(); //get the list selection mode
		final boolean isMultipleSelectionAllowed = selectionMode != ListSelectionModel.SINGLE_SELECTION; //see if multiple selections are allowed, either single intervals or multiple intervals
		final boolean isEditable = isEditable(); //see whether the list can be edited
		//TODO maybe just go with the way things work now, even though the lead selection may not be visible		final int selectedIndex=list.getSelectedIndex();	//get the first selected index 
		//TODO del if not needed		final boolean isLeadSelected=leadSelectionIndex>=0 && list.isSelectedIndex(leadSelectionIndex);	//see whether the lead index is selected	
		selectAllButton.setVisible(isMultipleSelectionAllowed); //only show the selection buttons if interval selections are allowed
		selectNoneButton.setVisible(isMultipleSelectionAllowed); //only show the selection buttons if multiple selections are allowed
		editSeparator.setVisible(isMultipleSelectionAllowed && isEditable); //only show the edit separator if editing is allowed, and we're showing buttons before it
		addButton.setVisible(isEditable); //only show the add button if editing is allowed
		deleteButton.setVisible(isEditable); //only show the delete button if editing is allowed
		editButton.setVisible(isEditable); //only show the edit button if editing is allowed	
		moveSeparator.setVisible(isEditable); //only show the move separator if editing is allowed
		moveUpButton.setVisible(isEditable); //only show the move up button if editing is allowed
		moveDownButton.setVisible(isEditable); //only show the move down button if editing is allowed
	}

}