path: root/src/esieequest/view/app/UserInterface.java

package esieequest.view.app;

import java.awt.BorderLayout;
import java.awt.Dimension;
import java.awt.Font;
import java.awt.Graphics;
import java.awt.event.ActionEvent;
import java.awt.event.ActionListener;
import java.awt.image.BufferedImage;
import java.net.URL;
import java.util.HashMap;

import javax.swing.JButton;
import javax.swing.JLabel;
import javax.swing.JPanel;
import javax.swing.JTextField;
import javax.swing.JTextPane;
import javax.swing.border.EmptyBorder;

import com.wordpress.tipsforjava.swing.StretchIcon;

import esieequest.controller.GameEngine;
import esieequest.controller.commands.Command;
import esieequest.model.events.Quest;
import esieequest.model.items.SimpleItem;
import esieequest.model.map.Direction;
import esieequest.model.map.Orientation;
import esieequest.model.map.Room;
import esieequest.model.map.Side;
import esieequest.view.Viewable;

/**
 * The Swing based graphical user interface.
 * 
 * @author Pacien TRAN-GIRARD
 */
abstract class UserInterface implements Viewable, ActionListener {

	private GameEngine gameEngine;

	private JPanel layout;

	private JTextPane questTextPane;
	private JTextPane infoTextPane;

	private JLabel imageLabel;

	private HashMap<String, JButton> gameButtons;
	private HashMap<String, JButton> controlButtons;
	private JTextField inputField;

	/**
	 * The default constructor.
	 */
	public UserInterface() {
		this.buildUI();
		this.inputField.addActionListener(this);
		this.setActionListener(this);
		this.setControlsState(false);
		this.inputField.setEnabled(true);
	}

	/**
	 * Creates the interface widgets.
	 */
	private void buildUI() {
		this.layout = new JPanel();
		this.layout.setLayout(new BorderLayout(0, 0));

		final JPanel menuPanel = new JPanel();
		this.layout.add(menuPanel, BorderLayout.NORTH);
		menuPanel.setLayout(new BorderLayout(0, 0));

		final JPanel questPanel = new JPanel();
		menuPanel.add(questPanel, BorderLayout.CENTER);

		this.questTextPane = new JTextPane();
		this.questTextPane.setEditable(false);
		this.questTextPane.setText("ESIEEquest");
		questPanel.add(this.questTextPane);

		final JPanel gamePanel = new JPanel();
		menuPanel.add(gamePanel, BorderLayout.WEST);

		final JButton newButton = new JButton("New");
		newButton.setToolTipText("New game");
		gamePanel.add(newButton);

		final JButton soundButton = new JButton("Sound");
		soundButton.setToolTipText("Toggle sound");
		gamePanel.add(soundButton);

		final JPanel filePanel = new JPanel();
		menuPanel.add(filePanel, BorderLayout.EAST);

		final JButton loadButton = new JButton("Load");
		loadButton.setToolTipText("Load a game");
		filePanel.add(loadButton);

		final JButton saveButton = new JButton("Save");
		saveButton.setToolTipText("Save the current game");
		filePanel.add(saveButton);

		final JPanel imagePanel = new JPanel();
		this.layout.add(imagePanel, BorderLayout.CENTER);
		imagePanel.setLayout(new BorderLayout(0, 0));

		this.imageLabel = new JLabel();
		imagePanel.add(this.imageLabel);

		final JPanel userPanel = new JPanel();
		this.layout.add(userPanel, BorderLayout.SOUTH);
		userPanel.setLayout(new BorderLayout(0, 0));

		final JPanel dispPanel = new JPanel();
		dispPanel.setBorder(new EmptyBorder(5, 5, 5, 0));
		userPanel.add(dispPanel, BorderLayout.CENTER);
		dispPanel.setLayout(new BorderLayout(0, 0));

		this.infoTextPane = new JTextPane();
		this.infoTextPane.setEditable(false);
		this.infoTextPane.setText("Welcome to ESIEEquest!");
		dispPanel.add(this.infoTextPane);

		this.inputField = new JTextField();
		dispPanel.add(this.inputField, BorderLayout.SOUTH);
		this.inputField.setColumns(10);

		final JPanel controlPanel = new JPanel();
		controlPanel.setBorder(new EmptyBorder(5, 5, 5, 5));
		userPanel.add(controlPanel, BorderLayout.EAST);
		controlPanel.setLayout(new BorderLayout(0, 0));

		final JPanel topControlPanel = new JPanel();
		controlPanel.add(topControlPanel, BorderLayout.NORTH);
		topControlPanel.setLayout(new BorderLayout(0, 0));

		final Font font = new Font("Dialog", Font.BOLD, 19);

		final JButton forwardButton = new JButton("↥");
		forwardButton.setFont(font);
		forwardButton.setToolTipText("Go forward");
		topControlPanel.add(forwardButton, BorderLayout.CENTER);

		final JButton inventoryButton = new JButton("⇱");
		inventoryButton.setFont(font);
		inventoryButton.setToolTipText("Use item");
		topControlPanel.add(inventoryButton, BorderLayout.WEST);

		final JButton actionButton = new JButton("⇲");
		actionButton.setFont(font);
		actionButton.setToolTipText("Talk/Take item");
		topControlPanel.add(actionButton, BorderLayout.EAST);

		final JPanel bottomControlPanel = new JPanel();
		controlPanel.add(bottomControlPanel, BorderLayout.SOUTH);
		bottomControlPanel.setLayout(new BorderLayout(0, 0));

		final JButton backButton = new JButton("↧");
		backButton.setFont(font);
		backButton.setToolTipText("Go back");
		bottomControlPanel.add(backButton, BorderLayout.CENTER);

		final JButton leftButton = new JButton("↰");
		leftButton.setFont(font);
		leftButton.setToolTipText("Turn left");
		bottomControlPanel.add(leftButton, BorderLayout.WEST);

		final JButton rightButton = new JButton("↱");
		rightButton.setFont(font);
		rightButton.setToolTipText("Turn right");
		bottomControlPanel.add(rightButton, BorderLayout.EAST);

		final Dimension squareButton = new Dimension(50, 50);
		forwardButton.setPreferredSize(squareButton);
		inventoryButton.setPreferredSize(squareButton);
		actionButton.setPreferredSize(squareButton);
		backButton.setPreferredSize(squareButton);
		leftButton.setPreferredSize(squareButton);
		rightButton.setPreferredSize(squareButton);

		newButton.setActionCommand(Command.NEW.name());
		soundButton.setActionCommand(Command.SOUND.name());
		loadButton.setActionCommand(Command.LOAD.name());
		saveButton.setActionCommand(Command.SAVE.name());

		forwardButton.setActionCommand(Command.FORWARD.name());
		inventoryButton.setActionCommand(Command.INVENTORY.name());
		actionButton.setActionCommand(Command.DO.name());
		backButton.setActionCommand(Command.BACK.name());
		leftButton.setActionCommand(Command.TURN.name() + " " + Orientation.LEFT);
		rightButton.setActionCommand(Command.TURN.name() + " " + Orientation.RIGHT);

		this.gameButtons = new HashMap<String, JButton>();

		this.gameButtons.put("newButton", newButton);
		this.gameButtons.put("soundButton", soundButton);
		this.gameButtons.put("loadButton", loadButton);
		this.gameButtons.put("saveButton", saveButton);

		this.controlButtons = new HashMap<String, JButton>();

		this.controlButtons.put("forwardButton", forwardButton);
		this.controlButtons.put("inventoryButton", inventoryButton);
		this.controlButtons.put("actionButton", actionButton);
		this.controlButtons.put("backButton", backButton);
		this.controlButtons.put("leftButton", leftButton);
		this.controlButtons.put("rightButton", rightButton);
	}

