/*
 * CDDL HEADER START
 *
 * The contents of this file are subject to the terms of the
 * Common Development and Distribution License, Version 1.0 only
 * (the "License").  You may not use this file except in compliance
 * with the License.
 *
 * You can obtain a copy of the license at
 * trunk/opends/resource/legal-notices/OpenDS.LICENSE
 * or https://OpenDS.dev.java.net/OpenDS.LICENSE.
 * See the License for the specific language governing permissions
 * and limitations under the License.
 *
 * When distributing Covered Code, include this CDDL HEADER in each
 * file and include the License file at
 * trunk/opends/resource/legal-notices/OpenDS.LICENSE.  If applicable,
 * add the following below this CDDL HEADER, with the fields enclosed
 * by brackets "[]" replaced with your own identifying information:
 *      Portions Copyright [yyyy] [name of copyright owner]
 *
 * CDDL HEADER END
 *
 *
 *      Copyright 2009 Sun Microsystems, Inc.
 */
package org.opends.guitools.controlpanel.ui;

import static org.opends.messages.AdminToolMessages.*;

import java.awt.Component;
import java.awt.GridBagConstraints;
import java.util.ArrayList;
import java.util.Collection;
import java.util.Iterator;
import java.util.LinkedHashSet;

import javax.swing.Box;
import javax.swing.JCheckBox;

import org.opends.guitools.controlpanel.datamodel.MonitoringAttributes;
import org.opends.guitools.controlpanel.event.ConfigurationChangeEvent;
import org.opends.guitools.controlpanel.util.Utilities;
import org.opends.messages.Message;

/**
 *
 * The panel that allows the user to select which attributes must be displayed
 * in the traffic monitoring tables.
 *
 * @param <T> the type of the objects that this panel manages.  For now it only
 * manages String and MonitoringAttribute objects.
 */
public class MonitoringAttributesViewPanel<T> extends StatusGenericPanel
{
  private static final long serialVersionUID = 6462932163745559L;

  private LinkedHashSet<T> selectedAttributes = new LinkedHashSet<T>();

  private LinkedHashSet<T> monitoringAttributes;

  private boolean isCancelled = true;

  // Note: the order of the checkboxes and the elements in the Attributes
  // enumeration will be the same.
  private JCheckBox[] checkboxes = {};

  /**
   * Creates an instance of this panel that uses String as attributes.
   * @param attributes the list of possible attributes.
   * @return an instance of this panel that uses String as attributes.
   */
  public static MonitoringAttributesViewPanel<String>
  createStringInstance(LinkedHashSet<String> attributes)
  {
    return new MonitoringAttributesViewPanel<String>(attributes);
  }

  /**
   * Creates an instance of this panel that uses MonitoringAttributes as
   * attributes.
   * @param attributes the list of possible attributes.
   * @return an instance of this panel that uses String as attributes.
   */
  public static MonitoringAttributesViewPanel<MonitoringAttributes>
  createMonitoringAttributesInstance(
      LinkedHashSet<MonitoringAttributes> attributes)
  {
    return new MonitoringAttributesViewPanel<MonitoringAttributes>(attributes);
  }

  /**
   * Default constructor.
   * @param attributes the attributes that will be proposed to the user.
   *
   */
  protected MonitoringAttributesViewPanel(
      LinkedHashSet<T> attributes)
  {
    super();
    monitoringAttributes = new LinkedHashSet<T>();
    monitoringAttributes.addAll(attributes);
    createLayout();
  }

  /**
   * Sets the attributes that must be selected in this dialog.
   * @param selectedAttributes the selected attributes.
   */
  public void setSelectedAttributes(
      Collection<T> selectedAttributes)
  {
    int i = 0;
    for (T attribute : monitoringAttributes)
    {
      checkboxes[i].setSelected(selectedAttributes.contains(attribute));
      i++;
    }
  }

