/*******************************************************************************
* Copyright (c) 2000, 2009 IBM Corporation and others.
* All rights reserved. This program and the accompanying materials
* are made available under the terms of the Eclipse Public License v1.0
* which accompanies this distribution, and is available at
* http://www.eclipse.org/legal/epl-v10.html
*
* Contributors:
* IBM Corporation - initial API and implementation
* Sebastian Davids <sdavids@gmx.de> - Fix for bug 19346 - Dialog
* font should be activated and used by other components.
* Red Hat Inc. - modified this file to work with ChangeLog Plugin
*******************************************************************************/
package org.eclipse.linuxtools.internal.changelog.core.actions;
import java.util.ArrayList;
import java.util.List;
import org.eclipse.core.resources.IContainer;
import org.eclipse.core.runtime.IPath;
import org.eclipse.linuxtools.internal.changelog.core.Messages;
import org.eclipse.swt.SWT;
import org.eclipse.swt.layout.GridData;
import org.eclipse.swt.widgets.Composite;
import org.eclipse.swt.widgets.Control;
import org.eclipse.swt.widgets.Label;
import org.eclipse.swt.widgets.Shell;
import org.eclipse.ui.PlatformUI;
import org.eclipse.ui.dialogs.SelectionDialog;
/**
* A standard selection dialog which solicits a container resource from the user.
* The <code>getResult</code> method returns the selected container resource.
* <p>
* This class may be instantiated; it is not intended to be subclassed.
* </p>
* <p>
* Example:
* <pre>
* ContainerSelectionDialog dialog =
* new ContainerSelectionDialog(getShell(), initialSelection, allowNewContainerName(), msg);
* dialog.open();
* Object[] result = dialog.getResult();
* </pre>
* </p>
* @noextend This class is not intended to be subclassed by clients.
*/
public class ChangeLogContainerSelectionDialog extends SelectionDialog {
private static final String ContainerSelectionDialog_title = Messages.getString("ChangeLogContainerSelectionDialog.Title"); //$NON-NLS-1$
private static final String ContainerSelectionDialog_message = Messages.getString("ChangeLogContainerSelectionDialog.Message"); //$NON-NLS-1$
private static final String CONTAINER_SELECTION_DIALOG = "org.eclipse.ui.ide.container_selection_dialog_context"; //$NON-NLS-1$
// the widget group;
ChangeLogContainerSelectionGroup group;
// the root resource to populate the viewer with
private IContainer initialSelection;
// allow the user to type in a new container name
private boolean allowNewContainerName = true;
// the validation message
Label statusMessage;
// show closed projects by default
private boolean showClosedProjects = true;
/**
* Creates a resource container selection dialog rooted at the given resource.
* All selections are considered valid.
*
* @param parentShell the parent shell
* @param initialRoot the initial selection in the tree
* @param allowNewContainerName <code>true</code> to enable the user to type in
* a new container name, and <code>false</code> to restrict the user to just
* selecting from existing ones
* @param message the message to be displayed at the top of this dialog, or
* <code>null</code> to display a default message
*/
public ChangeLogContainerSelectionDialog(Shell parentShell, IContainer initialRoot,
boolean allowNewContainerName, String message) {
super(parentShell);
setTitle(ContainerSelectionDialog_title);
this.initialSelection = initialRoot;
this.allowNewContainerName = allowNewContainerName;
if (message != null) {
setMessage(message);
} else {
setMessage(ContainerSelectionDialog_message);
}
setShellStyle(getShellStyle() | SWT.SHEET);
}
@Override
protected void configureShell(Shell shell) {
super.configureShell(shell);
PlatformUI.getWorkbench().getHelpSystem()
.setHelp(shell, CONTAINER_SELECTION_DIALOG);
}
@Override
protected Control createDialogArea(Composite parent) {
// create composite
Composite area = (Composite) super.createDialogArea(parent);
// container selection group
group = new ChangeLogContainerSelectionGroup(area,
allowNewContainerName, getMessage(), showClosedProjects, initialSelection);
if (initialSelection != null) {
group.setSelectedContainer(initialSelection);
}
statusMessage = new Label(area, SWT.WRAP);
statusMessage.setLayoutData(new GridData(GridData.FILL_HORIZONTAL));
statusMessage.setText(" \n "); //$NON-NLS-1$
statusMessage.setFont(parent.getFont());
return dialogArea;
}
/**
* The <code>ContainerSelectionDialog</code> implementation of this
* <code>Dialog</code> method builds a list of the selected resource containers
* for later retrieval by the client and closes this dialog.
*/
@Override
protected void okPressed() {
List<IPath> chosenContainerPathList = new ArrayList<>();
IPath returnValue = group.getContainerFullPath();
if (returnValue != null) {
chosenContainerPathList.add(returnValue);
}
setResult(chosenContainerPathList);
super.okPressed();
}
/**
* Set whether or not closed projects should be shown
* in the selection dialog.
*
* @param show Whether or not to show closed projects.
*/
public void showClosedProjects(boolean show) {
this.showClosedProjects = show;
}
}