RemoveCustomDocumentationAction

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

All Implemented Interfaces:

java.awt.event.ActionListener, java.io.Serializable, java.lang.Cloneable, java.util.EventListener, javax.swing.Action
```
public class RemoveCustomDocumentationAction
extends FigureAction
```
This class provides an action for removing instance-specific documentation.

Since:

Ptolemy II 5.2

Version:

$Id$

Author:

Edward A. Lee

See Also:

Serialized Form

Pt.AcceptedRating:

Red (johnr)

Pt.ProposedRating:

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

Constructor Summary

Constructors
Constructor Description

RemoveCustomDocumentationAction()
Construct an instance of this action.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`void`	`actionPerformed(java.awt.event.ActionEvent e)`	Perform the action by issuing a change request to remove the the first (and only?) DocAttribute contained by the target, if any.

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

Methods inherited from interface javax.swing.Action
accept

- Constructor Detail
  - RemoveCustomDocumentationAction
```
public RemoveCustomDocumentationAction()
```
    Construct an instance of this action.
- Method Detail
  - actionPerformed
```
public void actionPerformed(java.awt.event.ActionEvent e)
```
    Perform the action by issuing a change request to remove the the first (and only?) DocAttribute contained by the target, if any.
    
    Specified by:
    
    actionPerformed in interface java.awt.event.ActionListener
    
    Overrides:
    
    actionPerformed in class FigureAction
    
    Parameters:
    
    e - The action event.