Package adams.gui.flow.tree.menu

Class FindUsages

java.lang.Object

javax.swing.AbstractAction

adams.gui.action.AbstractBaseAction

adams.gui.action.AbstractActionWithDialog<D>

adams.gui.action.AbstractPropertiesAction<T,D>

adams.gui.action.AbstractPropertiesSubMenuAction<StateContainer,GenericObjectEditorDialog>

adams.gui.flow.tree.menu.AbstractTreePopupSubMenuAction

adams.gui.flow.tree.menu.FindUsages

All Implemented Interfaces:

CleanUpHandler, BaseAction, PropertiesAction<StateContainer>, TreePopupAction, ActionListener, Serializable, Cloneable, EventListener, Action

public class FindUsages
extends AbstractTreePopupSubMenuAction

Finds usages of callable actors, variables and storage items.

Author:

fracpete

See Also:

Serialized Form

Field Summary

Fields inherited from class adams.gui.action.AbstractPropertiesAction

m_State

Fields inherited from class adams.gui.action.AbstractActionWithDialog

m_Dialog

Fields inherited from class adams.gui.action.AbstractBaseAction

ASYNCHRONOUS

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
FindUsages()

Method Summary

Modifier and Type	Method	Description
protected JMenuItem	createActorLocationMenuItem(List<String> locations)	Creates a menu item for a jumping to an actor location.
protected JMenuItem	createActorReferenceMenuItem(String reference)	Creates a menu item for a actor reference.
JMenu	createMenu()	Creates a new menu.
protected JMenuItem	createStorageMenuItem(String storage)	Creates a menu item for a storage item.
protected JMenuItem	createVariableMenuItem(String variable)	Creates a menu item for a variable.
protected void	doUpdate()	Updates the action using the current state information.
protected List<String>	findActorLocations(Actor actor)	Locates all the occurrences of this actor.
protected List<String>	findStorageNames(Actor actor)	Tries to locate the storage name in the actor's options.
protected List<String>	findVariableNames(Actor actor)	Tries to locate the variable names in the actor's options.
protected String	getActorReference(Actor actor, Actor parent)	Returns the actor reference, if applicable.
protected AbstractPropertiesAction[]	getSubMenuActions()	Ignored.
protected String	getTitle()	Returns the caption of this action.

Methods inherited from class adams.gui.flow.tree.menu.AbstractTreePopupSubMenuAction

addUndoPoint, doActionPerformed, getParentDialog, getParentFrame, getProperties, keyStrokeApplies, update

Methods inherited from class adams.gui.action.AbstractPropertiesSubMenuAction

getMenuItem

Methods inherited from class adams.gui.action.AbstractPropertiesAction

canUseIcon, initialize

Methods inherited from class adams.gui.action.AbstractActionWithDialog

cleanUp, createDialog, getDialog

Methods inherited from class adams.gui.action.AbstractBaseAction

actionPerformed, getAccelerator, getIcon, getMnemonic, getName, getToolTipText, hasAccelerator, hasMnemonic, hasToolTipText, isAsynchronous, isSelected, postActionPerformed, preActionPerformed, setAccelerator, setAsynchronous, setIcon, setIcon, setMnemonic, setName, setSelected, setToolTipText

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, addPropertyChangeListener, getValue, isEnabled, putValue, removePropertyChangeListener, setEnabled

Methods inherited from interface java.awt.event.ActionListener

actionPerformed

Methods inherited from interface adams.gui.action.BaseAction

cleanUp, getAccelerator, getIcon, getMnemonic, getName, getToolTipText, hasAccelerator, hasMnemonic, hasToolTipText, isAsynchronous, isSelected, setAccelerator, setAsynchronous, setIcon, setIcon, setMnemonic, setName, setSelected, setToolTipText

Methods inherited from interface adams.gui.action.PropertiesAction

getMenuItem

Constructor Detail

FindUsages

public FindUsages()

Method Detail

getTitle

protected String getTitle()

Returns the caption of this action.

Specified by:

getTitle in class AbstractPropertiesAction<StateContainer,GenericObjectEditorDialog>

Returns:

the caption, null if not applicable

getActorReference

protected String getActorReference(Actor actor,
                                   Actor parent)

Returns the actor reference, if applicable.

Parameters:

actor - the current actor

parent - the parent of the actor, can be null

Returns:

the actor reference, null if not applicable

findVariableNames

protected List<String> findVariableNames(Actor actor)

Tries to locate the variable names in the actor's options.

Parameters:

actor - the actor to search

Returns:

the variable names, empty if none found

findStorageNames

protected List<String> findStorageNames(Actor actor)

Tries to locate the storage name in the actor's options.

Parameters:

actor - the actor to search

Returns:

the storage name, empty if none found

findActorLocations

protected List<String> findActorLocations(Actor actor)

Locates all the occurrences of this actor.

Parameters:

actor - the actor to look for

Returns:

the actor paths

getSubMenuActions

protected AbstractPropertiesAction[] getSubMenuActions()

Ignored.

Specified by:

getSubMenuActions in class AbstractTreePopupSubMenuAction

Returns:

always null

createActorReferenceMenuItem

protected JMenuItem createActorReferenceMenuItem(String reference)

Creates a menu item for a actor reference.

Parameters:

reference - the name of the referenced actor

Returns:

the menu item

createVariableMenuItem

protected JMenuItem createVariableMenuItem(String variable)

Creates a menu item for a variable.

Parameters:

variable - the name of the variable

Returns:

the menu item

createStorageMenuItem

protected JMenuItem createStorageMenuItem(String storage)

Creates a menu item for a storage item.

Parameters:

storage - the name of the storage item

Returns:

the menu item

createActorLocationMenuItem

protected JMenuItem createActorLocationMenuItem(List<String> locations)

Creates a menu item for a jumping to an actor location.

Parameters:

locations - the locations of the actor

Returns:

the menu item

createMenu

public JMenu createMenu()

Creates a new menu.

Overrides:

createMenu in class AbstractTreePopupSubMenuAction

doUpdate

protected void doUpdate()

Updates the action using the current state information.

Overrides:

doUpdate in class AbstractTreePopupSubMenuAction