/*

 * Copyright (c) 2007-2010 Nokia Corporation and/or its subsidiary(-ies). 

 * All rights reserved.

 * This component and the accompanying materials are made available

 * under the terms of "Eclipse Public License v1.0"

 * which accompanies this distribution, and is available

 * at the URL "http://www.eclipse.org/legal/epl-v10.html".

 *

 * Initial Contributors:

 * Nokia Corporation - initial contribution.

 *

 * Contributors:

 *

 * Description:

 *

 * Base class for property dialogs

 *

 */

package com.nokia.traceviewer.dialog;

import org.eclipse.jface.dialogs.IDialogConstants;

import org.eclipse.swt.SWT;

import org.eclipse.swt.events.KeyEvent;

import org.eclipse.swt.events.KeyListener;

import org.eclipse.swt.events.ModifyEvent;

import org.eclipse.swt.events.ModifyListener;

import org.eclipse.swt.events.SelectionAdapter;

import org.eclipse.swt.events.SelectionEvent;

import org.eclipse.swt.layout.GridData;

import org.eclipse.swt.layout.GridLayout;

import org.eclipse.swt.widgets.Button;

import org.eclipse.swt.widgets.Composite;

import org.eclipse.swt.widgets.Label;

import org.eclipse.swt.widgets.List;

import org.eclipse.swt.widgets.Shell;

import org.eclipse.swt.widgets.Text;

import com.nokia.traceviewer.dialog.treeitem.TreeItem;

import com.nokia.traceviewer.engine.TraceViewerGlobals;

/**

 * Base class for property dialogs

 * 

 */

public abstract class BasePropertyDialog extends BaseDialog {

	/**

	 * Index of Text Rule in Rules list

	 */

	protected static final int TEXT_RULE_INDEX = 0;

	/**

	 * Index of Component Rule in Rules list

	 */

	protected static final int COMPONENT_RULE_INDEX = 1;

	/**

	 * Wildcard indicating any component / group ID

	 */

	protected static final String WILDCARD_STRING = "*"; //$NON-NLS-1$

	/**

	 * Hex prefix

	 */

	protected static final String HEX_PREFIX = "0x"; //$NON-NLS-1$

	/**

	 * Hex radix

	 */

	protected static final int HEX_RADIX = 16;

	/**

	 * Wildcard integer value indicating any component / group ID

	 */

	public static final int WILDCARD_INTEGER = -1;

	/**

	 * Text rule name

	 */

	protected static final String TEXT_RULE_NAME = Messages

			.getString("BasePropertyDialog.TextRuleName"); //$NON-NLS-1$

	/**

	 * Component rule name

	 */

	protected static final String COMPONENT_RULE_NAME = Messages

			.getString("BasePropertyDialog.ComponentRuleName"); //$NON-NLS-1$

	/**

	 * Main UI Composite

	 */

	protected Composite mainComposite;

	/**

	 * Upper UI Composite

	 */

	protected Composite upperComposite;

	/**

	 * Right under UI Composite

	 */

	protected Composite rightUnderComposite;

	/**

	 * List of available rules

	 */

	protected List ruleList;

	/**

	 * UI Label for name

	 */

	protected Label nameLabel;

	/**

	 * UI Label for rule

	 */

	protected Label ruleLabel;

	/**

	 * UI Label for selected rule

	 */

	protected Label selectedRuleLabel;

	/**

	 * UI Label for information

	 */

	protected Label informationLabel;

	/**

	 * Text field for the name of the rule

	 */

	protected Text nameText;

	/**

	 * Button to change component ID

	 */

	protected Button changeComponentButton;

	/**

	 * Button to change group ID

	 */

	protected Button changeGroupButton;

	/**

	 * Component / Group selection dialog

	 */

	protected ComponentSelectionDialog selDialog;

	/**

	 * Text field for text of the rule when text rule is selected

	 */

	protected Text textText;

	/**

	 * Text field for component ID when component rule is selected

	 */

	protected Text componentTextField;

	/**

	 * UI Label for component name

	 */

	protected Label componentNameLabel;

	/**

	 * Text field for group ID when component rule is selected

	 */

	protected Text groupTextField;

	/**

	 * UI Label for group name

	 */

	protected Label groupNameLabel;

	/**

	 * UI Label for component ID

	 */

	protected Label componentLabel;

	/**

	 * UI Label for group ID

	 */

	protected Label groupLabel;

	/**

	 * UI Label for text

	 */

	protected Label textLabel;

	/**

	 * Matchcase checkbox

	 */

	protected Button matchCaseCheckBox;

	/**

	 * Always selected checkbox

	 */

	protected Button alwaysEnabledCheckBox;

	/**

	 * Spacer label

	 */

	protected Label spacer;

	/**

	 * Indicates if user has touched text field. Used when replicating user

	 * input to another field

	 */

	protected boolean textFieldTouched;

