| /******************************************************************************* |
| * Copyright (c) 2000, 2010 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 |
| * Stefan Xenos, IBM; Chris Torrence, ITT Visual Information Solutions - bug 51580 |
| * Nikolay Botev - bug 240651 |
| *******************************************************************************/ |
| package org.eclipse.ui.internal; |
| |
| import org.eclipse.e4.core.contexts.IEclipseContext; |
| |
| import java.util.HashMap; |
| import java.util.Iterator; |
| import java.util.Map; |
| import org.eclipse.core.runtime.Assert; |
| import org.eclipse.core.runtime.ListenerList; |
| import org.eclipse.e4.ui.model.application.MPart; |
| import org.eclipse.e4.workbench.ui.IPresentationEngine; |
| import org.eclipse.jface.resource.ImageDescriptor; |
| import org.eclipse.jface.resource.JFaceResources; |
| import org.eclipse.jface.util.IPropertyChangeListener; |
| import org.eclipse.jface.util.PropertyChangeEvent; |
| import org.eclipse.swt.graphics.Image; |
| import org.eclipse.swt.widgets.Display; |
| import org.eclipse.ui.IPropertyListener; |
| import org.eclipse.ui.ISaveablePart; |
| import org.eclipse.ui.ISaveablesLifecycleListener; |
| import org.eclipse.ui.ISharedImages; |
| import org.eclipse.ui.ISizeProvider; |
| import org.eclipse.ui.IWorkbenchPage; |
| import org.eclipse.ui.IWorkbenchPart; |
| import org.eclipse.ui.IWorkbenchPart2; |
| import org.eclipse.ui.IWorkbenchPart3; |
| import org.eclipse.ui.IWorkbenchPartConstants; |
| import org.eclipse.ui.IWorkbenchPartReference; |
| import org.eclipse.ui.PartInitException; |
| import org.eclipse.ui.PlatformUI; |
| import org.eclipse.ui.internal.e4.compatibility.CompatibilityPart; |
| import org.eclipse.ui.internal.misc.UIListenerLogging; |
| import org.eclipse.ui.internal.util.Util; |
| |
| /** |
| * |
| */ |
| public abstract class WorkbenchPartReference implements IWorkbenchPartReference, ISizeProvider { |
| |
| /** |
| * Internal property ID: Indicates that the underlying part was created |
| */ |
| public static final int INTERNAL_PROPERTY_OPENED = 0x211; |
| |
| /** |
| * Internal property ID: Indicates that the underlying part was destroyed |
| */ |
| public static final int INTERNAL_PROPERTY_CLOSED = 0x212; |
| |
| /** |
| * Internal property ID: Indicates that the result of IEditorReference.isPinned() |
| */ |
| public static final int INTERNAL_PROPERTY_PINNED = 0x213; |
| |
| /** |
| * Internal property ID: Indicates that the result of getVisible() has changed |
| */ |
| public static final int INTERNAL_PROPERTY_VISIBLE = 0x214; |
| |
| /** |
| * Internal property ID: Indicates that the result of isZoomed() has changed |
| */ |
| public static final int INTERNAL_PROPERTY_ZOOMED = 0x215; |
| |
| /** |
| * Internal property ID: Indicates that the part has an active child and the |
| * active child has changed. (fired by PartStack) |
| */ |
| public static final int INTERNAL_PROPERTY_ACTIVE_CHILD_CHANGED = 0x216; |
| |
| /** |
| * Internal property ID: Indicates that changed in the min / max |
| * state has changed |
| */ |
| public static final int INTERNAL_PROPERTY_MAXIMIZED = 0x217; |
| |
| // State constants ////////////////////////////// |
| |
| /** |
| * State constant indicating that the part is not created yet |
| */ |
| public static int STATE_LAZY = 0; |
| |
| /** |
| * State constant indicating that the part is in the process of being created |
| */ |
| public static int STATE_CREATION_IN_PROGRESS = 1; |
| |
| /** |
| * State constant indicating that the part has been created |
| */ |
| public static int STATE_CREATED = 2; |
| |
| /** |
| * State constant indicating that the reference has been disposed (the reference shouldn't be |
| * used anymore) |
| */ |
| public static int STATE_DISPOSED = 3; |
| |
| /** |
| * Current state of the reference. Used to detect recursive creation errors, disposed |
| * references, etc. |
| */ |
| private int state = STATE_LAZY; |
| |
| protected IWorkbenchPart legacyPart; |
| |
| |
| private boolean pinned = false; |
| |
| |
| /** |
| * Stores the current Image for this part reference. Lazily created. Null if not allocated. |
| */ |
| private Image image = null; |
| |
| private ImageDescriptor defaultImageDescriptor; |
| |
| /** |
| * Stores the current image descriptor for the part. |
| */ |
| private ImageDescriptor imageDescriptor; |
| |
| /** |
| * API listener list |
| */ |
| private ListenerList propChangeListeners = new ListenerList(); |
| |
| /** |
| * Internal listener list. Listens to the INTERNAL_PROPERTY_* property change events that are not yet API. |
| * TODO: Make these properties API in 3.2 |
| */ |
| private ListenerList internalPropChangeListeners = new ListenerList(); |
| |
| private ListenerList partChangeListeners = new ListenerList(); |
| |
| protected Map propertyCache = new HashMap(); |
| |
| |
| |
| private IPropertyListener propertyChangeListener = new IPropertyListener() { |
| /* (non-Javadoc) |
| * @see org.eclipse.ui.IPropertyListener#propertyChanged(java.lang.Object, int) |
| */ |
| public void propertyChanged(Object source, int propId) { |
| partPropertyChanged(source, propId); |
| } |
| }; |
| |
| private IPropertyChangeListener partPropertyChangeListener = new IPropertyChangeListener() { |
| public void propertyChange(PropertyChangeEvent event) { |
| partPropertyChanged(event); |
| } |
| }; |
| |
| private IWorkbenchPage page; |
| |
| private MPart part; |
| |
| private IEclipseContext windowContext; |
| |
| public WorkbenchPartReference(IEclipseContext windowContext, IWorkbenchPage page, MPart part) { |
| this.windowContext = windowContext; |
| this.page = page; |
| this.part = part; |
| } |
| |
| public boolean isDisposed() { |
| return state == STATE_DISPOSED; |
| } |
| |
| protected void checkReference() { |
| if (state == STATE_DISPOSED) { |
| throw new RuntimeException("Error: IWorkbenchPartReference disposed"); //$NON-NLS-1$ |
| } |
| } |
| |
| public MPart getModel() { |
| return part; |
| } |
| |
| protected void setImageDescriptor(ImageDescriptor descriptor) { |
| if (Util.equals(imageDescriptor, descriptor)) { |
| return; |
| } |
| |
| Image oldImage = image; |
| ImageDescriptor oldDescriptor = imageDescriptor; |
| image = null; |
| imageDescriptor = descriptor; |
| |
| // Don't queue events triggered by image changes. We'll dispose the image |
| // immediately after firing the event, so we need to fire it right away. |
| immediateFirePropertyChange(IWorkbenchPartConstants.PROP_TITLE); |
| // If we had allocated the old image, deallocate it now (AFTER we fire the property change |
| // -- listeners may need to clean up references to the old image) |
| if (oldImage != null) { |
| JFaceResources.getResources().destroy(oldDescriptor); |
| } |
| } |
| |
| protected void partPropertyChanged(Object source, int propId) { |
| |
| // We handle these properties directly (some of them may be transformed |
| // before firing events to workbench listeners) |
| // if (propId == IWorkbenchPartConstants.PROP_CONTENT_DESCRIPTION |
| // || propId == IWorkbenchPartConstants.PROP_PART_NAME |
| // || propId == IWorkbenchPartConstants.PROP_TITLE) { |
| // |
| // refreshFromPart(); |
| // } else { |
| // Any other properties are just reported to listeners verbatim |
| firePropertyChange(propId); |
| // } |
| |
| // Let the model manager know as well |
| if (propId == IWorkbenchPartConstants.PROP_DIRTY) { |
| IWorkbenchPart actualPart = getPart(false); |
| if (actualPart != null) { |
| SaveablesList modelManager = (SaveablesList) actualPart.getSite().getService(ISaveablesLifecycleListener.class); |
| modelManager.dirtyChanged(actualPart); |
| } |
| } |
| } |
| |
| protected void partPropertyChanged(PropertyChangeEvent event) { |
| firePartPropertyChange(event); |
| } |
| |
| |
| protected ImageDescriptor computeImageDescriptor() { |
| if (legacyPart != null) { |
| return ImageDescriptor |
| .createFromImage(legacyPart.getTitleImage(), Display.getCurrent()); |
| } |
| return defaultImageDescriptor; |
| } |
| |
| public void init(ImageDescriptor desc) { |
| Assert.isNotNull(desc); |
| |
| this.defaultImageDescriptor = desc; |
| this.imageDescriptor = computeImageDescriptor(); |
| } |
| |
| /** |
| * Releases any references maintained by this part reference |
| * when its actual part becomes known (not called when it is disposed). |
| */ |
| protected void releaseReferences() { |
| |
| } |
| |
| /* package */ void addInternalPropertyListener(IPropertyListener listener) { |
| internalPropChangeListeners.add(listener); |
| } |
| |
| /* package */ void removeInternalPropertyListener(IPropertyListener listener) { |
| internalPropChangeListeners.remove(listener); |
| } |
| |
| protected void fireInternalPropertyChange(int id) { |
| Object listeners[] = internalPropChangeListeners.getListeners(); |
| for (int i = 0; i < listeners.length; i++) { |
| ((IPropertyListener) listeners[i]).propertyChanged(this, id); |
| } |
| } |
| |
| /** |
| * @see IWorkbenchPart |
| */ |
| public void addPropertyListener(IPropertyListener listener) { |
| // The properties of a disposed reference will never change, so don't |
| // add listeners |
| if (isDisposed()) { |
| return; |
| } |
| |
| propChangeListeners.add(listener); |
| } |
| |
| /** |
| * @see IWorkbenchPart |
| */ |
| public void removePropertyListener(IPropertyListener listener) { |
| // Currently I'm not calling checkReference here for fear of breaking things late in 3.1, but it may |
| // make sense to do so later. For now we just turn it into a NOP if the reference is disposed. |
| if (isDisposed()) { |
| return; |
| } |
| propChangeListeners.remove(listener); |
| } |
| |
| |
| /* |
| * (non-Javadoc) |
| * |
| * @see org.eclipse.ui.IWorkbenchPartReference#getTitle() |
| */ |
| public String getTitle() { |
| return part.getLabel(); |
| } |
| |
| /* |
| * (non-Javadoc) |
| * |
| * @see org.eclipse.ui.IWorkbenchPartReference#getTitleToolTip() |
| */ |
| public String getTitleToolTip() { |
| String toolTip = part.getTooltip(); |
| return Util.safeString(toolTip); |
| } |
| |
| /* |
| * (non-Javadoc) |
| * |
| * @see org.eclipse.ui.IWorkbenchPartReference#getId() |
| */ |
| public String getId() { |
| return part.getId(); |
| } |
| |
| /** |
| * Computes a new title for the part. Subclasses may override to change the default behavior. |
| * |
| * @return the title for the part |
| */ |
| protected String computeTitle() { |
| return getRawTitle(); |
| } |
| |
| /** |
| * Returns the unmodified title for the part, or the empty string if none |
| * |
| * @return the unmodified title, as set by the IWorkbenchPart. Returns the empty string if none. |
| */ |
| protected final String getRawTitle() { |
| return Util.safeString(legacyPart.getTitle()); |
| } |
| |
| public final Image getTitleImage() { |
| if (isDisposed()) { |
| return PlatformUI.getWorkbench().getSharedImages().getImage(ISharedImages.IMG_DEF_VIEW); |
| } |
| |
| if (image == null) { |
| image = JFaceResources.getResources().createImageWithDefault(imageDescriptor); |
| } |
| return image; |
| } |
| |
| public ImageDescriptor getTitleImageDescriptor() { |
| if (isDisposed()) { |
| return PlatformUI.getWorkbench().getSharedImages().getImageDescriptor(ISharedImages.IMG_DEF_VIEW); |
| } |
| |
| return imageDescriptor; |
| } |
| |
| /* package */ void fireVisibilityChange() { |
| fireInternalPropertyChange(INTERNAL_PROPERTY_VISIBLE); |
| } |
| |
| /* package */ void fireZoomChange() { |
| fireInternalPropertyChange(INTERNAL_PROPERTY_ZOOMED); |
| } |
| |
| protected void firePropertyChange(int id) { |
| immediateFirePropertyChange(id); |
| } |
| |
| private void immediateFirePropertyChange(int id) { |
| UIListenerLogging.logPartReferencePropertyChange(this, id); |
| Object listeners[] = propChangeListeners.getListeners(); |
| for (int i = 0; i < listeners.length; i++) { |
| ((IPropertyListener) listeners[i]).propertyChanged(legacyPart, id); |
| } |
| |
| fireInternalPropertyChange(id); |
| } |
| |
| public abstract PartSite getSite(); |
| |
| public abstract void initialize(IWorkbenchPart part) throws PartInitException; |
| |
| private void addPropertyListeners() { |
| IWorkbenchPart workbenchPart = getPart(false); |
| if (workbenchPart != null) { |
| workbenchPart.addPropertyListener(new IPropertyListener() { |
| public void propertyChanged(Object source, int propId) { |
| firePropertyListeners(source, propId); |
| } |
| }); |
| |
| if (workbenchPart instanceof IWorkbenchPart3) { |
| ((IWorkbenchPart3) workbenchPart) |
| .addPartPropertyListener(new IPropertyChangeListener() { |
| public void propertyChange(PropertyChangeEvent event) { |
| firePartPropertyChange(event); |
| } |
| }); |
| |
| } |
| } |
| } |
| |
| private void firePropertyListeners(Object source, int propId) { |
| for (Object listener : propChangeListeners.getListeners()) { |
| ((IPropertyListener) listener).propertyChanged(source, propId); |
| } |
| } |
| |
| public final IWorkbenchPart getPart(boolean restore) { |
| if (isDisposed()) { |
| return null; |
| } |
| |
| if (legacyPart == null) { |
| if (restore) { |
| // ask the renderer to create this part |
| IPresentationEngine engine = (IPresentationEngine) windowContext |
| .get(IPresentationEngine.SERVICE_NAME); |
| engine.createGui(part); |
| } |
| |
| CompatibilityPart compatibilityPart = (CompatibilityPart) part.getObject(); |
| if (compatibilityPart != null) { |
| legacyPart = compatibilityPart.getPart(); |
| addPropertyListeners(); |
| } |
| } |
| return legacyPart; |
| |
| } |
| |
| public abstract IWorkbenchPart createPart() throws PartInitException; |
| |
| protected void doDisposeNestedParts() { |
| // To be implemented by subclasses |
| } |
| |
| /** |
| * |
| */ |
| public void doDisposePart() { |
| if (legacyPart != null) { |
| fireInternalPropertyChange(INTERNAL_PROPERTY_CLOSED); |
| // Don't let exceptions in client code bring us down. Log them and continue. |
| try { |
| legacyPart.removePropertyListener(propertyChangeListener); |
| if (legacyPart instanceof IWorkbenchPart3) { |
| ((IWorkbenchPart3) legacyPart) |
| .removePartPropertyListener(partPropertyChangeListener); |
| } |
| legacyPart.dispose(); |
| } catch (Exception e) { |
| WorkbenchPlugin.log(e); |
| } |
| legacyPart = null; |
| } |
| } |
| |
| public void setPinned(boolean newPinned) { |
| if (isDisposed()) { |
| return; |
| } |
| |
| if (newPinned == pinned) { |
| return; |
| } |
| |
| pinned = newPinned; |
| |
| setImageDescriptor(computeImageDescriptor()); |
| |
| fireInternalPropertyChange(INTERNAL_PROPERTY_PINNED); |
| } |
| |
| public boolean isPinned() { |
| return pinned; |
| } |
| |
| /* (non-Javadoc) |
| * @see org.eclipse.ui.IWorkbenchPartReference#getPartProperty(java.lang.String) |
| */ |
| public String getPartProperty(String key) { |
| if (legacyPart != null) { |
| if (legacyPart instanceof IWorkbenchPart3) { |
| return ((IWorkbenchPart3) legacyPart).getPartProperty(key); |
| } |
| } else { |
| return (String)propertyCache.get(key); |
| } |
| return null; |
| } |
| |
| /* (non-Javadoc) |
| * @see org.eclipse.ui.IWorkbenchPartReference#addPartPropertyListener(org.eclipse.jface.util.IPropertyChangeListener) |
| */ |
| public void addPartPropertyListener(IPropertyChangeListener listener) { |
| if (isDisposed()) { |
| return; |
| } |
| partChangeListeners.add(listener); |
| } |
| |
| /* (non-Javadoc) |
| * @see org.eclipse.ui.IWorkbenchPartReference#removePartPropertyListener(org.eclipse.jface.util.IPropertyChangeListener) |
| */ |
| public void removePartPropertyListener(IPropertyChangeListener listener) { |
| if (isDisposed()) { |
| return; |
| } |
| partChangeListeners.remove(listener); |
| } |
| |
| protected void firePartPropertyChange(PropertyChangeEvent event) { |
| Object[] l = partChangeListeners.getListeners(); |
| for (int i = 0; i < l.length; i++) { |
| ((IPropertyChangeListener) l[i]).propertyChange(event); |
| } |
| } |
| |
| protected void createPartProperties(IWorkbenchPart3 workbenchPart) { |
| Iterator i = propertyCache.entrySet().iterator(); |
| while (i.hasNext()) { |
| Map.Entry e = (Map.Entry) i.next(); |
| workbenchPart.setPartProperty((String) e.getKey(), (String) e.getValue()); |
| } |
| } |
| |
| /* (non-Javadoc) |
| * @see org.eclipse.ui.ISizeProvider#computePreferredSize(boolean, int, int, int) |
| */ |
| public int computePreferredSize(boolean width, int availableParallel, |
| int availablePerpendicular, int preferredResult) { |
| |
| ISizeProvider sizeProvider = (ISizeProvider) Util.getAdapter(legacyPart, |
| ISizeProvider.class); |
| if (sizeProvider != null) { |
| return sizeProvider.computePreferredSize(width, availableParallel, availablePerpendicular, preferredResult); |
| } |
| |
| return preferredResult; |
| } |
| |
| /* (non-Javadoc) |
| * @see org.eclipse.ui.ISizeProvider#getSizeFlags(boolean) |
| */ |
| public int getSizeFlags(boolean width) { |
| ISizeProvider sizeProvider = (ISizeProvider) Util.getAdapter(legacyPart, |
| ISizeProvider.class); |
| if (sizeProvider != null) { |
| return sizeProvider.getSizeFlags(width); |
| } |
| return 0; |
| } |
| |
| public IWorkbenchPage getPage() { |
| return page; |
| } |
| |
| /* |
| * (non-Javadoc) |
| * |
| * @see org.eclipse.ui.IWorkbenchPartReference#getPartName() |
| */ |
| public String getPartName() { |
| return part.getLabel(); |
| } |
| |
| /* |
| * (non-Javadoc) |
| * |
| * @see org.eclipse.ui.IWorkbenchPartReference#getContentDescription() |
| */ |
| public String getContentDescription() { |
| IWorkbenchPart workbenchPart = getPart(false); |
| if (workbenchPart instanceof IWorkbenchPart2) { |
| return ((IWorkbenchPart2) workbenchPart).getContentDescription(); |
| } |
| return workbenchPart.getTitle(); |
| } |
| |
| /* |
| * (non-Javadoc) |
| * |
| * @see org.eclipse.ui.IWorkbenchPartReference#isDirty() |
| */ |
| public boolean isDirty() { |
| IWorkbenchPart part = getPart(false); |
| if (part instanceof ISaveablePart) { |
| return ((ISaveablePart) part).isDirty(); |
| } |
| return false; |
| } |
| |
| public void invalidate() { |
| legacyPart = null; |
| } |
| } |
