IMemoryRenderingSynchronizationService


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.debug.core.model.IMemoryBlock;
14  import org.eclipse.jface.util.IPropertyChangeListener;
15  
16  
17  /**
18   * Provides facilities related to the synchronization of memory renderings.
19   * <p>
20   * Clients hosting renderings may implement this interface.
21   * </p>
22   * @since 3.1
23   */
24  public interface IMemoryRenderingSynchronizationService {
25      
26      /**
27       * Adds a listener for property changes notification for the specified properties.
28       * Specifying <code>null</code> indicates that the listener is interested in all 
29       * properties. If an identical listener is already registered, the properties
30       * it is registered to listen for are updated.
31       *
32       * @param listener a property change listener
33       * @param properties properties the listener is interested in, or <code>null</code>
34       *  to indicate all properties.
35       */    
36      public void addPropertyChangeListener(IPropertyChangeListener listener, String  [] properties);
37      
38      /**
39       * Removes the given listener for property change notification.
40       * Has no effect if the identical listener is not registered.
41       *
42       * @param listener a property change listener
43       */
44      public void removePropertyChangeListener(IPropertyChangeListener listener);
45      
46      /**
47       * Returns the current value of the specified property for the given memory block, or
48       * <code>null</code> if none.
49       * 
50       * @param block memory block for which a property is requested
51       * @param property the name of the property
52       * @return the property value or <code>null</code>
53       */
54      public Object   getProperty(IMemoryBlock block, String   property);
55      
56      /**
57       * Sets the rendering currently providing sychronization information for
58       * this synchronization service, or <code>null</code> if none.
59       * 
60       * @param rendering active rendering providing synchronization information or
61       *  <code>null</code>
62       */
63      public void setSynchronizationProvider(IMemoryRendering rendering);
64      
65      /**
66       * Returns the rendering currently providing synchronization information for
67       * this synchronization service, or <code>null</code if none.
68       * 
69       * @return rendering providing synchronization information or <code>null</code>
70       */
71      public IMemoryRendering getSynchronizationProvider(); 
72  }
73
A to Z: JavaDoc & Examples Daily Java News & Articles Open Source Projects Open Source Codes Free Computer Books Remove Frame
Popular Tags