/*
 *  $Source: /cvsroot2/open/projects/WebARTS/ca/bc/webarts/tools/X10Buttons.java,v $
 *  $Name:  $
 *  $Revision: 563 $
 *  $Date: 2012-11-03 19:28:37 -0700 (Sat, 03 Nov 2012) $
 *  $Locker:  $
 */
/*
 *  X10Buttons -- A simple Panel control pad that lists the available X10
 *  devices and house codes and calls the required X10 call.
 *
 *  Copyright (C) 2003 WebARTS Design, North Vancouver Canada
 *  http://www.webarts.bc.ca
 *
 *  This program is free software; you can redistribute it and/or modify
 *  it under the terms of Version 2 of the GNU General Public License as
 *  published by the Free Software Foundation.
 *
 *  This program is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *  GNU General Public License for more details.
 *
 *  You should have received a copy of the GNU General Public License
 *  along with this program; if not, write to the Free Software
 *  Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
 */
package ca.bc.webarts.tools;

import ca.bc.webarts.widgets.ColouredLabel;
import ca.bc.webarts.widgets.JToggleButton;
import ca.bc.webarts.widgets.Util;

//import com.jpeterson.x10.SendX10;
import javax.comm.NoSuchPortException;

import javax.comm.PortInUseException;

import java.awt.BorderLayout;
import java.awt.Color;
import java.awt.Dimension;
import java.awt.FlowLayout;
import java.awt.Font;
import java.awt.GridLayout;
import java.awt.event.ActionEvent;
import java.awt.event.ActionListener;
import java.awt.event.MouseAdapter;
import java.awt.event.MouseEvent;
import java.awt.event.MouseListener;
import java.awt.event.MouseMotionAdapter;
import java.io.File;
import javax.swing.BorderFactory;
import javax.swing.ButtonGroup;
import javax.swing.ImageIcon;
import javax.swing.JButton;
import javax.swing.JCheckBox;
import javax.swing.JPopupMenu;
import javax.swing.JRadioButton;
import javax.swing.JSpinner;
import javax.swing.JWindow;
import javax.swing.SpinnerListModel;
import javax.swing.border.BevelBorder;
import javax.swing.border.EmptyBorder;

import kiwi.ui.KButton;
import kiwi.ui.KPanel;

import x10.FireCracker;
import x10.X10Command;


/**
 *  A simple window widget that holds a bunch of buttons that directly turn an
 *  X10 device on or off. This app requires a few other libraries: webarts, and
 *  kiwi java libraries as well as some x10 devices and a X10 java
 *  implementation on your system.
 *
 * @author    tgutwin
 */
public class X10Buttons extends JWindow implements ActionListener
{

  // Colours
  /**  Constant holding the users file seperator. ("/" or "\")  */
  private final static String SYSTEM_FILE_SEPERATOR = File.separator;

  /**  Description of the Field */
  private final static String DEFAULT_TRANSMITTER =
      "com.jpeterson.x10.module.CM11A";
  /**  A Class holder for its name (used in Logging).  */
  private static String className_ = "X10Buttons";

  /**  The colour used for all panels except the display area.  */
  static Color mainBackColour_ = new Color( 100, 180, 245 );
  /**  The colour used to back the display area.  */
  static Color displayBackColour_ = Color.black;
  /**  The display area text colour.  */
  static Color displayTextColour_ = mainBackColour_.brighter();

  /**  The Main Popup menu  */
  static JPopupMenu mainMenu = new JPopupMenu( className_ + " Main Menu" );

