/**
@author  Scott Marshall
@author  University of Glasgow, MSc IT Project 2001
@author  Building an OnLine Course in Computing Fundamentals
*/


package ukacgla_KMap;

import java.util.*;
import javax.swing.*;
import javax.swing.border.*;
import javax.swing.table.*;
import javax.swing.table.TableColumn;
import javax.swing.table.TableCellRenderer;
import javax.swing.JColorChooser;
import javax.swing.table.AbstractTableModel;
import javax.swing.SwingUtilities;
import java.awt.*;
import java.awt.event.*;
import java.applet.Applet;


/** Frame  holds the GUI components of the exercise. */
abstract public class KMap_Frame extends JFrame {

	protected checkBoxListener listener; 
	
	/** Number of options to be presented to user. */
	protected int noOfOptions;	
	protected JPanel kMap, buttonPanel, checkBoxPanel, mid1, mid2, labelPanel, host;
	protected Border border;
	protected JCheckBox[] checkBox;
	protected JButton clear,reveal,nextMap;
	protected JTextArea output;
	protected JLabel lab1;
	protected JTable table;
	protected Container contentPane;

	protected int noOfRows;			//number of rows in myTableModel
	protected int noOfCols; 		//number of columns in myTableModel

	/** Sets titles of columns. */
	protected String[] columnNames;

	/** Model of the TableModel. */
	protected MyTableModel model;	

	/** 2D Object array to hold data in TableModel. */ 
	protected Object[][] data;		

	/** Vector holds all Minterm objects for display. */
	protected Vector answers;		

	public KMap_Frame(JApplet m, int noOfRows, int noOfCols, String[] c){
		contentPane = m.getContentPane();
		columnNames = c;
		mkUI();
		this.noOfRows = noOfRows;
		this.noOfCols = noOfCols;
	}

	/**
	Builds a new table model, calculates the answers, and redraws the panel on the screen
	*/
	protected abstract void newTable();


	/**
	Builds the table to display the K Map, and the model to hold the data.
	After initial instantiation, the newTable() method should be called.
	*/
	protected abstract JPanel mkTable();

	/**
	Builds the correct answers for the K Map
	*/
	protected abstract void buildAnswers();

	
	/**
	Returns an panel containing the JCheckBox buttons.
	The checkBox array is set using the contents of the answers vector
	*/
	protected abstract JPanel mkButtonPanel();
	

	/**
	Builds GUI and adds to applet content pane.
	Sets Look and Feel to Windows L&F.
	*/	
	public void mkUI() {

		try {
		
			UIManager.setLookAndFeel("com.sun.java.swing.plaf.windows.WindowsLookAndFeel");
		} 
		catch (Exception e) { }
		
		contentPane.setLayout(new BorderLayout(0,0));


		//-----------K MAP  ---------------------
		mid1 = new JPanel(new BorderLayout(10,10));
		mid1.setBorder(new BevelBorder(BevelBorder.LOWERED));

		JLabel lab1 = mkLabel("KMap for simplification  ", Font.PLAIN, 10);
		mid1.add("North", lab1);			

		//mkTable will also calculate the answer options and store these in a vector. 
		kMap = mkTable();
		mid1.add("Center", kMap);	
		
		contentPane.add("North", mid1);		

		//-----------CHECK BOXES  ---------------------
	
		/**
		Building the check box array requires the correct answers.
		This method is called repeatedly, every time another k map is drawn.
		As a result it is self contained within its own method
		*/
		mkCheckBoxPanel();


		//--------------- LABEL AND TXT AREA  ------------------------------
		JLabel lab3 = mkLabel("Program Output:  ", Font.PLAIN, 10);
				
		output = mkTextArea(5,40,false);

		JPanel mid3 = new JPanel(new BorderLayout(10,10));
		mid3.add("North", lab3);
		mid3.add("Center", output);


		//--------------- BUTTON PANEL  ------------------------------
		//make panel, make JButtons and add,set constraints and add add to frame
		buttonPanel = new JPanel( new FlowLayout() );
		buttonPanel.setBorder(new BevelBorder(BevelBorder.LOWERED));
		clear = mkButton("Reset", buttonPanel);
		clear.setToolTipText("Reset current question");
		reveal = mkButton("Reveal", buttonPanel);
		reveal.setToolTipText("Displays correct option");
		nextMap = mkButton("Next K Map", buttonPanel);
		nextMap.setToolTipText("Generates another random K Map");
		mid3.add("South", buttonPanel);

		contentPane.add("South", mid3);		
	}

