ChartSplitPane.java

package com.ibm.nmon.gui.main;

import java.beans.PropertyChangeListener;
import java.beans.PropertyChangeEvent;

import javax.swing.JFrame;
import javax.swing.JSplitPane;

import com.ibm.nmon.data.DataSetListener;

import com.ibm.nmon.gui.chart.BaseChartPanel;
import com.ibm.nmon.gui.chart.summary.ChartSummaryPanel;

/**
 * <p>
 * A split view that displays a chart on top and a linked table of charted values on the bottom.
 * Subclasses are responsible for updating the table when the chart changes.
 * </p>
 * 
 * <p>
 * This class listens for selection events from the table and highlights the associated value on the
 * chart. For the other direction of event flow, subclasses should link property change events on
 * their chart to this class' <code>ChartSummaryPanel</code> so that highlight selections made on
 * the chart updated the selected row of the table.
 * </p>
 * 
 * @see ChartSummaryPanel
 * @see BaseChartPanel#highlightElement(int, int)
 */
public abstract class ChartSplitPane extends JSplitPane implements PropertyChangeListener, DataSetListener {
    private static final long serialVersionUID = 7352498559598556656L;

    protected final NMONVisualizerGui gui;

    protected final ChartSummaryPanel summaryTable;

    private boolean changeInProgress;

    protected ChartSplitPane(NMONVisualizerGui gui, JFrame parent) {
        super(JSplitPane.VERTICAL_SPLIT);

        // summary panel gets a little of the extra space
        setResizeWeight(.75);
        setOneTouchExpandable(true);
        setBorder(null);

        this.gui = gui;
        summaryTable = new ChartSummaryPanel(gui, parent, getDefaultColumns());
        changeInProgress = false;

        setBottomComponent(summaryTable);

        summaryTable.addPropertyChangeListener("selectedRows", this);
        summaryTable.addPropertyChangeListener("rowVisible", this);
    }

    public void displayTableColumnChooser() {
        summaryTable.displayTableColumnChooser();
    }

    protected String[] getDefaultColumns() {
        return null;
    }

    @Override
    public void setEnabled(boolean enabled) {
        summaryTable.setEnabled(enabled);

        super.setEnabled(enabled);
    }

    @Override
    public void propertyChange(PropertyChangeEvent evt) {
        if (changeInProgress) {
            return;
        }

        changeInProgress = true;

        if ("highlightedLine".equals(evt.getPropertyName())) {
            Integer newRow = (Integer) evt.getNewValue();

            if (newRow == null) {
                summaryTable.clearSelection();
            }
            else {
                summaryTable.selectRow(newRow);
            }
        }
        else if ("highlightedBar".equals(evt.getPropertyName())) {
            int[] newValues = (int[]) evt.getNewValue();

            if (newValues == null) {
                summaryTable.clearSelection();
            }
            else {
                summaryTable.selectRow(newValues[0], newValues[1]);
            }
        }
        else if ("highlightedIntervalLine".equals(evt.getPropertyName())) {
            Integer newRow = (Integer) evt.getNewValue();

            if (newRow == null) {
                summaryTable.clearSelection();
            }
            else {
                summaryTable.selectRow(newRow);
            }
        }
        else if ("selectedRows".equals(evt.getPropertyName())) {
            BaseChartPanel chartPanel = getChartPanel();

            if (chartPanel != null) {
                boolean[] selectedRows = (boolean[]) evt.getNewValue();
                chartPanel.clearHighlightedElements();

                for (int i = 0; i < selectedRows.length; i++) {
                    if (selectedRows[i]) {
                        int row = summaryTable.getDatasetRow(i);
                        int column = summaryTable.getDatasetColumn(i);

                        chartPanel.highlightElement(row, column);
                    }
                }
            }
        }
        else if ("rowVisible".equals(evt.getPropertyName())) {
            BaseChartPanel chartPanel = getChartPanel();

            if (chartPanel != null) {
                Object[] values = (Object[]) evt.getNewValue();

                chartPanel.setElementVisible((Integer) values[0], (Integer) values[1], (Boolean) values[2]);
            }
        }

        changeInProgress = false;

        // forward event to this class' listeners
        firePropertyChange(evt.getPropertyName(), evt.getOldValue(), evt.getNewValue());
    }

    /**
     * @return the chart panel currently associated with this view; can be <code>null</code>
     */
    protected abstract BaseChartPanel getChartPanel();

    /** Save all the charts in this view to the given directory. **/
    protected abstract void saveCharts(String directory);
}