  /**  Popup menu Mouse Listener.  */
  static MouseListener popupListener_ =
    new MouseAdapter()
    {

      public void mousePressed( MouseEvent e )
      {
        maybeShowPopup( e );
      }


      public void mouseReleased( MouseEvent e )
      {
        maybeShowPopup( e );
      }


      private void maybeShowPopup( MouseEvent e )
      {
        if ( e.isPopupTrigger() )
        {
          mainMenu.show( e.getComponent(), e.getX(), e.getY() );
        }
      }
    };
  /**  The wrapper panel holding all in this JWindow.  */
  KPanel dragableMiniViewPanel = new KPanel();
  /**  The Button area wrapper inside the dragableMiniViewPanel.  */
  KPanel miniViewPanel = new KPanel();
  /**  The Control area at the top of the window.  */
  KPanel miniViewWindowControlPanel = new KPanel();
  /**  The window header / draggable button.  */
  KButton miniDragButton = new KButton( "" );
  /**  The button to Min/Max this mini app window  */
  KButton miniButtonView_ = new KButton( "" );
  /**  The button to close this mini app window.  */
  KButton miniButtonClose_ = new KButton( "" );
  /**  The panel holding the X10 buttons  */
  KPanel miniButtonPanel_ = new KPanel();
  /**  The panel holding the on/off toggle button  */
  KPanel onOffPanel_ = new KPanel();
  /**  The object holding the min/max icon.  */
  ImageIcon iconMiniView_ = new ImageIcon();
  /**  The object holding the close icon.  */
  ImageIcon iconMiniClose_ = new ImageIcon();
  /**  The object holding the dim icon.  */
  ImageIcon iconDim_ = new ImageIcon();
  /**  The object holding the bright icon.  */
  ImageIcon iconBright_ = new ImageIcon();
  /**  The X amount the current window was just dragged.  */
  private int XDifference_;
  /**  The Y amount the current window was just dragged. * */
  private int YDifference_;
  /**  the x position of the mini window. * */
  private int xPosition_ = 100;
  /**  the y position of the mini window. * */
  private int yPosition_ = 100;
  /**  the x position of the app window. * */
  private int appXpos = -1;
  /**  the y position of the app window. * */
  private int appYpos = -1;
  /**  the number of rows of buttons to display in the app window. * */
  private int displayRows_ = 9;
  /**  the number of columns of buttons to display in the app window. * */
  private int displayCols_ = 2;
  /**  Class var holding the number of x10 buttons * */
  private int numButtons_ = 16;
  /**  Description of the Field */
  private String portDescriptor_ = "/dev/ttyS0";

  /**  Holds the Hose code values for the House Code Spinner * */
  //private String [] houseCodes_ = {" F "," E "," D "," C "," B "," A "};
  private String[] houseCodes_ = {" A ", " B ", " C ", " D ", " E ", " F ", " G ",
      " H ", " I ", " J ", " K ", " L ", " M ", " N ",
      " O ", " P "};

  /**  The Spinner model used in the Hose Code Spinner * */
  private SpinnerListModel spinnerModel_ = new SpinnerListModel( houseCodes_ );
  /**  Description of the Field */
  private JSpinner houseSpinner_ = new JSpinner( spinnerModel_ );


  /**  The dir where the images are located.  */
  String IMAGE_DIR = "." + SYSTEM_FILE_SEPERATOR +
      "images" + SYSTEM_FILE_SEPERATOR;

  /**  The Extension for the button images * */
  String buttonImageExtension_ = ".gif";

  /**  The Extension for the button images * */
  String buttonImagepath_ = "/images/org/javalobby/icons/20x20/Circle_";

  /**  This is this apps draggable - Title bar.  */
  ColouredLabel miniDragLabel = new ColouredLabel(
      displayBackColour_,
      displayTextColour_,
      new Font( "Arial", Font.PLAIN, 9 ),
      "X10 Buttons" );

  /**  An array of the x10 buttons.  */
  KButton[] x10controlButton_ = new KButton[numButtons_];

  /**  A dim button.  */
  KButton x10DimButton_ = new KButton( "" );

  /**  A dim button.  */
  KButton x10BrightButton_ = new KButton( "" );

  /**  The toggle controlling if the next X10 command will be on or Off.  */
  JToggleButton onOffToggle_ = new JToggleButton();

  /**
   *  Listener for when the mouse is pressed on the fake window frame title bar
   *  button.
   */
  MouseAdapter miniViewMouseListener =
    new MouseAdapter()
    {
      /**
       *  the impl for a mouse press.
       *
       * @param  e  Description of Parameter
       * @since
       */
      public void mousePressed( MouseEvent e )
      {
        XDifference_ = e.getX();
        YDifference_ = e.getY();
      }
    };

