| /******************************************************************************* |
| * Copyright (c) 2004, 2008 Tasktop Technologies 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: |
| * Tasktop Technologies - initial API and implementation |
| *******************************************************************************/ |
| |
| package org.eclipse.mylyn.internal.tasks.ui.editors; |
| |
| import java.lang.reflect.Field; |
| import java.lang.reflect.Method; |
| import java.text.DateFormat; |
| import java.util.Date; |
| |
| import org.eclipse.jface.resource.JFaceResources; |
| import org.eclipse.jface.text.ITextOperationTarget; |
| import org.eclipse.jface.text.TextViewer; |
| import org.eclipse.jface.window.Window; |
| import org.eclipse.mylyn.internal.provisional.commons.ui.CommonTextSupport; |
| import org.eclipse.mylyn.internal.tasks.ui.util.TasksUiInternal; |
| import org.eclipse.mylyn.internal.tasks.ui.wizards.NewAttachmentWizardDialog; |
| import org.eclipse.mylyn.internal.tasks.ui.wizards.TaskAttachmentWizard.Mode; |
| import org.eclipse.mylyn.tasks.core.data.AbstractTaskAttachmentSource; |
| import org.eclipse.mylyn.tasks.core.data.TaskAttribute; |
| import org.eclipse.mylyn.tasks.core.data.TaskAttributeMapper; |
| import org.eclipse.mylyn.tasks.ui.editors.AbstractTaskEditorPage; |
| import org.eclipse.swt.custom.CTabFolder; |
| import org.eclipse.swt.custom.ScrolledComposite; |
| import org.eclipse.swt.events.DisposeEvent; |
| import org.eclipse.swt.events.DisposeListener; |
| import org.eclipse.swt.graphics.Font; |
| import org.eclipse.swt.layout.RowLayout; |
| import org.eclipse.swt.widgets.Composite; |
| import org.eclipse.swt.widgets.Control; |
| import org.eclipse.swt.widgets.Display; |
| import org.eclipse.swt.widgets.Menu; |
| import org.eclipse.swt.widgets.Widget; |
| import org.eclipse.ui.actions.ActionFactory; |
| import org.eclipse.ui.forms.IManagedForm; |
| import org.eclipse.ui.forms.editor.IFormPage; |
| import org.eclipse.ui.forms.widgets.ExpandableComposite; |
| import org.eclipse.ui.forms.widgets.ScrolledForm; |
| import org.eclipse.ui.forms.widgets.Section; |
| import org.eclipse.ui.forms.widgets.SharedScrolledComposite; |
| import org.eclipse.ui.internal.forms.widgets.FormUtil; |
| |
| public class EditorUtil { |
| |
| // public static final String DATE_FORMAT = "yyyy-MM-dd"; |
| // |
| // public static final String DATE_TIME_FORMAT = "yyyy-MM-dd HH:mm"; |
| |
| static final String KEY_MARKER = "marker"; //$NON-NLS-1$ |
| |
| static final String KEY_DISABLED = "org.eclipse.mylyn.tasks.ui.disabled"; //$NON-NLS-1$ |
| |
| static final String KEY_TEXT_VIEWER = "textViewer"; //$NON-NLS-1$ |
| |
| public static final int MAXIMUM_HEIGHT = 140; |
| |
| public static final int MAXIMUM_WIDTH = 500; |
| |
| // XXX why is this required? |
| public static final Font TEXT_FONT = JFaceResources.getDefaultFont(); |
| |
| public static final String KEY_TOGGLE_TO_MAXIMIZE_ACTION = "maximizeAction"; //$NON-NLS-1$ |
| |
| static boolean canDoGlobalAction(String actionId, TextViewer textViewer) { |
| if (actionId.equals(ActionFactory.CUT.getId())) { |
| return textViewer.canDoOperation(ITextOperationTarget.CUT); |
| } else if (actionId.equals(ActionFactory.COPY.getId())) { |
| return textViewer.canDoOperation(ITextOperationTarget.COPY); |
| } else if (actionId.equals(ActionFactory.PASTE.getId())) { |
| return textViewer.canDoOperation(ITextOperationTarget.PASTE); |
| } else if (actionId.equals(ActionFactory.DELETE.getId())) { |
| return textViewer.canDoOperation(ITextOperationTarget.DELETE); |
| } else if (actionId.equals(ActionFactory.UNDO.getId())) { |
| return textViewer.canDoOperation(ITextOperationTarget.UNDO); |
| } else if (actionId.equals(ActionFactory.REDO.getId())) { |
| return textViewer.canDoOperation(ITextOperationTarget.REDO); |
| } else if (actionId.equals(ActionFactory.SELECT_ALL.getId())) { |
| return textViewer.canDoOperation(ITextOperationTarget.SELECT_ALL); |
| } |
| return false; |
| } |
| |
| /** |
| * @deprecated use {@link CommonTextSupport#canPerformAction(String, Control)} instead |
| */ |
| @Deprecated |
| public static boolean canPerformAction(String actionId, Control focusControl) { |
| return CommonTextSupport.canPerformAction(actionId, focusControl); |
| } |
| |
| /** |
| * @deprecated use {@link CommonTextSupport#doAction(String, Control)} instead |
| */ |
| @Deprecated |
| public static void doAction(String actionId, Control focusControl) { |
| CommonTextSupport.doAction(actionId, focusControl); |
| } |
| |
| private static Control findControl(Composite composite, String key) { |
| if (!composite.isDisposed()) { |
| for (Control child : composite.getChildren()) { |
| if (key.equals(getMarker(child))) { |
| return child; |
| } |
| if (child instanceof Composite) { |
| Control found = findControl((Composite) child, key); |
| if (found != null) { |
| return found; |
| } |
| } |
| } |
| } |
| return null; |
| } |
| |
| /** |
| * Scroll to a specified piece of text |
| * |
| * @param control |
| * The StyledText to scroll to |
| */ |
| private static void focusOn(ScrolledForm form, Control control) { |
| int pos = 0; |
| control.setEnabled(true); |
| control.setFocus(); |
| control.forceFocus(); |
| while (control != null && control != form.getBody()) { |
| pos += control.getLocation().y; |
| control = control.getParent(); |
| } |
| |
| pos = pos - 60; // form.getOrigin().y; |
| if (!form.getBody().isDisposed()) { |
| form.setOrigin(0, pos); |
| } |
| } |
| |
| static DateFormat getDateFormat() { |
| return DateFormat.getDateInstance(DateFormat.MEDIUM); |
| } |
| |
| static String formatDate(Date date) { |
| return getDateFormat().format(date); |
| } |
| |
| static String formatDateTime(Date date) { |
| return getDateTimeFormat().format(date); |
| } |
| |
| static DateFormat getDateTimeFormat() { |
| return DateFormat.getDateTimeInstance(DateFormat.MEDIUM, DateFormat.SHORT); |
| } |
| |
| public static Control getFocusControl(IFormPage page) { |
| if (page == null) { |
| return null; |
| } |
| IManagedForm form = page.getManagedForm(); |
| if (form == null) { |
| return null; |
| } |
| Control control = form.getForm(); |
| if (control == null || control.isDisposed()) { |
| return null; |
| } |
| Display display = control.getDisplay(); |
| Control focusControl = display.getFocusControl(); |
| if (focusControl == null || focusControl.isDisposed()) { |
| return null; |
| } |
| return focusControl; |
| } |
| |
| public static String getMarker(Widget widget) { |
| return (String) widget.getData(KEY_MARKER); |
| } |
| |
| /** |
| * @deprecated use {@link CommonTextSupport#getTextViewer(Widget)} instead |
| */ |
| @Deprecated |
| public static TextViewer getTextViewer(Widget widget) { |
| return CommonTextSupport.getTextViewer(widget); |
| } |
| |
| public static NewAttachmentWizardDialog openNewAttachmentWizard(final AbstractTaskEditorPage page, Mode mode, |
| AbstractTaskAttachmentSource source) { |
| TaskAttributeMapper mapper = page.getModel().getTaskData().getAttributeMapper(); |
| TaskAttribute attribute = mapper.createTaskAttachment(page.getModel().getTaskData()); |
| final NewAttachmentWizardDialog dialog = TasksUiInternal.openNewAttachmentWizard(page.getSite().getShell(), |
| page.getTaskRepository(), page.getTask(), attribute, mode, source); |
| dialog.getShell().addDisposeListener(new DisposeListener() { |
| |
| public void widgetDisposed(DisposeEvent e) { |
| if (dialog.getReturnCode() == Window.OK) { |
| page.getTaskEditor().refreshPages(); |
| } |
| } |
| |
| }); |
| return dialog; |
| } |
| |
| /** |
| * Selects the given object in the editor. |
| * |
| * @param o |
| * The object to be selected. |
| * @param highlight |
| * Whether or not the object should be highlighted. |
| */ |
| public static boolean reveal(ScrolledForm form, String key) { |
| Control control = findControl(form.getBody(), key); |
| if (control != null) { |
| // expand all children |
| if (control instanceof ExpandableComposite) { |
| ExpandableComposite ex = (ExpandableComposite) control; |
| if (!ex.isExpanded()) { |
| toggleExpandableComposite(true, ex); |
| } |
| } |
| |
| // expand all parents of control |
| Composite comp = control.getParent(); |
| while (comp != null) { |
| if (comp instanceof Section) { |
| if (!((Section) comp).isExpanded()) { |
| ((Section) comp).setExpanded(true); |
| } |
| } else if (comp instanceof ExpandableComposite) { |
| ExpandableComposite ex = (ExpandableComposite) comp; |
| if (!ex.isExpanded()) { |
| toggleExpandableComposite(true, ex); |
| } |
| |
| // HACK: This is necessary |
| // due to a bug in SWT's ExpandableComposite. |
| // 165803: Expandable bars should expand when clicking anywhere |
| // https://bugs.eclipse.org/bugs/show_bug.cgi?taskId=165803 |
| if (ex.getData() != null && ex.getData() instanceof Composite) { |
| ((Composite) ex.getData()).setVisible(true); |
| } |
| } |
| comp = comp.getParent(); |
| } |
| focusOn(form, control); |
| } |
| return true; |
| } |
| |
| public static void setEnabledState(Composite composite, boolean enabled) { |
| if (enabled) { |
| enable(composite); |
| } else { |
| disable(composite); |
| } |
| } |
| |
| private static void disable(Composite composite) { |
| if (!composite.isDisposed()) { |
| if (!composite.getEnabled()) { |
| composite.setData(KEY_DISABLED, Boolean.TRUE); |
| } else { |
| composite.setEnabled(false); |
| } |
| for (Control control : composite.getChildren()) { |
| if (control instanceof Composite) { |
| disable((Composite) control); |
| } else { |
| if (!control.getEnabled()) { |
| control.setData(KEY_DISABLED, Boolean.TRUE); |
| } else { |
| control.setEnabled(false); |
| } |
| } |
| } |
| } |
| } |
| |
| private static void enable(Composite composite) { |
| if (!composite.isDisposed()) { |
| if (composite.getData(KEY_DISABLED) == null) { |
| composite.setEnabled(true); |
| } else { |
| composite.setData(KEY_DISABLED, null); |
| } |
| for (Control control : composite.getChildren()) { |
| if (control instanceof Composite) { |
| enable((Composite) control); |
| } else { |
| if (control.getData(KEY_DISABLED) == null) { |
| control.setEnabled(true); |
| } else { |
| control.setData(KEY_DISABLED, null); |
| } |
| } |
| } |
| } |
| } |
| |
| public static void setMarker(Widget widget, String text) { |
| widget.setData(KEY_MARKER, text); |
| } |
| |
| /** |
| * @deprecated use {@link CommonTextSupport#setTextViewer(Widget, TextViewer)} instead |
| */ |
| @Deprecated |
| public static void setTextViewer(Widget widget, TextViewer textViewer) { |
| CommonTextSupport.setTextViewer(widget, textViewer); |
| } |
| |
| /** |
| * Programmatically expand the provided ExpandableComposite, using reflection to fire the expansion listeners (see |
| * bug#70358) |
| * |
| * @param comp |
| */ |
| public static void toggleExpandableComposite(boolean expanded, ExpandableComposite comp) { |
| if (comp.isExpanded() != expanded) { |
| Method method = null; |
| try { |
| method = ExpandableComposite.class.getDeclaredMethod("programmaticToggleState"); //$NON-NLS-1$ |
| method.setAccessible(true); |
| method.invoke(comp); |
| } catch (Exception e) { |
| // ignore |
| } |
| } |
| } |
| |
| public static void disableScrollingOnFocus(ScrolledForm form) { |
| form.setData(FormUtil.FOCUS_SCROLLING, Boolean.FALSE); |
| } |
| |
| public static void ensureVisible(Control control) { |
| ScrolledComposite form = FormUtil.getScrolledComposite(control); |
| if (form != null) { |
| FormUtil.ensureVisible(form, control); |
| } |
| } |
| |
| // copied from Section.reflow() |
| public static void reflow(Control control) { |
| Composite c = control.getParent(); |
| while (c != null) { |
| c.setRedraw(false); |
| c = c.getParent(); |
| if (c instanceof SharedScrolledComposite) { |
| break; |
| } |
| } |
| c = control.getParent(); |
| while (c != null) { |
| c.layout(true); |
| c = c.getParent(); |
| if (c instanceof SharedScrolledComposite) { |
| ((SharedScrolledComposite) c).reflow(true); |
| break; |
| } |
| } |
| c = control.getParent(); |
| while (c != null) { |
| c.setRedraw(true); |
| c = c.getParent(); |
| if (c instanceof SharedScrolledComposite) { |
| break; |
| } |
| } |
| } |
| |
| public static Composite getLayoutAdvisor(AbstractTaskEditorPage page) { |
| Composite layoutAdvisor = page.getEditorComposite(); |
| do { |
| layoutAdvisor = layoutAdvisor.getParent(); |
| } while (!(layoutAdvisor instanceof CTabFolder)); |
| return layoutAdvisor.getParent(); |
| } |
| |
| /** |
| * Recursively sets the menu of all children of <code>composite</code>. |
| */ |
| public static void setMenu(Composite composite, Menu menu) { |
| if (!composite.isDisposed()) { |
| composite.setMenu(menu); |
| for (Control child : composite.getChildren()) { |
| child.setMenu(menu); |
| if (child instanceof Composite) { |
| setMenu((Composite) child, menu); |
| } |
| } |
| } |
| } |
| |
| // TODO e3.4 replace reflection by assignment to RowLayout.center |
| public static void center(RowLayout rowLayout) { |
| try { |
| Field field = RowLayout.class.getDeclaredField("center"); //$NON-NLS-1$ |
| field.set(rowLayout, Boolean.TRUE); |
| } catch (Throwable e) { |
| // ignore |
| } |
| } |
| |
| } |
