Skip to main content
summaryrefslogtreecommitdiffstats
blob: 497f627cbc8cfb6797b9dc963957c24abf0e52d6 (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
/*******************************************************************************
 * Copyright (c) 2006 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.actions;

import org.eclipse.core.runtime.CoreException;
import org.eclipse.core.runtime.IConfigurationElement;
import org.eclipse.core.runtime.IExecutableExtension;
import org.eclipse.help.HelpSystem;
import org.eclipse.help.IContext;
import org.eclipse.help.IHelpResource;
import org.eclipse.jface.action.Action;
import org.eclipse.ui.PlatformUI;

/**
 * This class is used to open the help page for a configuration param.
 * 
 * @author mengbo
 */
public class LoadHelpAction extends Action implements IExecutableExtension {
	private String _helpContextId = null;

	/**
	 * 
	 */
	public LoadHelpAction() {
		super();
	}

	/*
	 * (non-Javadoc)
	 * 
	 * @see org.eclipse.jface.action.IAction#run()
	 */
	public void run() {
		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);
			}
		}

	}

	/*
	 * (non-Javadoc)
	 * 
	 * @see org.eclipse.core.runtime.IExecutableExtension#setInitializationData(org.eclipse.core.runtime.IConfigurationElement,
	 *      java.lang.String, java.lang.Object)
	 */
	public void setInitializationData(IConfigurationElement config,
			String propertyName, Object data) throws CoreException {
		_helpContextId = config.getAttribute("actionparameters"); //$NON-NLS-1$
	}

	/**
	 * set the help reference to open.
	 * 
	 * @param href
	 */
	public void setContextId(String href) {
		_helpContextId = href;
	}
    
    protected String getContextId() {
        return _helpContextId;
    }
}

Back to the top