Target Explorer: Added stacked panel control

2 files changed, 253 insertions, 0 deletions

diff --git a/target_explorer/plugins/org.eclipse.tm.te.ui.controls/src/org/eclipse/tm/te/ui/controls/BaseWizardConfigurationPanelControl.java b/target_explorer/plugins/org.eclipse.tm.te.ui.controls/src/org/eclipse/tm/te/ui/controls/BaseWizardConfigurationPanelControl.java
new file mode 100644
index 000000000..2bec2de81
--- /dev/null
+++ b/target_explorer/plugins/org.eclipse.tm.te.ui.controls/src/org/eclipse/tm/te/ui/controls/BaseWizardConfigurationPanelControl.java
@@ -0,0 +1,176 @@
+/*******************************************************************************
+ * Copyright (c) 2011 Wind River Systems, Inc. and others. All rights reserved.
+ * This program and the accompanying materials are made available under the terms
+ * of the Eclipse Public License v1.0 which accompanies this distribution, and is
+ * available at http://www.eclipse.org/legal/epl-v10.html
+ *
+ * Contributors:
+ * Wind River Systems - initial API and implementation
+ *******************************************************************************/
+package org.eclipse.tm.te.ui.controls;
+
+import java.util.Hashtable;
+import java.util.Map;
+
+import org.eclipse.jface.dialogs.IDialogPage;
+import org.eclipse.swt.SWT;
+import org.eclipse.swt.custom.StackLayout;
+import org.eclipse.swt.widgets.Composite;
+import org.eclipse.swt.widgets.Group;
+import org.eclipse.tm.te.ui.controls.interfaces.IWizardConfigurationPanel;
+
+/**
+ * Target Explorer: Base control to deal with wizard or property page controls
+ * which should share the same UI space.
+ */
+public class BaseWizardConfigurationPanelControl extends BaseDialogPageControl {
+	private final Map<String, IWizardConfigurationPanel> configurationPanels = new Hashtable<String, IWizardConfigurationPanel>();
+
+	private boolean isGroup;
+
+	private Composite panel;
+	private StackLayout panelLayout;
+
+	/**
+	 * Constructor.
+	 *
+	 * @param parentPage The parent dialog page this control is embedded in.
+	 *                   Might be <code>null</code> if the control is not associated with a page.
+	 */
+	public BaseWizardConfigurationPanelControl(IDialogPage parentPage) {
+		super(parentPage);
+		clear();
+		setPanelIsGroup(false);
+	}
+
+	/**
+	 * Sets if or if not the controls panel is a <code>Group</code>.
+	 *
+	 * @param isGroup <code>True</code> if the controls panel is a group, <code>false</code> otherwise.
+	 */
+	public void setPanelIsGroup(boolean isGroup) {
+		this.isGroup = isGroup;
+	}
+
+	/**
+	 * Returns if or if not the controls panel is a <code>Group</code>.
+	 *
+	 * @return <code>True</code> if the controls panel is a group, <code>false</code> otherwise.
+	 */
+	public boolean isPanelIsGroup() {
+		return isGroup;
+	}
+
+	/**
+	 * Returns the controls panel.
+	 *
+	 * @return The controls panel or <code>null</code>.
+	 */
+	public Composite getPanel() {
+		return panel;
+	}
+
+	/**
+	 * Returns the label text to set for the group (if the panel is a group).
+	 *
+	 * @return The label text to apply or <code>null</code>.
+	 */
+	public String getGroupLabel() {
+		return null;
+	}
+
+	/**
+	 * To be called from the embedding control to setup the controls UI elements.
+	 *
+	 * @param parent The parent control. Must be not <code>null</code>!
+	 */
+	public void doSetupPanel(Composite parent, Object layoutData, String[] configurationPanelKeys) {
+		assert parent != null;
+
+		if (isPanelIsGroup()) {
+			panel = new Group(parent, SWT.NONE);
+			if (getGroupLabel() != null) ((Group)panel).setText(getGroupLabel());
+		} else {
+			panel = new Composite(parent, SWT.NONE);
+		}
+		assert panel != null;
+		panel.setFont(parent.getFont());
+		panel.setLayoutData(layoutData);
+
+		panelLayout = new StackLayout();
+		panel.setLayout(panelLayout);
+
+		setupConfigurationPanels(panel, configurationPanelKeys);
+	}
+
+	/**
+	 * Removes all configuration panels.
+	 */
+	public void clear() {
+		configurationPanels.clear();
+	}
+
+	/**
+	 * Returns the wizard configuration panel instance registered for the given configuration panel key.
+	 *
+	 * @param key The key to get the wizard configuration panel for. Must be not <code>null</code>!
+	 * @return The wizard configuration panel instance or <code>null</code> if the key is unknown.
+	 */
+	public IWizardConfigurationPanel getConfigurationPanel(String key) {
+		if (key == null) return null;
+		return configurationPanels.get(key);
+	}
+
+	/**
+	 * Adds the given wizard configuration panel under the given configuration panel key to the
+	 * list of known panels. If the given configuration panel is <code>null</code>, any configuration
+	 * panel stored under the given key is removed from the list of known panels.
+	 *
+	 * @param key The key to get the wizard configuration panel for. Must be not <code>null</code>!
+	 * @param panel The wizard configuration panel instance or <code>null</code>.
+	 */
+	public void addConfigurationPanel(String key, IWizardConfigurationPanel panel) {
+		if (key == null) return;
+		if (panel != null) {
+			configurationPanels.put(key, panel);
+		} else {
+			configurationPanels.remove(key);
+		}
+	}
+
+	/**
+	 * Setup the wizard configuration panels for being presented to the user. This method is called by the
+	 * controls <code>doSetupPanel(...)</code> and initialize all possible wizard configuration panels to show.
+	 * The default implementation iterates over the given list of configuration panel keys and calls
+	 * <code>setupPanel(...)</code> for each of them.
+	 *
+	 * @param parent The parent composite to use for the wizard configuration panels. Must be not <code>null</code>!
+	 * @param configurationPanelKeys The list of configuration panels to initialize. Might be <code>null</code> or empty!
+	 */
+	public void setupConfigurationPanels(Composite parent, String[] configurationPanelKeys) {
+		assert parent != null;
+		if (configurationPanelKeys != null) {
+			for (int i = 0; i < configurationPanelKeys.length; i++) {
+				IWizardConfigurationPanel configPanel = getConfigurationPanel(configurationPanelKeys[i]);
+				if (configPanel != null) configPanel.setupPanel(parent);
+			}
+		}
+	}
+
+	/**
+	 * Make the wizard configuration panel registered under the given configuration panel key the
+	 * most top configuration panel. If no configuration panel is registered under the given key,
+	 * nothing will happen.
+	 *
+	 * @param key The key to get the wizard configuration panel for. Must be not <code>null</code>!
+	 */
+	public void showConfigurationPanel(String key) {
+		if (key == null) return;
+
+		IWizardConfigurationPanel configPanel = getConfigurationPanel(key);
+		if (configPanel != null && configPanel.getTopControl() != null) {
+			panelLayout.topControl = configPanel.getTopControl();
+			panel.layout();
+		}
+	}
+}
diff --git a/target_explorer/plugins/org.eclipse.tm.te.ui.controls/src/org/eclipse/tm/te/ui/controls/interfaces/IWizardConfigurationPanel.java b/target_explorer/plugins/org.eclipse.tm.te.ui.controls/src/org/eclipse/tm/te/ui/controls/interfaces/IWizardConfigurationPanel.java
new file mode 100644
index 000000000..5b13718f8
--- /dev/null
+++ b/target_explorer/plugins/org.eclipse.tm.te.ui.controls/src/org/eclipse/tm/te/ui/controls/interfaces/IWizardConfigurationPanel.java
@@ -0,0 +1,77 @@
+/*******************************************************************************
+ * Copyright (c) 2011 Wind River Systems, Inc. and others. All rights reserved.
+ * This program and the accompanying materials are made available under the terms
+ * of the Eclipse Public License v1.0 which accompanies this distribution, and is
+ * available at http://www.eclipse.org/legal/epl-v10.html
+ *
+ * Contributors:
+ * Wind River Systems - initial API and implementation
+ *******************************************************************************/
+package org.eclipse.tm.te.ui.controls.interfaces;
+
+import org.eclipse.jface.dialogs.IDialogSettings;
+import org.eclipse.jface.dialogs.IMessageProvider;
+import org.eclipse.swt.widgets.Composite;
+
+/**
+ * Target explorer: Interface to deal with the replaceable wizard configuration panels.
+ */
+public interface IWizardConfigurationPanel extends IMessageProvider {
+
+	/**
+	 * Creates the wizard configuration panel UI elements within the given parent composite.
+	 * Wizard configuration panels should always create another composite within the given
+	 * composite, which is the panel top control. The top control is queried later from the
+	 * stack layout to show the different panels if the backend selection is changing.
+	 *
+	 * @param parent The parent composite to create the UI elements in. Must not be <code>null</code>.
+	 */
+	public void setupPanel(Composite parent);
+
+	/**
+	 * Cleanup all resources the wizard configuration panel might have been created.
+	 */
+	public void dispose();
+
+	/**
+	 * Returns the wizard configuration panels top control, typically a composite control.
+	 * This control is requested every time the stack layout is required to set a new top control
+	 * because the backend selection had been changed.
+	 *
+	 * @return The wizard configuration panels top control or <code>null</code> if the configuration panel has been not setup yet.
+	 */
+	public Composite getTopControl();
+
+	/**
+	 * Validates the control and sets the message text and type so the parent
+	 * page or control is able to display validation result informations.
+	 * The validation should be done by implementations of {@link WRValidator}!
+	 * The default implementation of this method does nothing.
+	 *
+	 * @return Result of validation.
+	 */
+	public boolean isValid();
+
+	/**
+	 * Restore the widget values plain from the given dialog settings. This method should
+	 * not fragment the given dialog settings any further.
+	 *
+	 * @param settings The dialog settings to restore the widget values from. Must not be <code>null</code>!
+	 * @param idPrefix The prefix to use for every dialog settings slot keys. If <code>null</code>, the dialog settings slot keys are not to prefix.
+	 */
+	public void doRestoreWidgetValues(IDialogSettings settings, String idPrefix);
+
+	/**
+	 * Save the widget values plain to the given dialog settings. This method should
+	 * not fragment the given dialog settings any further.
+	 *
+	 * @param settings The dialog settings to save the widget values to. Must not be <code>null</code>!
+	 * @param idPrefix The prefix to use for every dialog settings slot keys. If <code>null</code>, the dialog settings slot keys are not to prefix.
+	 */
+	public void doSaveWidgetValues(IDialogSettings settings, String idPrefix);
+
+	/**
+	 * Called to adjust the wizard configuration panels child controls enablement.
+	 */
+	public void adjustControlEnablement();
+}