package eu.irreality.age.windowing;

import java.awt.Component;
import java.awt.Dimension;
import java.awt.Graphics;
import java.awt.Toolkit;
import java.awt.event.FocusListener;
import java.util.Vector;

import javax.swing.JMenuBar;
import javax.swing.JPanel;

import eu.irreality.age.GameEngineThread;
import eu.irreality.age.InputOutputClient;
import eu.irreality.age.World;
import eu.irreality.age.observer.GameThreadObserver;

/**
 * Interface for any window that is able to serve as an AGE client.
 * For example, SwingAetheriaGameLoader is one.
 *
 */
public interface AGEClientWindow extends AGELoggingWindow, GameThreadObserver
{

    public void setTitle ( String s );
    public String getTitle();
    
    public void repaint();
    
    public JMenuBar getTheJMenuBar();
    public void setTheJMenuBar( JMenuBar jmb );
    
    public void setGlassPane(Component glassPane); //hides when loading log
    public Component getGlassPane();
    
    public World getWorld ();
    public void setWorld ( World w );
    
    public void setFullScreenMode(boolean b);
    public boolean isFullScreenMode();
    
    public Graphics getGraphics();
    
    public void reinit();
    
    public void update ( Graphics g );
    
    public void setVisible ( boolean b );
    
    public void updateNow();
    
    public JPanel getMainPanel();
    public void setMainPanel(JPanel p); //changes the panel that the window is showing
    
    public void guardarLog();
    public void guardarEstado();
    
    public Vector getGameLog();
    
    public void exitNow();
 
    public boolean supportsFullScreen();
    
    public void addFocusListener ( FocusListener fl );
    
    /**
     * Writes a String to the client window.
     */
    public void write ( String s );
    
    public void initClient();
    
    public InputOutputClient getIO();
    public void setIO ( InputOutputClient io );
    
    public GameEngineThread getEngineThread();
    public void setEngineThread ( GameEngineThread thread );
    
    
    public void prepareLog ( World theWorld ) throws Exception;
    
    
    /**
     * Returns the version of the client window.
     */
    public String getVersion();
    
    
	/**
	 * Obtains the size of the screen in which the window is being displayed. This can be useful to make layout decisions.
	 * @return The size of the screen, or null if it cannot be recovered for some reason (e.g. running in an applet with javascript disabled or applet not passing height and width parameters).
	 */
	public Dimension getScreenSize();

	public void onAttach ( GameEngineThread thread );
	public void onDetach ( GameEngineThread thread );
	
	
	
	/**
	 * This method can be called when we are loading a log file and its corresponding world is not found.
	 * It will be used to recover the world path.
	 * This can be done by using the last world loaded in this window, or by asking the user with a dialog, for example.
	 * If the path cannot be recovered, null will be returned. It is legal to implement this method in such a way that it always returns null.
	 * @return
	 */
	public String recoverMissingWorldPath();
	
    
}