KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > eclipse > debug > ui > memory > IMemoryRenderingSite


1 /*******************************************************************************
2  * Copyright (c) 2004, 2006 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.memory;
12
13 import org.eclipse.ui.IWorkbenchPartSite;
14
15 /**
16  * A workbench site that hosts memory renderings and provides
17  * synchronization services for memory renderings.
18  * <p>
19  * A rendering site has an optional synchronization provider at any one time. If a
20  * rendering provides synchronization information it should set itself as the synchronization
21  * provider for its memory rendering site when it is activated.
22  * </p>
23  * <p>
24  * Clients hosting memory rendering may implement this interface.
25  * </p>
26  * @since 3.1
27  */
28 public interface IMemoryRenderingSite {
29
30     /**
31      * Returns the workbench part site hosting memory renderings for this rendering site.
32      *
33      * @return the view site hosting memory renderings for this rendering site
34      */
35     public IWorkbenchPartSite getSite();
36         
37     /**
38      * Returns the syncrhonization service for this rendering site
39      * or <code>null</code> if none.
40      *
41      * @return the syncrhonization service for this rendering site or <code>null</code>
42      */
43     public IMemoryRenderingSynchronizationService getSynchronizationService();
44     
45     /**
46      * Returns all the memory rendering containers within this rendering site.
47      *
48      * @return all the memory rendering containers within this rendering site
49      */
50     public IMemoryRenderingContainer[] getMemoryRenderingContainers();
51     
52     /**
53      * Returns the rendering container with the given id or <code>null</code>
54      * if none.
55      *
56      * @param id identifier of the container being requested
57      * @return the rendering container with the given id or <code>null</code>
58      * if none
59      */
60     public IMemoryRenderingContainer getContainer(String JavaDoc id);
61     
62     
63 }
64
Popular Tags