IDynamicRenderingInfo


1   /*******************************************************************************
2    * Copyright (c) 2004 IBM Corporation and others.
3    * All rights reserved. This program and the accompanying materials 
4    * are made available under the terms of the Common Public License v1.0
5    * which accompanies this distribution, and is available at
6    * http://www.eclipse.org/legal/cpl-v10.html
7    * 
8    * Contributors:
9    *     IBM Corporation - initial API and implementation
10   *******************************************************************************/
11  package org.eclipse.debug.internal.core.memory;
12  
13  
14  /**
15   * This interface represents a dynamic rendering type to be determined
16   * by debug providers at runtime. 
17   * 
18   * Dynamic rendering types must be tied to a rendering extension.
19   * When IMemoryRenderingManager.getAllRenderingInfo(Object obj) is called,
20   * the manager will query for the "dynamicRenderingFactory" property from all rendering extensions.
21   * 
22   * If this property is defined in the rendering, the rendering defined will be considered
23   * dynamic.  The manager will ask the dynamicRenderingFactory for a list of rendering types.
24   * 
25   * The manager will create IMemoryRenderingInfo ojbect for each of the dynamic rendering
26   * type.  The dynamic rendering info will have all the properties defined in the extension.
27   * When one of these dynamic renderings is created, it will use the rendering factory defined
28   * in the extension to create the rendering.
29   * @since 3.0
30   */
31  public interface IDynamicRenderingInfo {
32      
33      /**
34       * @return the parent rendering definition of the dynamic rendering type
35       */
36      IMemoryRenderingInfo getParentRenderingInfo();
37      
38      /**
39       * @return the rendering id of this rendering
40       */
41      String   getRenderingId();
42      
43      /**
44       * @return the name of this dynamic rendering
45       */
46      String   getName();
47  }
48
A to Z: JavaDoc & Examples Daily Java News & Articles Open Source Projects Open Source Codes Free Computer Books Remove Frame
Popular Tags