/*
    * Copyright (c) 2007 Regents of the University of California (Regents). Created
    * by TELS, Graduate School of Education, University of California at Berkeley.
    *
    * This software is distributed under the GNU Lesser General Public License, v2.
    *
    * Permission is hereby granted, without written agreement and without license
    * or royalty fees, to use, copy, modify, and distribute this software and its
    * documentation for any purpose, provided that the above copyright notice and
   * the following two paragraphs appear in all copies of this software.
   *
   * REGENTS SPECIFICALLY DISCLAIMS ANY WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
   * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
   * PURPOSE. THE SOFTWAREAND ACCOMPANYING DOCUMENTATION, IF ANY, PROVIDED
   * HEREUNDER IS PROVIDED "AS IS". REGENTS HAS NO OBLIGATION TO PROVIDE
   * MAINTENANCE, SUPPORT, UPDATES, ENHANCEMENTS, OR MODIFICATIONS.
   *
   * IN NO EVENT SHALL REGENTS BE LIABLE TO ANY PARTY FOR DIRECT, INDIRECT,
   * SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES, INCLUDING LOST PROFITS,
   * ARISING OUT OF THE USE OF THIS SOFTWARE AND ITS DOCUMENTATION, EVEN IF
   * REGENTS HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
   */
  package org.telscenter.pas.common.ui.panel;
  
  import java.awt.BorderLayout;
  import java.awt.Color;
  import java.awt.Cursor;
  import java.awt.Dimension;
  import java.awt.event.ActionEvent;
  import java.awt.event.ActionListener;
  
  import javax.swing.BorderFactory;
  import javax.swing.ImageIcon;
  import javax.swing.JButton;
  import javax.swing.JPanel;
  import javax.swing.JScrollPane;
  import javax.swing.JTextArea;
  import javax.swing.ScrollPaneConstants;
  import javax.swing.border.Border;
  import javax.swing.text.JTextComponent;
  
  import org.telscenter.pas.common.ui.CommonUI;
  import org.telscenter.pas.ui.icons.PasCommonIconProvider;
  
  /***
   * @author aperritano
   *
   */
  public class TextEditorPanel extends JPanel {
  
  	/***
  	 * 
  	 */
  	public static final String TEXT_EDITOR_PANEL = "TextEditorPanel";
  
  	public static final String MODE = "MODE";
  
  	public static final String SAVE_MODE = "SAVE";
  
  	public static final long serialVersionUID = 1L;
  
  	public static final String EDIT_MODE = "EDIT";
  
  	public static final String CREATE_Label = "Create"; 
  
  	public static final String EDIT_LABEL = "Edit";
  
  	public static final String EDIT_BUTTON = "EDIT_BUTTON";
  
  	public static final String TEXT_COMP = "TEXT_COMP";
  
  	public static final String EDIT_PANEL = "EDIT_PANEL";
  
  	protected Dimension dim;
  
  	protected JTextComponent textComponent;
  
  	protected ImageIcon editIcon;
  
  	protected ImageIcon saveIcon;
  
  	protected Border whiteBorder;
  
  	protected Border blackBorder;
  
  	protected JButton editButton;
  	
  	private String editButtonName = "Edit";
  	
  	private String saveButtonName = "Save"; 
  	/***
  	 * 
  	 */
  	public TextEditorPanel(JTextComponent textComponent, Dimension dim)  {
  		
  		this.textComponent = textComponent;
  		this.dim = dim;
  		init();
  	}
 
 	/***
 	 * 
 	 */
 	protected void init() {
 		
 		final JScrollPane sp = new JScrollPane(textComponent);
 		editIcon = new ImageIcon(PasCommonIconProvider.getImage("page_edit16.png"));
 		saveIcon = new ImageIcon(PasCommonIconProvider.getImage("page_save16.png"));
 
 		whiteBorder = BorderFactory.createLineBorder(Color.white,
 				1);
 		blackBorder = BorderFactory.createLineBorder(Color.black,
 				1);
 		this.setLayout(new BorderLayout(0, 0));
 
 		textComponent.setToolTipText("To modify this field click the EDIT button.");
 		
 		if (textComponent instanceof JTextArea) {
 			textComponent.setBorder(whiteBorder);
 			((JTextArea) textComponent).setWrapStyleWord(true);
 			((JTextArea) textComponent).setLineWrap(true);
 			((JTextArea) textComponent).setEditable(false);
 			sp.setName("AuthorNotesScrollPane");
 			sp
 					.setHorizontalScrollBarPolicy(ScrollPaneConstants.HORIZONTAL_SCROLLBAR_AS_NEEDED);
 			sp
 					.setVerticalScrollBarPolicy(ScrollPaneConstants.VERTICAL_SCROLLBAR_AS_NEEDED);
 			if( dim != null)
 				sp.setPreferredSize(dim);
 			sp.setBorder(BorderFactory.createEmptyBorder());
 			textComponent.setBorder(BorderFactory.createEmptyBorder());
 			this.add(sp, BorderLayout.CENTER);
 		} else {
 			this.add(textComponent, BorderLayout.CENTER);
 		}
 
 		
 		textComponent.setName(TEXT_COMP);
 		editButton = new JButton(getEditButtonName());
 		editButton.setName(EDIT_BUTTON);
 		editButton.setHorizontalTextPosition(JButton.LEFT);
 		editButton.setIcon(editIcon);
 		
 
 		
 		final Color orgColor = textComponent.getBackground();
 		final Border orgBorder = textComponent.getBorder();
 		textComponent.setBorder(whiteBorder);
 		// CommonUI.makeEnhancedButton(editButton);
 		CommonUI.makeButtonTransparent(editButton);
 		
 		final Border editEmptyBorder = BorderFactory.createEmptyBorder(0, 4, 0, 4);
 		editButton.setBorder(editEmptyBorder);
 		editButton.setCursor(Cursor.getPredefinedCursor(Cursor.HAND_CURSOR));
 		editButton.putClientProperty(MODE, EDIT_MODE);
 		editButton.addActionListener(new ActionListener() {
 
 			public void actionPerformed(ActionEvent e) {
 				JButton source = (JButton) e.getSource();
 				String clientProperty = (String) source.getClientProperty(MODE);
 
 				if (clientProperty.equals(EDIT_MODE)) {
 					// it was last saved so go to edit
 					textComponent.setEditable(true);
 					textComponent.setBackground(Color.white);
 
 					//System.out.println("org border: " + orgBorder);
 					textComponent.setBorder(blackBorder);
 					if (textComponent instanceof JTextArea) {
 						sp.setBorder(BorderFactory.createEtchedBorder());
 					}
 					sp.setBorder(BorderFactory.createEmptyBorder());
 					source.putClientProperty(MODE, SAVE_MODE);
 					source.setText(getSaveButtonName());
 					source.setIcon(saveIcon);
 					source.revalidate();
 					textComponent.setFocusable(true);
 					textComponent.requestFocusInWindow();
 					// textComponent.setCaretPosition(0);
 				} else if (clientProperty.equals(SAVE_MODE)) {
 					// it was last edited so go to save
 					textComponent.setEditable(false);
 					textComponent.setBackground(orgColor);
 
 					textComponent.setBorder(whiteBorder);
 					if (textComponent instanceof JTextArea) {
 						sp.setBorder(BorderFactory.createEmptyBorder());
 					}
 					textComponent.setFocusable(false);
 
 					textComponent.transferFocus();
 					// textComponent.setCaretPosition(null);
 					source.putClientProperty(MODE, EDIT_MODE);
 					
 					source.setText(getEditButtonName());
 					source.setIcon(editIcon);
 					CommonUI.makeButtonTransparent(source);
 					source.setBorder(editEmptyBorder);
 					source.revalidate();
 				}// if
 
 			}
 
 		});
 
 		this.setOpaque(false);
 		//his.setBackground(Color.red);
 		if (textComponent instanceof JTextArea) {
 			JPanel a = new JPanel(new BorderLayout(0, 0));
 			a.setOpaque(false);
 			a.add(editButton, BorderLayout.NORTH);
 			this.add(a, BorderLayout.EAST);
 		} else {
 			this.add(editButton, BorderLayout.EAST);
 		}
 		this.setName(EDIT_PANEL);
 	}
 
 	/***
 	 * @return the editButton
 	 */
 	public JButton getEditButton() {
 		return editButton;
 	}
 	
 	
 
 	/***
 	 * @param editButton the editButton to set
 	 */
 	public void setEditButton(JButton editButton) {
 		this.editButton = editButton;
 	}
 
 	public JTextComponent getTextComponent() {
 		return textComponent;
 	}
 
 	public void setTextComponent(JTextComponent textComponent) {
 		this.textComponent = textComponent;
 	}
 
 	/***
 	 * @param editButtonName the editButtonName to set
 	 */
 	public void setEditButtonName(String editButtonName) {
 		this.editButtonName = editButtonName;
 		editButton.setText(editButtonName);
 	}
 
 	/***
 	 * @return the editButtonName
 	 */
 	public String getEditButtonName() {
 		return editButtonName;
 	}
 
 	/***
 	 * @param saveButtonName the saveButtonName to set
 	 */
 	public void setSaveButtonName(String saveButtonName) {
 		this.saveButtonName = saveButtonName;
 	}
 
 	/***
 	 * @return the saveButtonName
 	 */
 	public String getSaveButtonName() {
 		return saveButtonName;
 	}
 }