Mercurial > projects > dwt-addons
annotate dwtx/jface/viewers/ColumnViewerToolTipSupport.d @ 70:46a6e0e6ccd4
Merge with d-fied sources of 3.4M7
| author | Frank Benoit <benoit@tionex.de> |
|---|---|
| date | Thu, 22 May 2008 01:36:46 +0200 |
| parents | ea8ff534f622 |
| children | 5df4896124c7 |
| rev | line source |
|---|---|
| 10 | 1 /******************************************************************************* |
|
70
46a6e0e6ccd4
Merge with d-fied sources of 3.4M7
Frank Benoit <benoit@tionex.de>
parents:
43
diff
changeset
|
2 * Copyright (c) 2006, 2008 IBM Corporation and others. |
| 10 | 3 * All rights reserved. This program and the accompanying materials |
| 4 * are made available under the terms of the Eclipse Public License v1.0 | |
| 5 * which accompanies this distribution, and is available at | |
| 6 * http://www.eclipse.org/legal/epl-v10.html | |
| 7 * | |
| 8 * Contributors: | |
| 9 * IBM Corporation - initial API and implementation | |
| 10 * Tom Schindl <tom.schindl@bestsolution.at> - initial API and implementation | |
|
70
46a6e0e6ccd4
Merge with d-fied sources of 3.4M7
Frank Benoit <benoit@tionex.de>
parents:
43
diff
changeset
|
11 * bugfix in: 195137, 198089 |
| 10 | 12 * Fredy Dobler <fredy@dobler.net> - bug 159600 |
| 13 * Brock Janiczak <brockj@tpg.com.au> - bug 182443 | |
| 14 * Port to the D programming language: | |
| 15 * Frank Benoit <benoit@tionex.de> | |
| 16 *******************************************************************************/ | |
| 17 | |
| 18 module dwtx.jface.viewers.ColumnViewerToolTipSupport; | |
| 19 | |
| 20 import dwtx.jface.viewers.ColumnViewer; | |
| 21 import dwtx.jface.viewers.ViewerRow; | |
| 22 import dwtx.jface.viewers.ViewerColumn; | |
| 23 import dwtx.jface.viewers.CellLabelProvider; | |
| 24 import dwtx.jface.viewers.StructuredSelection; | |
| 25 | |
| 26 import dwt.graphics.Image; | |
| 27 import dwt.graphics.Point; | |
|
70
46a6e0e6ccd4
Merge with d-fied sources of 3.4M7
Frank Benoit <benoit@tionex.de>
parents:
43
diff
changeset
|
28 import dwt.widgets.Composite; |
| 10 | 29 import dwt.widgets.Event; |
| 30 import dwtx.jface.util.Policy; | |
| 31 import dwtx.jface.window.DefaultToolTip; | |
| 32 import dwtx.jface.window.ToolTip; | |
| 33 | |
| 34 import dwt.dwthelper.utils; | |
| 35 | |
| 36 /** | |
|
70
46a6e0e6ccd4
Merge with d-fied sources of 3.4M7
Frank Benoit <benoit@tionex.de>
parents:
43
diff
changeset
|
37 * The ColumnViewerTooltipSupport is the class that provides tool tips for |
|
46a6e0e6ccd4
Merge with d-fied sources of 3.4M7
Frank Benoit <benoit@tionex.de>
parents:
43
diff
changeset
|
38 * ColumnViewers. |
| 10 | 39 * |
| 40 * @since 3.3 | |
| 41 * | |
| 42 */ | |
| 43 public class ColumnViewerToolTipSupport : DefaultToolTip { | |
| 44 private ColumnViewer viewer; | |
| 45 | |
|
70
46a6e0e6ccd4
Merge with d-fied sources of 3.4M7
Frank Benoit <benoit@tionex.de>
parents:
43
diff
changeset
|
46 private static const String VIEWER_CELL_KEY = Policy.JFACE |
|
46a6e0e6ccd4
Merge with d-fied sources of 3.4M7
Frank Benoit <benoit@tionex.de>
parents:
43
diff
changeset
|
47 ~ "_VIEWER_CELL_KEY"; //$NON-NLS-1$ |
| 10 | 48 |
| 49 private static const int DEFAULT_SHIFT_X = 10; | |
| 50 | |
| 51 private static const int DEFAULT_SHIFT_Y = 0; | |
| 52 | |
| 53 /** | |
| 54 * Enable ToolTip support for the viewer by creating an instance from this | |
| 55 * class. To get all necessary informations this support class consults the | |
| 56 * {@link CellLabelProvider}. | |
| 57 * | |
| 58 * @param viewer | |
| 59 * the viewer the support is attached to | |
|
70
46a6e0e6ccd4
Merge with d-fied sources of 3.4M7
Frank Benoit <benoit@tionex.de>
parents:
43
diff
changeset
|
60 * @param style |
|
46a6e0e6ccd4
Merge with d-fied sources of 3.4M7
Frank Benoit <benoit@tionex.de>
parents:
43
diff
changeset
|
61 * style passed to control tool tip behavior |
| 10 | 62 * |
| 63 * @param manualActivation | |
| 64 * <code>true</code> if the activation is done manually using | |
| 65 * {@link #show(Point)} | |
| 66 */ | |
|
70
46a6e0e6ccd4
Merge with d-fied sources of 3.4M7
Frank Benoit <benoit@tionex.de>
parents:
43
diff
changeset
|
67 protected this(ColumnViewer viewer, int style, |
|
46a6e0e6ccd4
Merge with d-fied sources of 3.4M7
Frank Benoit <benoit@tionex.de>
parents:
43
diff
changeset
|
68 bool manualActivation) { |
|
46a6e0e6ccd4
Merge with d-fied sources of 3.4M7
Frank Benoit <benoit@tionex.de>
parents:
43
diff
changeset
|
69 super(viewer.getControl(), style, manualActivation); |
| 10 | 70 this.viewer = viewer; |
| 71 } | |
| 72 | |
| 73 /** | |
| 74 * Enable ToolTip support for the viewer by creating an instance from this | |
| 75 * class. To get all necessary informations this support class consults the | |
| 76 * {@link CellLabelProvider}. | |
| 77 * | |
| 78 * @param viewer | |
| 79 * the viewer the support is attached to | |
| 80 */ | |
| 81 public static void enableFor(ColumnViewer viewer) { | |
|
70
46a6e0e6ccd4
Merge with d-fied sources of 3.4M7
Frank Benoit <benoit@tionex.de>
parents:
43
diff
changeset
|
82 new ColumnViewerToolTipSupport(viewer, ToolTip.NO_RECREATE, false); |
| 10 | 83 } |
| 84 | |
| 85 /** | |
| 86 * Enable ToolTip support for the viewer by creating an instance from this | |
| 87 * class. To get all necessary informations this support class consults the | |
| 88 * {@link CellLabelProvider}. | |
| 89 * | |
| 90 * @param viewer | |
| 91 * the viewer the support is attached to | |
|
70
46a6e0e6ccd4
Merge with d-fied sources of 3.4M7
Frank Benoit <benoit@tionex.de>
parents:
43
diff
changeset
|
92 * @param style |
|
46a6e0e6ccd4
Merge with d-fied sources of 3.4M7
Frank Benoit <benoit@tionex.de>
parents:
43
diff
changeset
|
93 * style passed to control tool tip behavior |
| 10 | 94 * |
| 95 * @see ToolTip#RECREATE | |
| 96 * @see ToolTip#NO_RECREATE | |
| 97 */ | |
| 98 public static void enableFor(ColumnViewer viewer, int style) { | |
|
70
46a6e0e6ccd4
Merge with d-fied sources of 3.4M7
Frank Benoit <benoit@tionex.de>
parents:
43
diff
changeset
|
99 new ColumnViewerToolTipSupport(viewer, style, false); |
| 10 | 100 } |
| 101 | |
|
43
ea8ff534f622
Fix override and super aliases
Frank Benoit <benoit@tionex.de>
parents:
10
diff
changeset
|
102 protected override Object getToolTipArea(Event event) { |
|
70
46a6e0e6ccd4
Merge with d-fied sources of 3.4M7
Frank Benoit <benoit@tionex.de>
parents:
43
diff
changeset
|
103 return viewer.getCell(new Point(event.x, event.y)); |
|
46a6e0e6ccd4
Merge with d-fied sources of 3.4M7
Frank Benoit <benoit@tionex.de>
parents:
43
diff
changeset
|
104 } |
|
46a6e0e6ccd4
Merge with d-fied sources of 3.4M7
Frank Benoit <benoit@tionex.de>
parents:
43
diff
changeset
|
105 |
|
46a6e0e6ccd4
Merge with d-fied sources of 3.4M7
Frank Benoit <benoit@tionex.de>
parents:
43
diff
changeset
|
106 /** |
|
46a6e0e6ccd4
Merge with d-fied sources of 3.4M7
Frank Benoit <benoit@tionex.de>
parents:
43
diff
changeset
|
107 * Instead of overwriting this method subclasses should overwrite |
|
46a6e0e6ccd4
Merge with d-fied sources of 3.4M7
Frank Benoit <benoit@tionex.de>
parents:
43
diff
changeset
|
108 * {@link #createViewerToolTipContentArea(Event, ViewerCell, Composite)} |
|
46a6e0e6ccd4
Merge with d-fied sources of 3.4M7
Frank Benoit <benoit@tionex.de>
parents:
43
diff
changeset
|
109 */ |
|
46a6e0e6ccd4
Merge with d-fied sources of 3.4M7
Frank Benoit <benoit@tionex.de>
parents:
43
diff
changeset
|
110 protected Composite createToolTipContentArea(Event event, Composite parent) { |
|
46a6e0e6ccd4
Merge with d-fied sources of 3.4M7
Frank Benoit <benoit@tionex.de>
parents:
43
diff
changeset
|
111 ViewerCell cell = (ViewerCell) getData(VIEWER_CELL_KEY); |
|
46a6e0e6ccd4
Merge with d-fied sources of 3.4M7
Frank Benoit <benoit@tionex.de>
parents:
43
diff
changeset
|
112 setData(VIEWER_CELL_KEY, null); |
|
46a6e0e6ccd4
Merge with d-fied sources of 3.4M7
Frank Benoit <benoit@tionex.de>
parents:
43
diff
changeset
|
113 |
|
46a6e0e6ccd4
Merge with d-fied sources of 3.4M7
Frank Benoit <benoit@tionex.de>
parents:
43
diff
changeset
|
114 return createViewerToolTipContentArea(event, cell, parent); |
| 10 | 115 } |
| 116 | |
|
70
46a6e0e6ccd4
Merge with d-fied sources of 3.4M7
Frank Benoit <benoit@tionex.de>
parents:
43
diff
changeset
|
117 /** |
|
46a6e0e6ccd4
Merge with d-fied sources of 3.4M7
Frank Benoit <benoit@tionex.de>
parents:
43
diff
changeset
|
118 * Creates the content area of the tool tip giving access to the cell the |
|
46a6e0e6ccd4
Merge with d-fied sources of 3.4M7
Frank Benoit <benoit@tionex.de>
parents:
43
diff
changeset
|
119 * tip is shown for. Subclasses can overload this method to implement their |
|
46a6e0e6ccd4
Merge with d-fied sources of 3.4M7
Frank Benoit <benoit@tionex.de>
parents:
43
diff
changeset
|
120 * own tool tip design. |
|
46a6e0e6ccd4
Merge with d-fied sources of 3.4M7
Frank Benoit <benoit@tionex.de>
parents:
43
diff
changeset
|
121 * |
|
46a6e0e6ccd4
Merge with d-fied sources of 3.4M7
Frank Benoit <benoit@tionex.de>
parents:
43
diff
changeset
|
122 * <p> |
|
46a6e0e6ccd4
Merge with d-fied sources of 3.4M7
Frank Benoit <benoit@tionex.de>
parents:
43
diff
changeset
|
123 * This method is called from |
|
46a6e0e6ccd4
Merge with d-fied sources of 3.4M7
Frank Benoit <benoit@tionex.de>
parents:
43
diff
changeset
|
124 * {@link #createToolTipContentArea(Event, Composite)} and by default calls |
|
46a6e0e6ccd4
Merge with d-fied sources of 3.4M7
Frank Benoit <benoit@tionex.de>
parents:
43
diff
changeset
|
125 * the {@link DefaultToolTip#createToolTipContentArea(Event, Composite)}. |
|
46a6e0e6ccd4
Merge with d-fied sources of 3.4M7
Frank Benoit <benoit@tionex.de>
parents:
43
diff
changeset
|
126 * </p> |
|
46a6e0e6ccd4
Merge with d-fied sources of 3.4M7
Frank Benoit <benoit@tionex.de>
parents:
43
diff
changeset
|
127 * |
|
46a6e0e6ccd4
Merge with d-fied sources of 3.4M7
Frank Benoit <benoit@tionex.de>
parents:
43
diff
changeset
|
128 * @param event |
|
46a6e0e6ccd4
Merge with d-fied sources of 3.4M7
Frank Benoit <benoit@tionex.de>
parents:
43
diff
changeset
|
129 * the event that which |
|
46a6e0e6ccd4
Merge with d-fied sources of 3.4M7
Frank Benoit <benoit@tionex.de>
parents:
43
diff
changeset
|
130 * @param cell |
|
46a6e0e6ccd4
Merge with d-fied sources of 3.4M7
Frank Benoit <benoit@tionex.de>
parents:
43
diff
changeset
|
131 * the cell the tool tip is shown for |
|
46a6e0e6ccd4
Merge with d-fied sources of 3.4M7
Frank Benoit <benoit@tionex.de>
parents:
43
diff
changeset
|
132 * @param parent |
|
46a6e0e6ccd4
Merge with d-fied sources of 3.4M7
Frank Benoit <benoit@tionex.de>
parents:
43
diff
changeset
|
133 * the parent of the control to create |
|
46a6e0e6ccd4
Merge with d-fied sources of 3.4M7
Frank Benoit <benoit@tionex.de>
parents:
43
diff
changeset
|
134 * @return the control to be displayed in the tool tip area |
|
46a6e0e6ccd4
Merge with d-fied sources of 3.4M7
Frank Benoit <benoit@tionex.de>
parents:
43
diff
changeset
|
135 */ |
|
46a6e0e6ccd4
Merge with d-fied sources of 3.4M7
Frank Benoit <benoit@tionex.de>
parents:
43
diff
changeset
|
136 protected Composite createViewerToolTipContentArea(Event event, |
|
46a6e0e6ccd4
Merge with d-fied sources of 3.4M7
Frank Benoit <benoit@tionex.de>
parents:
43
diff
changeset
|
137 ViewerCell cell, Composite parent) { |
|
46a6e0e6ccd4
Merge with d-fied sources of 3.4M7
Frank Benoit <benoit@tionex.de>
parents:
43
diff
changeset
|
138 return super.createToolTipContentArea(event, parent); |
|
46a6e0e6ccd4
Merge with d-fied sources of 3.4M7
Frank Benoit <benoit@tionex.de>
parents:
43
diff
changeset
|
139 } |
|
46a6e0e6ccd4
Merge with d-fied sources of 3.4M7
Frank Benoit <benoit@tionex.de>
parents:
43
diff
changeset
|
140 |
|
46a6e0e6ccd4
Merge with d-fied sources of 3.4M7
Frank Benoit <benoit@tionex.de>
parents:
43
diff
changeset
|
141 protected override bool shouldCreateToolTip(Event event) { |
|
46a6e0e6ccd4
Merge with d-fied sources of 3.4M7
Frank Benoit <benoit@tionex.de>
parents:
43
diff
changeset
|
142 if (!super.shouldCreateToolTip(event)) { |
| 10 | 143 return false; |
| 144 } | |
| 145 | |
| 146 bool rv = false; | |
| 147 | |
| 148 ViewerRow row = viewer.getViewerRow_package(new Point(event.x, event.y)); | |
| 149 | |
| 150 viewer.getControl().setToolTipText(""); //$NON-NLS-1$ | |
| 151 Point point = new Point(event.x, event.y); | |
| 152 | |
| 153 if (row !is null) { | |
| 154 Object element = row.getItem().getData(); | |
| 155 | |
|
70
46a6e0e6ccd4
Merge with d-fied sources of 3.4M7
Frank Benoit <benoit@tionex.de>
parents:
43
diff
changeset
|
156 ViewerCell cell = row.getCell(point); |
|
46a6e0e6ccd4
Merge with d-fied sources of 3.4M7
Frank Benoit <benoit@tionex.de>
parents:
43
diff
changeset
|
157 ViewerColumn viewPart = viewer.getViewerColumn(cell |
|
46a6e0e6ccd4
Merge with d-fied sources of 3.4M7
Frank Benoit <benoit@tionex.de>
parents:
43
diff
changeset
|
158 .getColumnIndex()); |
| 10 | 159 |
| 160 if (viewPart is null) { | |
| 161 return false; | |
| 162 } | |
| 163 | |
| 164 CellLabelProvider labelProvider = viewPart.getLabelProvider(); | |
| 165 bool useNative = labelProvider.useNativeToolTip(element); | |
| 166 | |
| 167 String text = labelProvider.getToolTipText(element); | |
| 168 Image img = null; | |
| 169 | |
|
70
46a6e0e6ccd4
Merge with d-fied sources of 3.4M7
Frank Benoit <benoit@tionex.de>
parents:
43
diff
changeset
|
170 if (!useNative) { |
| 10 | 171 img = labelProvider.getToolTipImage(element); |
| 172 } | |
| 173 | |
|
70
46a6e0e6ccd4
Merge with d-fied sources of 3.4M7
Frank Benoit <benoit@tionex.de>
parents:
43
diff
changeset
|
174 if (useNative || (text is null && img is null)) { |
| 10 | 175 viewer.getControl().setToolTipText(text); |
| 176 rv = false; | |
| 177 } else { | |
| 178 setPopupDelay(labelProvider.getToolTipDisplayDelayTime(element)); | |
| 179 setHideDelay(labelProvider.getToolTipTimeDisplayed(element)); | |
| 180 | |
| 181 Point shift = labelProvider.getToolTipShift(element); | |
| 182 | |
| 183 if (shift is null) { | |
| 184 setShift(new Point(DEFAULT_SHIFT_X, DEFAULT_SHIFT_Y)); | |
| 185 } else { | |
| 186 setShift(new Point(shift.x, shift.y)); | |
| 187 } | |
| 188 | |
|
70
46a6e0e6ccd4
Merge with d-fied sources of 3.4M7
Frank Benoit <benoit@tionex.de>
parents:
43
diff
changeset
|
189 setData(VIEWER_CELL_KEY, cell); |
| 10 | 190 |
| 191 setText(text); | |
| 192 setImage(img); | |
| 193 setStyle(labelProvider.getToolTipStyle(element)); | |
|
70
46a6e0e6ccd4
Merge with d-fied sources of 3.4M7
Frank Benoit <benoit@tionex.de>
parents:
43
diff
changeset
|
194 setForegroundColor(labelProvider |
|
46a6e0e6ccd4
Merge with d-fied sources of 3.4M7
Frank Benoit <benoit@tionex.de>
parents:
43
diff
changeset
|
195 .getToolTipForegroundColor(element)); |
|
46a6e0e6ccd4
Merge with d-fied sources of 3.4M7
Frank Benoit <benoit@tionex.de>
parents:
43
diff
changeset
|
196 setBackgroundColor(labelProvider |
|
46a6e0e6ccd4
Merge with d-fied sources of 3.4M7
Frank Benoit <benoit@tionex.de>
parents:
43
diff
changeset
|
197 .getToolTipBackgroundColor(element)); |
| 10 | 198 setFont(labelProvider.getToolTipFont(element)); |
| 199 | |
| 200 // Check if at least one of the values is set | |
| 201 rv = getText(event) !is null || getImage(event) !is null; | |
| 202 } | |
| 203 } | |
| 204 | |
| 205 return rv; | |
| 206 } | |
| 207 | |
|
43
ea8ff534f622
Fix override and super aliases
Frank Benoit <benoit@tionex.de>
parents:
10
diff
changeset
|
208 protected override void afterHideToolTip(Event event) { |
|
70
46a6e0e6ccd4
Merge with d-fied sources of 3.4M7
Frank Benoit <benoit@tionex.de>
parents:
43
diff
changeset
|
209 super.afterHideToolTip(event); |
|
46a6e0e6ccd4
Merge with d-fied sources of 3.4M7
Frank Benoit <benoit@tionex.de>
parents:
43
diff
changeset
|
210 // Clear the restored value else this could be a source of a leak |
|
46a6e0e6ccd4
Merge with d-fied sources of 3.4M7
Frank Benoit <benoit@tionex.de>
parents:
43
diff
changeset
|
211 setData(VIEWER_CELL_KEY, null); |
| 10 | 212 if (event !is null && event.widget !is viewer.getControl()) { |
|
70
46a6e0e6ccd4
Merge with d-fied sources of 3.4M7
Frank Benoit <benoit@tionex.de>
parents:
43
diff
changeset
|
213 viewer.getControl().setFocus(); |
| 10 | 214 } |
| 215 } | |
| 216 } |