weka.gui.MainMenuExtension Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of weka-stable Show documentation

The Waikato Environment for Knowledge Analysis (WEKA), a machine learning workbench. This is the stable version. Apart from bugfixes, this version does not receive any other updates.

There is a newer version: 3.8.6

Show newest version

/*
 *   This program is free software: you can redistribute it and/or modify
 *   it under the terms of the GNU General Public License as published by
 *   the Free Software Foundation, either version 3 of the License, or
 *   (at your option) any later version.
 *
 *   This program is distributed in the hope that it will be useful,
 *   but WITHOUT ANY WARRANTY; without even the implied warranty of
 *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *   GNU General Public License for more details.
 *
 *   You should have received a copy of the GNU General Public License
 *   along with this program.  If not, see .
 */

/*
 * MainMenuExtension.java
 * Copyright (C) 2007-2012 University of Waikato, Hamilton, New Zealand
 */

package weka.gui;

import java.awt.Component;
import java.awt.event.ActionListener;

import javax.swing.JFrame;

/**
 * Classes implementing this interface will be displayed in the "Extensions"
 * menu in the main GUI of Weka.
 * 
 * @author  fracpete (fracpete at waikato dot ac dot nz)
 * @version $Revision: 8034 $
 */
public interface MainMenuExtension {
  
  /**
   * Returns the name of the submenu. If there is no submenu necessary then 
   * the return value is null.
   * 
   * @return		the title of the submenu or null if no submenu
   */
  public String getSubmenuTitle();
  
  /**
   * Returns the name of the menu item.
   * 
   * @return		the name of the menu item.
   */
  public String getMenuTitle();
  
  /**
   * If the extension has a custom ActionListener for the menu item, then it
   * must be returned here. Having a custom ActionListener also 
   * means that the component handles any frame by itself.
   * 
   * @param owner 	the owner of potential dialogs
   * @return		a custom ActionListener, can be null
   * @see		#fillFrame(Component)
   */
  public ActionListener getActionListener(JFrame owner);
  
  /**
   * Fills the frame with life, like adding components, window listeners,
   * setting size, location, etc. The frame object can be either derived from 
   * JFrame or from JInternalFrame. This method is 
   * only called in case getActionListener() returns null.
   * 
   * @param frame	the frame object to embed components, etc.
   * @see		#getActionListener(JFrame)
   * @see		javax.swing.JFrame
   * @see		javax.swing.JInternalFrame
   */
  public void fillFrame(Component frame);
}