IMemoryBlockTablePresentation


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  
12  
13  package org.eclipse.debug.ui.memory;
14  
15  import java.math.BigInteger  ;
16  import org.eclipse.debug.core.model.IMemoryBlock;
17  import org.eclipse.debug.ui.IDebugModelPresentation;
18  
19  
20  /**
21   * Allows debug models to customize the rendering of addresses for its memory blocks
22   * in table and text based renderings provided by the debug platform.
23   * <p>
24   * To contribute a memory block table presentation, implement your debug model
25   * presentation as documented in <code>org.eclipse.debug.ui.IDebugModelPresentation</code>.
26   * In addition, implement this interface in your debug model presentation.  Your model
27   * presentation will be called when <code>org.eclipse.debug.ui.memory.AbstractTableRendering</code>
28   * constructs its column and row labels. 
29   * </p>
30   * <p>
31   * Clients may implement this interface.
32   * </p>
33   * @since 3.1
34   */
35  public interface IMemoryBlockTablePresentation extends IDebugModelPresentation
36  {
37      
38      /**
39       * Returns a collection of labels to head columns in a <code>AbstractTableRendering</code>
40       * rendering, or <code>null</code> if default labels should be used.
41       *  
42       * @param blk memory block
43       * @param bytesPerLine the number if bytes to be displayed
44       * @param numColumns the number of columns the bytes are divided into 
45       * @return a collection of labels to head columns in a <code>AbstractTableRendering</code>
46       * rendering, or <code>null</code> if default labels should be used
47       */
48      public String  [] getColumnLabels(IMemoryBlock blk, int bytesPerLine, int numColumns);
49      
50      
51      /**
52       * Renders and returns a label for a row starting at the given address within the given
53       * memory block, or <code>null</code> if default rendering should be used.
54       * 
55       * @param blk memory block
56       * @param address an address in the memory block
57       * @return a label for a row starting at the given address within the given
58       * memory block, or <code>null</code> if default rendering should be used
59       */
60      public String   getRowLabel(IMemoryBlock blk, BigInteger   address);
61      
62  }
63
A to Z: JavaDoc & Examples Daily Java News & Articles Open Source Projects Open Source Codes Free Computer Books Remove Frame
Popular Tags