Java tutorial
/** * This file is protected by Copyright. * Please refer to the COPYRIGHT file distributed with this source distribution. * * This file is part of REDHAWK IDE. * * 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. * */ package gov.redhawk.diagram.ui.tools; import gov.redhawk.diagram.activator.PluginActivator; import gov.redhawk.diagram.ui.tools.internal.ComboCellEditorEx; import gov.redhawk.sca.util.Debug; import java.util.ArrayList; import java.util.Iterator; import java.util.List; import org.eclipse.core.runtime.Assert; import org.eclipse.draw2d.AncestorListener; import org.eclipse.draw2d.IFigure; import org.eclipse.draw2d.PositionConstants; import org.eclipse.draw2d.TextUtilities; import org.eclipse.draw2d.geometry.Dimension; import org.eclipse.draw2d.geometry.Rectangle; import org.eclipse.gef.GraphicalEditPart; import org.eclipse.gef.editparts.ZoomManager; import org.eclipse.gef.tools.CellEditorLocator; import org.eclipse.gef.tools.DirectEditManager; import org.eclipse.gmf.runtime.common.core.util.Log; import org.eclipse.gmf.runtime.common.core.util.Trace; import org.eclipse.gmf.runtime.diagram.ui.editparts.ITextAwareEditPart; import org.eclipse.gmf.runtime.diagram.ui.internal.DiagramUIDebugOptions; import org.eclipse.gmf.runtime.diagram.ui.internal.DiagramUIPlugin; import org.eclipse.gmf.runtime.diagram.ui.internal.DiagramUIStatusCodes; import org.eclipse.gmf.runtime.diagram.ui.label.ILabelDelegate; import org.eclipse.gmf.runtime.diagram.ui.parts.DiagramGraphicalViewer; import org.eclipse.gmf.runtime.draw2d.ui.figures.WrappingLabel; import org.eclipse.gmf.runtime.draw2d.ui.mapmode.MapModeUtil; import org.eclipse.jface.action.IAction; import org.eclipse.jface.resource.DeviceResourceException; import org.eclipse.jface.resource.FontDescriptor; import org.eclipse.jface.resource.JFaceResources; import org.eclipse.jface.resource.ResourceManager; import org.eclipse.jface.text.contentassist.IContentAssistProcessor; import org.eclipse.jface.viewers.CellEditor; import org.eclipse.jface.viewers.ComboBoxCellEditor; import org.eclipse.swt.SWT; import org.eclipse.swt.custom.CCombo; import org.eclipse.swt.graphics.Color; import org.eclipse.swt.graphics.Font; import org.eclipse.swt.graphics.FontData; import org.eclipse.swt.graphics.Point; import org.eclipse.swt.graphics.RGB; import org.eclipse.swt.widgets.Composite; import org.eclipse.swt.widgets.Control; import org.eclipse.swt.widgets.Display; import org.eclipse.swt.widgets.Event; import org.eclipse.swt.widgets.Shell; import org.eclipse.swt.widgets.Table; import org.eclipse.ui.IActionBars; import org.eclipse.ui.PlatformUI; import org.eclipse.ui.actions.ActionFactory; import org.eclipse.ui.part.CellEditorActionHandler; /** * @since 2.0 */ @SuppressWarnings("restriction") public class ComboDirectEditManager extends DirectEditManager { private static final Debug DEBUG = new Debug(PluginActivator.ID, "comboDirectEdit"); /** * content assist background color */ private Color proposalPopupBackgroundColor = null; /** * content assist foreground color */ private Color proposalPopupForegroundColor = null; private boolean committed = false; /** * flag used to avoid unhooking listeners twice if the UI thread is blocked */ private boolean listenersAttached = true; /** String buffer to hold initial characters * */ private StringBuffer initialString = new StringBuffer(); /** * Cache the font descriptor when a font is created so that it can be * disposed later. */ private final List<FontDescriptor> cachedFontDescriptors = new ArrayList<FontDescriptor>(); private IActionBars actionBars; private CellEditorActionHandler actionHandler; private IAction copy, cut, paste, undo, redo, find, selectAll, delete; private Font zoomLevelFont = null; /** * The superclass only relocates the cell editor when the location of the * editpart's figure moves, but we need to also relocate the cell editor * when the text figure's location changes. */ private AncestorListener textFigureListener; private final String[] items; /** * constructor * * @param source * <code>GraphicalEditPart</code> to support direct edit of. * The figure of the <code>source</code> edit part must be of * type <code>WrapLabel</code>. */ public ComboDirectEditManager(final ITextAwareEditPart source, final String[] items) { this(source, ComboDirectEditManager.getTextCellEditorLocator(source), items); } /** * @param source * @param editorType * @param locator */ public ComboDirectEditManager(final GraphicalEditPart source, final CellEditorLocator locator, final String[] items) { super(source, ComboBoxCellEditor.class, locator); this.items = items; } /** * @param source * the <code>ITextAwareEditPart</code> to determine the cell * editor for * @return the <code>CellEditorLocator</code> that is appropriate for the * source <code>EditPart</code> */ public static CellEditorLocator getTextCellEditorLocator(final ITextAwareEditPart source) { final ILabelDelegate label = (ILabelDelegate) source.getAdapter(ILabelDelegate.class); if (label != null) { return new CellEditorLocator() { @Override public void relocate(final CellEditor celleditor) { final CCombo text = (CCombo) celleditor.getControl(); final Rectangle rect = label.getTextBounds().getCopy(); if (label.getText().length() <= 0) { // if there is no text, let's assume a default size // of one character because it looks silly when the cell // editor is tiny. rect.setSize(TextUtilities.INSTANCE.getTextExtents("a", text.getFont())); //$NON-NLS-1$ if (label.isTextWrapOn()) { // adjust the location of the cell editor based on text // justification (i.e. where the cursor will be if (label.getTextJustification() == PositionConstants.RIGHT) { rect.translate(-rect.width, 0); } else if (label.getTextJustification() == PositionConstants.CENTER) { rect.translate(-rect.width / 2, 0); } } } if (!text.getFont().isDisposed()) { // Font may be disposed if the locator is called while // this manager is being brought down in which case the // calls below that use the font will result in an // exception. if (label.isTextWrapOn()) { // When zoomed in, the height of this rectangle is not // sufficient because the text is shifted downwards a // little bit. Add some to the height to compensate for // this. I'm not sure why this is happening, but I can // see the text shifting down even in a label on a GEF // logic diagram when zoomed into 400%. final int charHeight = org.eclipse.draw2d.FigureUtilities.getFontMetrics(text.getFont()) .getHeight(); rect.resize(0, charHeight / 2); } else { rect.setSize(new Dimension(text.computeSize(SWT.DEFAULT, SWT.DEFAULT))); // If SWT.WRAP is not passed in as a style of the // TextCellEditor, then for some reason the first // character disappears upon entering the second // character. This should be investigated and an // SWT bug logged. final int avr = org.eclipse.draw2d.FigureUtilities.getFontMetrics(text.getFont()) .getAverageCharWidth(); rect.setSize( new Dimension(text.computeSize(SWT.DEFAULT, SWT.DEFAULT)).expand(avr * 2, 0)); } } final org.eclipse.swt.graphics.Rectangle newRect = text.computeTrim(rect.x, rect.y, rect.width, rect.height); if (!newRect.equals(text.getBounds())) { text.setBounds(newRect.x, newRect.y, newRect.width, newRect.height); } } }; } // return a default figure locator return new CellEditorLocator() { @Override public void relocate(final CellEditor celleditor) { final CCombo text = (CCombo) celleditor.getControl(); final Rectangle rect = source.getFigure().getBounds().getCopy(); source.getFigure().translateToAbsolute(rect); if (!rect.equals(new Rectangle(text.getBounds()))) { text.setBounds(rect.x, rect.y, rect.width, rect.height); } } }; } /** * This method is overridden so that the editor class can have a style as * the style needs to be passed into the editor class when it is created. It * will default to the super behavior if an <code>editorType</code> was * passed into the constructor. * @since 2.1 */ @Override protected CellEditor createCellEditorOn(final Composite composite) { return new ComboCellEditorEx(composite, this.items); } /** * Given a label figure object, this will calculate the * correct Font needed to display into screen coordinates, taking into * account the current mapmode. This will typically be used by direct * edit cell editors that need to display independent of the zoom or any * coordinate mapping that is taking place on the drawing surface. * * @param label the label to use for the font calculation * @return the <code>Font</code> that is scaled to the screen coordinates. * Note: the returned <code>Font</code> should not be disposed since it is * cached by a common resource manager. */ protected Font getScaledFont(final IFigure label) { final Font scaledFont = label.getFont(); final FontData data = scaledFont.getFontData()[0]; final Dimension fontSize = new Dimension(0, MapModeUtil.getMapMode(label).DPtoLP(data.getHeight())); label.translateToAbsolute(fontSize); if (Math.abs(data.getHeight() - fontSize.height) < 2) { fontSize.height = data.getHeight(); } try { final FontDescriptor fontDescriptor = FontDescriptor.createFrom(data); this.cachedFontDescriptors.add(fontDescriptor); return getResourceManager().createFont(fontDescriptor); } catch (final DeviceResourceException e) { Trace.catching(DiagramUIPlugin.getInstance(), DiagramUIDebugOptions.EXCEPTIONS_CATCHING, getClass(), "getScaledFont", e); //$NON-NLS-1$ Log.error(DiagramUIPlugin.getInstance(), DiagramUIStatusCodes.IGNORED_EXCEPTION_WARNING, "getScaledFont", e); //$NON-NLS-1$ } return JFaceResources.getDefaultFont(); } @Override protected void initCellEditor() { this.committed = false; // Get the Text Compartments Edit Part final ITextAwareEditPart textEP = (ITextAwareEditPart) getEditPart(); setEditText(textEP.getEditText()); final IFigure label = textEP.getFigure(); Assert.isNotNull(label); final CCombo text = (CCombo) getCellEditor().getControl(); // scale the font accordingly to the zoom level text.setFont(getScaledFont(label)); // register a validator on the cell editor getCellEditor().setValidator(textEP.getEditTextValidator()); if (textEP.getParser() != null) { final IContentAssistProcessor processor = textEP.getCompletionProcessor(); if (processor != null) { // register content assist this.proposalPopupBackgroundColor = new Color(getCellEditor().getControl().getShell().getDisplay(), new RGB(254, 241, 233)); // SUPPRESS CHECKSTYLE MagicNumber this.proposalPopupForegroundColor = new Color(getCellEditor().getControl().getShell().getDisplay(), new RGB(0, 0, 0)); // ContentAssistantHelper.createTextContentAssistant(text, // proposalPopupForegroundColor, proposalPopupBackgroundColor, // processor); } } //Hook the cell editor's copy/paste actions to the actionBars so that they can // be invoked via keyboard shortcuts. this.actionBars = PlatformUI.getWorkbench().getActiveWorkbenchWindow().getActivePage().getActiveEditor() .getEditorSite().getActionBars(); saveCurrentActions(this.actionBars); this.actionHandler = new CellEditorActionHandler(this.actionBars); this.actionHandler.addCellEditor(getCellEditor()); this.actionBars.updateActionBars(); } /** * @see org.eclipse.gef.tools.DirectEditManager#commit() */ @Override protected void commit() { final Shell activeShell = Display.getCurrent().getActiveShell(); if (activeShell != null && getCellEditor().getControl().getShell().equals(activeShell.getParent())) { final Control[] children = activeShell.getChildren(); if (children.length == 1 && children[0] instanceof Table) { /* * CONTENT ASSIST: focus is lost to the content assist pop up - * stay in focus */ getCellEditor().getControl().setVisible(true); ((ComboCellEditorEx) getCellEditor()).setDeactivationLock(true); return; } } // content assist hacks if (this.committed) { bringDown(); return; } this.committed = true; super.commit(); } /** * @see org.eclipse.gef.tools.DirectEditManager#bringDown() */ @Override protected void bringDown() { if (this.proposalPopupForegroundColor != null) { this.proposalPopupForegroundColor.dispose(); this.proposalPopupForegroundColor = null; } if (this.proposalPopupBackgroundColor != null) { this.proposalPopupBackgroundColor.dispose(); this.proposalPopupBackgroundColor = null; } // myee - RATLC00523014: crashes when queued in asyncExec() eraseFeedback(); this.initialString = new StringBuffer(); Display.getCurrent().asyncExec(new Runnable() { @Override public void run() { // Content Assist hack - allow proper cleanup on childen // controls ComboDirectEditManager.super.bringDown(); } }); for (final Iterator<FontDescriptor> iter = this.cachedFontDescriptors.iterator(); iter.hasNext();) { getResourceManager().destroyFont(iter.next()); } this.cachedFontDescriptors.clear(); if (this.actionHandler != null) { this.actionHandler.dispose(); this.actionHandler = null; } if (this.actionBars != null) { restoreSavedActions(this.actionBars); this.actionBars.updateActionBars(); this.actionBars = null; } } /** * This method is used to set the cell editors text * * @param toEdit * String to be set in the cell editor */ public void setEditText(final String toEdit) { // Get the cell editor final CellEditor cellEditor = getCellEditor(); // IF the cell editor doesn't exist yet... if (cellEditor == null) { // Do nothing return; } // Get the Text Compartment Edit Part final ITextAwareEditPart textEP = (ITextAwareEditPart) getEditPart(); // Get the Text control final CCombo textControl = (CCombo) cellEditor.getControl(); // Set the Figures text textEP.setLabelText(toEdit); cellEditor.setValue(toEdit); // Set the controls text and position the caret at the end of the text textControl.setSelection(new Point(0, toEdit.length())); } /** * Performs show and sets the edit string to be the initial character or string * @param initialChar */ public void show(final char initialChar) { this.initialString = this.initialString.append(initialChar); show(); if (!"carbon".equals(SWT.getPlatform())) { //$NON-NLS-1$ // Set the cell editor text to the initial character setEditText(this.initialString.toString()); } } /** * This method obtains the fonts that are being used by the figure at its zoom level. * @param gep the associated <code>GraphicalEditPart</code> of the figure * @param actualFont font being used by the figure * @param display * @return <code>actualFont</code> if zoom level is 1.0 (or when there's an error), * new Font otherwise. */ private Font getZoomLevelFont(final Font actualFont, final Display display) { final Object zoom = getEditPart().getViewer().getProperty(ZoomManager.class.toString()); if (zoom != null) { final double zoomLevel = ((ZoomManager) zoom).getZoom(); if (zoomLevel == 1.0f) { return actualFont; } final FontData[] fd = new FontData[actualFont.getFontData().length]; FontData tempFD = null; for (int i = 0; i < fd.length; i++) { tempFD = actualFont.getFontData()[i]; fd[i] = new FontData(tempFD.getName(), (int) (zoomLevel * tempFD.getHeight()), tempFD.getStyle()); } try { final FontDescriptor fontDescriptor = FontDescriptor.createFrom(fd); this.cachedFontDescriptors.add(fontDescriptor); return getResourceManager().createFont(fontDescriptor); } catch (final DeviceResourceException e) { Trace.catching(DiagramUIPlugin.getInstance(), DiagramUIDebugOptions.EXCEPTIONS_CATCHING, getClass(), "getZoomLevelFonts", e); //$NON-NLS-1$ Log.error(DiagramUIPlugin.getInstance(), DiagramUIStatusCodes.IGNORED_EXCEPTION_WARNING, "getZoomLevelFonts", e); //$NON-NLS-1$ return actualFont; } } else { return actualFont; } } @Override public void show() { super.show(); final IFigure fig = getEditPart().getFigure(); final Control control = getCellEditor().getControl(); this.zoomLevelFont = getZoomLevelFont(fig.getFont(), control.getDisplay()); control.setFont(this.zoomLevelFont); //since the font's have been resized, we need to resize the Text control... getLocator().relocate(getCellEditor()); } /** * * Performs show and sends an extra mouse click to the point location so * that cursor appears at the mouse click point * * The Text control does not allow for the cursor to appear at point location but * at a character location * * @param location */ public void show(final Point location) { show(); sendClickToCellEditor(location); } private void sendClickToCellEditor(final Point location) { //make sure the diagram doesn't receive the click event.. getCellEditor().getControl().setCapture(true); if (getCellEditor() != null && getCellEditor().getControl().getBounds().contains(location)) { sendMouseClick(location); } } /** * * Sends a SWT MouseUp and MouseDown event to the point location * to the current Display * * @param location */ private void sendMouseClick(final Point location) { final Display currDisplay = Display.getCurrent(); currDisplay.asyncExec(new Runnable() { @Override public void run() { Event event; event = new Event(); event.type = SWT.MouseDown; event.button = 1; event.x = location.x; event.y = location.y; currDisplay.post(event); event.type = SWT.MouseUp; currDisplay.post(event); } }); } @Override protected void hookListeners() { super.hookListeners(); // TODO: This gets around the problem of the cell editor not growing big // enough when in autosize mode because it doesn't listen to textflow // size changes. The superclass should be modified to not assume we want // to listen to the editpart's figure. final ILabelDelegate label = (ILabelDelegate) getEditPart().getAdapter(ILabelDelegate.class); if (label != null && getEditPart().getFigure() instanceof WrappingLabel) { this.textFigureListener = new AncestorListener.Stub() { @Override public void ancestorMoved(final IFigure ancestor) { getLocator().relocate(getCellEditor()); } }; ((IFigure) ((WrappingLabel) getEditPart().getFigure()).getTextFigure().getChildren().get(0)) .addAncestorListener(this.textFigureListener); } } /* * Overrides super unhookListeners to set listeners attached flag This * method prevents unhooking listeners twice if the UI thread is blocked. * For example, a validation dialog may block the thread */ @Override protected void unhookListeners() { if (this.listenersAttached) { this.listenersAttached = false; super.unhookListeners(); final ILabelDelegate label = (ILabelDelegate) getEditPart().getAdapter(ILabelDelegate.class); if (label != null && this.textFigureListener != null) { ((IFigure) ((WrappingLabel) getEditPart().getFigure()).getTextFigure().getChildren().get(0)) .removeAncestorListener(this.textFigureListener); this.textFigureListener = null; } } } /* * Sets the listeners attached flag if the cell editor exists */ @Override protected void setCellEditor(final CellEditor editor) { super.setCellEditor(editor); if (editor != null) { this.listenersAttached = true; } } @Override public void showFeedback() { try { getEditPart().getRoot(); super.showFeedback(); } catch (final Exception e) { // SUPPRESS CHECKSTYLE Logging Exception if (DEBUG.enabled) { DEBUG.catching("Ignoring exception", e); } } } /** * Gets the resource manager to remember the resources allocated for this * graphical viewer. All resources will be disposed when the graphical * viewer is closed if they have not already been disposed. * @return */ protected ResourceManager getResourceManager() { return ((DiagramGraphicalViewer) getEditPart().getViewer()).getResourceManager(); } private void saveCurrentActions(final IActionBars actionBars) { this.copy = actionBars.getGlobalActionHandler(ActionFactory.COPY.getId()); this.paste = actionBars.getGlobalActionHandler(ActionFactory.PASTE.getId()); this.delete = actionBars.getGlobalActionHandler(ActionFactory.DELETE.getId()); this.selectAll = actionBars.getGlobalActionHandler(ActionFactory.SELECT_ALL.getId()); this.cut = actionBars.getGlobalActionHandler(ActionFactory.CUT.getId()); this.find = actionBars.getGlobalActionHandler(ActionFactory.FIND.getId()); this.undo = actionBars.getGlobalActionHandler(ActionFactory.UNDO.getId()); this.redo = actionBars.getGlobalActionHandler(ActionFactory.REDO.getId()); } private void restoreSavedActions(final IActionBars actionBars) { actionBars.setGlobalActionHandler(ActionFactory.COPY.getId(), this.copy); actionBars.setGlobalActionHandler(ActionFactory.PASTE.getId(), this.paste); actionBars.setGlobalActionHandler(ActionFactory.DELETE.getId(), this.delete); actionBars.setGlobalActionHandler(ActionFactory.SELECT_ALL.getId(), this.selectAll); actionBars.setGlobalActionHandler(ActionFactory.CUT.getId(), this.cut); actionBars.setGlobalActionHandler(ActionFactory.FIND.getId(), this.find); actionBars.setGlobalActionHandler(ActionFactory.UNDO.getId(), this.undo); actionBars.setGlobalActionHandler(ActionFactory.REDO.getId(), this.redo); } }