gate.swing.XJMenu Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of gate-core Show documentation

GATE - general achitecture for text engineering - is open source software capable of solving almost any text processing problem. This artifact enables you to embed the core GATE Embedded with its essential dependencies. You will able to use the GATE Embedded API and load and store GATE XML documents. This artifact is the perfect dependency for CREOLE plugins or for applications that need to customize the GATE dependencies due to confict with their own dependencies or for lower footprint.

The newest version!

/*
 *  Copyright (c) 1995-2012, The University of Sheffield. See the file
 *  COPYRIGHT.txt in the software or at http://gate.ac.uk/gate/COPYRIGHT.txt
 *
 *  This file is part of GATE (see http://gate.ac.uk/), and is free
 *  software, licenced under the GNU Library General Public License,
 *  Version 2, June 1991 (in the distribution as file licence.html,
 *  and also available at http://gate.ac.uk/gate/licence.html).
 *
 *  Valentin Tablan 20 Feb 2003
 *
 *  $Id: XJMenu.java 17612 2014-03-10 08:51:17Z markagreenwood $
 */

package gate.swing;

import gate.event.StatusListener;

import javax.swing.*;
import javax.swing.event.*;
import java.awt.event.MouseAdapter;
import java.awt.event.MouseEvent;
import java.awt.*;

/**
 * A modified version of JMenu that uses {@link MenuLayout} as its layout.
 * Adds also a description and a StatusListener as parameters.
 * The description is used in the statusListener.
 */
@SuppressWarnings("serial")
public class XJMenu extends JMenu {
  public XJMenu(){
    super();
    getPopupMenu().setLayout(new MenuLayout());
  }

  public XJMenu(Action a){
    super(a);
    // stop showing tooltip in the menu, status bar is enough
    setToolTipText(null);
    getPopupMenu().setLayout(new MenuLayout());
  }

  public XJMenu(Action a, StatusListener listener){
    super(a);
    this.description = (String)a.getValue(Action.SHORT_DESCRIPTION);
    this.listener = listener;
    // stop showing tooltip in the menu, status bar is enough
    setToolTipText(null);
    initListeners();
    getPopupMenu().setLayout(new MenuLayout());
  }

  public XJMenu(String s){
    super(s);
    getPopupMenu().setLayout(new MenuLayout());
  }

  public XJMenu(String s, String description, StatusListener listener){
    super(s);
    this.description = description;
    this.listener = listener;
    initListeners();
    getPopupMenu().setLayout(new MenuLayout());
  }

  public XJMenu(String s, boolean b){
    super(s, b);
    getPopupMenu().setLayout(new MenuLayout());
  }

  /**
   * Force separators to be the same width as the JPopupMenu.
   * This is because the MenuLayout make separators invisible contrary
   * to the default JMenu layout manager.
   * @param aFlag true if the popupmenu is visible
   */
  @Override
  public void setPopupMenuVisible(boolean aFlag) {
    super.setPopupMenuVisible(aFlag);
    if (!aFlag) { return; }
    MenuLayout layout = (MenuLayout) getPopupMenu().getLayout();
    for (int i = 0; i < getMenuComponents().length; i++) {
      Component component = getMenuComponents()[i];
      if (component instanceof JSeparator) {
        JSeparator separator = (JSeparator) component;
        int column = layout.getColumnForComponentIndex(i);
        int preferredWidth = layout.getPreferredWidthForColumn(column);
        // use the popupmenu width to set the separators width
        separator.setPreferredSize(new Dimension(
          preferredWidth, separator.getHeight()));
      }
    }
    getPopupMenu().revalidate();
  }

  protected void initListeners(){
    this.addMouseListener(new MouseAdapter() {
      @Override
      public void mouseExited(MouseEvent e) {
        // clear the status
        listener.statusChanged("");
      }
    });
    this.addChangeListener(new ChangeListener() {
      @Override
      public void stateChanged(ChangeEvent e) {
        // display the menu description in the status
        listener.statusChanged(description);
      }
    });
    this.addMenuListener(new MenuListener() {
      @Override
      public void menuCanceled(MenuEvent e) {
        // do nothing
      }
      @Override
      public void menuDeselected(MenuEvent e) {
        // clear the status
        listener.statusChanged("");
      }
      @Override
      public void menuSelected(MenuEvent e) {
        // do nothing
      }
    });
  }

  protected StatusListener listener;
  private String description;
}