KickJava   Java API By Example, From Geeks To Geeks.

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


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
14
15 /**
16  * A memory rendering container is a container within a memory rendering site
17  * for hosting a memory renderings.
18  * <p>
19  * Clients hosting memory renderings may implement this interface.
20  * </p>
21  * @since 3.1
22  */
23 public interface IMemoryRenderingContainer {
24     /**
25      * Returns the rendering site hosting this container.
26      *
27      * @return the rendering site hosting this container
28      */
29     public IMemoryRenderingSite getMemoryRenderingSite();
30     
31     /**
32      * Returns the identifier of this container. Identifiers
33      * are unique within a container.
34      *
35      * @return the identifier of this container
36      */
37     public String JavaDoc getId();
38     
39     /**
40      * Adds the given rendering to this container. A rendering must be
41      * initialized before it is added to a container. This causes
42      * the rendering's control to be created.
43      *
44      * @param rendering the rendering to add
45      */
46     public void addMemoryRendering(IMemoryRendering rendering);
47     
48     /**
49      * Removes the given rendering from this container. This
50      * causes the rendering to be disposed.
51      *
52      * @param rendering the rendering to remove
53      */
54     public void removeMemoryRendering(IMemoryRendering rendering);
55     
56     /**
57      * Returns all renderings currently hosted by this container.
58      *
59      * @return all renderings currently hosted by this container
60      */
61     public IMemoryRendering[] getRenderings();
62     
63     /**
64      * Returns the active rendering in this container, or <code>null</code>
65      * if none.
66      *
67      * @return the active rendering in this container, or <code>null</code>
68      * if none
69      */
70     public IMemoryRendering getActiveRendering();
71     
72     /**
73      * Returns the label for this container.
74      *
75      * @return the label for this container
76      */
77     public String JavaDoc getLabel();
78 }
79
Popular Tags