/*
 * SerialRealportView.java
 * 
 * Copyright (c) 2003-2004 Digi International
 * This program and the information contained in it is confidential and
 * proprietary to Digi International and may not be used, copied, or re-
 * produced without the prior written permission of Digi International.
 * 
 */

package com.digi.config.ui;

import com.digi.config.core.*;
import com.digi.config.util.*;

import javax.swing.*;
import javax.swing.text.*;
import java.text.*;
import javax.swing.event.*;
import javax.swing.tree.*;
import javax.swing.border.*;
import java.awt.*;
import java.awt.event.*;
import java.util.*;
import java.io.*;
import java.net.*;




/** 
 * This class is a view panel that shows serial realport
 * settings for the ConnectMe device
 * 
 * This view can be embedded in other panels as desired.
 */


public class SerialRealportView extends ConfigViewImpl {
    /** A KvpNode that holds just the settings used in this view */
    KvpNode viewSettingTree;
    /** listens to the device for changes to settings */
    DeviceChangeListener settingChangeListener;
    /** Panel that holds the view content */
    GridContentPanel content;
    GridContentPanel serverContent;
    GridContentPanel secureServerContent;

    // Data fields currently used in this view
    KvpField realportServerEnabledKvpField;
    KvpField realportServerPortKvpField;
    KvpField secureRealportServerEnabledKvpField;
    KvpField secureRealportServerPortKvpField;

    // UI Controls for each filed
    JCheckBox  realportServerEnabled_UIC;
    JTextField realportServerPort_UIC;
    JCheckBox  secureRealportServerEnabled_UIC;
    JTextField secureRealportServerPort_UIC;

    /**
     * Basic constructor. Sets up the tree view and the edit panel.
     */
    public SerialRealportView() throws Exception {
        // create the KvpNode and the change listener
        viewSettingTree = new KvpNode();
        settingChangeListener = new DeviceChangeListener() {
            public void deviceChanged(DeviceChangeEvent e) {
                //SystemLog.debug("SerialBasicView was notified that device kvpGroup changed");
                refreshViewKvpNode();
                refreshViewControls();
            }
        };
        // Create the panel that will hold the view controls
        content = new GridContentPanel(this.getName(),1);
        // create a listener that will detect when a user edits the field values
        ControlChangeAdapter fieldListener = new ControlChangeAdapter() {
            public void changePerformed(Object source, ActionEvent ae, FocusEvent fe) {
                //SystemLog.debug("SerialBasicView was notified that field "+source.toString()+" changed.");
                if (source==realportServerEnabled_UIC) {
                    realportServerEnabledKvpField.setStringValue(RciProtocol.toString(realportServerEnabled_UIC.isSelected()));
                    serverContent.setContainerEnabled(realportServerEnabled_UIC.isSelected());
                } else if (source==realportServerPort_UIC) {
                    realportServerPortKvpField.setStringValue(realportServerPort_UIC.getText());
                } else if (source==secureRealportServerEnabled_UIC) {
                    secureRealportServerEnabledKvpField.setStringValue(RciProtocol.toString(secureRealportServerEnabled_UIC.isSelected()));
                    secureServerContent.setContainerEnabled(secureRealportServerEnabled_UIC.isSelected());
                } else if (source==secureRealportServerPort_UIC) {
                    secureRealportServerPortKvpField.setStringValue(secureRealportServerPort_UIC.getText());
                }

            }
        };

        //
        // Create the fields and put them on the view
        //

        content.addHeadingBar("RealportServerHeading");

        realportServerEnabled_UIC = content.addJCheckBox("RealportServerEnabled", fieldListener);
        // Create the panel that will hold the server controls
        serverContent = new GridContentPanel(1);
        serverContent.addTextLine("RealportServerDesc");
        realportServerPort_UIC = serverContent.addJTextField("RealportServerPort","RealportServerPortDesc",100,fieldListener);
        realportServerPort_UIC.setDocument(createIntegerDocument());
        content.addSubPanel(serverContent);

        secureRealportServerEnabled_UIC = content.addJCheckBox("SecureRealportServerEnabled", fieldListener);
        // Create the panel that will hold the server controls
        secureServerContent = new GridContentPanel(1);
        secureServerContent.addTextLine("SecureRealportServerDesc");
        secureRealportServerPort_UIC = secureServerContent.addJTextField("SecureRealportServerPort","SecureRealportServerPortDesc",100,fieldListener);
        secureRealportServerPort_UIC.setDocument(createIntegerDocument());
        content.addSubPanel(secureServerContent);

        content.addVGlue();
    }

    /**
     * Returns a one word name identifying this view. 
     */
    public String getName() {
        return "SerialRealportView";
    }

    /** 
     * Return the Component that displays the primary content for this view
     */
    public Component getViewContent() {
        return content;
    }



    /**
     * Informs view what device to work with. View should flush any
     * cached device data and mark current view content as invalid
     * so that it is refreshed appropriatly.
     */
    public void setDevice(Device device) {
        super.setDevice(device);
        refreshViewKvpNode();
        refreshViewControls();
        device.addSettingChangeListener(settingChangeListener);
    }