	/**

	 * Indicates if user has touched name field. Used when replicating user

	 * input to another field

	 */

	protected boolean nameFieldTouched;

	/**

	 * New item to be created in this dialog

	 */

	protected TreeItem newItem;

	/**

	 * Constructor

	 * 

	 * @param parent

	 *            parent shell

	 * @param style

	 *            style bits

	 */

	public BasePropertyDialog(Shell parent, int style) {

		super(parent, style);

	}

	/*

	 * (non-Javadoc)

	 * 

	 * @see com.nokia.traceviewer.dialog.BaseDialog#createActionListeners()

	 */

	@Override

	protected void createActionListeners() {

		// Add selection listener to name field

		nameText.addModifyListener(new ModifyListener() {

			public void modifyText(ModifyEvent e) {

				// Text rule selected

				if (isTextRuleSelected()) {

					// Set the name text to follow text field

					if (!textFieldTouched) {

						textText.setText(nameText.getText());

					}

					if (isTextComponentsFilled()) {

						getButton(IDialogConstants.OK_ID).setEnabled(true);

					} else {

						getButton(IDialogConstants.OK_ID).setEnabled(false);

					}

					// Component rule selected

				} else if (isComponentRuleSelected()) {

					if (isComponentComponentsFilled()) {

						getButton(IDialogConstants.OK_ID).setEnabled(true);

					} else {

						getButton(IDialogConstants.OK_ID).setEnabled(false);

					}

				}

			}

		});

		// Add key listener to name field

		nameText.addKeyListener(new KeyListener() {

			public void keyPressed(KeyEvent e) {

				nameFieldTouched = true;

			}

			public void keyReleased(KeyEvent e) {

			}

		});

		// Add selection listener to rule list

		ruleList.addSelectionListener(new SelectionAdapter() {

			@Override

			public void widgetSelected(SelectionEvent event) {

				TraceViewerGlobals.postUiEvent("RuleListSelection" //$NON-NLS-1$

						+ ruleList.getSelectionIndex(), "1"); //$NON-NLS-1$

				setInformationLabel();

				createRightUnderComposite();

				TraceViewerGlobals.postUiEvent("RuleListSelection" //$NON-NLS-1$

						+ ruleList.getSelectionIndex(), "0"); //$NON-NLS-1$

			}

		});

	}

	/**

	 * Creates action listener when text rule is selected

	 */

	protected void createActionListenersForTextRule() {

		// Add selection listeners when text rule is selected

		if (isTextRuleSelected()) {

			textText.addModifyListener(new ModifyListener() {

				public void modifyText(ModifyEvent e) {

					if (isTextRuleSelected()) {

						// Set the name text to follow text field

						if (!nameFieldTouched) {

							nameText.setText(textText.getText());

						}

						if (isTextComponentsFilled()) {

							getButton(IDialogConstants.OK_ID).setEnabled(true);

						} else {

							getButton(IDialogConstants.OK_ID).setEnabled(false);

						}

					}

				}

			});

			// Add key listener to text field

			textText.addKeyListener(new KeyListener() {

				public void keyPressed(KeyEvent e) {

					textFieldTouched = true;

				}

				public void keyReleased(KeyEvent e) {

				}

			});

		}

	}

	/**

	 * Creates action listeners when component rule is selected

	 */

	protected void createActionListenersForComponentRule() {

		// Add selection listeners when component rule is selected

		if (isComponentRuleSelected()) {

			// Component text field

			componentTextField.addModifyListener(new ModifyListener() {

				public void modifyText(ModifyEvent e) {

					if (isComponentRuleSelected()) {

						if (isComponentComponentsFilled()) {

							getButton(IDialogConstants.OK_ID).setEnabled(true);

						} else {

							getButton(IDialogConstants.OK_ID).setEnabled(false);

						}

					}

				}

			});

			// Group text field

			groupTextField.addModifyListener(new ModifyListener() {

				public void modifyText(ModifyEvent e) {

					if (isComponentRuleSelected()) {

						if (isComponentComponentsFilled()) {

							getButton(IDialogConstants.OK_ID).setEnabled(true);

						} else {

							getButton(IDialogConstants.OK_ID).setEnabled(false);

						}

					}

				}

			});

			// Add selection listener to change component button

			changeComponentButton.addSelectionListener(new SelectionAdapter() {

				@Override

				public void widgetSelected(SelectionEvent event) {

					TraceViewerGlobals

							.postUiEvent("ChangeComponentButton", "1"); //$NON-NLS-1$ //$NON-NLS-2$

					if (selDialog == null) {

						selDialog = new ComponentSelectionDialog();

					}

					selDialog.setDialogToShowComponents(true, 0);

					selDialog.open();

					String componentId = selDialog.getSelectedItemId();

					if (componentId != null && !componentId.equals("")) { //$NON-NLS-1$

						componentTextField.setText(componentId);

						String componentName = selDialog.getSelectedItemName();

						componentNameLabel.setText(componentName);

					}

					TraceViewerGlobals

							.postUiEvent("ChangeComponentButton", "0"); //$NON-NLS-1$ //$NON-NLS-2$

				}

			});

			// Add selection listener to change group button

			changeGroupButton.addSelectionListener(new SelectionAdapter() {

				@Override

				public void widgetSelected(SelectionEvent event) {

					TraceViewerGlobals.postUiEvent("ChangeGroupButton", "1"); //$NON-NLS-1$ //$NON-NLS-2$

					if (selDialog == null) {

						selDialog = new ComponentSelectionDialog();

					}

					int componentId = NOT_DEFINED;

					try {

						String cid = componentTextField.getText();

						if (cid.length() > HEX_PREFIX.length()

								&& cid.substring(0, HEX_PREFIX.length())

										.equals(HEX_PREFIX)) {

							cid = cid.substring(HEX_PREFIX.length());

						}

						componentId = Integer.parseInt(cid, HEX_RADIX);

					} catch (NumberFormatException e) {

					}

					selDialog.setDialogToShowComponents(false, componentId);

					selDialog.open();

					String groupId = selDialog.getSelectedItemId();

					if (!groupId.equals("")) { //$NON-NLS-1$

						groupTextField.setText(groupId);

						String groupName = selDialog.getSelectedItemName();

						groupNameLabel.setText(groupName);

					}

					TraceViewerGlobals.postUiEvent("ChangeGroupButton", "0"); //$NON-NLS-1$ //$NON-NLS-2$

				}

			});

		}

	}

