Java tutorial
/******************************************************************************* * Copyright (c) 2000, 2012 IBM Corporation 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: * IBM Corporation - initial API and implementation *******************************************************************************/ package com.redhat.ceylon.eclipse.code.outline; import static org.eclipse.ui.IWorkbenchCommandConstants.WINDOW_SHOW_VIEW_MENU; import org.eclipse.jface.action.Action; import org.eclipse.jface.action.IAction; import org.eclipse.jface.action.IMenuManager; import org.eclipse.jface.dialogs.Dialog; import org.eclipse.jface.dialogs.IDialogSettings; import org.eclipse.jface.dialogs.PopupDialog; import org.eclipse.jface.layout.GridLayoutFactory; import org.eclipse.jface.text.IInformationControl; import org.eclipse.jface.text.IInformationControlExtension; import org.eclipse.jface.text.IInformationControlExtension2; import org.eclipse.jface.text.IInformationControlExtension3; import org.eclipse.jface.viewers.IStructuredSelection; import org.eclipse.jface.viewers.ITreeContentProvider; import org.eclipse.jface.viewers.StructuredSelection; import org.eclipse.jface.viewers.TreeViewer; import org.eclipse.jface.viewers.Viewer; import org.eclipse.jface.viewers.ViewerFilter; import org.eclipse.swt.SWT; import org.eclipse.swt.events.DisposeEvent; import org.eclipse.swt.events.DisposeListener; import org.eclipse.swt.events.FocusListener; import org.eclipse.swt.events.KeyEvent; import org.eclipse.swt.events.KeyListener; 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.MouseMoveListener; import org.eclipse.swt.events.SelectionEvent; import org.eclipse.swt.events.SelectionListener; import org.eclipse.swt.graphics.Color; import org.eclipse.swt.graphics.Point; import org.eclipse.swt.graphics.Rectangle; import org.eclipse.swt.layout.GridData; import org.eclipse.swt.widgets.Composite; import org.eclipse.swt.widgets.Control; import org.eclipse.swt.widgets.Item; import org.eclipse.swt.widgets.Label; import org.eclipse.swt.widgets.Shell; import org.eclipse.swt.widgets.Text; import org.eclipse.swt.widgets.Tree; import org.eclipse.swt.widgets.TreeItem; import org.eclipse.ui.PlatformUI; import org.eclipse.ui.commands.ActionHandler; import org.eclipse.ui.commands.HandlerSubmission; import org.eclipse.ui.commands.Priority; import com.redhat.ceylon.compiler.typechecker.model.Declaration; import com.redhat.ceylon.compiler.typechecker.tree.Node; import com.redhat.ceylon.compiler.typechecker.tree.Tree.Identifier; import com.redhat.ceylon.eclipse.code.editor.CeylonEditor; import com.redhat.ceylon.eclipse.ui.CeylonPlugin; /** * Abstract class for Show hierarchy in light-weight controls. * * @since 2.1 */ public abstract class TreeViewPopup extends PopupDialog implements IInformationControl, IInformationControlExtension, IInformationControlExtension2, IInformationControlExtension3, DisposeListener { private static GridLayoutFactory popupLayoutFactory; protected static GridLayoutFactory getPopupLayout() { if (popupLayoutFactory == null) { popupLayoutFactory = GridLayoutFactory.fillDefaults().margins(POPUP_MARGINWIDTH, POPUP_MARGINHEIGHT) .spacing(POPUP_HORIZONTALSPACING, POPUP_VERTICALSPACING); } return popupLayoutFactory; } protected CeylonEditor editor; /** * The NamePatternFilter selects the elements which * match the given string patterns. * * @since 2.0 */ protected class NamePatternFilter extends ViewerFilter { @Override public boolean select(Viewer viewer, Object parentElement, Object element) { /*JavaElementPrefixPatternMatcher matcher= getMatcher(); if (matcher == null || !(viewer instanceof TreeViewer)) return true; TreeViewer treeViewer= (TreeViewer) viewer; String matchName= ((ILabelProvider) treeViewer.getLabelProvider()).getText(element); matchName= TextProcessor.deprocess(matchName); if (matchName != null && matcher.matches(matchName)) return true; return hasUnfilteredChild(treeViewer, element);*/ //TODO: refactor down to OutlinePopup TreeViewer treeViewer = (TreeViewer) viewer; if (element instanceof CeylonOutlineNode) { Node node = ((CeylonOutlineNode) element).getTreeNode(); if (node instanceof com.redhat.ceylon.compiler.typechecker.tree.Tree.Declaration) { com.redhat.ceylon.compiler.typechecker.tree.Tree.Declaration dec = (com.redhat.ceylon.compiler.typechecker.tree.Tree.Declaration) node; Identifier id = dec.getIdentifier(); return id != null && id.getText().toLowerCase().startsWith(fFilterText.getText().toLowerCase()) || hasUnfilteredChild(treeViewer, element); } else { return false; } } //TODO: refactor down to HierarchyPopup else if (element instanceof CeylonHierarchyNode) { Declaration dec = ((CeylonHierarchyNode) element).getDeclaration(); String name = dec == null ? null : dec.getName(); return name != null && name.toLowerCase().startsWith(fFilterText.getText().toLowerCase()) || hasUnfilteredChild(treeViewer, element); } return true; } private boolean hasUnfilteredChild(TreeViewer viewer, Object element) { Object[] children = ((ITreeContentProvider) viewer.getContentProvider()).getChildren(element); for (int i = 0; i < children.length; i++) if (select(viewer, element, children[i])) return true; return false; } } /** The control's text widget */ protected Text fFilterText; /** The control's tree widget */ private TreeViewer fTreeViewer; /** The current string matcher */ //protected JavaElementPrefixPatternMatcher fPatternMatcher; //private ICommand fInvokingCommand; //private KeySequence[] fInvokingCommandKeySequences; /** * Fields that support the dialog menu * @since 3.0 * @since 3.2 - now appended to framework menu */ private Composite fViewMenuButtonComposite; //private CustomFiltersActionGroup fCustomFiltersActionGroup; private IAction fShowViewMenuAction; private HandlerSubmission fShowViewMenuHandlerSubmission; /** * Field for tree style since it must be remembered by the instance. * * @since 3.2 */ private int fTreeStyle; /** * The initially selected type. * @since 3.5 */ //protected IType fInitiallySelectedType; /** * Creates a tree information control with the given shell as parent. The given * styles are applied to the shell and the tree widget. * * @param parent the parent shell * @param shellStyle the additional styles for the shell * @param treeStyle the additional styles for the tree widget * @param invokingCommandId the id of the command that invoked this control or <code>null</code> * @param showStatusField <code>true</code> iff the control has a status field at the bottom */ public TreeViewPopup(Shell parent, int shellStyle, int treeStyle, /*String invokingCommandId,*/ CeylonEditor editor, Color color) { super(parent, shellStyle, true, true, false, true, true, null, null); this.editor = editor; /*if (invokingCommandId != null) { ICommandManager commandManager= PlatformUI.getWorkbench().getCommandSupport().getCommandManager(); fInvokingCommand= commandManager.getCommand(invokingCommandId); if (fInvokingCommand != null && !fInvokingCommand.isDefined()) fInvokingCommand= null; else // Pre-fetch key sequence - do not change because scope will change later. getInvokingCommandKeySequences(); }*/ fTreeStyle = treeStyle; // Title and status text must be set to get the title label created, so force empty values here. if (hasHeader()) setTitleText(""); //$NON-NLS-1$ setInfoText(""); // //$NON-NLS-1$ // Create all controls early to preserve the life cycle of the original implementation. create(); getShell().setBackground(color); setBackgroundColor(color); // Status field text can only be computed after widgets are created. setInfoText(getStatusFieldText()); } /** * Create the main content for this information control. * * @param parent The parent composite * @return The control representing the main content. * @since 3.2 */ @Override protected Control createDialogArea(Composite parent) { fTreeViewer = createTreeViewer(parent, fTreeStyle); //fCustomFiltersActionGroup= new CustomFiltersActionGroup(getId(), fTreeViewer); final Tree tree = fTreeViewer.getTree(); tree.addKeyListener(new KeyListener() { public void keyPressed(KeyEvent e) { if (e.character == 0x1B) // ESC dispose(); } public void keyReleased(KeyEvent e) { // do nothing } }); tree.addSelectionListener(new SelectionListener() { public void widgetSelected(SelectionEvent e) { // do nothing } public void widgetDefaultSelected(SelectionEvent e) { gotoSelectedElement(); } }); tree.addMouseMoveListener(new MouseMoveListener() { TreeItem fLastItem = null; public void mouseMove(MouseEvent e) { if (tree.equals(e.getSource())) { Object o = tree.getItem(new Point(e.x, e.y)); if (fLastItem == null ^ o == null) { tree.setCursor(o == null ? null : tree.getDisplay().getSystemCursor(SWT.CURSOR_HAND)); } if (o instanceof TreeItem) { Rectangle clientArea = tree.getClientArea(); if (!o.equals(fLastItem)) { fLastItem = (TreeItem) o; tree.setSelection(new TreeItem[] { fLastItem }); } else if (e.y - clientArea.y < tree.getItemHeight() / 4) { // Scroll up Point p = tree.toDisplay(e.x, e.y); Item item = fTreeViewer.scrollUp(p.x, p.y); if (item instanceof TreeItem) { fLastItem = (TreeItem) item; tree.setSelection(new TreeItem[] { fLastItem }); } } else if (clientArea.y + clientArea.height - e.y < tree.getItemHeight() / 4) { // Scroll down Point p = tree.toDisplay(e.x, e.y); Item item = fTreeViewer.scrollDown(p.x, p.y); if (item instanceof TreeItem) { fLastItem = (TreeItem) item; tree.setSelection(new TreeItem[] { fLastItem }); } } } else if (o == null) { fLastItem = null; } } } }); tree.addMouseListener(new MouseAdapter() { @Override public void mouseUp(MouseEvent e) { if (tree.getSelectionCount() < 1) return; if (e.button != 1) return; if (tree.equals(e.getSource())) { Object o = tree.getItem(new Point(e.x, e.y)); TreeItem selection = tree.getSelection()[0]; if (selection.equals(o)) gotoSelectedElement(); } } }); installFilter(); addDisposeListener(this); return fTreeViewer.getControl(); } protected abstract TreeViewer createTreeViewer(Composite parent, int style); /** * Returns the name of the dialog settings section. * * @return the name of the dialog settings section */ protected abstract String getId(); protected TreeViewer getTreeViewer() { return fTreeViewer; } /** * Returns <code>true</code> if the control has a header, <code>false</code> otherwise. * <p> * The default is to return <code>false</code>. * </p> * * @return <code>true</code> if the control has a header */ protected boolean hasHeader() { // default is to have no header return true; } protected Text getFilterText() { return fFilterText; } protected Text createFilterText(Composite parent) { fFilterText = new Text(parent, SWT.NONE); Dialog.applyDialogFont(fFilterText); GridData data = new GridData(GridData.FILL_HORIZONTAL); data.horizontalAlignment = GridData.FILL; data.verticalAlignment = GridData.CENTER; fFilterText.setLayoutData(data); fFilterText.addKeyListener(new KeyListener() { public void keyPressed(KeyEvent e) { if (e.keyCode == 0x0D || e.keyCode == SWT.KEYPAD_CR) // Enter key gotoSelectedElement(); if (e.keyCode == SWT.ARROW_DOWN) fTreeViewer.getTree().setFocus(); if (e.keyCode == SWT.ARROW_UP) fTreeViewer.getTree().setFocus(); if (e.character == 0x1B) // ESC dispose(); } public void keyReleased(KeyEvent e) { // do nothing } }); return fFilterText; } protected void createHorizontalSeparator(Composite parent) { Label separator = new Label(parent, SWT.SEPARATOR | SWT.HORIZONTAL | SWT.LINE_DOT); separator.setLayoutData(new GridData(GridData.FILL_HORIZONTAL)); } protected void updateStatusFieldText() { setInfoText(getStatusFieldText()); } protected String getStatusFieldText() { return ""; } private void installFilter() { fFilterText.setText(""); fFilterText.addModifyListener(new ModifyListener() { public void modifyText(ModifyEvent e) { String text = ((Text) e.widget).getText(); setMatcherString(text, true); } }); } /** * The string matcher has been modified. The default implementation * refreshes the view and selects the first matched element */ protected void stringMatcherUpdated() { // refresh viewer to re-filter fTreeViewer.getControl().setRedraw(false); fTreeViewer.refresh(); fTreeViewer.expandAll(); selectFirstMatch(); fTreeViewer.getControl().setRedraw(true); } /** * Sets the patterns to filter out for the receiver. * * @param pattern the pattern * @param update <code>true</code> if the viewer should be updated * */ protected void setMatcherString(String pattern, boolean update) { /*if (pattern.length() == 0) { fPatternMatcher= null; } else { fPatternMatcher= new JavaElementPrefixPatternMatcher(pattern); }*/ if (update) stringMatcherUpdated(); } /*protected JavaElementPrefixPatternMatcher getMatcher() { return fPatternMatcher; }*/ /** * Implementers can modify * * @return the selected element */ protected Object getSelectedElement() { if (fTreeViewer == null) { return null; } else { return ((IStructuredSelection) fTreeViewer.getSelection()).getFirstElement(); } } protected abstract void gotoSelectedElement(); /** * Selects the first element in the tree which * matches the current filter pattern. */ protected void selectFirstMatch() { //Object selectedElement= fTreeViewer.testFindItem(fInitiallySelectedType); TreeItem element; final Tree tree = fTreeViewer.getTree(); /*if (selectedElement instanceof TreeItem) element= findElement(new TreeItem[] { (TreeItem)selectedElement }); else*/ element = findElement(tree.getItems()); if (element != null) { tree.setSelection(element); tree.showItem(element); } else fTreeViewer.setSelection(StructuredSelection.EMPTY); } private TreeItem findElement(TreeItem[] items) { return findElement(items, null, true); } private TreeItem findElement(TreeItem[] items, TreeItem[] toBeSkipped, boolean allowToGoUp) { return items.length > 0 ? items[0] : null; //TODO: reenable filtering /*if (fPatternMatcher == null) return items.length > 0 ? items[0] : null; ILabelProvider labelProvider= (ILabelProvider)fTreeViewer.getLabelProvider(); // First search at same level for (int i= 0; i < items.length; i++) { final TreeItem item= items[i]; IJavaElement element= (IJavaElement)item.getData(); if (element != null) { String label= labelProvider.getText(element); if (fPatternMatcher.matches(label)) return item; } } // Go one level down for each item for (int i= 0; i < items.length; i++) { final TreeItem item= items[i]; TreeItem foundItem= findElement(selectItems(item.getItems(), toBeSkipped), null, false); if (foundItem != null) return foundItem; } if (!allowToGoUp || items.length == 0) return null; // Go one level up (parent is the same for all items) TreeItem parentItem= items[0].getParentItem(); if (parentItem != null) return findElement(new TreeItem[] { parentItem }, items, true); // Check root elements return findElement(selectItems(items[0].getParent().getItems(), items), null, false);*/ } private boolean canSkip(TreeItem item, TreeItem[] toBeSkipped) { if (toBeSkipped == null) return false; for (int i = 0; i < toBeSkipped.length; i++) { if (toBeSkipped[i] == item) return true; } return false; } private TreeItem[] selectItems(TreeItem[] items, TreeItem[] toBeSkipped) { if (toBeSkipped == null || toBeSkipped.length == 0) return items; int j = 0; for (int i = 0; i < items.length; i++) { TreeItem item = items[i]; if (!canSkip(item, toBeSkipped)) items[j++] = item; } if (j == items.length) return items; TreeItem[] result = new TreeItem[j]; System.arraycopy(items, 0, result, 0, j); return result; } /** * {@inheritDoc} */ public void setInformation(String information) { // this method is ignored, see IInformationControlExtension2 } /** * {@inheritDoc} */ public abstract void setInput(Object information); /** * Fills the view menu. * Clients can extend or override. * * @param viewMenu the menu manager that manages the menu * @since 3.0 */ protected void fillViewMenu(IMenuManager viewMenu) { //fCustomFiltersActionGroup.fillViewMenu(viewMenu); } /* * Overridden to call the old framework method. * * @see org.eclipse.jface.dialogs.PopupDialog#fillDialogMenu(IMenuManager) * @since 3.2 */ @Override protected void fillDialogMenu(IMenuManager dialogMenu) { super.fillDialogMenu(dialogMenu); fillViewMenu(dialogMenu); } protected void inputChanged(Object newInput, Object newSelection) { fTreeViewer.setInput(newInput); if (newSelection != null) { fTreeViewer.setSelection(new StructuredSelection(newSelection)); } fFilterText.setText(""); } public void setVisible(boolean visible) { if (visible) { open(); } else { removeHandlerAndKeyBindingSupport(); saveDialogBounds(getShell()); getShell().setVisible(false); } } @Override public int open() { addHandlerAndKeyBindingSupport(); return super.open(); } public final void dispose() { close(); } public void widgetDisposed(DisposeEvent event) { removeHandlerAndKeyBindingSupport(); fTreeViewer = null; fFilterText = null; } protected void addHandlerAndKeyBindingSupport() { // Register action with command support if (fShowViewMenuHandlerSubmission == null) { fShowViewMenuHandlerSubmission = new HandlerSubmission(null, getShell(), null, fShowViewMenuAction.getActionDefinitionId(), new ActionHandler(fShowViewMenuAction), Priority.MEDIUM); PlatformUI.getWorkbench().getCommandSupport().addHandlerSubmission(fShowViewMenuHandlerSubmission); } } protected void removeHandlerAndKeyBindingSupport() { // Remove handler submission if (fShowViewMenuHandlerSubmission != null) PlatformUI.getWorkbench().getCommandSupport().removeHandlerSubmission(fShowViewMenuHandlerSubmission); } public boolean hasContents() { return fTreeViewer != null && fTreeViewer.getInput() != null; } public void setSizeConstraints(int maxWidth, int maxHeight) { // ignore } public Point computeSizeHint() { // return the shell's size - note that it already has the persisted size if persisting // is enabled. return getShell().getSize(); } public void setLocation(Point location) { /* * If the location is persisted, it gets managed by PopupDialog - fine. Otherwise, the location is * computed in Window#getInitialLocation, which will center it in the parent shell / main * monitor, which is wrong for two reasons: * - we want to center over the editor / subject control, not the parent shell * - the center is computed via the initalSize, which may be also wrong since the size may * have been updated since via min/max sizing of AbstractInformationControlManager. * In that case, override the location with the one computed by the manager. Note that * the call to constrainShellSize in PopupDialog.open will still ensure that the shell is * entirely visible. */ if (!getPersistLocation() || getDialogSettings() == null) getShell().setLocation(location); } public void setSize(int width, int height) { getShell().setSize(width, height); } public void addDisposeListener(DisposeListener listener) { getShell().addDisposeListener(listener); } public void removeDisposeListener(DisposeListener listener) { getShell().removeDisposeListener(listener); } public void setForegroundColor(Color foreground) { applyForegroundColor(foreground, getContents()); } public void setBackgroundColor(Color background) { applyBackgroundColor(background, getContents()); } public boolean isFocusControl() { return getShell().getDisplay().getActiveShell() == getShell(); } public void setFocus() { getShell().forceFocus(); fFilterText.setFocus(); } public void addFocusListener(FocusListener listener) { getShell().addFocusListener(listener); } public void removeFocusListener(FocusListener listener) { getShell().removeFocusListener(listener); } /*final protected ICommand getInvokingCommand() { return fInvokingCommand; } final protected KeySequence[] getInvokingCommandKeySequences() { if (fInvokingCommandKeySequences == null) { if (getInvokingCommand() != null) { List<IKeySequenceBinding> list= getInvokingCommand().getKeySequenceBindings(); if (!list.isEmpty()) { fInvokingCommandKeySequences= new KeySequence[list.size()]; for (int i= 0; i < fInvokingCommandKeySequences.length; i++) { fInvokingCommandKeySequences[i]= list.get(i).getKeySequence(); } return fInvokingCommandKeySequences; } } } return fInvokingCommandKeySequences; }*/ @Override protected IDialogSettings getDialogSettings() { String sectionName = getId(); IDialogSettings dialogSettings = CeylonPlugin.getInstance().getDialogSettings(); IDialogSettings settings = dialogSettings.getSection(sectionName); if (settings == null) settings = dialogSettings.addNewSection(sectionName); return settings; } /* * Overridden to insert the filter text into the title and menu area. * * @since 3.2 */ @Override protected Control createTitleMenuArea(Composite parent) { fViewMenuButtonComposite = (Composite) super.createTitleMenuArea(parent); // If there is a header, then the filter text must be created // underneath the title and menu area. if (hasHeader()) { fFilterText = createFilterText(parent); } // Create show view menu action fShowViewMenuAction = new Action("showViewMenu") { //$NON-NLS-1$ /* * @see org.eclipse.jface.action.Action#run() */ @Override public void run() { showDialogMenu(); } }; fShowViewMenuAction.setEnabled(true); fShowViewMenuAction.setActionDefinitionId(WINDOW_SHOW_VIEW_MENU); return fViewMenuButtonComposite; } /* * Overridden to insert the filter text into the title control * if there is no header specified. * @since 3.2 */ @Override protected Control createTitleControl(Composite parent) { if (hasHeader()) { return super.createTitleControl(parent); } fFilterText = createFilterText(parent); return fFilterText; } @Override protected void setTabOrder(Composite composite) { if (hasHeader()) { composite.setTabList(new Control[] { fFilterText, fTreeViewer.getTree() }); } else { fViewMenuButtonComposite.setTabList(new Control[] { fFilterText }); composite.setTabList(new Control[] { fViewMenuButtonComposite, fTreeViewer.getTree() }); } } @Override public boolean restoresLocation() { return false; } @Override public boolean restoresSize() { return true; } @Override public Rectangle getBounds() { return getShell().getBounds(); } @Override public Rectangle computeTrim() { return getShell().computeTrim(0, 0, 0, 0); } }