KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > eclipse > debug > ui > sourcelookup > ISourceDisplay


1 /*******************************************************************************
2  * Copyright (c) 2005, 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.ui.sourcelookup;
12
13 import org.eclipse.ui.IWorkbenchPage;
14
15 /**
16  * Displays source for a debug model element. The debug platform displays
17  * source whenever a debug context containing a single element is
18  * activated (a structured selection with one element). The debug platform
19  * displays source by asking an element for its <code>ISourceDisplay</code>
20  * adapter or using the element directly if it implements <code>ISourceDisplay</code>.
21  * <p>
22  * The debug platform provides a source display adapter for instances
23  * of <code>IStackFrame</code>. The standard adapter uses the source locator associated
24  * with the stack frame's launch to lookup source. Clients may provide their own
25  * source display adapters as required.
26  * </p>
27  * <p>
28  * Clients may implement this interface.
29  * </p>
30  * @see org.eclipse.core.runtime.IAdaptable
31  * @since 3.3
32  */
33 public interface ISourceDisplay {
34     
35     /**
36      * Displays source for the given element in the specified page.
37      *
38      * @param element debug model element to display source for
39      * @param page the page in which to display source
40      * @param forceSourceLookup whether source lookup should be performed,
41      * ignoring any previously cached results for the same element
42      */
43     public void displaySource(Object JavaDoc element, IWorkbenchPage page, boolean forceSourceLookup);
44     
45 }
46
Popular Tags