Skip to main content
summaryrefslogtreecommitdiffstats
blob: a022c1b63c8f89a6d6bef5406950dec794f0a587 (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
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
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
/*******************************************************************************
 * Copyright (c) 2004, 2005 Sybase, Inc. 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:
 *     Sybase, Inc. - initial API and implementation
 *******************************************************************************/

package org.eclipse.jst.jsf.common.ui.internal.guiutils;

import org.eclipse.core.runtime.IConfigurationElement;
import org.eclipse.core.runtime.IPath;
import org.eclipse.core.runtime.Path;
import org.eclipse.core.runtime.Platform;
import org.eclipse.help.HelpSystem;
import org.eclipse.help.IContext;
import org.eclipse.help.IHelpResource;
import org.eclipse.jface.action.IAction;
import org.eclipse.jface.resource.ImageDescriptor;
import org.eclipse.jface.resource.ImageRegistry;
import org.eclipse.jface.resource.JFaceResources;
import org.eclipse.jst.jsf.common.ui.JSFUICommonPlugin;
import org.eclipse.jst.jsf.common.ui.internal.logging.Logger;
import org.eclipse.swt.SWT;
import org.eclipse.swt.graphics.Image;
import org.eclipse.swt.layout.RowLayout;
import org.eclipse.swt.widgets.Composite;
import org.eclipse.swt.widgets.Label;
import org.eclipse.ui.PlatformUI;
import org.eclipse.ui.forms.IManagedForm;
import org.eclipse.ui.forms.SectionPart;
import org.eclipse.ui.forms.events.HyperlinkAdapter;
import org.eclipse.ui.forms.events.HyperlinkEvent;
import org.eclipse.ui.forms.widgets.ExpandableComposite;
import org.eclipse.ui.forms.widgets.FormText;
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;
import org.eclipse.ui.forms.widgets.TableWrapData;
import org.eclipse.ui.forms.widgets.TableWrapLayout;
import org.eclipse.ui.plugin.AbstractUIPlugin;

/**
 * Provides a standard looking introduction section for a intro page for the
 * editors. This was taken and is suppose to look like the standard Sybase
 * workspace service editors intro page.
 * 
 * this was original written by Collinsc
 * 
 * TODO: Should this be moved into the facesconfig ui plugin since it is only
 * really used there?
 * 
 * @author collinsc,jchoi
 */
public class IntroductionSection extends SectionPart {

	private static final String HELP_IMAGE_FILE = "help.gif"; //$NON-NLS-1$

	private static Logger _log = JSFUICommonPlugin
			.getLogger(IntroductionSection.class);

	private String _editorId;

	private FormToolkit _toolkit;

	// private ImageHyperlink _helpImage;
	private Composite _textClient;

	private String _helpContextId;

	private String _helpTooltip;

	/**
	 * Basic constructor - no help with this one.
	 * 
	 * @param editorId
	 *            id of the editor this page is for.
	 * @param managedForm
	 * @param toolkit
	 */
	public IntroductionSection(String editorId, IManagedForm managedForm,
			FormToolkit toolkit) {
		this(editorId, managedForm, toolkit, null, null);
	}

	/**
	 * Constructor with help option.
	 * 
	 * @param editorId
	 *            id of the editor this page is for.
	 * @param managedForm
	 * @param toolkit
	 * @param contextId 
	 * @param helpTooltip
	 */
	public IntroductionSection(String editorId, IManagedForm managedForm,
			FormToolkit toolkit, final String contextId, String helpTooltip) {
		super(managedForm.getForm().getBody(), toolkit,
				ExpandableComposite.TITLE_BAR | Section.DESCRIPTION);
		super.initialize(managedForm);
		this._editorId = editorId;
		this._toolkit = toolkit;
		this._helpContextId = contextId;
		this._helpTooltip = helpTooltip;

		this._textClient = this._toolkit.createComposite(getSection(), SWT.NONE);
		this._textClient.setSize(32, 16);

		RowLayout rowLayout = new RowLayout();
		rowLayout.wrap = false;
		rowLayout.pack = false;
		rowLayout.justify = true;
		rowLayout.type = SWT.HORIZONTAL;
		rowLayout.marginLeft = 0;
		rowLayout.marginTop = 0;
		rowLayout.marginRight = 0;
		rowLayout.marginBottom = 0;
		rowLayout.spacing = 0;
		this._textClient.setLayout(rowLayout);

		this._toolkit.adapt(this._textClient, true, true);
		getSection().setTextClient(this._textClient);

		if (this._helpContextId != null) {
			// setup the help image.
			ImageHyperlink helpImage = new ImageHyperlink(this._textClient,
					SWT.NONE);
			this._toolkit.adapt(helpImage, true, true);
			helpImage.setImage(JSFUICommonPlugin.getDefault().getImage(HELP_IMAGE_FILE));
			if (this._helpTooltip != null) {
				helpImage.setToolTipText(this._helpTooltip);
			}
			helpImage.setBackground(getSection()
					.getTitleBarGradientBackground());
			helpImage.addHyperlinkListener(new HyperlinkAdapter() {
				public void linkActivated(HyperlinkEvent e) {
					IContext context = HelpSystem.getContext(_helpContextId);
					if (context != null) {
						IHelpResource[] topics = context.getRelatedTopics();
						if (topics != null && topics.length == 1) {
                            PlatformUI.getWorkbench().getHelpSystem().displayHelpResource(topics[0]
									.getHref());
						} else {
                            PlatformUI.getWorkbench().getHelpSystem().displayHelp(_helpContextId);
						}
					}
				}
			});
		}

		Composite client = this._toolkit.createComposite(getSection());
		createClient(client, this._toolkit);
		getSection().setClient(client);
	}

	private Composite createClient(Composite container, FormToolkit factory) {
		TableWrapLayout layout = new TableWrapLayout();
		layout.numColumns = 2;
		layout.makeColumnsEqualWidth = false;
		layout.horizontalSpacing = 20;
		layout.verticalSpacing = 20;
		container.setLayout(layout);

		IConfigurationElement element = getExtensions();

		if (element != null) {
			setPageDetails(element);

			IConfigurationElement[] children = element.getChildren();
			for (int ii = 0; ii < children.length; ii++) {
				processItems(container, factory, children[ii]);
			}
		} else {
			setText(Messages.IntroductionSection_noIntroTitle);

			setDescription(Messages.IntroductionSection_noIntroDescription);
		}

		factory.paintBordersFor(container);
        PlatformUI.getWorkbench().getHelpSystem().setHelp(container, _helpContextId);
		return container;
	}

	/**
	 * set the page details from the extensionpoint
	 * 
	 * @param element
	 */
	private void setPageDetails(IConfigurationElement element) {
		setText(element.getAttribute("name")); //$NON-NLS-1$
		setDescription(element.getAttribute("description")); //$NON-NLS-1$
	}

	/**
	 * add the extension elements to the page
	 * 
	 * @param parent
	 * @param toolkit_
	 * @param element
	 */
	private void processItems(Composite parent, FormToolkit toolkit_,
			IConfigurationElement element) {
		String hyperlink = element.getAttribute("hyperlink"); //$NON-NLS-1$
		String iconPath = element.getAttribute("icon"); //$NON-NLS-1$
		String text = element.getAttribute("text"); //$NON-NLS-1$
		String heading = element.getAttribute("heading"); //$NON-NLS-1$
		String action = element.getAttribute("hyperlinkaction"); //$NON-NLS-1$
		//String actionparameters = element.getAttribute("actionparameters"); //$NON-NLS-1$

		if (iconPath != null && iconPath.length() > 0) {
			// add an icon to the page
			String iconName;
			if (iconPath.indexOf(IPath.SEPARATOR) != -1) {
				iconName = new Path(iconPath).lastSegment();
			} else {
				iconName = iconPath;
			}

			ImageDescriptor imageDescriptor = AbstractUIPlugin
					.imageDescriptorFromPlugin(
							element.getDeclaringExtension()
									.getContributor().getName(), iconPath);
			
			if (imageDescriptor != null)
			{
				ImageRegistry imageRegistry =
					JSFUICommonPlugin.getDefault().getImageRegistry();
				
				
				Image image = imageRegistry.get(iconName);
				
				if (image == null)
				{
					image = imageDescriptor.createImage();
					
					if (image != null)
					{
						imageRegistry.put(iconName, image);
					}
					else
					{
						image = ImageDescriptor.getMissingImageDescriptor().createImage();
					}
				}
				
				if (image != null)
				{
					ImageContainer img = new ImageContainer(parent);
					img.setImage(image);
					TableWrapData td = new TableWrapData();
					td.rowspan = 2;
					img.setLayoutData(td);
				}
				else
				{
					JSFUICommonPlugin.getLogger(this.getClass()).error(new Throwable("Image not created for "+element)); //$NON-NLS-1$
				}
			}
			else
			{
				JSFUICommonPlugin.getLogger(this.getClass()).error(new Throwable("Image Descriptor not found for "+element)); //$NON-NLS-1$
			}
		}

		if (heading != null && heading.length() > 0) {
			// add a header
			Label lbl = toolkit_.createLabel(parent, heading);
			lbl.setFont(JFaceResources.getHeaderFont());
		}

		if (hyperlink != null && hyperlink.length() > 0) {
			Hyperlink hypr = toolkit_.createHyperlink(parent, hyperlink,
					SWT.NONE);
			if (action != null && action.length() > 0) {
				try {
					final IAction thisAction = (IAction) element
							.createExecutableExtension("hyperlinkaction"); //$NON-NLS-1$
					hypr.addHyperlinkListener(new HyperlinkAdapter() {
						public void linkActivated(HyperlinkEvent e) {
							thisAction.run();
						}
					});
				} catch (Exception ee) {
					// log.IntroductionSection.action.error=Failed to launch the
					// link {0}.
					_log.error("log.IntroductionSection.action.error", //$NON-NLS-1$
							hyperlink, ee);
					JSFUICommonPlugin.getAlerts().detailError(hyperlink,
							"log.IntroductionSection.action.error", hyperlink, //$NON-NLS-1$
							ee);
				}
			}
		}

		if (text != null && text.length() > 0) {
			FormText form = toolkit_.createFormText(parent, false);
			form.setText(text, false, false);
		}
	}

	/**
	 * Get the extension elements for the Introduction pages
	 */
	private IConfigurationElement getExtensions() {
		// find all service editor page extensions
		IConfigurationElement element = null;

		// find all service editor parameter dialog extensions
		IConfigurationElement[] elements = Platform
				.getExtensionRegistry()
				.getConfigurationElementsFor(
						"org.eclipse.jst.jsf.common.ui.introductionPage"); //$NON-NLS-1$
		if (elements.length > 0) {
			for (int ii = 0; ii < elements.length; ii++) {
				// get extensions for this dialog
				// String extPluginId =
				// elements[ii].getDeclaringExtension().getNamespace();
				String editorId1 = elements[ii].getDeclaringExtension()
						.getSimpleIdentifier();

				// see if we have any contributuins of dialogs
				if (this._editorId.equals(editorId1)) {
					element = elements[ii];
					break;
				}
			}
		}
		return element;
	}

	private void setText(String text) {
		getSection().setText(text);
	}

	private void setDescription(String text) {
		getSection().setDescription(text);
	}

	/**
	 * Set this section's layout data
	 * @param layoutData
	 */
	public void setLayoutData(Object layoutData) {
		getSection().setLayoutData(layoutData);
	}
}

Back to the top