AbstractMultiPageMenuItem (adams-spectral-base-pom 25.9.0-SNAPSHOT API)

java.lang.Object
- adams.core.logging.LoggingObject
- - adams.gui.visualization.threewaydata.heatmapviewer.multipageaction.AbstractMultiPageMenuItem

All Implemented Interfaces:

adams.core.logging.LoggingSupporter, adams.core.SizeOfHandler, Serializable, Comparable<AbstractMultiPageMenuItem>

Direct Known Subclasses:

OpenContainingFolder, Statistics, ViewAsSpreadSheet
```
public abstract class AbstractMultiPageMenuItem
extends adams.core.logging.LoggingObject
implements Comparable<AbstractMultiPageMenuItem>
```
Ancestor for menu item generators for the 3way data heatmap viewer's multi-page pane.

Author:

FracPete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary
- Fields inherited from class adams.core.logging.LoggingObject
  m_Logger, m_LoggingIsEnabled, m_LoggingLevel

Constructor Summary

Constructors
Constructor Description

AbstractMultiPageMenuItem()

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method	Description
`int`	`compareTo(AbstractMultiPageMenuItem o)`	Returns a comparison based on the name of the menu items.
`boolean`	`equals(Object obj)`	Returns whether the two objects are same.
`abstract String`	`getGroup()`	The name of the group this item belongs to.
`protected Icon`	`getIcon()`	Returns the icon to use.
`abstract String`	`getIconName()`	The name of the icon to use.
`abstract JMenuItem`	`getMenuItem(ThreeWayDataHeatmapViewerMultiPagePane multi)`	Creates the menu item.
`abstract String`	`getName()`	The name for the menu item.

Methods inherited from class adams.core.logging.LoggingObject
configureLogger, getLogger, getLoggingLevel, initializeLogging, isLoggingEnabled, sizeOf

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

- Constructor Detail
  - AbstractMultiPageMenuItem
```
public AbstractMultiPageMenuItem()
```
- Method Detail
  - getName
```
public abstract String getName()
```
    The name for the menu item.
    
    Returns:
    
    the name
  - getGroup
```
public abstract String getGroup()
```
    The name of the group this item belongs to.
    
    Returns:
    
    the name
  - getIconName
```
public abstract String getIconName()
```
    The name of the icon to use.
    
    Returns:
    
    the name
  - getIcon
```
protected Icon getIcon()
```
    Returns the icon to use.
    
    Returns:
    
    the icon
  - getMenuItem
```
public abstract JMenuItem getMenuItem(ThreeWayDataHeatmapViewerMultiPagePane multi)
```
    Creates the menu item.
  - compareTo
```
public int compareTo(AbstractMultiPageMenuItem o)
```
    Returns a comparison based on the name of the menu items.
    
    Specified by:
    
    compareTo in interface Comparable<AbstractMultiPageMenuItem>
    
    Parameters:
    
    o - the other item to compare against
    
    Returns:
    
    the result of the name comparison
  - equals
```
public boolean equals(Object obj)
```
    Returns whether the two objects are same.
    
    Overrides:
    
    equals in class Object
    
    Parameters:
    
    obj - the object to compare with
    
    Returns:
    
    true if the same
    
    See Also:
    
    compareTo(AbstractMultiPageMenuItem)