org.eclipse.ui.part.IShowInTarget Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of workbench Show documentation

This plug-in contains the bulk of the Workbench implementation, and depends on JFace, SWT, and Core Runtime. It cannot be used independently from org.eclipse.ui. Workbench client plug-ins should not depend directly on this plug-in.

The newest version!

/*******************************************************************************
 * 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.part;

/**
 * This interface must be provided by Show In targets (parts listed
 * in the Show In prompter).
 * The part can either directly implement this interface, or provide it
 * via IAdaptable.getAdapter(IShowInTarget.class).
 * 
 * @see org.eclipse.ui.IPageLayout#addShowInPart
 * 
 * @since 2.1
 */
public interface IShowInTarget {

    /**
     * Shows the given context in this target.
     * The target should check the context's selection for elements
     * to show.  If there are no relevant elements in the selection,
     * then it should check the context's input. 
     *
     * @param context the context to show
     * @return true if the context could be shown,
     *   false otherwise
     */
    public boolean show(ShowInContext context);
}