org.kepler.provenance.gui

Class ProvenanceConfigureAction

java.lang.Object

javax.swing.AbstractAction

ptolemy.vergil.toolbox.FigureAction

org.kepler.provenance.gui.ProvenanceConfigureAction

All Implemented Interfaces:

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

public class ProvenanceConfigureAction
extends FigureAction
implements ProvenanceEnabledListener

An action that toggles the default provenance recorder in the top level workflow container.

Author:

Daniel Crawl

See Also:

Serialized Form

Nested Class Summary

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

FigureAction.SourceType

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	OFF_ICON_STR Icon when top-level recorder is not present.
static java.lang.String	ON_ICON_STR Icon when top-level recorder is present.
static java.lang.String	OVER_ICON_STR Icon when cursor over button.

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
ProvenanceConfigureAction(KeplerGraphFrame owner)

Method Summary

Modifier and Type	Method and Description
void	actionPerformed(java.awt.event.ActionEvent event) Determine the target Ptolemy II object, the originating frame, and the X, Y position of the action, if possible.
void	setButton(javax.swing.JButton button) Set the button.
void	toggle(boolean enabled) This method is called when provenance is enabled or disabled.

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

Field Detail

ON_ICON_STR

public static final java.lang.String ON_ICON_STR

Icon when top-level recorder is present.

See Also:

Constant Field Values

OFF_ICON_STR

public static final java.lang.String OFF_ICON_STR

Icon when top-level recorder is not present.

See Also:

Constant Field Values

OVER_ICON_STR

public static final java.lang.String OVER_ICON_STR

Icon when cursor over button.

See Also:

Constant Field Values

Constructor Detail

ProvenanceConfigureAction

public ProvenanceConfigureAction(KeplerGraphFrame owner)

Method Detail

actionPerformed

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

Description copied from class: FigureAction

Determine the target Ptolemy II object, the originating frame, and the X, Y position of the action, if possible. After this is invoked, the other public methods can be used to access this data.

Specified by:

actionPerformed in interface java.awt.event.ActionListener

Overrides:

actionPerformed in class FigureAction

Parameters:

event - The event.

toggle

public void toggle(boolean enabled)

This method is called when provenance is enabled or disabled.

Specified by:

toggle in interface ProvenanceEnabledListener

Parameters:

enabled - True if provenance is enabled.

setButton

public void setButton(javax.swing.JButton button)

Set the button.