BasicMenuOperations.java

package nl.tudelft.bw4t.client.gui.menu;

import javax.swing.JMenu;
import javax.swing.JMenuItem;
import javax.swing.JPopupMenu;

import nl.tudelft.bw4t.client.gui.BW4TClientGUI;
import nl.tudelft.bw4t.client.gui.listeners.MessageSenderActionListener;
import nl.tudelft.bw4t.client.gui.listeners.NavigateObstaclesActionListener;
import nl.tudelft.bw4t.client.gui.listeners.PickUpActionListener;
import nl.tudelft.bw4t.client.gui.listeners.PickUpEPartnerActionListener;
import nl.tudelft.bw4t.client.message.BW4TMessage;
import nl.tudelft.bw4t.client.message.MessageTranslator;
import nl.tudelft.bw4t.map.view.ViewBlock;
import nl.tudelft.bw4t.map.view.ViewEPartner;
import nl.tudelft.bw4t.map.view.ViewEntity;

/**
 * Utility class containing some operations to add various things to pop-up
 * menu's.
 */
public final class BasicMenuOperations {

	/** Should never be instantiated */
	private BasicMenuOperations() {
	}

	/**
	 * Adds a menu item to a pop-up menu, used for messages.
	 * 
	 * @param message
	 *            - The message that this item represents.
	 * @param gui
	 *            - The {@link BW4TClientGUI} to create the pop-up menu on.
	 */
	public static void addMenuItemToPopupMenu(BW4TMessage message, BW4TClientGUI gui) {
		JMenuItem menuItem = new JMenuItem(MessageTranslator.translateMessage(message));
		menuItem.addActionListener(new MessageSenderActionListener(message, gui.getController()));
		gui.getjPopupMenu().add(menuItem);
	}

	/**
	 * Adds a section title to a pop-up menu.
	 * 
	 * @param title
	 *            - The title of the section to add.
	 * @param jPopupMenu
	 *            - The {@link JPopupMenu} to add the section to.
	 */
	public static void addSectionTitleToPopupMenu(String title, JPopupMenu jPopupMenu) {
		JMenuItem menuItem = new JMenuItem(title);
		menuItem.setEnabled(false);
		jPopupMenu.add(menuItem);
	}

	/**
	 * Adds a submenu to a pop-up menu.
	 * 
	 * @param text
	 *            - The title of the submenu to add.
	 * @param jPopupMenu
	 *            - The {@link JPopupMenu} to add the menu to.
	 * @return The newly added submenu.
	 */
	public static JMenu addSubMenuToPopupMenu(String text, JPopupMenu jPopupMenu) {
		JMenu menu = new JMenu(text);
		jPopupMenu.add(menu);
		return menu;
	}

	/**
	 * Adds a menu item to the pop up menu that holds the option to navigate
	 * past obstacle, but only if the "bumped" percept has been received.
	 *
	 * @param gui
	 *            The client gui.
	 */
	public static void addNavigateObstacleMenuItem(BW4TClientGUI gui) {
		ViewEntity theBot = gui.getController().getMapController().getTheBot();
		if (theBot.isCollided()) {
			JMenuItem menuItem = new JMenuItem("Navigate past obstacle");
			menuItem.addActionListener(new NavigateObstaclesActionListener(gui.getController()));

			gui.getjPopupMenu().add(menuItem);
		}
	}

	/**
	 * Adds the option to pick up a box to the menu.
	 *
	 * @param gui
	 *            The gui holding the menu.
	 * @param box
	 *            The box to be picked up.
	 */
	public static void addBlockPickUpMenuItem(BW4TClientGUI gui, ViewBlock box) {
		ViewEntity ourEntity = gui.getController().getMapController().getTheBot();
		Boolean canPickUpMore = ourEntity.getHolding().size() < ourEntity.getGripperCapacity();

		if (canPickUpMore) {
			String colorAsString = getColor(box.getColor().getName(), ourEntity);
			JMenuItem menuItem = new JMenuItem("Pick up " + colorAsString + " block");
			menuItem.addActionListener(new PickUpActionListener(box.getObjectId(), gui.getController()));
			gui.getjPopupMenu().add(menuItem);
		}
	}

	/**
	 * Adds the option to pick up an e-partner to the menu.
	 *
	 * @param gui
	 *            The gui holding the menu.
	 */
	public static void addEPartnerPickUpMenuItem(BW4TClientGUI gui, ViewEPartner ep) {
		if (gui.getController().getMapController().getTheBot().getHoldingEpartner() == -1 && !ep.isPickedUp()) {
			JMenuItem menuItem = new JMenuItem("Pick up e-partner");
			menuItem.addActionListener(new PickUpEPartnerActionListener(gui.getController(), gui));
			gui.getjPopupMenu().add(menuItem);
		}
	}

	/**
	 * Gets the color while taking into account that the agent might be color
	 * blind.
	 *
	 * @param color
	 *            The color that is observed be the environment (but not
	 *            necessarily by the agent.
	 * @param agent
	 *            The agent.
	 * @return The color, unknown if the agent is colorblind.
	 */
	public static String getColor(String color, ViewEntity entity) {
		if (entity.isColorBlind()) {
			if (Character.isUpperCase(color.charAt(0))) {
				return "Unknown";
			}
			return "unknown";
		}
		return color;
	}

}