bundles/org.eclipse.ui.workbench/Eclipse UI/org/eclipse/ui/dialogs/FileSelectionDialog.java

package org.eclipse.ui.dialogs;

/*
 * (c) Copyright IBM Corp. 2000, 2002. All Rights Reserved.
 * Contributors:  Sebastian Davids <sdavids@gmx.de> - Fix for bug 19346 - Dialog
 * font should be activated and used by other components.
 */
import org.eclipse.ui.help.*;
import org.eclipse.ui.internal.*;
import org.eclipse.ui.internal.misc.CheckboxTreeAndListGroup;
import org.eclipse.ui.model.*;
import org.eclipse.jface.viewers.*;
import org.eclipse.swt.SWT;
import org.eclipse.swt.events.*;
import org.eclipse.swt.graphics.Font;
import org.eclipse.swt.layout.GridData;
import org.eclipse.swt.layout.GridLayout;
import org.eclipse.swt.widgets.*;
import java.util.ArrayList;
import java.util.Iterator;

/**
 * A standard file selection dialog which solicits a list of files from the user.
 * The <code>getResult</code> method returns the selected files.
 * <p>
 * This class may be instantiated; it is not intended to be subclassed.
 * </p>
 * <p>
 * Example:
 * <pre>
 *	FileSelectionDialog dialog = 
 *		new FileSelectionDialog(getShell(), rootElement, msg);
 *	dialog.setInitialSelections(selectedResources);
 *	dialog.open();
 *	return dialog.getResult();
 * </pre>
 * </p>
 * @deprecated. Use org.eclipse.swt.widgets.FileDialog,
 */
public class FileSelectionDialog extends SelectionDialog {
	// the root file representative to populate the viewer with
	private FileSystemElement root;

	// the visual selection widget group
	private CheckboxTreeAndListGroup selectionGroup;

	// expand all items in the tree view on dialog open
	private boolean expandAllOnOpen = false;
	
