OptionTree (adams-pom 24.5.0-SNAPSHOT API)

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

All Implemented Interfaces:

Serializable, Comparable<AbstractMenuItemDefinition>
```
public class OptionTree
extends AbstractBasicMenuItemDefinition
```
Displays the OptionTree dialog.

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

OptionTree()
Initializes the menu item with no owner.

OptionTree(AbstractApplicationFrame owner)
Initializes the menu item.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`String`	`getCategory()`	Returns the category of the menu item in which it should appear, i.e., the name of the menu.
`String`	`getTitle()`	Returns the title of the window (and text of menuitem).
`UserMode`	`getUserMode()`	Returns the user mode, which determines visibility as well.
`boolean`	`isSingleton()`	Whether the panel can only be displayed once.
`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, getIconName, getLogger, getOwner, initialize, isAvailable, requiresRestartableApplication, setOwner

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

- Constructor Detail
  - OptionTree
```
public OptionTree()
```
    Initializes the menu item with no owner.
  - OptionTree
```
public OptionTree(AbstractApplicationFrame owner)
```
    Initializes the menu item.
    
    Parameters:
    
    owner - the owning application
- Method Detail
  - launch
```
public void launch()
```
    Launches the functionality of the menu item.
    
    Specified by:
    
    launch in class AbstractBasicMenuItemDefinition
  - getTitle
```
public String getTitle()
```
    Returns the title of the window (and text of menuitem).
    
    Specified by:
    
    getTitle in class AbstractMenuItemDefinition
    
    Returns:
    
    the title
  - isSingleton
```
public boolean isSingleton()
```
    Whether the panel can only be displayed once.
    
    Specified by:
    
    isSingleton in class AbstractMenuItemDefinition
    
    Returns:
    
    true if the panel can only be displayed once
  - 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