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
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
|
/*******************************************************************************
* Copyright (c) 2000, 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.pde.internal.ui.editor;
import org.eclipse.jface.viewers.IStructuredContentProvider;
import org.eclipse.pde.internal.ui.parts.ILinkLabelProvider;
import org.eclipse.swt.SWT;
import org.eclipse.swt.custom.BusyIndicator;
import org.eclipse.swt.events.SelectionAdapter;
import org.eclipse.swt.events.SelectionEvent;
import org.eclipse.swt.graphics.Image;
import org.eclipse.swt.layout.GridData;
import org.eclipse.swt.layout.GridLayout;
import org.eclipse.swt.widgets.Button;
import org.eclipse.swt.widgets.Composite;
import org.eclipse.swt.widgets.Control;
import org.eclipse.ui.forms.events.HyperlinkEvent;
import org.eclipse.ui.forms.events.IHyperlinkListener;
import org.eclipse.ui.forms.widgets.FormToolkit;
import org.eclipse.ui.forms.widgets.Hyperlink;
import org.eclipse.ui.forms.widgets.ImageHyperlink;
import org.eclipse.ui.forms.widgets.Section;
/**
* This class can be used to show a standard section with an array of links.
* Links are objects from editor pages, and each one will select the owning
* page and reveal the element in it. If the number of objects from the content
* provider is greated than the preset limit, only the first 'limit' number of
* links will be shown, and a 'More...' button will show up (this is a change
* from 2.1 where 'More...' was visible all the time).
*/
public class LinkSection extends PDESection {
private ILinkLabelProvider labelProvider;
private IStructuredContentProvider contentProvider;
private Composite linkContainer;
private Composite container;
private Button moreButton;
private String morePageId;
private int linkNumberLimit = 20;
private LinkHandler linkHandler;
class LinkHandler implements IHyperlinkListener {
public void linkActivated(HyperlinkEvent e) {
doLinkActivated((Hyperlink) e.widget);
}
public void linkEntered(HyperlinkEvent e) {
doEnter((Hyperlink) e.widget);
}
public void linkExited(HyperlinkEvent e) {
doExit((Hyperlink) e.widget);
}
}
/**
* @param page
* @param parent
* @param style
*/
public LinkSection(PDEFormPage page, Composite parent, int style) {
super(page, parent, style);
FormToolkit toolkit = page.getManagedForm().getToolkit();
linkHandler = new LinkHandler();
createClient(getSection(), toolkit);
}
/*
* (non-Javadoc)
*
* @see org.eclipse.pde.internal.ui.neweditor.PDESection#createClient(org.eclipse.ui.forms.widgets.Section,
* org.eclipse.ui.forms.widgets.FormToolkit)
*/
protected void createClient(Section section, FormToolkit toolkit) {
container = toolkit.createComposite(section);
GridLayout layout = new GridLayout();
layout.numColumns = 2;
container.setLayout(layout);
section.setClient(container);
linkContainer = toolkit.createComposite(container);
linkContainer.setLayoutData(new GridData(GridData.FILL_BOTH));
GridLayout linkLayout = new GridLayout();
linkLayout.marginWidth = 0;
linkLayout.marginHeight = 0;
linkLayout.verticalSpacing = 0;
linkContainer.setLayout(linkLayout);
}
private void createMoreButton() {
moreButton = getManagedForm().getToolkit().createButton(container, "More...", //$NON-NLS-1$
SWT.PUSH);
moreButton.addSelectionListener(new SelectionAdapter() {
public void widgetSelected(SelectionEvent e) {
BusyIndicator.showWhile(getSection().getDisplay(),
new Runnable() {
public void run() {
getPage().getEditor().setActivePage(morePageId);
}
});
}
});
moreButton
.setLayoutData(new GridData(GridData.VERTICAL_ALIGN_BEGINNING));
}
public void add(Object[] links) {
for (int i = 0; i < links.length; i++) {
createLink(links[i]);
}
updateMoreState(linkContainer.getChildren().length > linkNumberLimit);
reflow();
}
public void remove(Object[] links) {
for (int i = 0; i < links.length; i++) {
disposeLink(links[i]);
}
updateMoreState(linkContainer.getChildren().length > linkNumberLimit);
reflow();
}
private void disposeLink(Object obj) {
Hyperlink link = find(obj);
if (link != null)
link.dispose();
}
private Hyperlink find(Object object) {
Control[] children = linkContainer.getChildren();
for (int i = 0; i < children.length; i++) {
Control child = children[i];
if (child.getData().equals(object))
return (Hyperlink) child;
}
return null;
}
public void update(Object[] links) {
for (int i = 0; i < links.length; i++) {
update(links[i]);
}
reflow();
}
private void update(Object object) {
Hyperlink link = find(object);
if (link != null)
update(link, object);
}
private void update(Hyperlink hyperlink, Object object) {
String text = labelProvider != null
? labelProvider.getText(object)
: object.toString();
Image image = labelProvider != null
? labelProvider.getImage(object)
: null;
String tooltip = labelProvider != null ? labelProvider
.getToolTipText(object) : text;
hyperlink.setText(text);
hyperlink.setToolTipText(tooltip);
if (hyperlink instanceof ImageHyperlink)
((ImageHyperlink) hyperlink).setImage(image);
reflow();
}
public void refresh() {
// dispose old links
Control[] children = linkContainer.getChildren();
for (int i = 0; i < children.length; i++) {
children[i].dispose();
}
createLinks();
reflow();
}
private void reflow() {
linkContainer.layout();
container.layout();
getManagedForm().reflow(true);
}
private void createLinks() {
if (contentProvider == null)
return;
Object[] objects = contentProvider.getElements(getManagedForm().getInput());
for (int i = 0; i < objects.length; i++) {
if (i == linkNumberLimit)
break;
createLink(objects[i]);
}
if (objects.length > linkNumberLimit)
getManagedForm().getToolkit().createLabel(linkContainer, "...", SWT.NULL); //$NON-NLS-1$
updateMoreState(objects.length > linkNumberLimit);
}
private void updateMoreState(boolean needMore) {
if (needMore && moreButton == null) {
createMoreButton();
}
else if (!needMore && moreButton != null) {
moreButton.dispose();
moreButton = null;
}
}
private void createLink(Object object) {
Image image = labelProvider != null
? labelProvider.getImage(object)
: null;
Hyperlink hyperlink;
if (image != null) {
hyperlink = getManagedForm().getToolkit().createImageHyperlink(
linkContainer, SWT.NULL);
((ImageHyperlink) hyperlink).setImage(image);
} else
hyperlink = getManagedForm().getToolkit().createHyperlink(linkContainer,
null, SWT.NULL);
update(hyperlink, object);
hyperlink.setData(object);
hyperlink.addHyperlinkListener(linkHandler);
}
private void doEnter(Hyperlink link) {
String statusText = labelProvider != null ? labelProvider
.getStatusText(link.getData()) : link.getText();
getPage().getEditorSite().getActionBars().getStatusLineManager()
.setMessage(statusText);
}
private void doExit(Hyperlink link) {
getPage().getEditorSite().getActionBars().getStatusLineManager()
.setMessage(null);
}
protected void doLinkActivated(Hyperlink link) {
Object object = link.getData();
getPage().getEditor().setActivePage(morePageId, object);
}
public void setMorePageId(String id) {
this.morePageId = id;
}
public void setLinkNumberLimit(int limit) {
this.linkNumberLimit = limit;
}
public void setContentProvider(IStructuredContentProvider contentProvider) {
this.contentProvider = contentProvider;
}
public void setLabelProvider(ILinkLabelProvider provider) {
this.labelProvider = provider;
}
}
|