	/**
	 * Returns the layout.
	 * 
	 * @return the layout
	 */
	public JPanel getLayout() {
		return this.layout;
	}

	/**
	 * Sets the action listener for the given JButtons.
	 * 
	 * @param hashMap
	 *            the map of the JButtons
	 * @param actionListener
	 *            the action listener
	 */
	private void setActionListener(final HashMap<String, JButton> hashMap, final ActionListener actionListener) {
		for (final JButton vButton : hashMap.values()) {
			vButton.addActionListener(actionListener);
		}
	}

	/**
	 * Sets the action listener for all UI elements.
	 * 
	 * @param actionListener
	 *            the action listener
	 */
	public void setActionListener(final ActionListener actionListener) {
		this.inputField.addActionListener(actionListener);
		this.setActionListener(this.gameButtons, actionListener);
		this.setActionListener(this.controlButtons, actionListener);
	}

	/**
	 * Clears the textual input field.
	 */
	private void clearInputField() {
		this.inputField.setText(null);
	}

	/**
	 * Sets the controls state.
	 * 
	 * @param state
	 *            the controls state
	 */
	private void setControlsState(final boolean state) {
		this.inputField.setEnabled(state);
		for (final JButton vButton : this.controlButtons.values()) {
			vButton.setEnabled(state);
		}
	}

	/**
	 * Sets the quest title.
	 * 
	 * @param quest
	 *            the quest title
	 */
	private void setQuestLabel(final String questTitle) {
		this.questTextPane.setText(questTitle);
	}

	/**
	 * Updates the room's illustration.
	 * 
	 * Placeholder generation from http://stackoverflow.com/a/17802477/1348634
	 */
	private void updateIllustration(final String imageName) {
		final URL imageURL = this.getClass().getClassLoader().getResource(imageName + ".jpg");
		final StretchIcon imageIcon;
		if (imageURL == null) {
			final BufferedImage bufferedImage = new BufferedImage(240, 135, BufferedImage.TYPE_BYTE_BINARY);
			final Graphics graphics = bufferedImage.getGraphics();
			graphics.drawString(imageName, 5, 10 + 5);
			imageIcon = new StretchIcon(bufferedImage, true);
		} else {
			imageIcon = new StretchIcon(imageURL, true);
		}
		this.imageLabel.setIcon(imageIcon);
	}

	/**
	 * Translates the received ActionEvent into the corresponding game command
	 * and forwards it to the game engine.
	 */
	@Override
	public void actionPerformed(final ActionEvent actionEvent) {
		this.gameEngine.interpret(actionEvent.getActionCommand());
	}

	@Override
	public void setController(final GameEngine gameEngine) {
		this.gameEngine = gameEngine;
	}

	@Override
	public void enable() {
		this.setControlsState(true);
	}

	@Override
	public void disable() {
		this.setControlsState(false);
		this.setQuestLabel("ESIEEquest");
	}

	@Override
	public void echo(final String message) {
		this.infoTextPane.setText(message);
		this.clearInputField();
	}

	@Override
	public void updateLocation(final Room room, final Direction direction, final Side side) {
		this.echo(room.getInformations());
		this.updateIllustration(room.name() + "_" + direction.name());
	}

	@Override
	public void updateQuest(final Quest quest) {
		this.setQuestLabel(quest.getTitle());
	}

	@Override
	public void updateInventory(final HashMap<String, SimpleItem> items) {
		// TODO Auto-generated method stub
	}

}