/*
    *******************************************************************************
    * Copyright (c) 2005 Chris Rose and AIMedia
    * All rights reserved. SummaryPanel and the accompanying materials
    * are made available under the terms of the Common Public License v1.0
    * which accompanies this distribution, and is available at
    * http://www.eclipse.org/legal/cpl-v10.html
    * 
    * Contributors:
   *     Chris Rose
   *******************************************************************************/
   
  package ca.spaz.cron.summary;
  
  import java.awt.BorderLayout;
  import java.util.*;
  
  import javax.swing.*;
  
  import com.aimedia.ui.IValueListUser;
  
  /***
   * An abstract UI class for display of a set of field values.  Supports
   * arbitrary numbers of rows in 3-column displays.
   * 
   * @deprecated No longer needed for UI.
   * @author Chris Rose
   */
  public abstract class SummaryPanel extends JPanel {
  
      private Map valueHash;
  
  //    private Map valueLabels;
  
      private List values;
  
      private Map valueSuffixes;
  
  //    private int columns;
  
      private Comparator fieldOrdering;
  
      private Map valueLabelText;
  
      private SimpleSummaryContent content;
  
      /***
       * Construct a summary panel with the default ordering of components.
       */
      protected SummaryPanel() {
          this(null);
      }
      
      /***
       * Construct a summary panel with the specified number of columns and field ordering.
       * 
       * @param fieldOrdering The <code>Comparator</code> to sort the fields with.  If null,
       * the field default ordering is the order they are added in.
       */
      protected SummaryPanel(Comparator fieldOrdering) {
          super();
  //        this.columns = columns;
          valueHash = new HashMap();
          values = new ArrayList();
  //        valueLabels = new HashMap();
          valueSuffixes = new HashMap();
          valueLabelText = new HashMap();
          this.fieldOrdering = fieldOrdering;
          this.setBorder(BorderFactory.createEmptyBorder(4,4,4,4));
          this.setLayout(new BorderLayout());
      }
  
      /***
       * Add a new value field to the component.  Sets a default value of "" (empty string)
       * for the value.
       * 
       * @param valueName The name to use for both the label and as the key.  Must be unique.
       * @param valueUnit The unit of measure (will be appended to the output value by default).
       */
      protected final void addValueField(String valueName, String valueUnit) {
          addValueField(valueName, valueName, valueUnit);
      }
  
      /***
       * Add a new value field to the component.  Sets a default value of "" (empty string)
       * for the value.
       * 
       * @param valueName The name to use for both the label and as the key.  Must be unique.
       * @param labelText The text to be displayed on the label.
       * @param valueUnit The unit of measure (will be appended to the output value by default).
       */
      protected final void addValueField(String valueName, String labelText, String valueUnit) {
          values.add(valueName);
          valueLabelText.put(valueName, labelText);
          valueSuffixes.put(valueName, valueUnit);
          setValue(valueName, "");
      }
  
      /***
      * Format a <code>Boolean</code> for display.  Defaults to toString(), but sublcasses
      * can override this behaviour.
      * @param valueName The name of the value to be formatted.
      * @param value The value to format.
      * @return a formatted String for value.
      */
     protected String doBooleanString(String valueName, Boolean value) {
         return value.toString() + " " + getUnit(valueName);
     }
 
     /***
      * Format a <code>Double</code> for display.  Defaults to toString(), but sublcasses
      * can override this behaviour.
      * @param valueName The name of the value to be formatted.
      * @param value The value to format.
      * @return a formatted String for value.
      */
     protected String doDoubleString(String valueName, Double value) {
         return value.toString() + " " + getUnit(valueName);
     }
 
     /***
      * Get the label text for a value.
      * 
      * @param valueName The name of the value to retrieve.
      * @param value The actual value to display.
      * @return a String with the value name and the value itself formatted according to the
      * policy of this component.
      */
     protected final String doGetTextForValue(String valueName, Object value) {
         String ret = "";
         if (value instanceof Integer) {
             Integer ival = (Integer) value;
             ret = doIntegerString(valueName, ival);
         } else if (value instanceof Double) {
             Double dval = (Double) value;
             ret = doDoubleString(valueName, dval);
         } else if (value instanceof Boolean) {
             Boolean bval = (Boolean) value;
             ret = doBooleanString(valueName, bval);
         } else if (value instanceof String) {
             String sval = (String) value;
             ret = doString(valueName, sval);
         } else {
             ret = value.toString();
         }
         return ret;
     }
 
     /***
      * Format a <code>Integer</code> for display.  Defaults to toString(), but sublcasses
      * can override this behaviour.
      * @param valueName The name of the value to be formatted.
      * @param value The value to format.
      * @return a formatted String for value.
      */
     protected String doIntegerString(String valueName, Integer value) {
         return value.toString() + " " + getUnit(valueName);
     }
 
     private void doSetValue(String valueName, Object value) {
         valueHash.put(valueName, value);
 //        relabelValue(valueName);
         if (content != null) {
             ((IValueListUser)content).setValueList(getValueList());
         }
         doValueUpdate(valueName);
         revalidate();
     }
 
     /***
      * Format a <code>String</code> for display.  Defaults to unmodified, but sublcasses
      * can override this behaviour.
      * @param valueName The name of the value to be formatted.
      * @param value The value to format.
      * @return a formatted String for value.
      */
    protected String doString(String valueName, String value) {
         return value + " " + getUnit(valueName);
     }
 
     /***
      * get the unit string for the value, with all the fixings.
      * @param valueName the value to get the unit for.
      * @return the unit stored in valueSuffixes, or an empty string if there was none.
      */
     protected final String getUnit(String valueName) {
         String ret = (String) valueSuffixes.get(valueName);
         return (ret == null) ? "" : ret;
     }
     
     protected final String getText(String valueName) {
         String ret = (String) valueLabelText.get(valueName);
         return (ret == null) ? "" : ret;
     }
     
     public final String getValueText(String valueName) {
         return doGetTextForValue(valueName, valueHash.get(valueName));
     }
     
     public final String getLabelText(String valueName) {
         String ret = (String) valueLabelText.get(valueName);
         if (ret == null) {
             return valueName;
         } else {
             return ret;
         }
     }
 
     /***
      * Subclass-specific behaviour on value settings occurs here.  By the time this
      * is called, the value will already be set, but the UI will not have been updated
      * yet.  Empty implementations of this are perfectly valid.
      * 
      * @param valueName the name of the value that was updated.
      */
     protected abstract void doValueUpdate(String valueName);
 
     /***
      * Retrieve a <code>boolean</code> value. 
      * @param valueName the name of the value to return.
      * @return the value stored under <code>valueName</code>.  False if no boolean stored.
      */
     public final boolean getBooleanValue(String valueName) {
         boolean ret = false;
         Object o = valueHash.get(valueName);
         if (o != null && o instanceof Boolean) {
             ret = ((Boolean) o).booleanValue();
         }
         return ret;
     }
 
     /***
      * Retrieve a <code>double</code> value. 
      * @param valueName the name of the value to return.
      * @return the value stored under <code>valueName</code>.  
      * <code>Double.NaN</code> if no double stored.
      */
     public final double getDoubleValue(String valueName) {
         double ret = Double.NaN;
         Object o = valueHash.get(valueName);
         if (o != null && o instanceof Double) {
             ret = ((Double) o).doubleValue();
         }
         return ret;
     }
 
     /***
      * Retrieve an <code>int</code> value. 
      * @param valueName the name of the value to return.
      * @return the value stored under <code>valueName</code>.  
      * 0 if no int stored.
      */
     public final int getIntValue(String valueName) {
         int ret = 0;
         Object o = valueHash.get(valueName);
         if (o != null && o instanceof Integer) {
             ret = ((Integer) o).intValue();
         }
         return ret;
     }
 
     /***
      * Retrieve a <code>String</code> value. 
      * @param valueName the name of the value to return.
      * @return the value stored under <code>valueName</code>.  
      * Empty string if no object stored.
      */
     public final String getStringValue(String valueName) {
         String ret = "";
         Object o = valueHash.get(valueName);
         if (o != null) {
             ret = o.toString();
         }
         return ret;
     }
 
     /***
      * @param valueName
      */
 //    private void relabelValue(String valueName) {
 //        Object value = valueHash.get(valueName);
 //        if (null == value) {
 //            return;
 //        }
 //        JLabel lbl = (JLabel) valueLabels.get(valueName);
 //        if (lbl == null) {
 //            lbl = new JLabel();
 //            lbl.setAlignmentX(JLabel.LEFT_ALIGNMENT);
 //            valueLabels.put(valueName, lbl);
 //        }
 //        lbl.setText(doGetTextForValue(valueName, value));
 //    }
 
     /***
      * Regenerate the UI components.  Call this whenever the return
      * value of getContentPane() would change.
      */
     protected final void generateContentPane() {
         removeAll();
         List intersect = getValueList();
         add(getContentPane(intersect), BorderLayout.CENTER);
     }
     
     /***
      * Get a list of the values in this summary panel.
      * @return a <code>List</code> containing all the values in this summary panel.
      */
     protected final List getValueList() {
         List intersect = new ArrayList(values);
         intersect.retainAll(valueHash.keySet());
         if (null != fieldOrdering) {
             Collections.sort(intersect, fieldOrdering);
         }
         return intersect;
     }
 
     /***
      * Overridable method to select the actual content panel of the display 
      * component.
      * @param contentValues The list of value tags that will be displayed in 
      * this component.
      * 
      */
     protected JComponent getContentPane(List contentValues) {
         content = new SimpleSummaryContent(this);
         content.setValueList(contentValues);
 /*        int numlbls = contentValues.size();
         int nrows = numlbls / columns;
         if ((numlbls % columns) != 0) {
             nrows++;
         }
 //        content.removeAll();
         content.setLayout(new GridBagLayout());
         GridBagConstraints gclbl = new GridBagConstraints();
         GridBagConstraints gcval = new GridBagConstraints();
         gclbl.ipadx=4;
 //        gclbl.ipady=4;
         gcval.ipadx=4;
 //        gcval.ipady=4;
         gclbl.insets=new Insets(2,2,2,6);
         gcval.insets=new Insets(2,2,6,2);
         gclbl.anchor=GridBagConstraints.WEST;
         gcval.anchor=GridBagConstraints.EAST;
         gclbl.weightx=1;
         gcval.weightx=0.9;
         gclbl.gridy = 0;
         gcval.gridy = 0;
         int col = 0;
         for (Iterator iter = contentValues.iterator(); iter.hasNext();) {
             String valueName = (String) iter.next();
             JLabel vlbl = (JLabel) valueLabels.get(valueName);
             content.add(makeRLabel(valueName), gclbl);
             content.add(vlbl, gcval);
             col+=2;
             if (col % (2 * columns) == 0) {
                 gcval.gridy++;
                 gclbl.gridy++;
             }
         }*/
         return content;
     }
     
     /***
      * Purge a value from the component.  Removes all versions of it.
      * @param valueName
      */
     protected final void removeValueField(String valueName) {
         values.remove(valueName);
         valueSuffixes.remove(valueName);
 //        valueLabels.remove(valueName);
         valueHash.remove(valueName);
 //        generateContentPane();
     }
 
     /***
      * Set a <code>boolean</code> value in the value set.
      * @param valueName the name of the value to set.
      * @param value the value to set.
      */
     public final void setValue(String valueName, boolean value) {
         doSetValue(valueName, Boolean.valueOf(value));
     }
 
     /***
      * Set a <code>double</code> value in the value set.
      * @param valueName the name of the value to set.
      * @param value the value to set.
      */
     public final void setValue(String valueName, double value) {
         doSetValue(valueName, new Double(value));
     }
 
     /***
      * Set an <code>int</code> value in the value set.
      * @param valueName the name of the value to set.
      * @param value the value to set.
      */
 
     public final void setValue(String valueName, int value) {
         doSetValue(valueName, new Integer(value));
     }
 
     /***
      * Set a <code>String</code> value in the value set.
      * @param valueName the name of the value to set.
      * @param value the value to set.
      */
     public final void setValue(String valueName, String value) {
         doSetValue(valueName, value);
     }
 
 }