blob: fd8c21c6c62d7fc79ab29d12fd05eb4bb0409522 (
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
|
/*******************************************************************************
* Copyright (c) 2000, 2006 IBM Corporation and others.
*
* This program and the accompanying materials
* are made available under the terms of the Eclipse Public License 2.0
* which accompanies this distribution, and is available at
* https://www.eclipse.org/legal/epl-2.0/
*
* SPDX-License-Identifier: EPL-2.0
*
* Contributors:
* IBM Corporation - initial API and implementation
*******************************************************************************/
package org.eclipse.ui.model;
import org.eclipse.jface.resource.ImageDescriptor;
/**
* This adapter interface provides visual presentation and hierarchical structure
* for workbench elements, allowing them to be displayed in the UI
* without having to know the concrete type of the element.
* <p>
* There is an associate label provider and content provider for showing
* elements with a registered workbench adapter in JFace structured viewers.
* </p>
* @see WorkbenchLabelProvider
* @see BaseWorkbenchContentProvider
*/
public interface IWorkbenchAdapter {
/**
* Returns the children of this object. When this object
* is displayed in a tree, the returned objects will be this
* element's children. Returns an empty array if this
* object has no children.
*
* @param o The object to get the children for.
* @return Object[]
*/
Object[] getChildren(Object o);
/**
* Returns an image descriptor to be used for displaying an object in the workbench.
* Returns <code>null</code> if there is no appropriate image.
*
* @param object The object to get an image descriptor for.
* @return ImageDescriptor
*/
ImageDescriptor getImageDescriptor(Object object);
/**
* Returns the label text for this element. This is typically
* used to assign a label to this object when displayed
* in the UI. Returns an empty string if there is no appropriate
* label text for this object.
*
* @param o The object to get a label for.
* @return String
*/
String getLabel(Object o);
/**
* Returns the logical parent of the given object in its tree.
* Returns <code>null</code> if there is no parent, or if this object doesn't
* belong to a tree.
*
* @param o The object to get the parent for.
* @return Object
*/
Object getParent(Object o);
}
|
