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

*/

package ukacgla_ATT;

import javax.swing.border.*;
import javax.swing.JTable;
import javax.swing.table.AbstractTableModel;
import javax.swing.DefaultCellEditor;
import javax.swing.JScrollPane;
import javax.swing.JFrame;
import javax.swing.SwingUtilities;
import java.awt.*;
import java.awt.event.*;
import javax.swing.*;
import javax.swing.table.TableColumn;
import java.util.Vector;


/** 
When instantiated, calls abstract mehod createExercise(). 
createExercise() must generate the JInternal Frames to display the exercise, then
create the GUI, then create the truth table and Checker object that verifies the student
input.
*/
public abstract class TableUI extends JFrame{

	/**	Internal frame to display on Truth table.	*/
	protected JInternalFrame tableFrame;

	/** Object allows generation of JInternalFrames. */ 
	protected frameMaker gui;			
	
	/** Object instantiates circuitGrpahics object. */
	protected circuitGraphics diagram;	
	
	/** Hold random numbers used to generate circuit. */	
	protected TTRandom random;			
	
	/** Checks answers and provides hints */
	protected Checker marker; 			 
		
	/** Holds number of rows to be used with the TableModel */	
	protected int noOfRows;				

	/** Holds the headers for each column */
	protected String[] columnNames;		

	/** Holds data displyed through the TableModel */
	protected Object[][] data;			

	/** Defines column headers, and used extensively to set the size of the TableModel*/
	protected Vector colTitle; 			

	/** Holds and presents Truth Table data */
	protected MyTableModel myModel;		

	/** Number of columns containing outputs */
	protected int noOfOutPuts;			
	
	//GUI components
	protected JPanel truthTable,middle,buttonPanel;

	/** Activate JButton to clear all student input from table  */	
	protected JButton clear;

	/**  Activate JButton to submit student answers for checking */
	protected JButton submit;

	/** Activate JButton to generate next circuit */
	protected JButton nextCircuit;

	/** Array contains JCheckBoxes for selecting individual lines */	
	protected JCheckBox[] checkBox;
	
	/** JCheckBox listener */
	protected checkBoxListener listener; 


	/** JTextArea for displaying program output. */	
	protected JTextArea  output;

	/** contentPane the exercise will be displayed on  */	
	protected Container contentPane;
	
	
	/** Requires a frameMaker object to allow creation of JInternalFrames */
	public TableUI(frameMaker g){
		gui = g;
		random = new TTRandom();		//Start random number generation
		createExercise();	
	}

	
	/**  Creates JInternalFrames, mkTable and Checker objects. */
	abstract protected void createExercise();


	//-------------- INTERACTIVE METHODS ----------------------------
	
	/**
	Method to compare answers versus real. 
	Each row is checked one row at a time.  
	The results for each row are displayed through the  Checker.calcAnswer() method.
	A JOptionPane provides a visible message to the user as to the overall results.
	*/
	public void checkAnswers(){	

		int i = 0;
		while (i<noOfRows){
			marker.checkAnswer(i);
			i++;
		}
	
		String error = "Errors found at Lines " + marker.wrongLines();

		if (marker.allCorrect()==true)
			makeDialog("Results checked.", "All answers correct", JOptionPane.INFORMATION_MESSAGE, JOptionPane.DEFAULT_OPTION);
		
		else 			
			makeDialog("Results checked.", error , JOptionPane.ERROR_MESSAGE, JOptionPane.DEFAULT_OPTION);
		
	}	


	//-------------- GUI FACTORY METHODS ---------------------------
	
	/** Returns JCheckBox at defined size (120,20) with checkBoxListener included */
	protected JCheckBox mkChkButton(Container b,String name,boolean checked){
		JCheckBox temp = new JCheckBox(name,checked);
		temp.setPreferredSize(new Dimension(120,20));
		temp.addItemListener(new checkBoxListener() );
		b.add(temp);
		return temp;	
	
	}

	/** Returns JTextArea at defined size (rows x cols).
	User can choose if JTextArea is editable or not. */
	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 at defined size (100,25) with actionListener included */
	protected JButton mkButton(String nm,Container c) {
	    JButton b = new JButton(nm);
		b.setPreferredSize(new Dimension(100,25));
	    b.addActionListener(new ButtonListener());
	    c.add(b);
	    return b;
	}
	
	/** Returns JLabel in arial Font, with programmer specifed 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;
	}


	public void makeDialog(String title,String message,int messageType,int optionType){
	  	JOptionPane optionPane = new JOptionPane(message,messageType,optionType);
	  	JDialog dialog = optionPane.createDialog(contentPane,title);
	  	dialog.show();
	}


	/**	All arguments are used to create a GridBagConstraints object.	*/
	protected GridBagConstraints  mkConstraints(int gridX, int gridY, int fill, int gridWidth, int gridHeight, double weightX, double weightY, int anchor, int padX, int padY ){
		GridBagConstraints c = new GridBagConstraints();
		c.gridx = gridX; c.gridy = gridY;		// = x,y co ordinates
		c.fill = fill; 							// = when component is smaller than allocated area
		c.gridwidth = gridWidth; c.gridheight = gridHeight;	// = specifies size of component in grid size
		c.weightx = weightX; c.weighty = weightY;	//= how to distribute extra space on x y lines
		c.anchor = anchor;
		c.ipadx = padX; c.ipady = padY;
		return c;
	}



