diff options
Diffstat (limited to 'org.eclipse.mylyn.tasks.ui/src/org/eclipse/mylyn/internal/tasklist/ui/views/TaskListToolTipHandler.java')
| -rw-r--r-- | org.eclipse.mylyn.tasks.ui/src/org/eclipse/mylyn/internal/tasklist/ui/views/TaskListToolTipHandler.java | 298 |
1 files changed, 298 insertions, 0 deletions
diff --git a/org.eclipse.mylyn.tasks.ui/src/org/eclipse/mylyn/internal/tasklist/ui/views/TaskListToolTipHandler.java b/org.eclipse.mylyn.tasks.ui/src/org/eclipse/mylyn/internal/tasklist/ui/views/TaskListToolTipHandler.java new file mode 100644 index 000000000..f318f96fb --- /dev/null +++ b/org.eclipse.mylyn.tasks.ui/src/org/eclipse/mylyn/internal/tasklist/ui/views/TaskListToolTipHandler.java @@ -0,0 +1,298 @@ +/******************************************************************************* + * Copyright (c) 2004 - 2006 University Of British Columbia 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: + * University Of British Columbia - initial API and implementation + *******************************************************************************/ +/** + * Copied from newsgroup, forwarded from Make Technologies + */ + +package org.eclipse.mylar.internal.tasklist.ui.views; + +import java.util.Date; + +import org.eclipse.core.runtime.IAdaptable; +import org.eclipse.mylar.provisional.tasklist.AbstractQueryHit; +import org.eclipse.mylar.provisional.tasklist.AbstractRepositoryQuery; +import org.eclipse.mylar.provisional.tasklist.AbstractRepositoryTask; +import org.eclipse.mylar.provisional.tasklist.ITaskListElement; +import org.eclipse.swt.SWT; +import org.eclipse.swt.events.MouseAdapter; +import org.eclipse.swt.events.MouseEvent; +import org.eclipse.swt.events.MouseTrackAdapter; +import org.eclipse.swt.graphics.Image; +import org.eclipse.swt.graphics.Point; +import org.eclipse.swt.graphics.Rectangle; +import org.eclipse.swt.layout.GridData; +import org.eclipse.swt.layout.GridLayout; +import org.eclipse.swt.widgets.Control; +import org.eclipse.swt.widgets.Display; +import org.eclipse.swt.widgets.Label; +import org.eclipse.swt.widgets.Shell; +import org.eclipse.swt.widgets.Table; +import org.eclipse.swt.widgets.ToolBar; +import org.eclipse.swt.widgets.Tree; +import org.eclipse.swt.widgets.Widget; + +/** + * @author Mik Kersten + * @author Eric Booth + */ +public class TaskListToolTipHandler { + + private Shell tipShell; + + private Label tipLabelImage; + + private Label tipLabelText; + + private Widget tipWidget; // widget this tooltip is hovering over + + protected Point tipPosition; // the position being hovered over on the + + protected Point widgetPosition; // the position hovered over in the Widget; + + public TaskListToolTipHandler(Shell parentShell) { + if (parentShell != null) { + tipShell = createTipShell(parentShell); + } + } + + private Shell createTipShell(Shell parent) { + Shell tipShell = new Shell(parent, SWT.NONE); + GridLayout gridLayout = new GridLayout(); + gridLayout.numColumns = 2; + gridLayout.marginWidth = 2; + gridLayout.marginHeight = 2; + tipShell.setLayout(gridLayout); + tipShell.setBackground(parent.getDisplay().getSystemColor(SWT.COLOR_INFO_BACKGROUND)); + + tipLabelImage = new Label(tipShell, SWT.NONE); + tipLabelImage.setForeground(parent.getDisplay().getSystemColor(SWT.COLOR_INFO_FOREGROUND)); + tipLabelImage.setBackground(parent.getDisplay().getSystemColor(SWT.COLOR_INFO_BACKGROUND)); + + GridData imageGridData = new GridData(GridData.HORIZONTAL_ALIGN_BEGINNING | GridData.VERTICAL_ALIGN_BEGINNING); + tipLabelImage.setLayoutData(imageGridData); + + tipLabelText = new Label(tipShell, SWT.NONE); + tipLabelText.setForeground(parent.getDisplay().getSystemColor(SWT.COLOR_INFO_FOREGROUND)); + tipLabelText.setBackground(parent.getDisplay().getSystemColor(SWT.COLOR_INFO_BACKGROUND)); + + GridData textGridData = new GridData(GridData.FILL_HORIZONTAL | GridData.VERTICAL_ALIGN_CENTER); + tipLabelText.setLayoutData(textGridData); + + return tipShell; + } + + private ITaskListElement getTaskListElement(Object hoverObject) { + if (hoverObject instanceof Widget) { + Object data = ((Widget) hoverObject).getData(); + if (data != null) { + if (data instanceof ITaskListElement) { + return (ITaskListElement) data; + } else if (data instanceof IAdaptable) { + return (ITaskListElement) ((IAdaptable) data).getAdapter(ITaskListElement.class); + } + } + } + return null; + } + + protected String getToolTipText(Object object) { + ITaskListElement element = getTaskListElement(object); + if (element instanceof AbstractRepositoryQuery) { + AbstractRepositoryQuery query = (AbstractRepositoryQuery) element; + String tooltip = ""; + if (query.getHits().size() == 1) { + tooltip += "1 hit"; + } else { + tooltip += query.getHits().size() + " hits"; + } + if (query.getMaxHits() != -1) { + tooltip += " (max set to: " + query.getMaxHits() + ")"; + } + tooltip += formatLastRefreshTime(query.getLastRefresh()); + return tooltip; + } else if (element instanceof AbstractRepositoryTask || element instanceof AbstractQueryHit) { + AbstractRepositoryTask repositoryTask; + if (element instanceof AbstractQueryHit) { + repositoryTask = ((AbstractQueryHit)element).getCorrespondingTask(); + } else { + repositoryTask = (AbstractRepositoryTask) element; + } + String toolTip = ((ITaskListElement)element).getDescription(); + if (repositoryTask != null) { + Date lastRefresh = repositoryTask.getLastRefresh(); + if (lastRefresh != null) { + toolTip += formatLastRefreshTime(repositoryTask.getLastRefresh()); + } + } + return toolTip; + } else if (element != null) { + return ((ITaskListElement) element).getDescription(); + } else if (object instanceof Control) { + return (String) ((Control) object).getData("TIP_TEXT"); + } + return null; + } + + private String formatLastRefreshTime(Date lastRefresh) { + String toolTip = "\n---------------\n" + "Last synchronized: "; + Date timeNow = new Date(); + if (lastRefresh == null) + lastRefresh = new Date(); + long timeDifference = (timeNow.getTime() - lastRefresh.getTime()) / 60000; + long minutes = timeDifference % 60; + timeDifference /= 60; + long hours = timeDifference % 24; + timeDifference /= 24; + if (timeDifference > 0) { + toolTip += timeDifference + ((timeDifference == 1) ? " day, " : " days, "); + } + if (hours > 0 || timeDifference > 0) { + toolTip += hours + ((hours == 1) ? " hour, " : " hours, "); + } + toolTip += minutes + ((minutes == 1) ? " minute " : " minutes ") + "ago"; + return toolTip; + } + + protected Image getToolTipImage(Object object) { + if (object instanceof Control) { + return (Image) ((Control) object).getData("TIP_IMAGE"); + } + return null; + } + + protected Object getToolTipHelp(Object object) { + if (object instanceof Control) { + return (String) ((Control) object).getData("TIP_HELPTEXT"); + } + return null; + } + + /** + * Enables customized hover help for a specified control + * + * @control the control on which to enable hoverhelp + */ + public void activateHoverHelp(final Control control) { + + /* + * Get out of the way if we attempt to activate the control underneath + * the tooltip + */ + control.addMouseListener(new MouseAdapter() { + + @Override + public void mouseDown(MouseEvent e) { + if (tipShell.isVisible()) + tipShell.setVisible(false); + } + }); + /* + * Trap hover events to pop-up tooltip + */ + control.addMouseTrackListener(new MouseTrackAdapter() { + + @Override + public void mouseExit(MouseEvent e) { + if (tipShell != null && tipShell.isVisible()) { + tipShell.setVisible(false); + } + tipWidget = null; + } + + @Override + public void mouseHover(MouseEvent event) { + widgetPosition = new Point(event.x, event.y); + Widget widget = event.widget; + if (widget instanceof ToolBar) { + ToolBar w = (ToolBar) widget; + widget = w.getItem(widgetPosition); + } + if (widget instanceof Table) { + Table w = (Table) widget; + widget = w.getItem(widgetPosition); + } + if (widget instanceof Tree) { + Tree w = (Tree) widget; + widget = w.getItem(widgetPosition); + } + if (widget == null) { + tipShell.setVisible(false); + tipWidget = null; + return; + } + if (widget == tipWidget) + return; + tipWidget = widget; + tipPosition = control.toDisplay(widgetPosition); + String text = getToolTipText(widget); + Image image = getToolTipImage(widget); + if (text == null) { // HACK: don't check length + return; + } + + if (tipShell.getShell() != null && tipShell.getShell().getParent() != null + && Display.getCurrent().getActiveShell() != null + && tipShell.getShell().getParent() != Display.getCurrent().getActiveShell()) { + tipShell.close(); + tipShell = createTipShell(Display.getCurrent().getActiveShell()); + } + + tipLabelText.setText(text); + tipLabelImage.setImage(image); // accepts null + tipShell.pack(); + setHoverLocation(tipShell, tipPosition); + tipShell.setVisible(true); + } + }); + // /* + // * Trap F1 Help to pop up a custom help box + // */ + // control.addHelpListener(new HelpListener() { + // public void helpRequested(HelpEvent event) { + // if (tipWidget == null) + // return; + // Object help = getToolTipHelp(tipWidget); + // if (help == null) + // return; + // if (help.getClass() != String.class) { + // return; + // } + // if (tipShell.isVisible()) { + // tipShell.setVisible(false); + // Shell helpShell = new Shell(parentShell, SWT.SHELL_TRIM); + // helpShell.setLayout(new FillLayout()); + // Label label = new Label(helpShell, SWT.NONE); + // label.setText((String) help); + // helpShell.pack(); + // setHoverLocation(helpShell, tipPosition); + // helpShell.open(); + // } + // } + // }); + } + + /** + * Sets the location for a hovering shell + * + * @param shell + * the object that is to hover + * @param position + * the position of a widget to hover over + * @return the top-left location for a hovering box + */ + private void setHoverLocation(Shell shell, Point position) { + Rectangle displayBounds = shell.getDisplay().getBounds(); + Rectangle shellBounds = shell.getBounds(); + shellBounds.x = Math.max(Math.min(position.x, displayBounds.width - shellBounds.width), 0); + shellBounds.y = Math.max(Math.min(position.y + 10, displayBounds.height - shellBounds.height), 0); + shell.setBounds(shellBounds); + } +} |