blob: 448dfc845cd4c6d8926a4a3b26344ea00efc598b (
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
|
/*******************************************************************************
* Copyright (c) 2006 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
*******************************************************************************/
package org.eclipse.debug.internal.ui.viewers.model.provisional;
import org.eclipse.jface.resource.ImageDescriptor;
/**
* Defines the possible set of columns presented in a view for a model.
* A column presentation is customizable per presentation context (view) and
* view input, and is created by an <code>IColumnPresentationFactoryAdapter</code>.
*
* @since 3.2
*/
public interface IColumnPresentation {
/**
* Initializes this column presentation to be used in the
* given context.
*
* @param context
*/
public void init(IPresentationContext context);
/**
* Disposes this column presentation
*/
public void dispose();
/**
* Returns an array of all columns supported by this adapter as
* column identifiers.
*
* @return column identifiers
*/
public String[] getAvailableColumns();
/**
* Returns an ordered array of columns that should be displayed initially for
* this presentation as column IDs.
*
* @return initial columns to display
*/
public String[] getInitialColumns();
/**
* Returns the column header for the column with the given identifier.
*
* @param id a column identifier included in <code>getColumns()</code>
* @return column header
*/
public String getHeader(String id);
/**
* Returns the image for the column with the given identifier, or <code>null</code>
*
* @param id column id
* @return image descriptor or <code>null</code>
*/
public ImageDescriptor getImageDescriptor(String id);
/**
* Returns an identifier for this columns presentation.
* The identifier should be unique per kind of column presentation
* (for example, the column presentation for Java stack frames
* in the variables view). Allows visible column information to be
* persisted by the platform.
*
* @return identifier
*/
public String getId();
/**
* Returns whether this column presentation is optional. When a column presentation
* is optional, the user may toggle columns on/off.
*
* @return whether this column presentation is optional
*/
public boolean isOptional();
}
|