    /** 
     * Refreshes the local copy of the kvpGroup displayed in the view. The updated kvpGroup come
     * from those currently cached in the Device
     */
    private void refreshViewKvpNode() {
        viewSettingTree.clear();
        realportServerEnabledKvpField = viewSettingTree.mergeFrom(device.getInternalSettingTree(), "realport", "state"); 
        realportServerPortKvpField = viewSettingTree.mergeFrom(device.getInternalSettingTree(), "realport", "port"); 
        secureRealportServerEnabledKvpField = viewSettingTree.mergeFrom(device.getInternalSettingTree(), "secure_realport", "state"); 
        secureRealportServerPortKvpField = viewSettingTree.mergeFrom(device.getInternalSettingTree(), "secure_realport", "port"); 
    }

    /** 
     * Refreshes the state of the controls in the view to match the data in the views kvpGroup.
     */
    private void refreshViewControls() {
        realportServerPort_UIC.setEnabled(realportServerPortKvpField!=null);
        if (realportServerPortKvpField!=null) {
            realportServerPort_UIC.setText(realportServerPortKvpField.getStringValue());
        }
        realportServerEnabled_UIC.setEnabled(realportServerEnabledKvpField!=null);
        if (realportServerEnabledKvpField!=null) {
            realportServerEnabled_UIC.setSelected(RciProtocol.booleanValue(realportServerEnabledKvpField.getStringValue()));
            serverContent.setContainerEnabled(realportServerEnabled_UIC.isSelected());
        }

        secureRealportServerPort_UIC.setEnabled(secureRealportServerPortKvpField!=null);
        if (secureRealportServerPortKvpField!=null) {
            secureRealportServerPort_UIC.setText(secureRealportServerPortKvpField.getStringValue());
        }
        secureRealportServerEnabled_UIC.setEnabled(secureRealportServerEnabledKvpField!=null);
        if (secureRealportServerEnabledKvpField!=null) {
            secureRealportServerEnabled_UIC.setSelected(RciProtocol.booleanValue(secureRealportServerEnabledKvpField.getStringValue()));
            secureServerContent.setContainerEnabled(secureRealportServerEnabled_UIC.isSelected());
        }

        // If no device data is not available, disable the entire panel
        if (realportServerEnabledKvpField==null) {
            content.setContainerEnabled(false);
        }
    }


    /**
     * This method is called to instruct the view that it is about to be made
     * active. When a view is active it needs to make sure its content is correct.
     * An example of why a panel may be inactive is if it were on a tabbed pane 
     * and was not currently visible or if the user selected some other view.
     */
    public void activate() {
        SystemLog.debug("Activating "+getName());
    }

    /**
     * This method is called to instruct the view that it is about to be made
     * inactive. When a view is inactive, it does not need to worry
     * about maintaining its content in a correct state. An example of why a panel
     * may be inactive is if it were on a tabbed pane and was not currently visible
     * or if the user selected some other view.
     */
    public void deactivate() {
        SystemLog.debug("Deactivating "+getName());
    }

    /**
     * Indicates if any changes have been made by the user that have not yet been
     * saved to the device(ie committed).
     */
    public boolean isChanged() {
        return viewSettingTree.hasChanged();
    }

    /**
     * This method instructs the view to validate any of the changes the user has made
     * within the view. Any errors are to be added to the provided errorList. 
     * 
     * @param errorList is a collection of ViewValidationError objects
     */
    public void validateChanges(Collection errorList) {
        // If enabled, validate the port
        if (realportServerEnabled_UIC.isSelected()) {
            if (!ValidationHelper.isValidNetworkPort(realportServerPort_UIC.getText()) ||
                (Integer.parseInt(realportServerPort_UIC.getText()) <= 0))
                errorList.add(new ValidationError("RealportServerPortValidationError"));
        }
        // If enabled, validate the port
        if (secureRealportServerEnabled_UIC.isSelected()) {
            if (!ValidationHelper.isValidNetworkPort(secureRealportServerPort_UIC.getText()) ||
                (Integer.parseInt(secureRealportServerPort_UIC.getText()) <= 0))
                errorList.add(new ValidationError("SecureRealportServerPortValidationError"));
        }
    }

    /**
     * This method instructs the view to place any changes the user has made within 
     * the view into the provided clusters. Once the changes have been saved to
     * to the device, a subsequent call to commitChanges() will be made.
     */
    public void getChanges(KvpNode settingCluster, KvpNode stateCluster) {
        // Merge the view changes into the provided cluster
        settingCluster.merge(viewSettingTree, false);
    }

    /**
     * Instructs the view to consider any user changes within the view as 
     * saved to the device (ie committed).
     */
    public void commitChanges() {
        // simply reset flags indicating user changes in the contols
        viewSettingTree.resetChanged();
    }

    /** 
     * Instructs the view to discard any changes the user has made within the
     * view and revert those fields to the original state. The view is also 
     * free to refresh all its fields to the present cached state of the device at 
     * this time.
     */
    public void cancelChanges() {
        refreshViewKvpNode();
        refreshViewControls();
    }


}