Java tutorial
/******************************************************************************* * Copyright (c) 2004, 2008 John Krasnay 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: * John Krasnay - initial implementation * Holger Voormann * Igor Jacy Lino Campista - Java 5 warnings fixed (bug 311325) *******************************************************************************/ package org.eclipse.vex.ui.internal.swt; import java.text.MessageFormat; import java.util.Collections; import java.util.Comparator; import java.util.LinkedList; import java.util.List; import org.eclipse.core.runtime.QualifiedName; import org.eclipse.jface.dialogs.IDialogSettings; import org.eclipse.jface.dialogs.PopupDialog; import org.eclipse.jface.layout.GridDataFactory; import org.eclipse.jface.layout.GridLayoutFactory; import org.eclipse.jface.preference.JFacePreferences; import org.eclipse.jface.resource.JFaceResources; import org.eclipse.jface.viewers.ArrayContentProvider; import org.eclipse.jface.viewers.ISelection; import org.eclipse.jface.viewers.StructuredSelection; import org.eclipse.jface.viewers.StyledCellLabelProvider; import org.eclipse.jface.viewers.StyledString; import org.eclipse.jface.viewers.StyledString.Styler; import org.eclipse.jface.viewers.TableViewer; import org.eclipse.jface.viewers.ViewerCell; import org.eclipse.jface.window.Window; import org.eclipse.swt.SWT; import org.eclipse.swt.events.KeyAdapter; import org.eclipse.swt.events.KeyEvent; import org.eclipse.swt.events.ModifyEvent; import org.eclipse.swt.events.ModifyListener; import org.eclipse.swt.events.MouseAdapter; import org.eclipse.swt.events.MouseEvent; import org.eclipse.swt.events.SelectionAdapter; import org.eclipse.swt.events.SelectionEvent; 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.TextStyle; import org.eclipse.swt.widgets.Composite; import org.eclipse.swt.widgets.Control; import org.eclipse.swt.widgets.Display; import org.eclipse.swt.widgets.Label; import org.eclipse.swt.widgets.Text; import org.eclipse.vex.core.internal.core.ElementName; import org.eclipse.vex.core.internal.widget.swt.VexWidget; import org.eclipse.vex.core.provisional.dom.ContentPosition; import org.eclipse.vex.core.provisional.dom.IElement; import org.eclipse.vex.ui.internal.Icon; import org.eclipse.vex.ui.internal.Messages; import org.eclipse.vex.ui.internal.VexPlugin; /** * Content assist dialog that is popped up to show a list of actions to select from. The input field at the top above * the list could be used to filter the content. */ public class ContentAssist extends PopupDialog { private static final String SETTINGS_SECTION = "contentAssistant"; //$NON-NLS-1$ private final VexWidget vexWidget; private final AbstractVexAction[] actions; private final boolean autoExecute; private final Point location; private Text textWidget; private TableViewer viewer; private Font boldFont; /** * Constructs a new content assist dialog which can be opened by {@link #open()}. * * @param vexWidget * the vex widget this content assist belongs to * @param actions * list of actions to select from * @param autoExecute * if {@code true} and if there is only one action then {@link #open()} does not show dialog but executes * the only action */ private ContentAssist(final VexWidget vexWidget, final AbstractVexAction[] actions, final boolean autoExecute) { super(vexWidget.getShell(), SWT.RESIZE, true, // take focus on open false, // persist size false, // persist location false, // show dialog menu false, // show persist actions null, // title null); // footer line this.vexWidget = vexWidget; this.actions = actions; this.autoExecute = autoExecute; location = vexWidget.toDisplay(vexWidget.getLocationForContentAssist()); } @Override public int open() { if (autoExecute && actions.length == 1) { actions[0].execute(vexWidget); return Window.OK; } return super.open(); } @Override protected IDialogSettings getDialogSettings() { final IDialogSettings root = VexPlugin.getDefault().getDialogSettings(); IDialogSettings settings = root.getSection(SETTINGS_SECTION); if (settings == null) { settings = root.addNewSection(SETTINGS_SECTION); } return settings; } @Override protected Color getForeground() { return JFaceResources.getColorRegistry().get(JFacePreferences.CONTENT_ASSIST_FOREGROUND_COLOR); } @Override protected Color getBackground() { return JFaceResources.getColorRegistry().get(JFacePreferences.CONTENT_ASSIST_BACKGROUND_COLOR); } @Override protected Control createDialogArea(final Composite parent) { // dialog area panel final Composite composite = new Composite(parent, SWT.NONE); GridLayoutFactory.fillDefaults().extendedMargins(0, 0, 4, 0).applyTo(composite); // 1. input field textWidget = new Text(composite, SWT.SINGLE); GridDataFactory.fillDefaults().grab(true, false).applyTo(textWidget); textWidget.addModifyListener(new ModifyListener() { @Override public void modifyText(final ModifyEvent e) { repopulateList(); } }); textWidget.addKeyListener(new KeyAdapter() { @Override public void keyPressed(final KeyEvent e) { if (e.keyCode == SWT.CR) { doAction(); } else if (e.widget == textWidget && e.keyCode == SWT.ARROW_DOWN) { viewer.getControl().setFocus(); } } }); // 2. separator final int separatorStyle = SWT.SEPARATOR | SWT.HORIZONTAL | SWT.LINE_DOT; final Label separator = new Label(composite, separatorStyle); GridDataFactory.fillDefaults().grab(true, false).applyTo(separator); // 3. list of proposals viewer = new TableViewer(composite, SWT.H_SCROLL | SWT.V_SCROLL); final Control viewerControl = viewer.getControl(); GridDataFactory.fillDefaults().grab(true, false).hint(SWT.DEFAULT, 300).applyTo(viewerControl); boldFont = getModifiedFont(viewerControl.getFont(), SWT.BOLD); viewer.setLabelProvider(new MyLabelProvider()); viewer.setContentProvider(new ArrayContentProvider()); viewer.getTable().addSelectionListener(new SelectionAdapter() { @Override public void widgetDefaultSelected(final SelectionEvent e) { doAction(); } }); viewer.getTable().addMouseListener(new MouseAdapter() { @Override public void mouseUp(final MouseEvent e) { if (e.button == 1) { doAction(); } } }); // fill with content repopulateList(); return composite; } @Override protected Point getDefaultLocation(final Point initialSize) { return location; } @Override public boolean close() { if (boldFont != null) { boldFont.dispose(); } return super.close(); } /** * Perform the action that is currently selected in the tree view, if any, and close the dialog. */ private void doAction() { final ISelection selection = viewer.getSelection(); if (selection instanceof StructuredSelection) { final Object first = ((StructuredSelection) selection).getFirstElement(); if (first instanceof AbstractVexAction) { ((AbstractVexAction) first).execute(vexWidget); } } close(); } private void repopulateList() { final String filterText = textWidget.getText().toLowerCase(); final List<AbstractVexAction> actionList = new LinkedList<AbstractVexAction>(); for (final AbstractVexAction action : actions) { if (action.getText().toLowerCase().contains(filterText)) { actionList.add(action); } } // primary order: "start with" before "contains" filter text if (filterText.length() > 0) { Collections.sort(actionList, new Comparator<AbstractVexAction>() { @Override public int compare(final AbstractVexAction action1, final AbstractVexAction action2) { final String actionText1 = action1.getElementName().getLocalName().toLowerCase(); final String actionText2 = action2.getElementName().getLocalName().toLowerCase(); if (!actionText1.startsWith(filterText) && !actionText2.startsWith(filterText)) { return 0; } return actionText1.startsWith(filterText) ? -1 : 1; } }); } // update UI viewer.setInput(actionList.toArray(new AbstractVexAction[actionList.size()])); viewer.getTable().setSelection(0); } private class MyLabelProvider extends StyledCellLabelProvider { private final Styler boldStyler = new Styler() { @Override public void applyStyles(final TextStyle textStyle) { textStyle.font = boldFont; } }; @Override public void update(final ViewerCell cell) { final AbstractVexAction action = (AbstractVexAction) cell.getElement(); final String filterText = textWidget.getText(); final String text = action.getText(); StyledString styledString = new StyledString(action.getText()); // show matching text in bold if (text.contains(filterText)) { final int start = text.indexOf(filterText); final int end = start + filterText.length(); styledString = new StyledString(text.substring(0, start)); styledString.append(text.substring(start, end), boldStyler); styledString.append(text.substring(end)); } cell.setText(styledString.toString()); cell.setStyleRanges(styledString.getStyleRanges()); cell.setImage(Icon.get(action.getImage())); super.update(cell); } } private static abstract class AbstractVexAction { private final VexWidget widget; private final ElementName elementName; private final String text; private final Icon image; public AbstractVexAction(final VexWidget widget, final ElementName elementName, final String text, final Icon image) { this.widget = widget; this.elementName = elementName; this.text = text; this.image = image; } abstract void execute(VexWidget vexWidget); public VexWidget getWidget() { return widget; } public ElementName getElementName() { return elementName; } public String getText() { return text; } public Icon getImage() { return image; } } /** * Shows the content assist to add a new element. * * @param widget * the VexWidget which hosts the content assist */ public static void openAddElementsContentAssist(final VexWidget widget) { final AbstractVexAction[] addActions = computeAddElementsActions(widget); final ContentAssist assist = new ContentAssist(widget, addActions, true); assist.open(); } /** * Shows the content assist to convert current element. * * @param widget * the VexWidget which hosts the content assist */ public static void openQuickFixContentAssist(final VexWidget widget) { final AbstractVexAction[] quickFixActions = computeQuickFixActions(widget); final ContentAssist assist = new ContentAssist(widget, quickFixActions, true); assist.open(); } private static AbstractVexAction[] computeAddElementsActions(final VexWidget widget) { final ElementName[] names = widget.getValidInsertElements(); final AbstractVexAction[] actions = new AbstractVexAction[names.length]; for (int i = 0; i < names.length; i++) { final QualifiedName qualifiedName = names[i].getQualifiedName(); actions[i] = new AbstractVexAction(widget, names[i], names[i].toString(), Icon.ELEMENT) { @Override public void execute(final VexWidget vexWidget) { getWidget().insertElement(qualifiedName); } }; } return actions; } private static AbstractVexAction[] computeQuickFixActions(final VexWidget widget) { final ElementName[] names = widget.getValidMorphElements(); final AbstractVexAction[] actions = new AbstractVexAction[names.length]; final ContentPosition caretPosition = widget.getCaretPosition(); final IElement element = widget.getDocument().getElementForInsertionAt(caretPosition.getOffset()); final String sourceName = element.getPrefixedName(); for (int i = 0; i < names.length; i++) { final QualifiedName qualifiedName = names[i].getQualifiedName(); final String message = Messages.getString("command.convertElement.dynamicCommandName"); //$NON-NLS-1$ final String text = MessageFormat.format(message, sourceName, names[i]); final Icon icon = Icon.CONVERT; actions[i] = new AbstractVexAction(widget, names[i], text, icon) { @Override public void execute(final VexWidget vexWidget) { getWidget().morph(qualifiedName); } }; } return actions; } private static Font getModifiedFont(final Font baseFont, final int additionalStyle) { final FontData[] baseData = baseFont.getFontData(); final FontData[] styleData = new FontData[baseData.length]; for (int i = 0; i < styleData.length; i++) { final FontData data = baseData[i]; styleData[i] = new FontData(data.getName(), data.getHeight(), data.getStyle() | additionalStyle); } return new Font(Display.getCurrent(), styleData); } }