/******************************************************************************* * Copyright (c) 2006, 2013 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.debug.ui; import java.util.Set; import org.eclipse.jface.viewers.IStructuredSelection; /** * A detail pane factory creates one or more types of detail panes. *
* Detail pane factories are contributed via the org.eclipse.debug.ui.detailPaneFactories
* extension point. Following is an example of a detail pane factory extension:
*
* <extension point="org.eclipse.debug.ui.detailPaneFactories"> * <detailFactories * class="org.eclipse.temp.TableDetailPaneFactory" * name="Table Detail Factory"> * </detailFactories> * </extension> ** *
*
* Clients contributing a detail pane factory are intended to implement this interface.
* @see IDetailPane
* @since 3.3
*
*/
public interface IDetailPaneFactory {
/**
* Returns all possible types detail panes that this factory can
* create for the given selection, possibly empty. Detail panes are returned
* as a set of detail pane identifiers.
*
* @param selection The current selection
* @return Set of String IDs for possible detail pane types, possibly empty
*/
public Setnull
if this factory has no preference.
* A factory can override the platform's default detail pane by returning
* a non-null
value.
*
* @param selection The current selection
* @return a detail pane type identifier or null
*/
public String getDefaultDetailPane(IStructuredSelection selection);
/**
* Creates and returns a detail pane corresponding to the given detail pane
* type identifier that this factory can produce (according to
* getDetailPaneTypes(IStructuredSelection selection)
).
*
* @param paneID The id of the detain pane type to be created
* @return detail pane or null
if one could not be created
*/
public IDetailPane createDetailPane(String paneID);
/**
* Returns a name for the detail pane type associated with the given ID
* or null
if none. Used to
* populate the context menu with meaningful names of the pane types.
*
* @param paneID detail pane type identifier
* @return detail pane name or null
if none
*/
public String getDetailPaneName(String paneID);
/**
* Returns a description for the detail pane type associated with the given ID
* or null
if none.
*
* @param paneID detail pane type identifier
* @return detail pane description or null
if none
*/
public String getDetailPaneDescription(String paneID);
}