	/**

	 * Tells that text rule is selected from the view

	 * 

	 * @return true if text rule is selected from the view

	 */

	private boolean isTextRuleSelected() {

		boolean textRuleSelected = false;

		if (textText != null && !textText.isDisposed()) {

			textRuleSelected = true;

		}

		return textRuleSelected;

	}

	/**

	 * Tells that component rule is selected from the view

	 * 

	 * @return true if component rule is selected from the view

	 */

	private boolean isComponentRuleSelected() {

		boolean componentRuleSelected = false;

		if (componentTextField != null && !componentTextField.isDisposed()

				&& groupTextField != null && !groupTextField.isDisposed()) {

			componentRuleSelected = true;

		}

		return componentRuleSelected;

	}

	/**

	 * Checks if all needed components are filled when text rule is selected

	 * 

	 * @return true if all needed components are filled

	 */

	private boolean isTextComponentsFilled() {

		boolean componentsFilled = false;

		if (textText.getText().length() > 0 && nameText.getText().length() > 0) {

			componentsFilled = true;

		}

		return componentsFilled;

	}

	/**

	 * Checks if all needed components are filled when component rule is

	 * selected

	 * 

	 * @return true if all needed components are filled

	 */

	private boolean isComponentComponentsFilled() {

		boolean componentsFilled = false;

		if (componentTextField.getText().length() > 0

				&& groupTextField.getText().length() > 0

				&& nameText.getText().length() > 0) {

			componentsFilled = true;

		}

		return componentsFilled;

	}

	/**

	 * Disposes changeable elements if they exist. Is called when selection is

	 * changed from the selection list and components are changed

	 */

	private void disposeChangeableElements() {

		if (textLabel != null) {

			textLabel.dispose();

		}

		if (textText != null) {

			textText.dispose();

		}

		if (matchCaseCheckBox != null) {

			matchCaseCheckBox.dispose();

		}

		if (spacer != null) {

			spacer.dispose();

		}

		if (componentLabel != null) {

			componentLabel.dispose();

		}

		if (componentTextField != null) {

			componentTextField.dispose();

		}

		if (groupLabel != null) {

			groupLabel.dispose();

		}

		if (groupTextField != null) {

			groupTextField.dispose();

		}

		if (changeComponentButton != null) {

			changeComponentButton.dispose();

		}

		if (changeGroupButton != null) {

			changeGroupButton.dispose();

		}

		if (componentNameLabel != null) {

			componentNameLabel.dispose();

		}

		if (groupNameLabel != null) {

			groupNameLabel.dispose();

		}

	}

	/**

	 * This method creates mainComposite

	 */

	protected void createMainComposite() {

		// Main composite

		GridLayout mainCompositeGridLayout = new GridLayout();

		mainCompositeGridLayout.horizontalSpacing = 4;

		mainCompositeGridLayout.verticalSpacing = 4;

		mainCompositeGridLayout.marginWidth = 0;

		mainCompositeGridLayout.marginHeight = 0;

		mainCompositeGridLayout.numColumns = 2;

		GridData mainCompositeGridData = new GridData();

		mainComposite = new Composite(composite, SWT.NONE);

		mainComposite.setLayoutData(mainCompositeGridData);

		mainComposite.setLayout(mainCompositeGridLayout);

		createUpperComposite();