org.eclipse.debug.ui.IDetailPane Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of org.eclipse.debug.ui Show documentation
This is org.eclipse.debug.ui jar used by Scout SDK
The newest version!
/*******************************************************************************
 *  Copyright (c) 2006, 2008 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
 *     Wind River - Anton Leherbauer - Fix selection provider (Bug 254442)
 *******************************************************************************/
package org.eclipse.debug.ui;

import org.eclipse.jface.viewers.IStructuredSelection;
import org.eclipse.swt.widgets.Composite;
import org.eclipse.swt.widgets.Control;
import org.eclipse.ui.IWorkbenchPartSite;

/**
 * A detail pane is created from a detail pane factory and displays detailed information about
 * a current selection with an SWT Control. Use the
 * org.eclipse.debug.ui.detailFactories extension point to contribute a detail pane
 * factory.
 * 
 * Implementors should implement {@link IDetailPane2} in favor of this interface.
 * 
 * @see IDetailPaneFactory
 * @see IDetailPane2
 * @since 3.3 
 */
public interface IDetailPane {

	/**
	 * Initializes this detail pane for the given workbench part site. This is the first method
	 * invoked on a detail pane after instantiation.  If this detail pane is being added to a
	 * non-view component such as a dialog, the passed workbench part site will be null.
	 * 
	 * @param partSite The workbench part site that this detail pane has been created in or null
	 */
	public void init(IWorkbenchPartSite partSite);
	
	/**
	 * Creates and returns the main control for this detail pane using the given composite as a
	 * parent.
	 * 
	 * @param parent The parent composite that UI components should be added to
	 * @return The main control for this detail pane
	 */
	public Control createControl(Composite parent);
	
	/**
	 * Disposes this detail pane. This is the last method invoked on a detail pane and should
	 * dispose of all UI components including the main composite returned in createControl().
	 */
	public void dispose();
	
	/**
	 * Displays details for the given selection, possible null.  An empty selection
	 * or null should clear this detail pane.
	 * 
	 * @param selection The selection to be displayed, possibly empty or null
	 */
	public void display(IStructuredSelection selection);
	
	/**
	 * Allows this detail pane to give focus to an appropriate control, and returns whether
	 * the detail pane accepted focus. If this detail pane does not want focus, it should
	 * return false, allowing the containing view to choose another target
	 * for focus.
	 * 
	 * @return whether focus was taken
	 */
	public boolean setFocus();
	
	/**
	 * Returns a unique identifier for this detail pane.
	 * 
	 * @return A unique identifier for this detail pane
	 */
	public String getID();
	
	/**
	 * The human readable name of this detail pane. This is a short description of the type
	 * of details this pane displays that appears in the context menu.
	 * 
	 * @return name of this detail pane
	 */
	public String getName();
	
	/**
	 * A brief description of this detail pane, or null if none
	 * 
	 * @return a description of this detail pane, or null if none
	 */
	public String getDescription();
	
}