IDetailPaneContainer


1   /*******************************************************************************
2    * Copyright (c) 2007 IBM Corporation and others.
3    * All rights reserved. This program and the accompanying materials
4    * are made available under the terms of the Eclipse Public License v1.0
5    * which accompanies this distribution, and is available at
6    * http://www.eclipse.org/legal/epl-v10.html
7    * 
8    * Contributors:
9    *     IBM Corporation - initial API and implementation
10   *******************************************************************************/
11  package org.eclipse.debug.internal.ui.views.variables.details;
12  
13  import org.eclipse.jface.viewers.IStructuredSelection;
14  import org.eclipse.swt.widgets.Composite;
15  import org.eclipse.ui.IWorkbenchPartSite;
16  
17  /**
18   * Interface for UI elements that contain detail panes.  Provides access to 
19   * information about the current detail pane and allows the container to be
20   * informed of changes.
21   *
22   * @since 3.3
23   * @see AvailableDetailPanesAction
24   * @see DetailPaneProxy
25   */
26  public interface IDetailPaneContainer {
27  
28      /**
29       * Returns the string ID of the detail pane currently being displayed.
30       * 
31       * @return the ID of the current detail pane
32       */
33      public String   getCurrentPaneID();
34      
35      /**
36       * Returns the selection to be displayed in the detail pane.
37       * 
38       * @return the selection to be displayed in the detail pane.
39       */
40      public IStructuredSelection getCurrentSelection();
41      
42      /**
43       * Returns the composite that detail panes will be added to.
44       * 
45       * @return the composite that detail panes will be added to
46       */
47      public Composite getParentComposite();
48      
49      /**
50       * Returns the workbench part site that the detail pane is in or <code>null</code>
51       * if the detail pane is not in a workbench part site.
52       * 
53       * @return the workbench part site the detail pane is in or <code>null</code>
54       */
55      public IWorkbenchPartSite getWorkbenchPartSite();
56      
57      /**
58       * Refreshes the current detail pane with the current selection.
59       */
60      public void refreshDetailPaneContents();
61      
62      /**
63       * Informs the container that the type of detail pane being used has changed.
64       * 
65       * @param newPaneID ID of the new detail pane
66       */
67      public void paneChanged(String   newPaneID);
68      
69  }
70
A to Z: JavaDoc & Examples Daily Java News & Articles Open Source Projects Open Source Codes Free Computer Books Remove Frame
Popular Tags