blob: 4c2e7c616ba69fe90eec1082b15b76a750bc0f6c (
plain) (
blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
|
/*******************************************************************************
* Copyright (c) 2006, 2011 IBM Corporation and others.
* All rights reserved. This program and the accompanying materials
* are made available under the terms of the Eclipse Public License v1.0
* which accompanies this distribution, and is available at
* http://www.eclipse.org/legal/epl-v10.html
*
* Contributors:
* IBM Corporation - initial API and implementation
* Wind River Systems, Inc. - adapted for for disassembly parts
*******************************************************************************/
package org.eclipse.cdt.debug.ui.disassembly.rulers;
import org.eclipse.core.runtime.IConfigurationElement;
import org.eclipse.jface.text.source.IVerticalRulerColumn;
import org.eclipse.ui.IWorkbenchPart;
/**
* Interface that has to be implemented by contributions to the
* <code>org.eclipse.cdt.debug.ui.disassembly.rulerColumns</code> extension point.
* <p>
* Implementors must have a zero-argument constructor so that they can be created
* by {@link IConfigurationElement#createExecutableExtension(String)}.</p>
*
* @since 7.2
*/
public interface IContributedRulerColumn extends IVerticalRulerColumn {
/**
* Returns the extension point descriptor of this ruler.
*
* @return descriptor the extension point descriptor of this ruler or <code>null</code> if called before {@link #columnCreated()}
*/
RulerColumnDescriptor getDescriptor();
/**
* Sets the extension point descriptor of this ruler.
* <p>
* <em>This method will be called by the framework and must not
* be called by clients.</em></p>
*
* @param descriptor the extension point descriptor
*/
void setDescriptor(RulerColumnDescriptor descriptor);
/**
* Sets the disassembly part (called right after the extension was instantiated).
* <p>
* <em>This method will be called by the framework and must not
* be called by clients.</em></p>
*
* @param disassembly the disassembly part targeted by this ruler instance
*/
void setDisassemblyPart(IWorkbenchPart disassembly);
/**
* Returns the disassembly part targeted by this ruler instance.
*
* @return the disassembly part targeted by this ruler instance or <code>null</code> if called before {@link #columnCreated()}
*/
IWorkbenchPart getDisassemblyPart();
/**
* Hook method called after a column has been instantiated, but before it is
* added to a {@link org.eclipse.jface.text.source.CompositeRuler} and before
* {@linkplain org.eclipse.jface.text.source.IVerticalRulerColumn#createControl(org.eclipse.jface.text.source.CompositeRuler, org.eclipse.swt.widgets.Composite) createControl}
* is called.
* <p>
* This happens when
* <ul>
* <li>the column is set visible by the user or programmatically</li>
* <li>the disassembly part is created, if this ruler targets the disassembly part and is enabled by default</li>
* <li>the disassembly part input changes and the column now targets the new disassembly part contents.</li>
* </ul></p>
*/
void columnCreated();
/**
* Hook method called after a column has been removed from the {@link org.eclipse.jface.text.source.CompositeRuler}.
* <p>
* This happens when
* <ul>
* <li>the column is hidden by the user or programmatically</li>
* <li>the disassembly part is closed</li>
* <li>the disassembly part input changes and the column no longer targets the disassembly part
* contents.</li>
* </ul>
* </p>
* <p>
* The column will not be used after this method has been called. A new
* column will be instantiated if the same column type should be shown for
* the same disassembly part.
* </p>
*/
void columnRemoved();
}
|
