ptolemy.vergil.basic
Class CustomizeDocumentationAction

java.lang.Object
  javax.swing.AbstractAction
      ptolemy.vergil.toolbox.FigureAction
          ptolemy.vergil.basic.CustomizeDocumentationAction

All Implemented Interfaces:

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

public class CustomizeDocumentationAction
extends FigureAction

An action for editing instance-specific documentation.

Since:

Ptolemy II 5.2

Version:

$Id: CustomizeDocumentationAction.java 57040 2010-01-27 20:52:32Z cxh $

Author:

Edward A. Lee

See Also:

Serialized Form

Accepted Rating:

Red (johnr)

Proposed Rating:

Red (eal)

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, LONG_DESCRIPTION, MNEMONIC_KEY, NAME, SHORT_DESCRIPTION, SMALL_ICON

Constructor Summary

CustomizeDocumentationAction()
Construct an instance of this action.

Method Summary

private void	_editDocAttribute(java.awt.Frame owner, DocAttribute attribute, NamedObj target) Edit the specified documentation attribute.
void	actionPerformed(java.awt.event.ActionEvent e) Perform the action by first ensuring that the target has an instance of DocAttribute, and then opening an edit parameters dialog on that attribute.

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

CustomizeDocumentationAction

public CustomizeDocumentationAction()

Construct an instance of this action.

Method Detail

actionPerformed

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

Perform the action by first ensuring that the target has an instance of DocAttribute, and then opening an edit parameters dialog on that attribute.

Specified by:

actionPerformed in interface java.awt.event.ActionListener

Overrides:

actionPerformed in class FigureAction

Parameters:

e - The event.

_editDocAttribute

private void _editDocAttribute(java.awt.Frame owner,
                               DocAttribute attribute,
                               NamedObj target)

Edit the specified documentation attribute.

Parameters:

owner - The owning frame.

attribute - The attribute to edit.

target - The target whose documentation is being edited.