+ * This wizard can be included in the Eclipse UI by extending the + * org.eclipse.ui.workingSets extension point, as shown in the following + * example. + *
+ *+ * + * @since 3.0 + */ +public class ProjectWorkingSetPage extends WizardPage implements IWorkingSetPage { + static final int LIST_WIDTH_HINT = 200; + static final int LIST_HEIGHT_HINT = 250; + + private Text text; + private Label countLabel; + private TableViewer availableListViewer; + private TableViewer inclusionListViewer; + private ProjectWorkingSet workingSet; + private IAdaptable[] availableList; + private boolean firstCheck = true; + + + /** + * Creates a new instance of the receiver. + */ + public ProjectWorkingSetPage() { + super("projectWorkingSetPage", //$NON-NLS-1$ + IDEWorkbenchMessages.getString("ProjectWorkingSetPage.title"), //$NON-NLS-1$ + IDEInternalWorkbenchImages.getImageDescriptor( + IDEInternalWorkbenchImages.IMG_WIZBAN_NEWPRJ_WIZ)); + setDescription(IDEWorkbenchMessages.getString("ProjectWorkingSetPage.description")); //$NON-NLS-1$ + workingSet = new ProjectWorkingSet("", new IProject[0]); //$NON-NLS-1$ + } + + /** + * Get available projects and project-sets from workspace. + */ + private IAdaptable[] getAvailableList() { + List available = new ArrayList(); + List /*+ * + *+ * + *
null is returned.
+ *
+ * @return the shell for the given widget
+ */
+ public static Shell getShell(Widget widget) {
+ if (widget instanceof Control)
+ return ((Control) widget).getShell();
+ if (widget instanceof Caret)
+ return ((Caret) widget).getParent().getShell();
+ if (widget instanceof DragSource)
+ return ((DragSource) widget).getControl().getShell();
+ if (widget instanceof DropTarget)
+ return ((DropTarget) widget).getControl().getShell();
+ if (widget instanceof Menu)
+ return ((Menu) widget).getParent().getShell();
+ if (widget instanceof ScrollBar)
+ return ((ScrollBar) widget).getParent().getShell();
+
+ return null;
+ }
+
+ /**
+ * Returns a width hint for a button control.
+ */
+ public static int getButtonWidthHint(Button button) {
+ if (button.getFont().equals(JFaceResources.getDefaultFont()))
+ button.setFont(JFaceResources.getDialogFont());
+ PixelConverter converter= new PixelConverter(button);
+ int widthHint= converter.convertHorizontalDLUsToPixels(IDialogConstants.BUTTON_WIDTH);
+ return Math.max(widthHint, button.computeSize(SWT.DEFAULT, SWT.DEFAULT, true).x);
+ }
+
+ /**
+ * Returns a height hint for a button control.
+ */
+ public static int getButtonHeigthHint(Button button) {
+ if (button.getFont().equals(JFaceResources.getDefaultFont()))
+ button.setFont(JFaceResources.getDialogFont());
+ PixelConverter converter= new PixelConverter(button);
+ return converter.convertVerticalDLUsToPixels(IDialogConstants.BUTTON_HEIGHT);
+ }
+
+ /**
+ * Sets width and height hint for the button control.
+ * Note: This is a NOP if the button's layout data is not
+ * an instance of GridData.
+ *
+ * @param the button for which to set the dimension hint
+ */
+ public static void setButtonDimensionHint(Button button) {
+ Assert.isNotNull(button);
+ Object gd = button.getLayoutData();
+ if (gd instanceof GridData) {
+ ((GridData) gd).heightHint = getButtonHeigthHint(button);
+ ((GridData) gd).widthHint = getButtonWidthHint(button);
+ }
+ }
+
+ public static void setDialogSize(Dialog dialog, int width, int height) {
+ Point computedSize =
+ dialog.getShell().computeSize(SWT.DEFAULT, SWT.DEFAULT);
+ width = Math.max(computedSize.x, width);
+ height = Math.max(computedSize.y, height);
+ dialog.getShell().setSize(width, height);
+ }
+}
Index: src/org/eclipse/ui/internal/ide/model/ProjectWorkingSet.java
===================================================================
RCS file: src/org/eclipse/ui/internal/ide/model/ProjectWorkingSet.java
diff -N src/org/eclipse/ui/internal/ide/model/ProjectWorkingSet.java
--- /dev/null 1 Jan 1970 00:00:00 -0000
+++ src/org/eclipse/ui/internal/ide/model/ProjectWorkingSet.java 1 Jan 1970 00:00:00 -0000
@@ -0,0 +1,153 @@
+/*******************************************************************************
+ * Copyright (c) 2004 IBM Corporation and others.
+ * All rights reserved. This program and the accompanying materials
+ * are made available under the terms of the Common Public License v1.0
+ * which accompanies this distribution, and is available at
+ * http://www.eclipse.org/legal/cpl-v10.html
+ *
+ * Contributors:
+ * IBM Corporation - initial API and implementation
+ *******************************************************************************/
+package org.eclipse.ui.internal.ide.model;
+
+import org.eclipse.core.resources.IProject;
+import org.eclipse.core.runtime.IAdaptable;
+import org.eclipse.jface.resource.ImageDescriptor;
+import org.eclipse.ui.IContainmentAdapter;
+import org.eclipse.ui.IMemento;
+import org.eclipse.ui.IPersistableElement;
+import org.eclipse.ui.ISharedImages;
+import org.eclipse.ui.IWorkingSet;
+import org.eclipse.ui.PlatformUI;
+import org.eclipse.ui.internal.WorkingSet;
+import org.eclipse.ui.internal.ide.dialogs.ProjectWorkingSetReference;
+
+/**
+ * A ProjectWorkingSet is a WorkingSet that holds projects and nested sub-sets.
+ *
+ * Each element of the ProjectWorkingSet implents the IAdaptable
+ * interface as needed by IWorkingSet. In addition, ProjectWorkingSet
+ * implements the IContainmentAdapter interface which allows it to
+ * answer questions about elements contained by the working set. This is
+ * what allows ProjectWorkingSet to hold projects nested within sub-sets without
+ * exposing that structure to clients of the IWorkingSet interface.
+ *
+ * The contains method is eventually called by the WorkingSetFilter
+ * classes within the workbench to decide if this WorkingSet contains projects
+ * that should be included or excluded by the filter.
+ *
+ * A ProjectWorkingSet defines a working set as a set of Projects and ProjectWorkingSets.
+ * Projects are the usual workspace projects. ProjectWorkingSets that are included in a
+ * definition are proxied by a ProjectWorkingSetReference and all usage of the working
+ * set is evaluated as lazily (late) as possible. The actual project working set that
+ * is refered to is not instantiated until the working set is used via the
+ * contains method. This allows the definition of referenced sub-sets to
+ * change and result in changed run-time behavior of the parent working set.
+ *
+ * ProjectWorkingSet(s) may contain references to other ProjectWorkingSet(s), which
+ * makes it possible to have circular references between sets. The only restrictions
+ * placed on defintions of ProjectWorkingSets is that they may not reference themselves.
+ * Circular references are detected at evaluation time in the contains
+ * method so that working sets are only tested once. It is important to allow these
+ * cycles because the definer of a working set has not control over what other sets
+ * may include her working sets. Also, because sets will be persisted, imported, and
+ * exported, these evaluations must be done as late as possible. References to sets
+ * that do not exist are quietly ignored at evaluation time. This ensures robust
+ * operation in environments of large working groups with hundreds of projects,
+ * tens of working sets, and frequent sharing/importing of working set definitions.
+ *
+ * ProjectWorkingSet(s) and their proxies are persistable via the IPersitableElement
+ * interface, which allows them to be saved as part of the existing WorkingSet
+ * infrastructure (@see WorkingSetManager). They are re-created from their persisted
+ * content via a ProjectWorkingSetFactory class that is registered in the
+ * plugin XML specification under the extension point "org.eclipse.ui.elementFactories".
+ * The ProjectWorkingSetReference also has a factory.
+ */
+public class ProjectWorkingSet extends WorkingSet implements IContainmentAdapter {
+ static final String FACTORY_ID = "org.eclipse.ui.ide.ProjectWorkingSetFactory"; //$NON-NLS-1$
+
+ /**
+ * Construct a ProjectWorkingSet from a previously persisted
+ * IMemento. This is meant to be called by an element
+ * factory that restores saved working set definitions.
+ *
+ * @param name the name of the new working set. Should not have
+ * leading or trailing whitespace.
+ * @param memento persistence memento containing the elements of
+ * the working set.
+ */
+ public ProjectWorkingSet(String name, IMemento memento) {
+ super(name, memento);
+ }
+
+ /**
+ * Construct a ProjectWorkingSet from it's name and the memebers of its set.
+ * Set members implement the IAdaptable interface, and presently
+ * include IProject and ProjectWorkingSetReference.
+ *
+ * @param name
+ * @param elements
+ */
+ public ProjectWorkingSet(String name, IAdaptable[] elements) {
+ super(name, elements);
+ }
+ /* (non-Javadoc)
+ * @see org.eclipse.ui.IWorkingSet#getId()
+ */
+ public String getId() {
+ return "org.eclipse.ui.ide.projectWorkingSetPage"; //$NON-NLS-1$
+ }
+ /* (non-Javadoc)
+ * @see org.eclipse.ui.IPersistableElement
+ */
+ public String getFactoryId() {
+ return FACTORY_ID;
+ }
+ /* (non-Javadoc)
+ * @see org.eclipse.ui.IWorkingSet#getImage()
+ */
+ public ImageDescriptor getImage() {
+ return PlatformUI.getWorkbench().getSharedImages().getImageDescriptor(ISharedImages.IMG_OBJ_ELEMENT);
+ }
+
+ /**
+ * Returns the receiver if the requested type is either IWorkingSet
+ * or IPersistableElement or IContainmentAdapter. In the later case,
+ * we answer questions about sub-sets and projects contained within
+ * this working set.
+ *
+ * @param adapter the requested type
+ * @return the receiver if the requested type is either IWorkingSet
+ * or IPersistableElement or IContainmentAdapter.
+ */
+ public Object getAdapter(Class adapter) {
+ if (adapter == IContainmentAdapter.class || adapter == IWorkingSet.class || adapter == IPersistableElement.class) {
+ return this;
+ }
+ return null;
+ }
+
+ /* (non-Javadoc)
+ * @see org.eclipse.ui.IContainmentAdapter#contains(java.lang.Object, java.lang.Object, int)
+ */
+ public boolean contains(Object workingSetElement, Object element, int flags) {
+ if (element == null) return false;
+ if (workingSetElement == element) return true;
+ if (workingSetElement instanceof IProject) {
+ // for project element, just compare the full project name
+ IProject wsProject = (IProject) workingSetElement;
+ IProject project = (IProject) element;
+ return wsProject.getFullPath().equals(project.getFullPath());
+ } else if (workingSetElement instanceof ProjectWorkingSetReference) {
+ // for workingset references, we ask the reference to answer the question
+ // because it needs to provide cycle detection. Pass the name of the top-level
+ // working set as a "context" so that the down-stream search can avoid cycling
+ // back into the parent.
+ ProjectWorkingSetReference reference = (ProjectWorkingSetReference) workingSetElement;
+ return reference.contains(getName(), element, flags);
+ } else {
+ // workingSetElement wasn't a type we understand
+ return false;
+ }
+ }
+}
Index: src/org/eclipse/ui/internal/ide/model/ProjectWorkingSetFactory.java
===================================================================
RCS file: src/org/eclipse/ui/internal/ide/model/ProjectWorkingSetFactory.java
diff -N src/org/eclipse/ui/internal/ide/model/ProjectWorkingSetFactory.java
--- /dev/null 1 Jan 1970 00:00:00 -0000
+++ src/org/eclipse/ui/internal/ide/model/ProjectWorkingSetFactory.java 1 Jan 1970 00:00:00 -0000
@@ -0,0 +1,45 @@
+/*******************************************************************************
+ * Copyright (c) 2004 IBM Corporation and others.
+ * All rights reserved. This program and the accompanying materials
+ * are made available under the terms of the Common Public License v1.0
+ * which accompanies this distribution, and is available at
+ * http://www.eclipse.org/legal/cpl-v10.html
+ *
+ * Contributors:
+ * IBM Corporation - initial API and implementation
+ *******************************************************************************/
+package org.eclipse.ui.internal.ide.model;
+
+import org.eclipse.core.runtime.IAdaptable;
+import org.eclipse.ui.IElementFactory;
+import org.eclipse.ui.IMemento;
+import org.eclipse.ui.internal.IWorkbenchConstants;
+
+/**
+ * A ProjectWorkingSetFactory is used to recreate a persisted ProjectWorkingSet
+ * object.
+ */
+public class ProjectWorkingSetFactory implements IElementFactory {
+
+ /* (non-Javadoc)
+ * @see org.eclipse.ui.IElementFactory
+ */
+ public IAdaptable createElement(IMemento memento) {
+ String workingSetName = memento.getString(IWorkbenchConstants.TAG_NAME);
+ String workingSetEditPageId = memento.getString(IWorkbenchConstants.TAG_EDIT_PAGE_ID);
+
+ if (workingSetName == null)
+ return null;
+
+ ProjectWorkingSet workingSet = new ProjectWorkingSet(workingSetName, memento);
+ if (workingSetEditPageId != null) {
+ workingSet.setId(workingSetEditPageId);
+ }
+ else {
+ // working sets created with builds 20020418 and 20020419 will not
+ // have an edit page id. fix this automatically.
+ workingSet.setId("org.eclipse.ui.ide.projectWorkingSetPage"); //$NON-NLS-1$
+ }
+ return workingSet;
+ }
+}
Index: src/org/eclipse/ui/internal/ide/model/ProjectWorkingSetReferenceFactory.java
===================================================================
RCS file: src/org/eclipse/ui/internal/ide/model/ProjectWorkingSetReferenceFactory.java
diff -N src/org/eclipse/ui/internal/ide/model/ProjectWorkingSetReferenceFactory.java
--- /dev/null 1 Jan 1970 00:00:00 -0000
+++ src/org/eclipse/ui/internal/ide/model/ProjectWorkingSetReferenceFactory.java 1 Jan 1970 00:00:00 -0000
@@ -0,0 +1,37 @@
+/*******************************************************************************
+ * Copyright (c) 2004 IBM Corporation and others.
+ * All rights reserved. This program and the accompanying materials
+ * are made available under the terms of the Common Public License v1.0
+ * which accompanies this distribution, and is available at
+ * http://www.eclipse.org/legal/cpl-v10.html
+ *
+ * Contributors:
+ * IBM Corporation - initial API and implementation
+ *******************************************************************************/
+package org.eclipse.ui.internal.ide.model;
+
+import org.eclipse.core.runtime.IAdaptable;
+import org.eclipse.ui.IElementFactory;
+import org.eclipse.ui.IMemento;
+import org.eclipse.ui.internal.IWorkbenchConstants;
+import org.eclipse.ui.internal.ide.dialogs.ProjectWorkingSetReference;
+
+/**
+ * A ProjectWorkingSetReferenceFactory is used to recreate a persisted
+ * ProjectWorkingSetReference object.
+ */
+public class ProjectWorkingSetReferenceFactory implements IElementFactory {
+
+ /* (non-Javadoc)
+ * @see org.eclipse.ui.IElementFactory
+ */
+ public IAdaptable createElement(IMemento memento) {
+ String workingSetName = memento.getString(IWorkbenchConstants.TAG_NAME);
+
+ if (workingSetName == null)
+ return null;
+
+ ProjectWorkingSetReference workingSet = new ProjectWorkingSetReference(workingSetName);
+ return workingSet;
+ }
+}