|
Removed
Link Here
|
| 1 |
/******************************************************************************* |
| 2 |
* Copyright (c) 2000, 2005 IBM Corporation and others. |
| 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 |
*******************************************************************************/ |
| 11 |
package org.eclipse.gef.internal.ui.palette.editparts; |
| 12 |
|
| 13 |
import java.beans.PropertyChangeEvent; |
| 14 |
import java.beans.PropertyChangeListener; |
| 15 |
import java.util.ArrayList; |
| 16 |
import java.util.Collections; |
| 17 |
import java.util.HashMap; |
| 18 |
import java.util.Iterator; |
| 19 |
import java.util.List; |
| 20 |
import java.util.Map; |
| 21 |
|
| 22 |
import org.eclipse.swt.graphics.Image; |
| 23 |
import org.eclipse.swt.widgets.Display; |
| 24 |
|
| 25 |
import org.eclipse.jface.resource.ImageDescriptor; |
| 26 |
import org.eclipse.ui.IMemento; |
| 27 |
|
| 28 |
import org.eclipse.draw2d.Border; |
| 29 |
import org.eclipse.draw2d.IFigure; |
| 30 |
import org.eclipse.draw2d.MarginBorder; |
| 31 |
import org.eclipse.draw2d.geometry.Dimension; |
| 32 |
import org.eclipse.draw2d.text.FlowPage; |
| 33 |
import org.eclipse.draw2d.text.TextFlow; |
| 34 |
|
| 35 |
import org.eclipse.gef.AccessibleEditPart; |
| 36 |
import org.eclipse.gef.DragTracker; |
| 37 |
import org.eclipse.gef.Request; |
| 38 |
import org.eclipse.gef.editparts.AbstractGraphicalEditPart; |
| 39 |
import org.eclipse.gef.palette.PaletteContainer; |
| 40 |
import org.eclipse.gef.palette.PaletteEntry; |
| 41 |
import org.eclipse.gef.palette.PaletteSeparator; |
| 42 |
import org.eclipse.gef.tools.SelectEditPartTracker; |
| 43 |
import org.eclipse.gef.ui.palette.PaletteMessages; |
| 44 |
import org.eclipse.gef.ui.palette.PaletteViewer; |
| 45 |
import org.eclipse.gef.ui.palette.PaletteViewerPreferences; |
| 46 |
|
| 47 |
public abstract class PaletteEditPart |
| 48 |
extends AbstractGraphicalEditPart |
| 49 |
implements PropertyChangeListener |
| 50 |
{ |
| 51 |
|
| 52 |
public static final String XML_NAME = "entry"; //$NON-NLS-1$ |
| 53 |
private static final Border TOOLTIP_BORDER = new MarginBorder(0, 2, 1, 0); |
| 54 |
private static ImageCache globalImageCache; |
| 55 |
private AccessibleEditPart acc; |
| 56 |
private PropertyChangeListener childListener = new PropertyChangeListener() { |
| 57 |
public void propertyChange(PropertyChangeEvent evt) { |
| 58 |
if (evt.getPropertyName().equals(PaletteEntry.PROPERTY_VISIBLE)) { |
| 59 |
refreshChildren(); |
| 60 |
} |
| 61 |
} |
| 62 |
}; |
| 63 |
private Image image; |
| 64 |
private ImageDescriptor imgDescriptor; |
| 65 |
|
| 66 |
public PaletteEditPart(PaletteEntry model) { |
| 67 |
setModel(model); |
| 68 |
} |
| 69 |
|
| 70 |
/** |
| 71 |
* @see org.eclipse.gef.editparts.AbstractGraphicalEditPart#activate() |
| 72 |
*/ |
| 73 |
public void activate() { |
| 74 |
super.activate(); |
| 75 |
PaletteEntry model = (PaletteEntry)getModel(); |
| 76 |
model.addPropertyChangeListener(this); |
| 77 |
traverseChildren(model, true); |
| 78 |
} |
| 79 |
|
| 80 |
/** |
| 81 |
* returns the AccessibleEditPart for this EditPart. This method is called lazily from |
| 82 |
* {@link #getAccessibleEditPart()}. |
| 83 |
*/ |
| 84 |
protected AccessibleEditPart createAccessible() { |
| 85 |
return null; |
| 86 |
} |
| 87 |
|
| 88 |
public void createEditPolicies() { } |
| 89 |
|
| 90 |
protected IFigure createToolTip() { |
| 91 |
String message = getToolTipText(); |
| 92 |
if (message == null || message.length() == 0) |
| 93 |
return null; |
| 94 |
|
| 95 |
FlowPage fp = new FlowPage() { |
| 96 |
public Dimension getPreferredSize(int w, int h) { |
| 97 |
Dimension d = super.getPreferredSize(-1, -1); |
| 98 |
if (d.width > 150) |
| 99 |
d = super.getPreferredSize(150, -1); |
| 100 |
return d; |
| 101 |
} |
| 102 |
}; |
| 103 |
fp.setOpaque(true); |
| 104 |
fp.setBorder(TOOLTIP_BORDER); |
| 105 |
TextFlow tf = new TextFlow(); |
| 106 |
tf.setText(message); |
| 107 |
fp.add(tf); |
| 108 |
return fp; |
| 109 |
} |
| 110 |
|
| 111 |
/** |
| 112 |
* @see org.eclipse.gef.editparts.AbstractGraphicalEditPart#deactivate() |
| 113 |
*/ |
| 114 |
public void deactivate() { |
| 115 |
PaletteEntry model = (PaletteEntry)getModel(); |
| 116 |
model.removePropertyChangeListener(this); |
| 117 |
traverseChildren(model, false); |
| 118 |
if (image != null) { |
| 119 |
image.dispose(); |
| 120 |
image = null; |
| 121 |
} |
| 122 |
super.deactivate(); |
| 123 |
} |
| 124 |
|
| 125 |
|
| 126 |
protected AccessibleEditPart getAccessibleEditPart() { |
| 127 |
if (acc == null) |
| 128 |
acc = createAccessible(); |
| 129 |
return acc; |
| 130 |
} |
| 131 |
|
| 132 |
class SingleSelectionTracker extends SelectEditPartTracker { |
| 133 |
SingleSelectionTracker() { |
| 134 |
super(PaletteEditPart.this); |
| 135 |
} |
| 136 |
protected void performSelection() { |
| 137 |
if (hasSelectionOccurred()) |
| 138 |
return; |
| 139 |
setFlag(FLAG_SELECTION_PERFORMED, true); |
| 140 |
getCurrentViewer().select(getSourceEditPart()); |
| 141 |
} |
| 142 |
} |
| 143 |
|
| 144 |
/** |
| 145 |
* @see org.eclipse.gef.editparts.AbstractGraphicalEditPart#getDragTracker(Request) |
| 146 |
*/ |
| 147 |
public DragTracker getDragTracker(Request request) { |
| 148 |
return new SingleSelectionTracker(); |
| 149 |
} |
| 150 |
|
| 151 |
/** |
| 152 |
* Returns the image cache. |
| 153 |
* The cache is global, and is shared by all palette edit parts. This has the disadvantage |
| 154 |
* that once an image is allocated, it is never freed until the display is disposed. |
| 155 |
* However, it has the advantage that the same image in different palettes is |
| 156 |
* only ever created once. |
| 157 |
*/ |
| 158 |
protected static ImageCache getImageCache() { |
| 159 |
ImageCache cache = globalImageCache; |
| 160 |
if (cache == null) { |
| 161 |
globalImageCache = cache = new ImageCache(); |
| 162 |
Display display = Display.getDefault(); |
| 163 |
if (display != null) { |
| 164 |
display.disposeExec(new Runnable() { |
| 165 |
public void run() { |
| 166 |
if (globalImageCache != null) { |
| 167 |
globalImageCache.dispose(); |
| 168 |
globalImageCache = null; |
| 169 |
} |
| 170 |
} |
| 171 |
}); |
| 172 |
} |
| 173 |
} |
| 174 |
return cache; |
| 175 |
} |
| 176 |
|
| 177 |
/** |
| 178 |
* @see org.eclipse.gef.editparts.AbstractEditPart#getModelChildren() |
| 179 |
*/ |
| 180 |
public List getModelChildren() { |
| 181 |
List modelChildren; |
| 182 |
if (getModel() instanceof PaletteContainer) |
| 183 |
modelChildren = new ArrayList(((PaletteContainer)getModel()).getChildren()); |
| 184 |
else |
| 185 |
return Collections.EMPTY_LIST; |
| 186 |
|
| 187 |
PaletteEntry prevVisibleEntry = null; |
| 188 |
for (Iterator iter = modelChildren.iterator(); iter.hasNext();) { |
| 189 |
PaletteEntry entry = (PaletteEntry) iter.next(); |
| 190 |
if (!entry.isVisible()) |
| 191 |
// not visible |
| 192 |
iter.remove(); |
| 193 |
else if (entry instanceof PaletteSeparator && prevVisibleEntry == null) |
| 194 |
// first visible item in a group is a separator, don't need it |
| 195 |
iter.remove(); |
| 196 |
else if (entry instanceof PaletteSeparator && prevVisibleEntry instanceof PaletteSeparator) |
| 197 |
// previous visible entry was a separator, don't need it |
| 198 |
iter.remove(); |
| 199 |
else |
| 200 |
prevVisibleEntry = entry; |
| 201 |
} |
| 202 |
// check to see if last visible entry was a separator, and thus should be hidden |
| 203 |
if (prevVisibleEntry instanceof PaletteSeparator) |
| 204 |
modelChildren.remove(prevVisibleEntry); |
| 205 |
|
| 206 |
return modelChildren; |
| 207 |
} |
| 208 |
|
| 209 |
protected PaletteEntry getPaletteEntry() { |
| 210 |
return (PaletteEntry)getModel(); |
| 211 |
} |
| 212 |
|
| 213 |
PaletteViewer getPaletteViewer() { |
| 214 |
return (PaletteViewer)getViewer(); |
| 215 |
} |
| 216 |
|
| 217 |
protected PaletteViewerPreferences getPreferenceSource() { |
| 218 |
return ((PaletteViewer)getViewer()).getPaletteViewerPreferences(); |
| 219 |
} |
| 220 |
|
| 221 |
protected IFigure getToolTipFigure() { |
| 222 |
return getFigure(); |
| 223 |
} |
| 224 |
|
| 225 |
protected String getToolTipText() { |
| 226 |
String text = null; |
| 227 |
PaletteEntry entry = (PaletteEntry)getModel(); |
| 228 |
String desc = entry.getDescription(); |
| 229 |
boolean needName = nameNeededInToolTip(); |
| 230 |
if (desc == null |
| 231 |
|| desc.trim().equals(entry.getLabel()) |
| 232 |
|| desc.trim().equals("")) { //$NON-NLS-1$ |
| 233 |
if (needName) |
| 234 |
text = entry.getLabel(); |
| 235 |
} else { |
| 236 |
if (needName) |
| 237 |
text = entry.getLabel() + " " //$NON-NLS-1$ |
| 238 |
+ PaletteMessages.NAME_DESCRIPTION_SEPARATOR + " " + desc; //$NON-NLS-1$ |
| 239 |
else |
| 240 |
text = desc; |
| 241 |
} |
| 242 |
if (text != null && text.trim().equals(""))//$NON-NLS-1$ |
| 243 |
return null; |
| 244 |
return text; |
| 245 |
} |
| 246 |
|
| 247 |
protected boolean nameNeededInToolTip() { |
| 248 |
return getPreferenceSource().getLayoutSetting() |
| 249 |
== PaletteViewerPreferences.LAYOUT_ICONS; |
| 250 |
} |
| 251 |
|
| 252 |
/** |
| 253 |
* @see java.beans.PropertyChangeListener#propertyChange(PropertyChangeEvent) |
| 254 |
*/ |
| 255 |
public void propertyChange(PropertyChangeEvent evt) { |
| 256 |
String property = evt.getPropertyName(); |
| 257 |
if (property.equals(PaletteContainer.PROPERTY_CHILDREN)) { |
| 258 |
traverseChildren((List)evt.getOldValue(), false); |
| 259 |
refreshChildren(); |
| 260 |
traverseChildren((List)evt.getNewValue(), true); |
| 261 |
} else if (property.equals(PaletteEntry.PROPERTY_LABEL) |
| 262 |
|| property.equals(PaletteEntry.PROPERTY_SMALL_ICON) |
| 263 |
|| property.equals(PaletteEntry.PROPERTY_LARGE_ICON) |
| 264 |
|| property.equals(PaletteEntry.PROPERTY_DESCRIPTION)) |
| 265 |
refreshVisuals(); |
| 266 |
} |
| 267 |
|
| 268 |
public void restoreState(IMemento memento) { |
| 269 |
Iterator iter = getChildren().iterator(); |
| 270 |
IMemento[] childMementos = memento.getChildren(XML_NAME); |
| 271 |
int index = 0; |
| 272 |
while (iter.hasNext()) |
| 273 |
((PaletteEditPart)iter.next()).restoreState(childMementos[index++]); |
| 274 |
} |
| 275 |
|
| 276 |
public void saveState(IMemento memento) { |
| 277 |
Iterator iter = getChildren().iterator(); |
| 278 |
while (iter.hasNext()) |
| 279 |
((PaletteEditPart)iter.next()).saveState(memento.createChild(XML_NAME)); |
| 280 |
} |
| 281 |
|
| 282 |
protected void setImageDescriptor(ImageDescriptor desc) { |
| 283 |
if (desc == imgDescriptor) |
| 284 |
return; |
| 285 |
imgDescriptor = desc; |
| 286 |
setImageInFigure(getImageCache().getImage(imgDescriptor)); |
| 287 |
} |
| 288 |
|
| 289 |
protected void setImageInFigure(Image image) { } |
| 290 |
|
| 291 |
private void traverseChildren(PaletteEntry parent, boolean add) { |
| 292 |
if (!(parent instanceof PaletteContainer)) |
| 293 |
return; |
| 294 |
PaletteContainer container = (PaletteContainer)parent; |
| 295 |
traverseChildren(container.getChildren(), add); |
| 296 |
} |
| 297 |
|
| 298 |
private void traverseChildren(List children, boolean add) { |
| 299 |
for (Iterator iter = children.iterator(); iter.hasNext();) { |
| 300 |
PaletteEntry entry = (PaletteEntry) iter.next(); |
| 301 |
if (add) { |
| 302 |
entry.addPropertyChangeListener(childListener); |
| 303 |
} else { |
| 304 |
entry.removePropertyChangeListener(childListener); |
| 305 |
} |
| 306 |
} |
| 307 |
} |
| 308 |
|
| 309 |
protected static class ImageCache { |
| 310 |
/** Map from ImageDescriptor to Image */ |
| 311 |
private Map images = new HashMap(11); |
| 312 |
|
| 313 |
Image getImage(ImageDescriptor desc) { |
| 314 |
if (desc == null) { |
| 315 |
return null; |
| 316 |
} |
| 317 |
Image img = null; |
| 318 |
Object obj = images.get(desc); |
| 319 |
if (obj != null) { |
| 320 |
img = (Image)obj; |
| 321 |
} else { |
| 322 |
img = desc.createImage(); |
| 323 |
images.put(desc, img); |
| 324 |
} |
| 325 |
return img; |
| 326 |
} |
| 327 |
|
| 328 |
Image getMissingImage() { |
| 329 |
return getImage(ImageDescriptor.getMissingImageDescriptor()); |
| 330 |
} |
| 331 |
|
| 332 |
void dispose() { |
| 333 |
for (Iterator i = images.values().iterator(); i.hasNext();) { |
| 334 |
Image img = (Image) i.next(); |
| 335 |
img.dispose(); |
| 336 |
} |
| 337 |
images.clear(); |
| 338 |
} |
| 339 |
} |
| 340 |
|
| 341 |
} |