Eclipse中的IPartListener2

最新推荐文章于 2021-08-23 16:20:07 发布

原创最新推荐文章于 2021-08-23 16:20:07 发布 · 854 阅读

0 ·

CC 4.0 BY-SA版权

文章标签：

#eclipse #interface #string #properties #ibm #delegates

本文介绍如何使用IPartListener2接口来监听Eclipse工作台中各部件的状态变化，包括激活、关闭、隐藏等事件。

IPartListener2是用于监听工作空间workbench内各个WorkbenchPart的状态变化。

使用如下：ViewPart.getSite().getWorkbenchWindow().getPartService().addPartListener(
_partListener);

接口定义如下：

/******************************************************************************* * Copyright (c) 2000, 2006 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.ui; /** * Interface for listening to part lifecycle events. * * This is a replacement for <code>IPartListener</code>. * * This interface may be implemented by clients. * * * @see IPartService#addPartListener(IPartListener2) */ public interface IPartListener2 { /** * Notifies this listener that the given part has been activated. * * @param partRef the part that was activated * @see IWorkbenchPage#activate */ public void partActivated(IWorkbenchPartReference partRef); /** * Notifies this listener that the given part has been brought to the top. * * These events occur when an editor is brought to the top in the editor area, * or when a view is brought to the top in a page book with multiple views. * They are normally only sent when a part is brought to the top * programmatically (via <code>IPerspective.bringToTop</code>). When a part is * activated by the user clicking on it, only <code>partActivated</code> is sent. * * * @param partRef the part that was surfaced * @see IWorkbenchPage#bringToTop */ public void partBroughtToTop(IWorkbenchPartReference partRef); /** * Notifies this listener that the given part has been closed. * * Note that if other perspectives in the same page share the view, * this notification is not sent. It is only sent when the view * is being removed from the page entirely (it is being disposed). * * * @param partRef the part that was closed * @see IWorkbenchPage#hideView */ public void partClosed(IWorkbenchPartReference partRef); /** * Notifies this listener that the given part has been deactivated. * * @param partRef the part that was deactivated * @see IWorkbenchPage#activate */ public void partDeactivated(IWorkbenchPartReference partRef); /** * Notifies this listener that the given part has been opened. * * Note that if other perspectives in the same page share the view, * this notification is not sent. It is only sent when the view * is being newly opened in the page (it is being created). * * * @param partRef the part that was opened * @see IWorkbenchPage#showView */ public void partOpened(IWorkbenchPartReference partRef); /** * Notifies this listener that the given part is hidden or obscured by another part. * * @param partRef the part that is hidden or obscured by another part */ public void partHidden(IWorkbenchPartReference partRef); /** * Notifies this listener that the given part is visible. * * @param partRef the part that is visible */ public void partVisible(IWorkbenchPartReference partRef); /** * Notifies this listener that the given part's input was changed. * * @param partRef the part whose input was changed */ public void partInputChanged(IWorkbenchPartReference partRef); }

这是IWorkbenchPartReference 的类定义

/******************************************************************************* * Copyright (c) 2000, 20078 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.ui; import org.eclipse.jface.util.IPropertyChangeListener; import org.eclipse.swt.graphics.Image; /** * Implements a reference to a IWorkbenchPart. * The IWorkbenchPart will not be instantiated until the part * becomes visible or the API getPart is sent with true; * * This interface is not intended to be implemented by clients. * * @noimplement This interface is not intended to be implemented by clients. */ public interface IWorkbenchPartReference { /** * Returns the IWorkbenchPart referenced by this object. * Returns <code>null</code> if the editors was not instantiated or * it failed to be restored. Tries to restore the editor * if <code>restore</code> is true. */ public IWorkbenchPart getPart(boolean restore); /** * @see IWorkbenchPart#getTitle */ public String getTitle(); /** * @see IWorkbenchPart#getTitleImage */ public Image getTitleImage(); /** * @see IWorkbenchPart#getTitleToolTip */ public String getTitleToolTip(); /** * @see IWorkbenchPartSite#getId */ public String getId(); /** * @see IWorkbenchPart#addPropertyListener */ public void addPropertyListener(IPropertyListener listener); /** * @see IWorkbenchPart#removePropertyListener */ public void removePropertyListener(IPropertyListener listener); /** * Returns the workbench page that contains this part */ public IWorkbenchPage getPage(); /** * Returns the name of the part, as it should be shown in tabs. * * @return the part name * * @since 3.0 */ public String getPartName(); /** * Returns the content description for the part (or the empty string if none) * * @return the content description for the part * * @since 3.0 */ public String getContentDescription(); /** * Returns whether the part is dirty (i.e. has unsaved changes). * * @return <code>true</code> if the part is dirty, <code>false</code> otherwise * * @since 3.2 (previously existed on IEditorReference) */ public boolean isDirty(); /** * Return an arbitrary property from the reference. If the part has been * instantiated, it just delegates to the part. If not, then it looks in its * own cache of properties. If the property is not available or the part has * never been instantiated, it can return <code>null</code>. * * @param key * The property to return. Must not be <code>null</code>. * @return The String property, or <code>null</code>. * @since 3.3 */ public String getPartProperty(String key); /** * Add a listener for changes in the arbitrary properties set. * * @param listener * Must not be <code>null</code>. * @since 3.3 */ public void addPartPropertyListener(IPropertyChangeListener listener); /** * Remove a listener for changes in the arbitrary properties set. * * @param listener * Must not be <code>null</code>. * @since 3.3 */ public void removePartPropertyListener(IPropertyChangeListener listener); }