| /******************************************************************************* |
| * Copyright (c) 2006, 2018 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 |
| *******************************************************************************/ |
| package org.eclipse.team.examples.model.ui; |
| |
| import java.util.*; |
| |
| import org.eclipse.core.resources.*; |
| import org.eclipse.core.runtime.*; |
| import org.eclipse.jface.viewers.AbstractTreeViewer; |
| import org.eclipse.jface.viewers.Viewer; |
| import org.eclipse.swt.widgets.Display; |
| import org.eclipse.team.examples.filesystem.FileSystemPlugin; |
| import org.eclipse.team.examples.model.*; |
| import org.eclipse.team.ui.mapping.*; |
| import org.eclipse.ui.IMemento; |
| import org.eclipse.ui.model.BaseWorkbenchContentProvider; |
| import org.eclipse.ui.navigator.*; |
| |
| /** |
| * Model content provider for use with the Common Navigator framework. |
| * It makes use of an IWorkbenchAdapter to get the children and parent |
| * of model objects. It also makes use of the Common Navigator pipeline |
| * to override the resource content extension so that model projects will |
| * replace the corresponding resource project in the Project Explorer. |
| */ |
| public class ModelNavigatorContentProvider extends BaseWorkbenchContentProvider |
| implements ICommonContentProvider, IResourceChangeListener, IPipelinedTreeContentProvider, ITeamStateChangeListener, IAdaptable { |
| |
| private ICommonContentExtensionSite extensionSite; |
| private boolean isWorkspaceRoot; |
| private Viewer viewer; |
| private final boolean updateViewer; |
| private SynchronizationStateTester syncStateTester; |
| private Object saveablesProvider = new ModelSaveablesProvider(); |
| |
| public ModelNavigatorContentProvider() { |
| super(); |
| updateViewer = true; |
| } |
| |
| /** |
| * Create a contentProvider |
| * @param updateViewer whether this content provider is reponsible for updating the viewer |
| */ |
| public ModelNavigatorContentProvider(boolean updateViewer) { |
| this.updateViewer = updateViewer; |
| } |
| |
| /* (non-Javadoc) |
| * @see org.eclipse.ui.navigator.ICommonContentProvider#init(org.eclipse.ui.navigator.ICommonContentExtensionSite) |
| */ |
| public void init(ICommonContentExtensionSite aConfig) { |
| extensionSite = aConfig; |
| if (updateViewer) { |
| ResourcesPlugin.getWorkspace().addResourceChangeListener(this, IResourceChangeEvent.POST_CHANGE); |
| // Use a synchronization state tester to listen for team state changes |
| syncStateTester = new SynchronizationStateTester(); |
| syncStateTester.getTeamStateProvider().addDecoratedStateChangeListener(this); |
| } |
| } |
| |
| /* (non-Javadoc) |
| * @see org.eclipse.ui.model.BaseWorkbenchContentProvider#dispose() |
| */ |
| public void dispose() { |
| super.dispose(); |
| ResourcesPlugin.getWorkspace().removeResourceChangeListener(this); |
| if (syncStateTester != null) |
| syncStateTester.getTeamStateProvider().removeDecoratedStateChangeListener(this); |
| } |
| |
| /* (non-Javadoc) |
| * @see org.eclipse.ui.navigator.IMementoAware#restoreState(org.eclipse.ui.IMemento) |
| */ |
| public void restoreState(IMemento aMemento) { |
| // Nothing to do |
| } |
| |
| /* (non-Javadoc) |
| * @see org.eclipse.ui.navigator.IMementoAware#saveState(org.eclipse.ui.IMemento) |
| */ |
| public void saveState(IMemento aMemento) { |
| // Nothing to do |
| } |
| |
| /** |
| * Return the extension site for this label provider. |
| * @return the extension site for this label provider |
| */ |
| public ICommonContentExtensionSite getExtensionSite() { |
| return extensionSite; |
| } |
| |
| /* (non-Javadoc) |
| * @see org.eclipse.ui.model.BaseWorkbenchContentProvider#getElements(java.lang.Object) |
| */ |
| public Object[] getElements(Object element) { |
| // Since we are used in the project explorer, the root may be |
| // an IWorkspaceRoot. We need to change it to the ModelWorkspace |
| if (element instanceof IWorkspaceRoot) { |
| isWorkspaceRoot = true; |
| return super.getElements(ModelObject.create((IWorkspaceRoot)element)); |
| |
| } |
| return super.getElements(element); |
| } |
| |
| /* (non-Javadoc) |
| * @see org.eclipse.ui.model.BaseWorkbenchContentProvider#getParent(java.lang.Object) |
| */ |
| public Object getParent(Object element) { |
| Object parent = super.getParent(element); |
| if (isWorkspaceRoot && parent instanceof ModelWorkspace) { |
| return ((ModelWorkspace)parent).getResource(); |
| } |
| return parent; |
| } |
| |
| public void inputChanged(Viewer viewer, Object oldInput, Object newInput) { |
| this.viewer = viewer; |
| super.inputChanged(viewer, oldInput, newInput); |
| } |
| |
| /* (non-Javadoc) |
| * @see org.eclipse.team.ui.mapping.ITeamStateChangeListener#teamStateChanged(org.eclipse.team.ui.mapping.ITeamStateChangeEvent) |
| */ |
| public void teamStateChanged(ITeamStateChangeEvent event) { |
| // We need to listen to team state changes in order to determine when we need |
| // to perform label updates on model elements. |
| // We actually just refresh all projects that contain changes. |
| // This is inefficient but will do for an example |
| Set refreshProjects = new HashSet(); |
| IResource[] addedRoots = event.getAddedRoots(); |
| for (int i = 0; i < addedRoots.length; i++) { |
| IResource resource = addedRoots[i]; |
| if (isModelProject(resource.getProject())) { |
| refreshProjects.add(ModelObject.create(resource.getProject())); |
| } |
| } |
| IResource[] removedRoots = event.getRemovedRoots(); |
| for (int i = 0; i < removedRoots.length; i++) { |
| IResource resource = removedRoots[i]; |
| if (isModelProject(resource.getProject())) { |
| refreshProjects.add(ModelObject.create(resource.getProject())); |
| } |
| } |
| IResource[] changed = event.getChangedResources(); |
| for (int i = 0; i < changed.length; i++) { |
| IResource resource = changed[i]; |
| if (isModelProject(resource.getProject())) { |
| refreshProjects.add(ModelObject.create(resource.getProject())); |
| } |
| } |
| |
| refreshProjects((ModelProject[]) refreshProjects.toArray(new ModelProject[refreshProjects.size()])); |
| } |
| |
| /* (non-Javadoc) |
| * @see org.eclipse.core.resources.IResourceChangeListener#resourceChanged(org.eclipse.core.resources.IResourceChangeEvent) |
| */ |
| public void resourceChanged(IResourceChangeEvent event) { |
| if (viewer == null) return; |
| IResourceDelta delta = event.getDelta(); |
| IResourceDelta[] children = delta.getAffectedChildren(); |
| boolean refreshAll = false; |
| List refreshProjects = new ArrayList(); |
| for (int i = 0; i < children.length; i++) { |
| IResourceDelta childDelta = children[i]; |
| if (isModelProject(childDelta.getResource())) { |
| if (isProjectChange(childDelta)) { |
| refreshAll = true; |
| break; |
| } |
| refreshProjects.add(ModelObject.create(childDelta.getResource())); |
| } |
| } |
| if (refreshAll || !refreshProjects.isEmpty()) { |
| if (refreshAll) |
| refreshViewer(); |
| else |
| refreshProjects((ModelProject[]) refreshProjects.toArray(new ModelProject[refreshProjects.size()])); |
| } |
| } |
| |
| private void refreshProjects(final ModelProject[] projects) { |
| Display.getDefault().asyncExec(new Runnable() { |
| public void run() { |
| if (!getViewer().getControl().isDisposed()) { |
| for (int i = 0; i < projects.length; i++) { |
| ModelProject project = projects[i]; |
| ((AbstractTreeViewer)getViewer()).refresh(project, true); |
| } |
| } |
| } |
| |
| }); |
| } |
| |
| private void refreshViewer() { |
| Display.getDefault().asyncExec(new Runnable() { |
| public void run() { |
| if (!getViewer().getControl().isDisposed()) { |
| getViewer().refresh(); |
| } |
| } |
| |
| }); |
| } |
| |
| private boolean isProjectChange(IResourceDelta childDelta) { |
| if ((childDelta.getFlags() & (IResourceDelta.DESCRIPTION | IResourceDelta.OPEN)) > 0) |
| return true; |
| return false; |
| } |
| |
| private boolean isModelProject(IResource resource) { |
| try { |
| return ModelProject.isModProject(resource.getProject()); |
| } catch (CoreException e) { |
| FileSystemPlugin.log(e); |
| return false; |
| } |
| } |
| |
| Viewer getViewer() { |
| return viewer; |
| } |
| |
| /* (non-Javadoc) |
| * @see org.eclipse.ui.navigator.IPipelinedTreeContentProvider#getPipelinedChildren(java.lang.Object, java.util.Set) |
| */ |
| public void getPipelinedChildren(Object aParent, Set theCurrentChildren) { |
| // Nothing to do |
| } |
| |
| /* (non-Javadoc) |
| * @see org.eclipse.ui.navigator.IPipelinedTreeContentProvider#getPipelinedElements(java.lang.Object, java.util.Set) |
| */ |
| public void getPipelinedElements(Object anInput, Set theCurrentElements) { |
| // Replace any model projects with a ModelProject |
| if (anInput instanceof IWorkspaceRoot) { |
| List newProjects = new ArrayList(); |
| for (Iterator iter = theCurrentElements.iterator(); iter.hasNext();) { |
| Object element = iter.next(); |
| if (element instanceof IProject) { |
| IProject project = (IProject) element; |
| try { |
| if (ModelProject.isModProject(project)) { |
| iter.remove(); |
| newProjects.add(ModelObject.create(project)); |
| } |
| } catch (CoreException e) { |
| FileSystemPlugin.log(e); |
| } |
| } |
| } |
| theCurrentElements.addAll(newProjects); |
| } |
| } |
| |
| /* (non-Javadoc) |
| * @see org.eclipse.ui.navigator.IPipelinedTreeContentProvider#getPipelinedParent(java.lang.Object, java.lang.Object) |
| */ |
| public Object getPipelinedParent(Object anObject, Object aSuggestedParent) { |
| // We're not changing the parenting of any resources |
| return aSuggestedParent; |
| } |
| |
| /* (non-Javadoc) |
| * @see org.eclipse.ui.navigator.IPipelinedTreeContentProvider#interceptAdd(org.eclipse.ui.navigator.PipelinedShapeModification) |
| */ |
| public PipelinedShapeModification interceptAdd(PipelinedShapeModification anAddModification) { |
| if (anAddModification.getParent() instanceof IWorkspaceRoot) { |
| for (Iterator iter = anAddModification.getChildren().iterator(); iter.hasNext();) { |
| Object element = iter.next(); |
| if (element instanceof IProject) { |
| IProject project = (IProject) element; |
| try { |
| if (ModelProject.isModProject(project)) { |
| iter.remove(); |
| } |
| } catch (CoreException e) { |
| FileSystemPlugin.log(e); |
| } |
| } |
| } |
| } |
| return null; |
| } |
| |
| /* (non-Javadoc) |
| * @see org.eclipse.ui.navigator.IPipelinedTreeContentProvider#interceptRefresh(org.eclipse.ui.navigator.PipelinedViewerUpdate) |
| */ |
| public boolean interceptRefresh(PipelinedViewerUpdate aRefreshSynchronization) { |
| // No need to intercept the refresh |
| return false; |
| } |
| |
| /* (non-Javadoc) |
| * @see org.eclipse.ui.navigator.IPipelinedTreeContentProvider#interceptRemove(org.eclipse.ui.navigator.PipelinedShapeModification) |
| */ |
| public PipelinedShapeModification interceptRemove(PipelinedShapeModification aRemoveModification) { |
| // No need to intercept the remove |
| return aRemoveModification; |
| } |
| |
| /* (non-Javadoc) |
| * @see org.eclipse.ui.navigator.IPipelinedTreeContentProvider#interceptUpdate(org.eclipse.ui.navigator.PipelinedViewerUpdate) |
| */ |
| public boolean interceptUpdate(PipelinedViewerUpdate anUpdateSynchronization) { |
| // No need to intercept the update |
| return false; |
| } |
| |
| public <T> T getAdapter(Class<T> adapter) { |
| if (adapter == SaveablesProvider.class) { |
| return adapter.cast(saveablesProvider); |
| } |
| return Platform.getAdapterManager().getAdapter(this, adapter); |
| } |
| |
| } |