  /**  Listener for changing the location of this window. *  */
  MouseMotionAdapter dragMiniViewMotionListener =
    new MouseMotionAdapter()
    {
      /**
       *  Implementation of the mouse dragged event handler.
       *
       * @param  e  Description of Parameter
       * @since
       */
      public void mouseDragged( MouseEvent e )
      {
        setLocation( xPosition_ + ( e.getX() - XDifference_ ),
            yPosition_ + ( e.getY() - YDifference_ ) );
        xPosition_ = xPosition_ + ( e.getX() - XDifference_ );
        yPosition_ = yPosition_ + ( e.getY() - YDifference_ );
      }
    };


  /**  Constructor * */
  X10Buttons()
  {
    initWindowPanels();
    pack();
    setLocation( xPosition_, yPosition_ );
    setVisible( true );
    toFront();
  }


  /**  Constructor * */
  X10Buttons(boolean invisible)
  {
    if (!invisible)
    {
      initWindowPanels();
      pack();
      setLocation( xPosition_, yPosition_ );
      setVisible( true );
      toFront();
    }
  }


  /**
   *  The main program for the X10Buttons class.
   *
   * @param  arg  The command line arguments
   */
  public static void main( String[] arg )
  {
    System.out.println( "Starting X10Buttons " );
    X10Buttons instance = new X10Buttons();
  }


  /**
   *  Handles all the Actions originating from the Control Buttons.
   *
   * @param  e  The action event to handle
   */
  public void actionPerformed( ActionEvent e )
  {
    final String methodName = className_ + ": actionPerformed()";

    JButton pressedButton = (JButton)( e.getSource() );
    ImageIcon buttonIcon = (ImageIcon)pressedButton.getIcon();
    String command = "";
    int commandButtonNumber = 0;
    boolean dim = false;
    boolean bright = false;
    if ( buttonIcon != null )
    {
      command = buttonIcon.getDescription();
      //System.out.println("Action From: "+command);
      if ( command.trim().equals( "Close " + className_ ) )
      {
        //System.out.println("Close App");
        //stop();
        //log_.close();
        System.exit( 0 );
      }
      else if ( command.trim().equals( "dim" ) )
      {
        System.out.println( "dim" );
        dim = true;
      }
      else if ( command.trim().equals( "bright" ) )
      {
        System.out.println( "bright" );
        bright = true;
      }
      else
      {
        commandButtonNumber =
            Integer.parseInt( ( command.substring( command.length() - 2 ) ).trim() );
        //System.out.println("Button ICON Pressed: "+commandButtonNumber);
      }
    }
    else
    {
      command = pressedButton.getToolTipText();
      commandButtonNumber =
          Integer.parseInt( ( command.substring( command.length() - 2 ) ).trim() );
      //System.out.println("Button Pressed: "+commandButtonNumber);
    }
    String x10HouseCode = ( (String)houseSpinner_.getValue() ).trim().toUpperCase();
    String x10DeviceNumber = String.valueOf( commandButtonNumber );
    String x10Command = ( onOffToggle_.getState() ? "on" : "off" );
    if ( dim || bright )
    {
      x10Command = ( dim ? "dim" : "bright" );
      x10DeviceNumber = "";
    }
    sendX10Command( x10Command, x10HouseCode, x10DeviceNumber );
  }


