org.kepler.gui

Class ShowDocumentationAction

java.lang.Object

javax.swing.AbstractAction

ptolemy.vergil.toolbox.FigureAction

org.kepler.gui.ShowDocumentationAction

All Implemented Interfaces:

java.awt.event.ActionListener, java.io.Serializable, java.lang.Cloneable, java.util.EventListener, javax.swing.Action

public class ShowDocumentationAction
extends FigureAction

This action displays Kepler documentation. Created to display when actor in library tree is right clicked.

Since:

6/5/2007

Author:

Chad Berkley

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class ptolemy.vergil.toolbox.FigureAction

FigureAction.SourceType

Field Summary

Fields inherited from class ptolemy.vergil.toolbox.FigureAction

CANVAS_TYPE, CONTEXTMENU_TYPE, HOTKEY_TYPE, MENUBAR_TYPE, PASTE_OFFSET, TOOLBAR_TYPE

Fields inherited from class javax.swing.AbstractAction

changeSupport, enabled

Fields inherited from interface javax.swing.Action

ACCELERATOR_KEY, ACTION_COMMAND_KEY, DEFAULT, DISPLAYED_MNEMONIC_INDEX_KEY, LARGE_ICON_KEY, LONG_DESCRIPTION, MNEMONIC_KEY, NAME, SELECTED_KEY, SHORT_DESCRIPTION, SMALL_ICON

Constructor Summary

Constructors

Constructor and Description
ShowDocumentationAction(TableauFrame parent)
ShowDocumentationAction(javax.swing.tree.TreePath path, java.awt.Component parent) Constructor

Method Summary

Modifier and Type	Method and Description
void	actionPerformed(java.awt.event.ActionEvent e) Invoked when an action occurs.
KeplerLSID	getLsidToView()
void	setLsidToView(KeplerLSID lsid)
void	setPtolemyFrame(PtolemyFrame pFrame) allows you to set the ptolemyFrame that should be used as the parent of this action.

Methods inherited from class ptolemy.vergil.toolbox.FigureAction

getFigure, getFrame, getSourceType, getTarget, getX, getY, offsetFigure

Methods inherited from class javax.swing.AbstractAction

addPropertyChangeListener, clone, firePropertyChange, getKeys, getPropertyChangeListeners, getValue, isEnabled, putValue, removePropertyChangeListener, setEnabled

Methods inherited from class java.lang.Object

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

Constructor Detail

ShowDocumentationAction

public ShowDocumentationAction(javax.swing.tree.TreePath path,
                               java.awt.Component parent)

Constructor

Parameters:

path - the TreePath where the actor is being removed.

ShowDocumentationAction

public ShowDocumentationAction(TableauFrame parent)

Method Detail

setLsidToView

public void setLsidToView(KeplerLSID lsid)

getLsidToView

public KeplerLSID getLsidToView()

actionPerformed

public void actionPerformed(java.awt.event.ActionEvent e)

Invoked when an action occurs.

Specified by:

actionPerformed in interface java.awt.event.ActionListener

Overrides:

actionPerformed in class FigureAction

Parameters:

e - ActionEvent

setPtolemyFrame

public void setPtolemyFrame(PtolemyFrame pFrame)

allows you to set the ptolemyFrame that should be used as the parent of this action.