Mercurial > projects > dwt-addons
annotate dwtx/jface/viewers/ViewerColumn.d @ 72:5df4896124c7
JFace and its examples do compile
| author | Frank Benoit <benoit@tionex.de> |
|---|---|
| date | Thu, 22 May 2008 17:56:17 +0200 |
| parents | 46a6e0e6ccd4 |
| children |
| rev | line source |
|---|---|
| 10 | 1 /******************************************************************************* |
|
70
46a6e0e6ccd4
Merge with d-fied sources of 3.4M7
Frank Benoit <benoit@tionex.de>
parents:
54
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 Shindl <tom.schindl@bestsolution.at> - initial API and implementation | |
|
70
46a6e0e6ccd4
Merge with d-fied sources of 3.4M7
Frank Benoit <benoit@tionex.de>
parents:
54
diff
changeset
|
11 * fix for bug 163317, 201905 |
| 10 | 12 * Port to the D programming language: |
| 13 * Frank Benoit <benoit@tionex.de> | |
| 14 *******************************************************************************/ | |
| 15 | |
| 16 module dwtx.jface.viewers.ViewerColumn; | |
| 17 | |
| 18 import dwtx.jface.viewers.CellLabelProvider; | |
| 19 import dwtx.jface.viewers.EditingSupport; | |
| 20 import dwtx.jface.viewers.ILabelProviderListener; | |
| 21 import dwtx.jface.viewers.ColumnViewer; | |
| 22 import dwtx.jface.viewers.ViewerCell; | |
| 23 import dwtx.jface.viewers.LabelProviderChangedEvent; | |
| 24 | |
| 25 import dwt.events.DisposeEvent; | |
| 26 import dwt.events.DisposeListener; | |
| 27 import dwt.widgets.Widget; | |
| 28 import dwtx.jface.util.Policy; | |
| 29 | |
| 30 import dwt.dwthelper.utils; | |
| 31 | |
| 32 /** | |
| 33 * Instances of this class represent a column of a {@link ColumnViewer}. Label | |
| 34 * providers and editing support can be configured for each column separately. | |
| 35 * Concrete subclasses of {@link ColumnViewer} should implement a matching | |
| 36 * concrete subclass of {@link ViewerColumn}. | |
|
72
5df4896124c7
JFace and its examples do compile
Frank Benoit <benoit@tionex.de>
parents:
70
diff
changeset
|
37 * |
| 10 | 38 * @since 3.3 |
|
72
5df4896124c7
JFace and its examples do compile
Frank Benoit <benoit@tionex.de>
parents:
70
diff
changeset
|
39 * |
| 10 | 40 */ |
| 41 public abstract class ViewerColumn { | |
| 42 | |
| 43 private CellLabelProvider labelProvider; | |
| 44 | |
| 45 static String COLUMN_VIEWER_KEY = Policy.JFACE ~ ".columnViewer";//$NON-NLS-1$ | |
| 46 | |
| 47 private EditingSupport editingSupport; | |
| 48 | |
| 49 private ILabelProviderListener listener; | |
| 50 | |
| 51 private bool listenerRegistered = false; | |
| 52 | |
|
70
46a6e0e6ccd4
Merge with d-fied sources of 3.4M7
Frank Benoit <benoit@tionex.de>
parents:
54
diff
changeset
|
53 private ColumnViewer viewer; |
|
46a6e0e6ccd4
Merge with d-fied sources of 3.4M7
Frank Benoit <benoit@tionex.de>
parents:
54
diff
changeset
|
54 |
| 10 | 55 /** |
| 56 * Create a new instance of the receiver at columnIndex. | |
|
72
5df4896124c7
JFace and its examples do compile
Frank Benoit <benoit@tionex.de>
parents:
70
diff
changeset
|
57 * |
| 10 | 58 * @param viewer |
| 59 * the viewer the column is part of | |
| 60 * @param columnOwner | |
| 61 * the widget owning the viewer in case the widget has no columns | |
| 62 * this could be the widget itself | |
| 63 */ | |
| 64 protected this(ColumnViewer viewer, Widget columnOwner) { | |
|
70
46a6e0e6ccd4
Merge with d-fied sources of 3.4M7
Frank Benoit <benoit@tionex.de>
parents:
54
diff
changeset
|
65 this.viewer = viewer; |
| 10 | 66 columnOwner.setData(ViewerColumn.COLUMN_VIEWER_KEY, this); |
| 39 | 67 this.listener = new class(viewer) ILabelProviderListener { |
| 10 | 68 ColumnViewer viewer_; |
| 39 | 69 this(ColumnViewer a){ |
| 70 viewer_= a; | |
| 10 | 71 } |
| 72 public void labelProviderChanged(LabelProviderChangedEvent event) { | |
| 73 viewer_.handleLabelProviderChanged_package(event); | |
| 74 } | |
| 75 | |
| 76 }; | |
| 39 | 77 columnOwner.addDisposeListener(new class(viewer) DisposeListener { |
| 10 | 78 ColumnViewer viewer_; |
| 39 | 79 this(ColumnViewer a){ |
| 80 viewer_= a; | |
| 10 | 81 } |
| 82 public void widgetDisposed(DisposeEvent e) { | |
| 83 handleDispose(viewer_); | |
| 84 } | |
| 85 }); | |
| 86 } | |
| 87 | |
| 88 /** | |
| 89 * Return the label provider for the receiver. | |
|
72
5df4896124c7
JFace and its examples do compile
Frank Benoit <benoit@tionex.de>
parents:
70
diff
changeset
|
90 * |
| 10 | 91 * @return ViewerLabelProvider |
| 92 */ | |
| 93 /* package */CellLabelProvider getLabelProvider() { | |
| 94 return labelProvider; | |
| 95 } | |
| 96 | |
| 97 /** | |
| 98 * Set the label provider for the column. Subclasses may extend but must | |
| 99 * call the super implementation. | |
|
72
5df4896124c7
JFace and its examples do compile
Frank Benoit <benoit@tionex.de>
parents:
70
diff
changeset
|
100 * |
| 10 | 101 * @param labelProvider |
| 102 * the new {@link CellLabelProvider} | |
| 103 */ | |
| 104 public void setLabelProvider(CellLabelProvider labelProvider) { | |
| 105 setLabelProvider(labelProvider, true); | |
| 106 } | |
| 107 | |
| 108 /** | |
| 109 * @param labelProvider | |
| 110 * @param registerListener | |
| 111 */ | |
| 112 /* package */void setLabelProvider(CellLabelProvider labelProvider, | |
| 113 bool registerListener) { | |
| 114 if (listenerRegistered && this.labelProvider !is null) { | |
| 115 this.labelProvider.removeListener(listener); | |
| 116 listenerRegistered = false; | |
|
70
46a6e0e6ccd4
Merge with d-fied sources of 3.4M7
Frank Benoit <benoit@tionex.de>
parents:
54
diff
changeset
|
117 if (registerListener) { |
|
46a6e0e6ccd4
Merge with d-fied sources of 3.4M7
Frank Benoit <benoit@tionex.de>
parents:
54
diff
changeset
|
118 this.labelProvider.dispose(viewer, this); |
|
46a6e0e6ccd4
Merge with d-fied sources of 3.4M7
Frank Benoit <benoit@tionex.de>
parents:
54
diff
changeset
|
119 } |
| 10 | 120 } |
| 121 | |
| 122 this.labelProvider = labelProvider; | |
| 123 | |
| 124 if (registerListener) { | |
|
72
5df4896124c7
JFace and its examples do compile
Frank Benoit <benoit@tionex.de>
parents:
70
diff
changeset
|
125 this.labelProvider.initialize_package(viewer, this); |
| 10 | 126 this.labelProvider.addListener(listener); |
| 127 listenerRegistered = true; | |
| 128 } | |
| 129 } | |
| 130 | |
| 131 /** | |
| 132 * Return the editing support for the receiver. | |
|
72
5df4896124c7
JFace and its examples do compile
Frank Benoit <benoit@tionex.de>
parents:
70
diff
changeset
|
133 * |
| 10 | 134 * @return {@link EditingSupport} |
| 135 */ | |
| 136 /* package */EditingSupport getEditingSupport() { | |
| 137 return editingSupport; | |
| 138 } | |
| 139 | |
| 140 /** | |
| 141 * Set the editing support. Subclasses may extend but must call the super | |
| 142 * implementation. | |
|
70
46a6e0e6ccd4
Merge with d-fied sources of 3.4M7
Frank Benoit <benoit@tionex.de>
parents:
54
diff
changeset
|
143 * <p> |
|
46a6e0e6ccd4
Merge with d-fied sources of 3.4M7
Frank Benoit <benoit@tionex.de>
parents:
54
diff
changeset
|
144 * Users setting up an editable {@link TreeViewer} or {@link TableViewer} with more than 1 column <b>have</b> |
|
46a6e0e6ccd4
Merge with d-fied sources of 3.4M7
Frank Benoit <benoit@tionex.de>
parents:
54
diff
changeset
|
145 * to pass the DWT.FULL_SELECTION style bit when creating the viewer |
|
46a6e0e6ccd4
Merge with d-fied sources of 3.4M7
Frank Benoit <benoit@tionex.de>
parents:
54
diff
changeset
|
146 * </p> |
| 10 | 147 * @param editingSupport |
| 148 * The {@link EditingSupport} to set. | |
| 149 */ | |
| 150 public void setEditingSupport(EditingSupport editingSupport) { | |
| 151 this.editingSupport = editingSupport; | |
| 152 } | |
| 153 | |
| 154 /** | |
| 155 * Refresh the cell for the given columnIndex. <strong>NOTE:</strong>the | |
| 156 * {@link ViewerCell} provided to this method is no longer valid after this | |
| 157 * method returns. Do not cache the cell for future use. | |
|
72
5df4896124c7
JFace and its examples do compile
Frank Benoit <benoit@tionex.de>
parents:
70
diff
changeset
|
158 * |
| 10 | 159 * @param cell |
| 160 * {@link ViewerCell} | |
| 161 */ | |
| 162 /* package */void refresh(ViewerCell cell) { | |
| 163 getLabelProvider().update(cell); | |
| 164 } | |
| 165 | |
| 166 /** | |
| 167 * Disposes of the label provider (if set), unregisters the listener and | |
| 168 * nulls the references to the label provider and editing support. This | |
| 169 * method is called when the underlying widget is disposed. Subclasses may | |
| 170 * extend but must call the super implementation. | |
| 171 */ | |
| 172 protected void handleDispose() { | |
| 173 bool disposeLabelProvider = listenerRegistered; | |
| 174 CellLabelProvider cellLabelProvider = labelProvider; | |
| 175 setLabelProvider(null, false); | |
| 176 if (disposeLabelProvider) { | |
|
70
46a6e0e6ccd4
Merge with d-fied sources of 3.4M7
Frank Benoit <benoit@tionex.de>
parents:
54
diff
changeset
|
177 cellLabelProvider.dispose(viewer, this); |
| 10 | 178 } |
| 179 editingSupport = null; | |
| 180 listener = null; | |
|
70
46a6e0e6ccd4
Merge with d-fied sources of 3.4M7
Frank Benoit <benoit@tionex.de>
parents:
54
diff
changeset
|
181 viewer = null; |
| 10 | 182 } |
| 183 | |
| 184 private void handleDispose(ColumnViewer viewer) { | |
| 185 handleDispose(); | |
| 186 viewer.clearLegacyEditingSetup(); | |
| 187 } | |
|
70
46a6e0e6ccd4
Merge with d-fied sources of 3.4M7
Frank Benoit <benoit@tionex.de>
parents:
54
diff
changeset
|
188 |
|
46a6e0e6ccd4
Merge with d-fied sources of 3.4M7
Frank Benoit <benoit@tionex.de>
parents:
54
diff
changeset
|
189 /** |
|
46a6e0e6ccd4
Merge with d-fied sources of 3.4M7
Frank Benoit <benoit@tionex.de>
parents:
54
diff
changeset
|
190 * Returns the viewer of this viewer column. |
|
72
5df4896124c7
JFace and its examples do compile
Frank Benoit <benoit@tionex.de>
parents:
70
diff
changeset
|
191 * |
|
70
46a6e0e6ccd4
Merge with d-fied sources of 3.4M7
Frank Benoit <benoit@tionex.de>
parents:
54
diff
changeset
|
192 * @return Returns the viewer. |
|
72
5df4896124c7
JFace and its examples do compile
Frank Benoit <benoit@tionex.de>
parents:
70
diff
changeset
|
193 * |
|
70
46a6e0e6ccd4
Merge with d-fied sources of 3.4M7
Frank Benoit <benoit@tionex.de>
parents:
54
diff
changeset
|
194 * @since 3.4 |
|
46a6e0e6ccd4
Merge with d-fied sources of 3.4M7
Frank Benoit <benoit@tionex.de>
parents:
54
diff
changeset
|
195 */ |
|
46a6e0e6ccd4
Merge with d-fied sources of 3.4M7
Frank Benoit <benoit@tionex.de>
parents:
54
diff
changeset
|
196 public ColumnViewer getViewer() { |
|
46a6e0e6ccd4
Merge with d-fied sources of 3.4M7
Frank Benoit <benoit@tionex.de>
parents:
54
diff
changeset
|
197 return viewer; |
|
46a6e0e6ccd4
Merge with d-fied sources of 3.4M7
Frank Benoit <benoit@tionex.de>
parents:
54
diff
changeset
|
198 } |
| 10 | 199 } |