  /**
   *  Abstracts the actual sending of the X10 Command.
   *
   * @param  x10Command       This is either 'on' or 'off'
   * @param  x10HouseCode     send an uppercase house code
   * @param  x10DeviceNumber  send the device nuymber as a string... ie. 'String.valueOf( 1 );'
   */
  public void sendX10Command( String x10Command,
                              String x10HouseCode,
                              String x10DeviceNumber )
  {
    // Now disable all buttons and send the X10 command
    enableDeviceButtons( false );

    FireCracker fc = new FireCracker();
    try
    {
      System.out.println( "Connecting to FireCracker on port " + portDescriptor_ );

      fc.openPort( portDescriptor_ );
    }
    catch ( PortInUseException piux )
    {
      System.out.println( "Specified port in use by application: " +
          piux.currentOwner );
      return;
    }
    catch ( NoSuchPortException nspx )
    {
      System.out.println( "Specified port not recognized: " + portDescriptor_ + "\n" );
      //usage();
    }

    // Give the device time to power up?
    // It's not very reliable without this delay.
    Util.sleep( 400 );

    X10Command xcmd = null;
    //System.out.println("Preparing:"+ x10HouseCode.charAt(0)+Integer.parseInt(x10DeviceNumber)+" "+x10Command);
    if ( x10Command.equals( "on" ) )
    {
      xcmd = X10Command.makeOnCommand( x10HouseCode.charAt( 0 ),
          Integer.parseInt( x10DeviceNumber ) );
    }
    else if ( x10Command.equals( "off" ) )
    {
      xcmd = X10Command.makeOffCommand( x10HouseCode.charAt( 0 ),
          Integer.parseInt( x10DeviceNumber ) );
    }
    else if ( x10Command.equals( "dim" ) )
    {
      xcmd = X10Command.makeDimCommand( x10HouseCode.charAt( 0 ) );
    }
    else if ( x10Command.equals( "bright" ) )
    {
      xcmd = X10Command.makeBrightCommand( x10HouseCode.charAt( 0 ) );
    }
    System.out.println( "Sending:" + x10HouseCode.charAt( 0 ) + x10DeviceNumber + " " + x10Command );
    fc.sendCommand( xcmd );

    System.out.println( "\nDisconnecting from FireCracker" );
    fc.closePort();

    //String [] x10Args = {x10Command, x10HouseCode, x10DeviceNumber};
    //SendX10 sx = new SendX10("/dev/ttyS1", DEFAULT_TRANSMITTER );
    //sx.transmit(0, x10Args);

    //Util.sleep(2500);
    enableDeviceButtons( true );
  }


  /**
   *  Creates a button using a Icon with a preset imagename
   *
   * @param  controlNumber  Description of the Parameter
   * @return                Description of the Return Value
   */
  private KButton createIconButton( int controlNumber )
  {
    KButton retVal = new KButton( String.valueOf( controlNumber ) );
    ImageIcon tempIcon;
    tempIcon =
        new ImageIcon(
        Util.loadImage( buttonImagepath_ + controlNumber + buttonImageExtension_ ),
        "X10 Device " + controlNumber );

    retVal.setIcon( tempIcon );
    retVal.setPreferredSize(
        new Dimension( tempIcon.getIconWidth() + 3, tempIcon.getIconHeight() + 3 ) );
    retVal.setToolTipText( "X10 Device #" + controlNumber );
    retVal.addActionListener( this );
    retVal.setBorder( BorderFactory.createBevelBorder(
        BevelBorder.RAISED ) );
    return retVal;
  }


  /**
   *  Creates a button using only text inside
   *
   * @param  controlNumber  Description of the Parameter
   * @return                Description of the Return Value
   */
  private KButton createButton( int controlNumber )
  {
    KButton retVal = new KButton( String.valueOf( controlNumber ) );
    // TO_DO: Add a custom tooltip naming the device on the end of this num
    retVal.setToolTipText( "X10 Device # " + controlNumber );
    retVal.addActionListener( this );
    retVal.setBorder( BorderFactory.createBevelBorder(
        BevelBorder.RAISED ) );
    return retVal;
  }