  /**
   * Creates the layout of the panel (but the contents are not populated here).
   */
  private void createLayout()
  {
    GridBagConstraints gbc = new GridBagConstraints();
    gbc.fill = GridBagConstraints.HORIZONTAL;
    gbc.gridy = 0;
    int nCols = monitoringAttributes.size() > 30 ? 3 : 2;

    gbc.gridwidth = nCols;
    gbc.gridx = 0;
    add(Utilities.createPrimaryLabel(
        INFO_CTRL_PANEL_OPERATION_VIEW_LABEL.get()), gbc);
    gbc.gridy ++;
    gbc.gridwidth = 1;
    gbc.insets.top = 10;

    checkboxes = new JCheckBox[monitoringAttributes.size()];

    int i = 0;
    Iterator<T> ops = monitoringAttributes.iterator();
    while (ops.hasNext())
    {
      T operation = ops.next();
      Message m = getMessage(operation);

      JCheckBox cb = Utilities.createCheckBox(m);
      gbc.gridx = 0;
      gbc.weightx = 0.0;
      gbc.insets.left = 0;
      checkboxes[i] = cb;
      add(checkboxes[i], gbc);
      gbc.weightx = 1.0;
      gbc.insets.left = 40;
      while (gbc.gridx + 1 < nCols)
      {
        gbc.gridx ++;
        if (i + 1 >= checkboxes.length)
        {
          add(Box.createHorizontalGlue(), gbc);
        }
        else
        {
          operation = ops.next();
          m = getMessage(operation);
          cb = Utilities.createCheckBox(m);
          checkboxes[i+1] = cb;
          add(checkboxes[i+1], gbc);
          i ++;
          checkboxes[i].setSelected(true);
        }
      }
      gbc.gridy ++;
      i++;
    }
    gbc.gridx = 0;
    gbc.gridwidth = nCols;
    gbc.weighty = 1.0;
    gbc.fill = GridBagConstraints.VERTICAL;
    add(Box.createVerticalGlue(), gbc);
  }

  /**
   * {@inheritDoc}
   */
  public Message getTitle()
  {
    return INFO_CTRL_PANEL_ATTRIBUTE_VIEW_OPTIONS_TITLE.get();
  }

  /**
   * {@inheritDoc}
   */
  public void configurationChanged(ConfigurationChangeEvent ev)
  {
  }

  /**
   * {@inheritDoc}
   */
  public Component getPreferredFocusComponent()
  {
    return checkboxes[0];
  }

  /**
   * {@inheritDoc}
   */
  public void toBeDisplayed(boolean visible)
  {
    if (visible)
    {
      isCancelled = true;
    }
  }

  /**
   * {@inheritDoc}
   */
  public void okClicked()
  {
    // Check that at least one checkbox is selected.
    selectedAttributes.clear();
    int i = 0;
    for (T operation : monitoringAttributes)
    {
      if (checkboxes[i].isSelected())
      {
        selectedAttributes.add(operation);
      }
      i++;
    }
    if (selectedAttributes.isEmpty())
    {
      ArrayList<Message> errors = new ArrayList<Message>();
      errors.add(INFO_CTRL_PANEL_NO_OPERATION_SELECTED.get());
      super.displayErrorDialog(errors);
    }
    else
    {
      isCancelled = false;
      super.closeClicked();
    }
  }

  /**
   * {@inheritDoc}
   */
  public GenericDialog.ButtonType getButtonType()
  {
    return GenericDialog.ButtonType.OK_CANCEL;
  }

  /**
   * Returns <CODE>true</CODE> if the user closed the dialog by cancelling it
   * and <CODE>false</CODE> otherwise.
   * @return <CODE>true</CODE> if the user closed the dialog by cancelling it
   * and <CODE>false</CODE> otherwise.
   */
  public boolean isCancelled()
  {
    return isCancelled;
  }

  /**
   * Returns the list of attributes that the user selected.
   * @return the list of attributes that the user selected.
   */
  public LinkedHashSet<T> getAttributes()
  {
    return selectedAttributes;
  }

  /**
   * Returns the message for the provided operation.
   * @param operation the operation.
   * @return the message for the provided operation.
   */
  protected Message getMessage(T operation)
  {
    Message m;
    if (operation instanceof MonitoringAttributes)
    {
      m = ((MonitoringAttributes)operation).getMessage();
    }
    else
    {
      m = Message.raw(operation.toString());
    }
    return m;
  }
}