blob: 87d60e1b9b6bca9c1737f3b573ef2eeab6056f4f (
plain) (
blame)
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
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
|
/*******************************************************************************
* Copyright (c) 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;
import org.eclipse.core.runtime.Assert;
import org.eclipse.jface.dialogs.IDialogPage;
import org.eclipse.jface.dialogs.IMessageProvider;
import org.eclipse.jface.fieldassist.ControlDecoration;
import org.eclipse.jface.fieldassist.FieldDecoration;
import org.eclipse.jface.fieldassist.FieldDecorationRegistry;
import org.eclipse.swt.SWT;
import org.eclipse.swt.widgets.Control;
import org.eclipse.tcf.te.ui.controls.nls.Messages;
/**
* AbstractDecoratedDialogPageControl
*/
public abstract class AbstractDecoratedDialogPageControl extends BaseDialogPageControl {
private ControlDecoration controlDecoration;
/**
* Constructor.
*/
public AbstractDecoratedDialogPageControl() {
}
/**
* Constructor.
* @param parentPage
*/
public AbstractDecoratedDialogPageControl(IDialogPage parentPage) {
super(parentPage);
}
/**
* Creates a new instance of a {@link ControlDecoration} object associated with
* the given control. The method is called after the control has been created.
*
* @param control The control. Must not be <code>null</code>.
* @return The control decoration object instance.
*/
public ControlDecoration doCreateControlDecoration(Control control) {
Assert.isNotNull(control);
controlDecoration = new ControlDecoration(control, doGetControlDecorationPosition());
return controlDecoration;
}
/* (non-Javadoc)
* @see org.eclipse.tcf.te.ui.controls.BaseControl#dispose()
*/
@Override
public void dispose() {
super.dispose();
controlDecoration = null;
}
/**
* Returns the control decoration position. The default is
* {@link SWT#TOP} | {@link SWT#LEFT}.
*
* @return The control position.
*/
protected int doGetControlDecorationPosition() {
return SWT.TOP | SWT.LEFT;
}
/**
* Configure the given control decoration.
*
* @param decoration The control decoration. Must not be <code>null</code>.
*/
protected void configureControlDecoration(ControlDecoration decoration) {
Assert.isNotNull(decoration);
decoration.setShowOnlyOnFocus(false);
}
/**
* Updates the control decoration to represent the given message and message type.
* If the message is <code>null</code> or the message type is IMessageProvider.NONE,
* no decoration will be shown.
*
* @param message The message.
* @param messageType The message type.
*/
public void updateControlDecoration(String message, int messageType) {
if (getControlDecoration() != null) {
// The description is the same as the message
getControlDecoration().setDescriptionText(message);
// The icon depends on the message type
FieldDecorationRegistry registry = FieldDecorationRegistry.getDefault();
// Determine the id of the decoration to show
String decorationId = FieldDecorationRegistry.DEC_INFORMATION;
if (messageType == IMessageProvider.ERROR) {
decorationId = FieldDecorationRegistry.DEC_ERROR;
} else if (messageType == IMessageProvider.WARNING) {
decorationId = FieldDecorationRegistry.DEC_WARNING;
}
// Get the field decoration
FieldDecoration fieldDeco = registry.getFieldDecoration(decorationId);
if (fieldDeco != null) {
getControlDecoration().setImage(fieldDeco.getImage());
}
if (message == null || messageType == IMessageProvider.NONE) {
if (!hasContentAssist()) {
getControlDecoration().hide();
}
else {
fieldDeco = registry.getFieldDecoration(FieldDecorationRegistry.DEC_CONTENT_PROPOSAL);
if (fieldDeco != null) {
getControlDecoration().setDescriptionText(Messages.AbstractDecoratedDialogPageControl_contentAssist_message);
getControlDecoration().setImage(fieldDeco.getImage());
getControlDecoration().show();
}
}
}
else {
getControlDecoration().show();
}
}
}
/**
* Returns the control decoration.
*
* @return The control decoration instance or <code>null</code> if not yet created.
*/
public final ControlDecoration getControlDecoration() {
return controlDecoration;
}
protected boolean hasContentAssist() {
return false;
}
}
|