  /**  Inits the gui widgets * */
  private void initWindowPanels()
  {
    /*
     *  Init Window dressing
     */
    String miniViewFilename = "/images/miniViewButtonImage.jpg";
    String miniCloseFilename = "/images/miniCloseButtonImage.jpg";
    String x10DimFilename = "/images/Down24.gif";
    String x10BrightFilename = "/images/Up24.gif";

    // the dragabler title bar button
    miniDragButton.setMaximumSize( new Dimension( 100, 16 ) );
    miniDragButton.setBorder( BorderFactory.createRaisedBevelBorder() );
    miniDragButton.setBorderPainted( true );
    miniDragButton.setDoubleBuffered( true );
    miniDragButton.add( miniDragLabel );
    miniDragButton.addMouseListener( miniViewMouseListener );
    miniDragButton.addMouseMotionListener( dragMiniViewMotionListener );
    miniDragButton.addMouseListener( popupListener_ );

    // the mini close button
    iconMiniClose_ =
        new ImageIcon( Util.loadImage( miniCloseFilename ), "Close " + className_ );
    miniButtonClose_.addActionListener( this );
    miniButtonClose_.setIcon( iconMiniClose_ );
    miniButtonClose_.setToolTipText( "Close " + className_ );
    miniButtonClose_.setPreferredSize( new Dimension( 16, 16 ) );
    miniButtonClose_.setBorder( new EmptyBorder( 0, 0, 0, 0 ) );
    miniButtonClose_.setBorderPainted( false );
    miniButtonClose_.setDoubleBuffered( true );

    // the mini Dim button
    iconDim_ =
        new ImageIcon( Util.loadImage( x10DimFilename ), "dim" );
    x10DimButton_.addActionListener( this );
    x10DimButton_.setIcon( iconDim_ );
    x10DimButton_.setToolTipText( "dim" );
    x10DimButton_.setPreferredSize( new Dimension( 16, 16 ) );
    x10DimButton_.setBorder( new EmptyBorder( 0, 0, 0, 0 ) );
    x10DimButton_.setBorderPainted( false );
    x10DimButton_.setDoubleBuffered( true );

    // the mini Dim button
    iconBright_ =
        new ImageIcon( Util.loadImage( x10BrightFilename ), "bright" );
    x10BrightButton_.addActionListener( this );
    x10BrightButton_.setIcon( iconBright_ );
    x10BrightButton_.setToolTipText( "bright" );
    x10BrightButton_.setPreferredSize( new Dimension( 16, 16 ) );
    x10BrightButton_.setBorder( new EmptyBorder( 0, 0, 0, 0 ) );
    x10BrightButton_.setBorderPainted( false );
    x10BrightButton_.setDoubleBuffered( true );

    // the Title Area Panel
    miniViewWindowControlPanel.add( miniDragButton, BorderLayout.CENTER );
    miniViewWindowControlPanel.add( miniButtonClose_, BorderLayout.EAST );
    miniViewWindowControlPanel.setDoubleBuffered( true );
    miniViewWindowControlPanel.addMouseListener( popupListener_ );

    // the Button Panel
    miniButtonPanel_.setLayout( new GridLayout( displayRows_, displayCols_, 1, 1 ) );
    miniButtonPanel_.setBorder( new EmptyBorder( 0, 0, 0, 0 ) );
    miniButtonPanel_.addMouseListener( popupListener_ );
    for ( int i = 0; i < numButtons_; i++ )
    {
      x10controlButton_[i] = createButton( i + 1 );
      miniButtonPanel_.add( x10controlButton_[i] );
    }
    miniButtonPanel_.add( x10BrightButton_ );
    miniButtonPanel_.add( x10DimButton_ );

    onOffPanel_.setBorder( new EmptyBorder( 0, 0, 0, 0 ) );
    houseSpinner_.setValue( houseCodes_[0] );
    onOffPanel_.add( houseSpinner_ );
    onOffPanel_.add( onOffToggle_ );

    // now stitch it all together
    dragableMiniViewPanel.setDoubleBuffered( true );
    dragableMiniViewPanel.setLayout( new BorderLayout( 0, 0 ) );
    dragableMiniViewPanel.add( miniViewWindowControlPanel, BorderLayout.NORTH );
    dragableMiniViewPanel.add( miniButtonPanel_, BorderLayout.CENTER );
    dragableMiniViewPanel.add( onOffPanel_, BorderLayout.SOUTH );
    getContentPane().add( dragableMiniViewPanel );
  }


  /**
   *  Description of the Method
   *
   * @param  state  Description of the Parameter
   */
  private void enableDeviceButtons( boolean state )
  {
    for ( int i = 0; i < numButtons_; i++ )
    {
      x10controlButton_[i].setEnabled( state );
    }
  }
}