	/**
	Adds the panel with the JCheckboxes to the contentPane.
	Called repeatedly when a new K Map is required.
	*/
	protected void mkCheckBoxPanel(){
		if (mid2!=null)
			contentPane.remove(mid2);
		mid2 = new JPanel(new BorderLayout(10,10));
		mid2.setBorder(new BevelBorder(BevelBorder.LOWERED));

		checkBoxPanel = mkButtonPanel();
		JLabel lab2 = mkLabel("Select one of following options :",Font.PLAIN, 10); 
		mid2.add("North", lab2);
		mid2.add("Center", checkBoxPanel);
		contentPane.add("Center",mid2);	
		contentPane.validate();		
	}

	


	/** Check boxes are given labels and action commands based on the Minterm object. */	
	protected JCheckBox mkChkButton(Container b,String name,String correct, boolean checked){
		JCheckBox temp = new JCheckBox(name,checked);
		temp.setActionCommand(correct);
		temp.setPreferredSize(new Dimension(250,20));
		temp.addItemListener(new checkBoxListener() );
		b.add(temp);
		return temp;	
	}
	
	/** Sets all boxes in GUI to de selected. Used for each new table. */
	protected void clearChkbox()	{
		for (int i = 0; i<noOfOptions; i++)	{
			checkBox[i].setSelected(false);
			checkBox[i].setEnabled(true);			
			checkBox[i].repaint();
		}
		clearTxtArea();
	}
	
	
	/**	Returns JTextArea of required size. Programmer must specify if editable during instantiation. */
	protected JTextArea mkTextArea(int rows, int cols, boolean editable){
		JTextArea temp = new JTextArea(rows, cols);
		temp.setLineWrap(true);
		temp.setEditable(editable);
		temp.setBackground(Color.white);
		Border border = new EtchedBorder(EtchedBorder.RAISED);
		temp.setBorder(border);
		return temp;
	}
	
	/**	Returns JButton of standard size 100 x 25. */	
	protected JButton mkButton(String nm,Container c) {
	    JButton b = new JButton(nm);
		b.setForeground(Color.blue);
		b.setPreferredSize(new Dimension(100,25));
	    b.addActionListener(new ButtonListener());
	    c.add(b);
	    return b;
	}
	
	/**	Returns JLabel using "arial" font. User can specify Font style and size. */		
	protected JLabel mkLabel(String nm, int style, int size)	{
		JLabel l = new JLabel(nm);
		l.setFont(new Font("arial",style , size));	
		l.setOpaque(true);
		return l;
	}


	
	/** Sets output JTextArea to new blank String ( "" )*/ 	
	public void clearTxtArea(){
		output.setText("");
	}


	/** Appends String argument to output JTextArea. */ 	
	public void setTxtArea(String s){
		output.append(s+"\n");
	}	



	//-------------------------- INNER CLASSES----------------------------

	//-------------------------- TABLE MODEL -----------------------------


	abstract protected class MyTableModel extends AbstractTableModel
	{

		String[] columnNames;

		protected MyTableModel(String[] c)	{
			columnNames = c;
		}
		
   
		/**
		This ensures that the table will not be made exclusively of ones or zeros
		*/
		abstract public void proofReadTable();



		public int getColumnCount() {
	        return columnNames.length;
	    }
	    
	    public int getRowCount() {
	        return data.length;
	    }

	    public String getColumnName(int col) {
	        return columnNames[col];
	    }

	    public Object getValueAt(int row, int col) {
	        return data[row][col];
	    }

	    public Class getColumnClass(int c) {
			return getValueAt(0, c).getClass();
	    }

		
	}//ends MyTableModel

	//-------------------------- BUTTON LISTENER -------------------------

		protected class ButtonListener implements ActionListener{
			public void actionPerformed(ActionEvent event){
				Object source = event.getSource();
				
				if (source == clear){
					clearChkbox();	//clears the checkboxes
				}
			
				if (source == reveal){
					int i = 0;
					while (i<checkBox.length){
						if (checkBox[i].getActionCommand().equals("Correct"))
							break;
						i++;
					}
					clearTxtArea();
					setTxtArea("Option " + (i+1) + " is correct");
					
				}
			
				if (source == nextMap){
					clearTxtArea();					
					newTable();
				}

			}


		}//ends ButtonListener


	//-------------------------- CHECK BOX LISTENER-----------------------

		protected class checkBoxListener implements ItemListener{
			public void itemStateChanged (ItemEvent e){
				Object source = e.getItemSelectable();
				
				//only process answer if state is changed to selected
				if (e.getStateChange() == ItemEvent.SELECTED){
	
					//prevent further input after the first one.
					for (int j=0; j<checkBox.length;j++){
						checkBox[j].setEnabled(false);
					}

					int i = 0;
					while (source!=checkBox[i]) {
						i++;
					}
					clearTxtArea();
					setTxtArea(checkBox[i].getActionCommand());
					if ((checkBox[i].getActionCommand()).equals("Incorrect"))
						setTxtArea("Press Reset to try again,\nor reveal to see the correct answer");

				}//ends if
				
			}

		}//ends check Box Listener

	
}//ends class