	//-------------- TABLE MANIPULATION METHODS ----------------------------


	/**
	 Code modified from Sun Microsystems website.
	 Ensures only String 0's or 1's are entered into table
	 Strings must be used to allow the initial display for certain cells
	 to be blank. Use of Integers requires an initial value of 0 to be displayed
	 */
	 protected void setUpIntegerEditor(JTable table) {
	     //Set up the editor for the table cells.
	     final WholeNumberField tableField = new WholeNumberField(new String("0"), colTitle.size());
	     tableField.setHorizontalAlignment(WholeNumberField.LEFT);
	
	     DefaultCellEditor integerEditor = new DefaultCellEditor(tableField) {
	        public Object getCellEditorValue() {
	           String answer = "";
			   try  {
			   		answer = tableField.getValue();
			   }
			   
			   catch (InvalidEntryException x)   {
					makeDialog("Input Error",x.getString(),JOptionPane.ERROR_MESSAGE,JOptionPane.DEFAULT_OPTION);
			   }
			   		
			   return answer;
	           }
	         };
	     table.setDefaultEditor(String.class, integerEditor);
	 }

 
	/**
	Checks each cell in table for incomplete cells.
	WholeNumberField prevents incorrect entries, only entries can be 0,1 or <space>
	This method detects <space> strings.
	*/
  	public boolean testCellsComplete(Object[][] d) {
		
		String value;
		boolean missing = false;	
			
  		try	{	
	  		for (int i=0; i<noOfRows ; i++){
	  			for(int j=0; j<colTitle.size(); j++) {	 
  					value = (String) d[i][j];
  					if (value.equals(""))
  						throw new EmptyCellException(i,j);
	  			}//ends j
				
	  		}//ends i
				
  		}//ends try
  		catch(EmptyCellException e ){
  			makeDialog("Table checked", "Please complete all cells. Empty cell found at Line " + (e.getRow()+1) + ", Column " + (e.getCol()+1), JOptionPane.ERROR_MESSAGE, JOptionPane.DEFAULT_OPTION);
			missing = true;
  		}
		
		return missing;

  	}

	/** Returns contents of specified table cell */
  	public String getCellValue(int row, int col) {
  	    String value = (String) data[row][col];
		return value;

  	}

	/** Set contents of the 2D array supplied as an argument to the object specified. */
  	protected void setCellValue(Object value, int row, int col, Object[][] a) {
  	     	a[row][col] = value;
  	}






	//---------------------- ALTER DISPLAY TO USER ----------------------------

	/** 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");
	}	




	/** Sets all JCheckBoxes in GUI to de-selected. Used for each new table.*/ 
	protected void clearChkbox()	{
		for (int i = 0; i<noOfRows; i++)	{
			checkBox[i].setSelected(false);
			checkBox[i].setEnabled(true);			
			checkBox[i].repaint();
		}
	}
	
	
	
	//-------------------------- INNER CLASSES----------------------------

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


	abstract protected class MyTableModel extends AbstractTableModel{
	
		/** Sets all entries in table to new blank String ( "" )	*/
		public void tableReset(int rowStart, int noRows, int colStart,int noOfCols){
			String value = "";
			for (int i = rowStart; i<noOfRows ; i++) {
				for (int j = colStart; j < noOfCols; j++)	{
					data[i][j]= value;
					fireTableCellUpdated(i, j);
				}
			}
			
		}


		protected MyTableModel(String[] c)	{
			columnNames = c;
		}
		
	    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();
	    }


	    public boolean isCellEditable(int row, int col) {
	        if (col < (colTitle.size()-3))  
	            return false;
 			else 
	            return true;

	    }


	    public void setValueAt(Object value, int row, int col) {
	         data[row][col] = value;
	         fireTableCellUpdated(row, col);

	    }

		
	}//ends MyTableModel

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

	protected class ButtonListener implements ActionListener{
		public void actionPerformed(ActionEvent event){
			Object source = event.getSource();

			if (source == clear){
				clearTxtArea();
				clearChkbox();
				myModel.tableReset(0,noOfRows,colTitle.size()-3, colTitle.size());
			}

			/**
			It is essential to empty the marker vector which holds the incorrect lines.
			If all cells are complete, the students answers will be marked.
			*/
			if (source == submit){
				clearTxtArea();
				marker.clearVector();
				if (testCellsComplete(data) == false)
					checkAnswers();
			}

			if (source == nextCircuit)
				createExercise();
			

		}
	
	}//ends ButtonListener


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

		protected class checkBoxListener implements ItemListener{
			public void itemStateChanged (ItemEvent e){
				Object source = e.getItemSelectable();
				
				//only display answer if state is changed to selected
				if (e.getStateChange() == ItemEvent.SELECTED){
					int i = 0;
					while (source!=checkBox[i]) {
						i++;
					}
					marker.revealAnswer(i);

				}//ends if
		
			}//ends itemStateChanged


		}//ends check Box Listener


}//ends class