AbstractJDKMenuItemDefinition (adams-pom 24.12.0-SNAPSHOT API)

java.lang.Object
- adams.gui.application.AbstractMenuItemDefinition
- - adams.gui.application.AbstractBasicMenuItemDefinition
  - - adams.gui.menu.AbstractJDKMenuItemDefinition

All Implemented Interfaces:

Serializable, Comparable<AbstractMenuItemDefinition>

Direct Known Subclasses:

AdamsHomeDir, HeapDump, JConsole, JDeps, JMap
```
public abstract class AbstractJDKMenuItemDefinition
extends AbstractBasicMenuItemDefinition
```
Ancestor for menu items that require a JDK present.

Version:

$Revision$

Author:

fracpete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary
- Fields inherited from class adams.gui.application.AbstractMenuItemDefinition
  CATEGORY_HELP, CATEGORY_MACHINELEARNING, CATEGORY_MAINTENANCE, CATEGORY_PROGRAM, CATEGORY_TOOLS, CATEGORY_VISUALIZATION, CATEGORY_WIZARD, m_Owner

Constructor Summary

Constructors
Constructor	Description
`AbstractJDKMenuItemDefinition()`	Initializes the menu item with no owner.
`AbstractJDKMenuItemDefinition(AbstractApplicationFrame owner)`	Initializes the menu item.

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method	Description
`protected abstract void`	`doLaunch()`	Performs the actual launch.
`String`	`getCategory()`	Returns the category of the menu item in which it should appear, i.e., the name of the menu.
`String`	`getIconName()`	Returns the file name of the icon.
`UserMode`	`getUserMode()`	Returns the user mode, which determines visibility as well.
`void`	`launch()`	Launches the functionality of the menu item.

Methods inherited from class adams.gui.application.AbstractBasicMenuItemDefinition
getMenuItem, getUseThread, postLaunch, preLaunch

Methods inherited from class adams.gui.application.AbstractMenuItemDefinition
compareTo, createChildFrame, createChildFrame, equals, forCommandLine, forName, getActualCategory, getIcon, getLogger, getOwner, getTitle, initialize, isAvailable, isSingleton, requiresRestartableApplication, setOwner

Methods inherited from class java.lang.Object
clone, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - AbstractJDKMenuItemDefinition
```
public AbstractJDKMenuItemDefinition()
```
    Initializes the menu item with no owner.
  - AbstractJDKMenuItemDefinition
```
public AbstractJDKMenuItemDefinition(AbstractApplicationFrame owner)
```
    Initializes the menu item.
    
    Parameters:
    
    owner - the owning application
- Method Detail
  - getIconName
```
public String getIconName()
```
    Returns the file name of the icon.
    
    Overrides:
    
    getIconName in class AbstractMenuItemDefinition
    
    Returns:
    
    the filename or null if no icon available
  - doLaunch
```
protected abstract void doLaunch()
```
    Performs the actual launch.
  - launch
```
public void launch()
```
    Launches the functionality of the menu item.
    
    Specified by:
    
    launch in class AbstractBasicMenuItemDefinition
  - getUserMode
```
public UserMode getUserMode()
```
    Returns the user mode, which determines visibility as well.
    
    Specified by:
    
    getUserMode in class AbstractMenuItemDefinition
    
    Returns:
    
    the user mode
  - getCategory
```
public String getCategory()
```
    Returns the category of the menu item in which it should appear, i.e., the name of the menu.
    
    Specified by:
    
    getCategory in class AbstractMenuItemDefinition
    
    Returns:
    
    the category/menu name