/**
    * This program is free software: you can redistribute it and/or modify
    * it under the terms of the GNU General Public License as published by
    * the Free Software Foundation, version 3.
    *
    * 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, see <http://www.gnu.org/licenses/>.
   */
  
  package net.curre.prefcount.gui;
  
  import java.awt.*;
  import java.awt.event.KeyAdapter;
  import java.awt.event.KeyEvent;
  import java.util.ArrayList;
  import java.util.Iterator;
  import java.util.List;
  import java.util.ResourceBundle;
  import javax.swing.*;
  
  import net.curre.prefcount.gui.theme.skin.PrefSkin;
  import net.curre.prefcount.gui.aa.AAJTextField;
  import net.curre.prefcount.service.LafThemeService;
  import net.curre.prefcount.util.Utilities;
  
  import org.apache.commons.lang.StringUtils;
  
  
  /**
   * Object of this class represents a players names panel -
   * the first panel, where player names/achronyms are entered.
   * <p/>
   * Created date: Apr 8, 2007
   *
   * @author Yevgeny Nyden
   */
  public class PlayersNamesPanel extends DialogInnerPanel {
  
    /** List of references to the player names fields. */
    protected List<JTextField> playersFields;
  
    /** Reference to the parent dialog frame. */
    private PlayerDialogBasePanel dialogWindow;
  
    /**
     * Current error field index - field that
     * failed validation (null if none).
     */
    private JTextField currErrorField;
  
    /**
     * Constructor.
     *
     * @param dialogWindow Reference to the dialog window/frame.
     * @param numPlayers   Number of players in the game.
     * @throws IllegalArgumentException If number of players is not supported.
     */
    public PlayersNamesPanel(PlayerDialogBasePanel dialogWindow,
                             int numPlayers) {
      super("pref.dialog.playerNames.message", PanelPosition.FIRST);
      this.dialogWindow = dialogWindow;
      playersFields = new ArrayList<JTextField>();
  
      GridBagLayout pLayout = new GridBagLayout();
      super.setLayout(pLayout);
      pLayout.columnWidths = new int[]{35, 40, 40, 40, 30, 0};
      pLayout.rowHeights = new int[]{20, 40, 25, 40, 15, 0};
      pLayout.columnWeights = new double[]{0.0, 0.0, 0.0, 0.0, 0.0, 1.0E-4};
      pLayout.rowWeights = new double[]{0.0, 0.0, 0.0, 0.0, 0.0, 1.0E-4};
  
      if (numPlayers == 3) {
  
        createNameFieldHelper(false, 3, 1, 1, 1, new Insets(0, 0, 5, 5));
        createNameFieldHelper(false, 2, 3, 1, 1, new Insets(0, 0, 5, 5));
        createNameFieldHelper(false, 1, 1, 1, 1, new Insets(0, 0, 5, 5));
  
        createNameFieldHelper(true, 0, 2, 1, 1, new Insets(0, 0, 5, 5));
        createNameFieldHelper(true, 2, 2, 1, 1, new Insets(0, 0, 5, 5));
        createNameFieldHelper(true, 4, 2, 1, 1, new Insets(0, 0, 5, 0));
        createNameFieldHelper(true, 2, 4, 1, 1, new Insets(0, 0, 0, 5));
        createNameFieldHelper(true, 2, 0, 1, 1, new Insets(0, 0, 5, 5));
  
      } else if (numPlayers == 4) {
  
        createNameFieldHelper(false, 2, 1, 1, 1, new Insets(0, 0, 5, 5));
        createNameFieldHelper(false, 3, 2, 1, 1, new Insets(0, 0, 5, 5));
        createNameFieldHelper(false, 2, 3, 1, 1, new Insets(0, 0, 5, 5));
        createNameFieldHelper(false, 1, 2, 1, 1, new Insets(0, 0, 5, 5));
  
        createNameFieldHelper(true, 2, 0, 1, 1, new Insets(0, 0, 5, 5));
        createNameFieldHelper(true, 4, 2, 1, 1, new Insets(0, 0, 5, 0));
        createNameFieldHelper(true, 2, 4, 1, 1, new Insets(0, 0, 0, 5));
        createNameFieldHelper(true, 0, 2, 1, 1, new Insets(0, 0, 5, 5));
  
     } else {
       throw new IllegalArgumentException("Player names panel can only handle 3 or 4 players right now!");
     }
   }
 
   /** {@inheritDoc} */
   public void focusFirstInputField() {
     if (currErrorField == null) {
       playersFields.get(0).requestFocus();
     } else {
       currErrorField.requestFocus();
     }
   }
 
   /**
    * Validates players names fields.
    *
    * @return True if all players names are entered; false otherwise.
    */
   public boolean validateFields() {
     for (JTextField fieldName : playersFields) {
       if (StringUtils.isBlank(fieldName.getText())) {
         ResourceBundle bundle = ResourceBundle.getBundle("default");
         dialogWindow.toggleErrorField(bundle.getString("pref.dialog.errorLabel.playerNames"));
         currErrorField = fieldName;
         fieldName.requestFocus(); // need to try to transfer focus from the Next button
         return false;
       }
     }
     dialogWindow.toggleErrorField(null);
     return true;
   }
 
   /**
    * Does nothing.
    * <p/>
    * {@inheritDoc}
    */
   public void doOnEntry() {
   }
 
   /** {@inheritDoc} */
   public void doOnLeave() {
     // creating a list of players names/achronyms
     List<String> playersNames = new ArrayList<String>();
     for (JTextField field : playersFields) {
       String playerLetter = Utilities.getFirstLetterFromField(field);
       playersNames.add(playerLetter);
     }
     // setting/changing players names on the players input panels
     for (int i = 1; i <= playersFields.size(); ++i) {
       PlayerDataPanel panel = (PlayerDataPanel) dialogWindow.questionsPane.getComponent(i);
       panel.adjustPlayersNames(playersNames);
     }
     // setting players names in the game results bean
     dialogWindow.setPlayersNames(playersNames);
   }
 
   /**
    * Generates a text field for a player name input field
    * and adds created field object to the panel and the
    * playerFields list.
    *
    * @param isSpacer True if a spacer needs to be created; false - a text field.
    * @param i        First argument for the <code>GridBagConstraints</code> ctor.
    * @param i1       Second argument for the <code>GridBagConstraints</code> ctor.
    * @param i2       Third argument for the <code>GridBagConstraints</code> ctor.
    * @param i3       Fourth argument for the <code>GridBagConstraints</code> ctor.
    * @param ins      Insert object for the <code>GridBagConstraints</code> ctor.
    */
   private void createNameFieldHelper(boolean isSpacer,
                                      int i, int i1, int i2, int i3,
                                      Insets ins) {
     if (isSpacer) {
       super.add(new JPanel(null),
                 new GridBagConstraints(i, i1, i2, i3, 0d, 0d,
                                        GridBagConstraints.CENTER,
                                        GridBagConstraints.BOTH,
                                        ins, 0, 0));
     } else {
       PrefSkin skin = LafThemeService.getInstance().getCurrentSkin();
       JTextField textField = new AAJTextField(1);
       textField.setHorizontalAlignment(JTextField.CENTER);
       textField.setFont(skin.getPlayerNameFont());
       textField.setFocusTraversalKeysEnabled(false);
       textField.addKeyListener(new KeyAdapter() {
         public void keyPressed(KeyEvent ke) {
           if (ke.getKeyCode() == KeyEvent.VK_TAB) {
             ke.consume();
             focusNextNameField();
           }
         }
       });
       super.add(textField,
                 new GridBagConstraints(i, i1, i2, i3, 0d, 0d,
                                        GridBagConstraints.CENTER,
                                        GridBagConstraints.BOTH,
                                        ins, 0, 0));
       textField.setOpaque(true);
       playersFields.add(textField);
     }
   }
 
   /**
    * Transfers focus to the next player name field
    * according to the order of the fields as they are
    * stored on the playersFields list.
    */
   private void focusNextNameField() {
     // looking for the current focus among the player text fields
     for (Iterator<JTextField> it = playersFields.iterator(); it.hasNext();) {
       JTextField field = it.next();
       if (field.isFocusOwner()) {
         if (it.hasNext()) {
           it.next().requestFocus();
         } else {
           dialogWindow.focusFirstNavigationalButton();
         }
         return;
       }
     }
   }
 
 }