ptolemy.backtrack.eclipse.plugin.actions

Class HelpAction

java.lang.Object

ptolemy.backtrack.eclipse.plugin.actions.HelpAction

All Implemented Interfaces:

org.eclipse.ui.IActionDelegate, org.eclipse.ui.IWorkbenchWindowActionDelegate

public class HelpAction
extends java.lang.Object
implements org.eclipse.ui.IWorkbenchWindowActionDelegate

Action to trigger the help center of the Eclipse backtracking plugin.

Since:

Ptolemy II 5.1

Version:

$Id$

Author:

Thomas Feng

Pt.AcceptedRating:

Red (tfeng)

Pt.ProposedRating:

Red (tfeng)

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	HELP_RESOURCE The table of contents of the Eclipse backtracking plugin help.

Constructor Summary

Constructors

Constructor and Description
HelpAction()

Method Summary

Modifier and Type	Method and Description
void	dispose() Dispose of system resources allocated for this actions.
void	init(org.eclipse.ui.IWorkbenchWindow window) Initialize the action with a window as its parent.
void	run(org.eclipse.jface.action.IAction action) Activate the action and show the Eclipse help center.
void	selectionChanged(org.eclipse.jface.action.IAction action, org.eclipse.jface.viewers.ISelection selection) Handle the change of selection.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

HELP_RESOURCE

public static final java.lang.String HELP_RESOURCE

The table of contents of the Eclipse backtracking plugin help.

See Also:

Constant Field Values

Constructor Detail

HelpAction

public HelpAction()

Method Detail

dispose

public void dispose()

Dispose of system resources allocated for this actions.

Specified by:

dispose in interface org.eclipse.ui.IWorkbenchWindowActionDelegate

init

public void init(org.eclipse.ui.IWorkbenchWindow window)

Initialize the action with a window as its parent.

Specified by:

init in interface org.eclipse.ui.IWorkbenchWindowActionDelegate

Parameters:

window - The parent window.

run

public void run(org.eclipse.jface.action.IAction action)

Activate the action and show the Eclipse help center. The help center shows the Eclipse backtracking plugin documentation, whose table of contents page is "ptolemy/backtrack/eclipse/plugin/doc/toc.xml".

Specified by:

run in interface org.eclipse.ui.IActionDelegate

Parameters:

action - The action proxy (not used in this method).

selectionChanged

public void selectionChanged(org.eclipse.jface.action.IAction action,
                             org.eclipse.jface.viewers.ISelection selection)

Handle the change of selection.

Specified by:

selectionChanged in interface org.eclipse.ui.IActionDelegate

Parameters:

action - The action proxy (not used in this method).

selection - The new selection (not used in this method).