1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
|
/*******************************************************************************
* Copyright (c) 2011, 2012 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.tcf.te.ui.controls.interfaces;
import org.eclipse.jface.dialogs.IDialogSettings;
import org.eclipse.jface.dialogs.IMessageProvider;
import org.eclipse.swt.events.TypedEvent;
import org.eclipse.swt.widgets.Composite;
import org.eclipse.tcf.te.runtime.interfaces.properties.IPropertiesContainer;
import org.eclipse.tcf.te.ui.controls.validator.Validator;
import org.eclipse.ui.forms.widgets.FormToolkit;
/**
* 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>.
* @param toolkit The form toolkit. Must not be <code>null</code>.
*/
public void setupPanel(Composite parent, FormToolkit toolkit);
/**
* 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 getControl();
/**
* 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 Validator}!
* The default implementation of this method does nothing.
*
* @return Result of validation.
*/
public boolean isValid();
/**
* Called from external to query if the panel control values have changed
* compared to the given data.
*
* @param data The data. Must not be <code>null</code>.
* @param e The event which triggered the invocation or <code>null</code>.
*
* @return <code>True</code> if the panel control values are different to the given reference data, <code>false</code> otherwise.
*/
public boolean dataChanged(IPropertiesContainer data, TypedEvent e);
public String getDialogSettingsSectionName();
/**
* 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);
/**
* Enables or disables all UI elements belonging to the wizard configuration panel.
*
* @param enabled <code>True</code> to enable the UI elements, <code>false</code> otherwise.
*/
public void setEnabled(boolean enabled);
/**
* Called when the panel gets the active panel.
*/
public void activate();
}
|