	// sizing constants
	private	static final int SIZING_SELECTION_WIDGET_WIDTH = 500;
	private	static final int SIZING_SELECTION_WIDGET_HEIGHT = 250;
/**
 * Creates a file selection dialog rooted at the given file system element.
 *
 * @param parentShell the parent shell
 * @param fileSystemElement the root element to populate this dialog with
 * @param message the message to be displayed at the top of this dialog, or
 *    <code>null</code> to display a default message
 */
public FileSelectionDialog(Shell parentShell, FileSystemElement fileSystemElement, String message) {
	super(parentShell);
	setTitle(WorkbenchMessages.getString("FileSelectionDialog.title")); //$NON-NLS-1$
	root = fileSystemElement;
	if (message != null)
		setMessage(message);
	else
		setMessage(WorkbenchMessages.getString("FileSelectionDialog.message")); //$NON-NLS-1$
}
/**
 * Add the selection and deselection buttons to the dialog.
 * @param composite org.eclipse.swt.widgets.Composite
 */
private void addSelectionButtons(Composite composite) {
	Font font = composite.getFont();
	
	Composite buttonComposite = new Composite(composite,SWT.RIGHT);
	GridLayout layout = new GridLayout();
	layout.numColumns = 2;
	buttonComposite.setLayout(layout);
	GridData data = new GridData(GridData.HORIZONTAL_ALIGN_END);
	composite.setData(data);

	Button selectButton = new Button(buttonComposite,SWT.PUSH);
	selectButton.setFont(font);
	selectButton.setText(SELECT_ALL_TITLE);
	SelectionListener listener = new SelectionAdapter() {
		public void widgetSelected(SelectionEvent e) {
			selectionGroup.setAllSelections(true);
		}
	};
	selectButton.addSelectionListener(listener);

	Button deselectButton = new Button(buttonComposite,SWT.PUSH);
	deselectButton.setFont(font);
	deselectButton.setText(DESELECT_ALL_TITLE);
	listener = new SelectionAdapter() {
		public void widgetSelected(SelectionEvent e) {
			selectionGroup.setAllSelections(false);

		}
	};
	deselectButton.addSelectionListener(listener);
	
	}
/**
 * Visually checks the previously-specified elements in the container (left)
 * portion of this dialog's file selection viewer.
 */
private void checkInitialSelections() {
	Iterator itemsToCheck = getInitialElementSelections().iterator();
	
	while (itemsToCheck.hasNext()) {
		FileSystemElement currentElement = (FileSystemElement)itemsToCheck.next();
		
		if (currentElement.isDirectory())
			selectionGroup.initialCheckTreeItem(currentElement);
		else
			selectionGroup.initialCheckListItem(currentElement);
	}
}
/* (non-Javadoc)
 * Method declared in Window.
 */
protected void configureShell(Shell shell) {
	super.configureShell(shell);
	WorkbenchHelp.setHelp(shell, IHelpContextIds.FILE_SELECTION_DIALOG);
}
public void create() {
	super.create();
	initializeDialog();
}
/* (non-Javadoc)
 * Method declared on Dialog.
 */
protected Control createDialogArea(Composite parent) {
	// page group
	Composite composite = (Composite)super.createDialogArea(parent);
	
	createMessageArea(composite);

	// Create a fake parent of the root to be the dialog input element.
	// Use an empty label so that display of the element's full name
	// doesn't include a confusing label
	FileSystemElement input = new FileSystemElement("", null, true);//$NON-NLS-1$
	input.addChild(root);
	root.setParent(input);

	selectionGroup =
		new CheckboxTreeAndListGroup(
			composite,
			input,
			getFolderProvider(),
			new WorkbenchLabelProvider(),
			getFileProvider(),
			new WorkbenchLabelProvider(),
			SWT.NONE,
			SIZING_SELECTION_WIDGET_WIDTH,		// since this page has no other significantly-sized
			SIZING_SELECTION_WIDGET_HEIGHT);	// widgets we need to hardcode the combined widget's
												// size, otherwise it will open too small

	ICheckStateListener listener = new ICheckStateListener() {
		public void checkStateChanged(CheckStateChangedEvent event) {
			getOkButton().setEnabled(selectionGroup.getCheckedElementCount() > 0);
		}
	};

	WorkbenchViewerSorter sorter = new WorkbenchViewerSorter();
	selectionGroup.setTreeSorter(sorter);
	selectionGroup.setListSorter(sorter);
	selectionGroup.addCheckStateListener(listener);

	addSelectionButtons(composite);

	return composite;
}
/**
 * Returns whether the tree view of the file system element
 * will be fully expanded when the dialog is opened.
 *
 * @return true to expand all on dialog open, false otherwise.
 */
public boolean getExpandAllOnOpen() {
	return expandAllOnOpen;
}
/**
 * Returns a content provider for <code>FileSystemElement</code>s that returns 
 * only files as children.
 */
private ITreeContentProvider getFileProvider() {
	return new WorkbenchContentProvider() {
		public Object[] getChildren(Object o) {
			if (o instanceof FileSystemElement) {
				return ((FileSystemElement)o).getFiles().getChildren(o);
			}
			return new Object[0];
		}
	};
}
/**
 * Returns a content provider for <code>FileSystemElement</code>s that returns 
 * only folders as children.
 */
private ITreeContentProvider getFolderProvider() {
	return new WorkbenchContentProvider() {
		public Object[] getChildren(Object o) {
			if (o instanceof FileSystemElement) {
				return ((FileSystemElement)o).getFolders().getChildren(o);
			}
			return new Object[0];
		}
	};
}
/**
 * Initializes this dialog's controls.
 */
private void initializeDialog() {
	// initialize page	
	if (getInitialElementSelections().isEmpty())
		getOkButton().setEnabled(false);
	else
		checkInitialSelections();
	selectionGroup.aboutToOpen();
	if (expandAllOnOpen)
		selectionGroup.expandAll();
}
/**
 * The <code>FileSelectionDialog</code> implementation of this
 * <code>Dialog</code> method builds a list of the selected files for later 
 * retrieval by the client and closes this dialog.
 */
protected void okPressed() {
	Iterator resultEnum = selectionGroup.getAllCheckedListItems();
	ArrayList list = new ArrayList();
	while (resultEnum.hasNext())
		list.add(resultEnum.next());
	setResult(list);
	super.okPressed();
}
/**
 * Set whether the tree view of the file system element
 * will be fully expanded when the dialog is opened.
 *
 * @parm expandAll true to expand all on dialog open, false otherwise.
 */
public void setExpandAllOnOpen(boolean expandAll) {
	expandAllOnOpen = expandAll;
}
}