| /******************************************************************************* |
| * Copyright (c) 2005, 2018 IBM Corporation and others. |
| * |
| * This program and the accompanying materials |
| * are made available under the terms of the Eclipse Public License 2.0 |
| * which accompanies this distribution, and is available at |
| * https://www.eclipse.org/legal/epl-2.0/ |
| * |
| * SPDX-License-Identifier: EPL-2.0 |
| * |
| * Contributors: |
| * IBM Corporation - initial API and implementation |
| *******************************************************************************/ |
| package org.eclipse.cdt.debug.internal.ui.dialogfields; |
| |
| import java.util.ArrayList; |
| import java.util.Iterator; |
| import java.util.List; |
| |
| import org.eclipse.cdt.debug.internal.ui.SWTUtil; |
| import org.eclipse.core.runtime.Assert; |
| import org.eclipse.jface.layout.PixelConverter; |
| import org.eclipse.jface.viewers.ILabelProvider; |
| import org.eclipse.jface.viewers.ISelection; |
| import org.eclipse.jface.viewers.ISelectionChangedListener; |
| import org.eclipse.jface.viewers.IStructuredContentProvider; |
| import org.eclipse.jface.viewers.IStructuredSelection; |
| import org.eclipse.jface.viewers.SelectionChangedEvent; |
| import org.eclipse.jface.viewers.StructuredSelection; |
| import org.eclipse.jface.viewers.TableViewer; |
| import org.eclipse.jface.viewers.Viewer; |
| import org.eclipse.jface.viewers.ViewerComparator; |
| import org.eclipse.swt.SWT; |
| import org.eclipse.swt.events.SelectionEvent; |
| import org.eclipse.swt.events.SelectionListener; |
| import org.eclipse.swt.layout.GridData; |
| import org.eclipse.swt.layout.GridLayout; |
| import org.eclipse.swt.widgets.Button; |
| 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.Table; |
| |
| /** |
| * A list with a button bar. |
| * Typical buttons are 'Add', 'Remove', 'Up' and 'Down'. |
| * List model is independend of widget creation. |
| * DialogFields controls are: Label, List and Composite containing buttons. |
| */ |
| public class ListDialogField extends DialogField { |
| |
| protected TableViewer fTable; |
| protected ILabelProvider fLabelProvider; |
| protected ListViewerAdapter fListViewerAdapter; |
| protected List fElements; |
| protected ViewerComparator fViewerComparator; |
| |
| protected String[] fButtonLabels; |
| private Button[] fButtonControls; |
| |
| private boolean[] fButtonsEnabled; |
| |
| private int fRemoveButtonIndex; |
| private int fUpButtonIndex; |
| private int fDownButtonIndex; |
| |
| private Label fLastSeparator; |
| |
| protected Table fTableControl; |
| private Composite fButtonsControl; |
| private ISelection fSelectionWhenEnabled; |
| |
| private IListAdapter fListAdapter; |
| |
| private Object fParentElement; |
| |
| /** |
| * Creates the <code>ListDialogField</code>. |
| * @param adapter A listener for button invocation, selection changes. |
| * @param buttonLabels The labels of all buttons: <code>null</code> is a valid array entry and |
| * marks a separator. |
| * @param lprovider The label provider to render the table entries |
| */ |
| public ListDialogField(IListAdapter adapter, String[] buttonLabels, ILabelProvider lprovider) { |
| super(); |
| fListAdapter = adapter; |
| |
| fLabelProvider = lprovider; |
| fListViewerAdapter = new ListViewerAdapter(); |
| fParentElement = this; |
| |
| fElements = new ArrayList(10); |
| |
| fButtonLabels = buttonLabels; |
| if (fButtonLabels != null) { |
| int nButtons = fButtonLabels.length; |
| fButtonsEnabled = new boolean[nButtons]; |
| for (int i = 0; i < nButtons; i++) { |
| fButtonsEnabled[i] = true; |
| } |
| } |
| |
| fTable = null; |
| fTableControl = null; |
| fButtonsControl = null; |
| |
| fRemoveButtonIndex = -1; |
| fUpButtonIndex = -1; |
| fDownButtonIndex = -1; |
| } |
| |
| /** |
| * Sets the index of the 'remove' button in the button label array passed in the constructor. |
| * The behaviour of the button marked as the 'remove' button will then be handled internally. |
| * (enable state, button invocation behaviour) |
| */ |
| public void setRemoveButtonIndex(int removeButtonIndex) { |
| Assert.isTrue(removeButtonIndex < fButtonLabels.length); |
| fRemoveButtonIndex = removeButtonIndex; |
| } |
| |
| /** |
| * Sets the index of the 'up' button in the button label array passed in the constructor. |
| * The behaviour of the button marked as the 'up' button will then be handled internally. |
| * (enable state, button invocation behaviour) |
| */ |
| public void setUpButtonIndex(int upButtonIndex) { |
| Assert.isTrue(upButtonIndex < fButtonLabels.length); |
| fUpButtonIndex = upButtonIndex; |
| } |
| |
| /** |
| * Sets the index of the 'down' button in the button label array passed in the constructor. |
| * The behaviour of the button marked as the 'down' button will then be handled internally. |
| * (enable state, button invocation behaviour) |
| */ |
| public void setDownButtonIndex(int downButtonIndex) { |
| Assert.isTrue(downButtonIndex < fButtonLabels.length); |
| fDownButtonIndex = downButtonIndex; |
| } |
| |
| /** |
| * Sets the viewerComparator. |
| * @param viewerComparator The viewerComparator to set |
| */ |
| public void setViewerComparator(ViewerComparator viewerComparator) { |
| fViewerComparator = viewerComparator; |
| } |
| |
| // ------ adapter communication |
| |
| private void buttonPressed(int index) { |
| if (!managedButtonPressed(index)) { |
| fListAdapter.customButtonPressed(this, index); |
| } |
| } |
| |
| /** |
| * Checks if the button pressed is handled internally |
| * @return Returns true if button has been handled. |
| */ |
| protected boolean managedButtonPressed(int index) { |
| if (index == fRemoveButtonIndex) { |
| remove(); |
| } else if (index == fUpButtonIndex) { |
| up(); |
| } else if (index == fDownButtonIndex) { |
| down(); |
| } else { |
| return false; |
| } |
| return true; |
| } |
| |
| // ------ layout helpers |
| |
| /* |
| * @see DialogField#doFillIntoGrid |
| */ |
| @Override |
| public Control[] doFillIntoGrid(Composite parent, int nColumns) { |
| PixelConverter converter = new PixelConverter(parent); |
| |
| assertEnoughColumns(nColumns); |
| |
| Label label = getLabelControl(parent); |
| GridData gd = gridDataForLabel(1); |
| gd.verticalAlignment = GridData.BEGINNING; |
| label.setLayoutData(gd); |
| |
| Control list = getListControl(parent); |
| gd = new GridData(); |
| gd.horizontalAlignment = GridData.FILL; |
| gd.grabExcessHorizontalSpace = false; |
| gd.verticalAlignment = GridData.FILL; |
| gd.grabExcessVerticalSpace = true; |
| gd.horizontalSpan = nColumns - 2; |
| gd.widthHint = converter.convertWidthInCharsToPixels(50); |
| gd.heightHint = converter.convertHeightInCharsToPixels(6); |
| |
| list.setLayoutData(gd); |
| |
| Composite buttons = getButtonBox(parent); |
| gd = new GridData(); |
| gd.horizontalAlignment = GridData.FILL; |
| gd.grabExcessHorizontalSpace = false; |
| gd.verticalAlignment = GridData.FILL; |
| gd.grabExcessVerticalSpace = true; |
| gd.horizontalSpan = 1; |
| buttons.setLayoutData(gd); |
| |
| return new Control[] { label, list, buttons }; |
| } |
| |
| /* |
| * @see DialogField#getNumberOfControls |
| */ |
| @Override |
| public int getNumberOfControls() { |
| return 3; |
| } |
| |
| /** |
| * Sets the minimal width of the buttons. Must be called after widget creation. |
| */ |
| public void setButtonsMinWidth(int minWidth) { |
| if (fLastSeparator != null) { |
| ((GridData) fLastSeparator.getLayoutData()).widthHint = minWidth; |
| } |
| } |
| |
| // ------ ui creation |
| |
| /** |
| * Returns the list control. When called the first time, the control will be created. |
| * @param The parent composite when called the first time, or <code>null</code> |
| * after. |
| */ |
| public Control getListControl(Composite parent) { |
| if (fTableControl == null) { |
| assertCompositeNotNull(parent); |
| |
| fTable = createTableViewer(parent); |
| fTable.setContentProvider(fListViewerAdapter); |
| fTable.setLabelProvider(fLabelProvider); |
| fTable.addSelectionChangedListener(fListViewerAdapter); |
| |
| fTableControl = (Table) fTable.getControl(); |
| |
| fTable.setInput(fParentElement); |
| |
| if (fViewerComparator != null) { |
| fTable.setComparator(fViewerComparator); |
| } |
| |
| fTableControl.setEnabled(isEnabled()); |
| if (fSelectionWhenEnabled != null) { |
| postSetSelection(fSelectionWhenEnabled); |
| } |
| } |
| return fTableControl; |
| } |
| |
| /** |
| * Returns the internally used table viewer. |
| */ |
| public TableViewer getTableViewer() { |
| return fTable; |
| } |
| |
| /* |
| * Subclasses may override to specify a different style. |
| */ |
| protected int getListStyle() { |
| return SWT.BORDER + SWT.MULTI + SWT.H_SCROLL + SWT.V_SCROLL; |
| } |
| |
| protected TableViewer createTableViewer(Composite parent) { |
| Table table = new Table(parent, getListStyle()); |
| return new TableViewer(table); |
| } |
| |
| protected Button createButton(Composite parent, String label, SelectionListener listener) { |
| Button button = new Button(parent, SWT.PUSH); |
| button.setText(label); |
| button.addSelectionListener(listener); |
| GridData gd = new GridData(); |
| gd.horizontalAlignment = GridData.FILL; |
| gd.grabExcessHorizontalSpace = true; |
| gd.verticalAlignment = GridData.BEGINNING; |
| gd.widthHint = SWTUtil.getButtonWidthHint(button); |
| |
| button.setLayoutData(gd); |
| return button; |
| } |
| |
| private Label createSeparator(Composite parent) { |
| Label separator = new Label(parent, SWT.NONE); |
| separator.setVisible(false); |
| GridData gd = new GridData(); |
| gd.horizontalAlignment = GridData.FILL; |
| gd.verticalAlignment = GridData.BEGINNING; |
| gd.heightHint = 4; |
| separator.setLayoutData(gd); |
| return separator; |
| } |
| |
| /** |
| * Returns the composite containing the buttons. When called the first time, the control |
| * will be created. |
| * @param The parent composite when called the first time, or <code>null</code> |
| * after. |
| */ |
| public Composite getButtonBox(Composite parent) { |
| if (fButtonsControl == null) { |
| assertCompositeNotNull(parent); |
| |
| SelectionListener listener = new SelectionListener() { |
| @Override |
| public void widgetDefaultSelected(SelectionEvent e) { |
| doButtonSelected(e); |
| } |
| |
| @Override |
| public void widgetSelected(SelectionEvent e) { |
| doButtonSelected(e); |
| } |
| }; |
| |
| Composite contents = new Composite(parent, SWT.NULL); |
| GridLayout layout = new GridLayout(); |
| layout.marginWidth = 0; |
| layout.marginHeight = 0; |
| contents.setLayout(layout); |
| |
| if (fButtonLabels != null) { |
| fButtonControls = new Button[fButtonLabels.length]; |
| for (int i = 0; i < fButtonLabels.length; i++) { |
| String currLabel = fButtonLabels[i]; |
| if (currLabel != null) { |
| fButtonControls[i] = createButton(contents, currLabel, listener); |
| fButtonControls[i].setEnabled(isEnabled() && fButtonsEnabled[i]); |
| } else { |
| fButtonControls[i] = null; |
| createSeparator(contents); |
| } |
| } |
| } |
| |
| fLastSeparator = createSeparator(contents); |
| |
| updateButtonState(); |
| fButtonsControl = contents; |
| } |
| |
| return fButtonsControl; |
| } |
| |
| protected void doButtonSelected(SelectionEvent e) { |
| if (fButtonControls != null) { |
| for (int i = 0; i < fButtonControls.length; i++) { |
| if (e.widget == fButtonControls[i]) { |
| buttonPressed(i); |
| return; |
| } |
| } |
| } |
| } |
| |
| // ------ enable / disable management |
| |
| /* |
| * @see DialogField#dialogFieldChanged |
| */ |
| @Override |
| public void dialogFieldChanged() { |
| super.dialogFieldChanged(); |
| updateButtonState(); |
| } |
| |
| /* |
| * Updates the enable state of the all buttons |
| */ |
| protected void updateButtonState() { |
| if (fButtonControls != null) { |
| ISelection sel = fTable.getSelection(); |
| for (int i = 0; i < fButtonControls.length; i++) { |
| Button button = fButtonControls[i]; |
| if (isOkToUse(button)) { |
| boolean extraState = getManagedButtonState(sel, i); |
| button.setEnabled(isEnabled() && extraState && fButtonsEnabled[i]); |
| } |
| } |
| } |
| } |
| |
| protected boolean getManagedButtonState(ISelection sel, int index) { |
| if (index == fRemoveButtonIndex) { |
| return !sel.isEmpty(); |
| } else if (index == fUpButtonIndex) { |
| return !sel.isEmpty() && canMoveUp(); |
| } else if (index == fDownButtonIndex) { |
| return !sel.isEmpty() && canMoveDown(); |
| } |
| return true; |
| } |
| |
| /* |
| * @see DialogField#updateEnableState |
| */ |
| @Override |
| protected void updateEnableState() { |
| super.updateEnableState(); |
| |
| boolean enabled = isEnabled(); |
| if (isOkToUse(fTableControl)) { |
| if (!enabled) { |
| fSelectionWhenEnabled = fTable.getSelection(); |
| selectElements(null); |
| } else { |
| selectElements(fSelectionWhenEnabled); |
| fSelectionWhenEnabled = null; |
| } |
| fTableControl.setEnabled(enabled); |
| } |
| updateButtonState(); |
| } |
| |
| /** |
| * Sets a button enabled or disabled. |
| */ |
| public void enableButton(int index, boolean enable) { |
| if (fButtonsEnabled != null && index < fButtonsEnabled.length) { |
| fButtonsEnabled[index] = enable; |
| updateButtonState(); |
| } |
| } |
| |
| // ------ model access |
| |
| /** |
| * Sets the elements shown in the list. |
| */ |
| public void setElements(List elements) { |
| fElements = new ArrayList(elements); |
| if (fTable != null) { |
| fTable.refresh(); |
| } |
| dialogFieldChanged(); |
| } |
| |
| /** |
| * Gets the elements shown in the list. |
| * The list returned is a copy, so it can be modified by the user. |
| */ |
| public List getElements() { |
| return new ArrayList(fElements); |
| } |
| |
| /** |
| * Gets the elements shown at the given index. |
| */ |
| public Object getElement(int index) { |
| return fElements.get(index); |
| } |
| |
| /** |
| * Replace an element. |
| */ |
| public void replaceElement(Object oldElement, Object newElement) throws IllegalArgumentException { |
| int idx = fElements.indexOf(oldElement); |
| if (idx != -1) { |
| if (oldElement.equals(newElement) || fElements.contains(newElement)) { |
| return; |
| } |
| fElements.set(idx, newElement); |
| if (fTable != null) { |
| List selected = getSelectedElements(); |
| if (selected.remove(oldElement)) { |
| selected.add(newElement); |
| } |
| fTable.refresh(); |
| selectElements(new StructuredSelection(selected)); |
| } |
| dialogFieldChanged(); |
| } else { |
| throw new IllegalArgumentException(); |
| } |
| } |
| |
| /** |
| * Adds an element at the end of the list. |
| */ |
| public void addElement(Object element) { |
| if (fElements.contains(element)) { |
| return; |
| } |
| fElements.add(element); |
| if (fTable != null) { |
| fTable.add(element); |
| } |
| dialogFieldChanged(); |
| } |
| |
| /** |
| * Adds elements at the end of the list. |
| */ |
| public void addElements(List elements) { |
| int nElements = elements.size(); |
| |
| if (nElements > 0) { |
| // filter duplicated |
| ArrayList elementsToAdd = new ArrayList(nElements); |
| |
| for (int i = 0; i < nElements; i++) { |
| Object elem = elements.get(i); |
| if (!fElements.contains(elem)) { |
| elementsToAdd.add(elem); |
| } |
| } |
| fElements.addAll(elementsToAdd); |
| if (fTable != null) { |
| fTable.add(elementsToAdd.toArray()); |
| } |
| dialogFieldChanged(); |
| } |
| } |
| |
| /** |
| * Adds an element at a position. |
| */ |
| public void insertElementAt(Object element, int index) { |
| if (fElements.contains(element)) { |
| return; |
| } |
| fElements.add(index, element); |
| if (fTable != null) { |
| fTable.add(element); |
| } |
| |
| dialogFieldChanged(); |
| } |
| |
| /** |
| * Adds an element at a position. |
| */ |
| public void removeAllElements() { |
| if (fElements.size() > 0) { |
| fElements.clear(); |
| if (fTable != null) { |
| fTable.refresh(); |
| } |
| dialogFieldChanged(); |
| } |
| } |
| |
| /** |
| * Removes an element from the list. |
| */ |
| public void removeElement(Object element) throws IllegalArgumentException { |
| if (fElements.remove(element)) { |
| if (fTable != null) { |
| fTable.remove(element); |
| } |
| dialogFieldChanged(); |
| } else { |
| throw new IllegalArgumentException(); |
| } |
| } |
| |
| /** |
| * Removes elements from the list. |
| */ |
| public void removeElements(List elements) { |
| if (elements.size() > 0) { |
| fElements.removeAll(elements); |
| if (fTable != null) { |
| fTable.remove(elements.toArray()); |
| } |
| dialogFieldChanged(); |
| } |
| } |
| |
| /** |
| * Gets the number of elements |
| */ |
| public int getSize() { |
| return fElements.size(); |
| } |
| |
| public void selectElements(ISelection selection) { |
| fSelectionWhenEnabled = selection; |
| if (fTable != null) { |
| fTable.setSelection(selection, true); |
| } |
| } |
| |
| public void selectFirstElement() { |
| Object element = null; |
| if (fViewerComparator != null) { |
| Object[] arr = fElements.toArray(); |
| fViewerComparator.sort(fTable, arr); |
| if (arr.length > 0) { |
| element = arr[0]; |
| } |
| } else { |
| if (fElements.size() > 0) { |
| element = fElements.get(0); |
| } |
| } |
| if (element != null) { |
| selectElements(new StructuredSelection(element)); |
| } |
| } |
| |
| public void postSetSelection(final ISelection selection) { |
| if (isOkToUse(fTableControl)) { |
| Display d = fTableControl.getDisplay(); |
| d.asyncExec(() -> { |
| if (isOkToUse(fTableControl)) { |
| selectElements(selection); |
| } |
| }); |
| } |
| } |
| |
| /** |
| * Refreshes the table. |
| */ |
| public void refresh() { |
| fTable.refresh(); |
| } |
| |
| // ------- list maintenance |
| |
| private List moveUp(List elements, List move) { |
| int nElements = elements.size(); |
| List res = new ArrayList(nElements); |
| Object floating = null; |
| for (int i = 0; i < nElements; i++) { |
| Object curr = elements.get(i); |
| if (move.contains(curr)) { |
| res.add(curr); |
| } else { |
| if (floating != null) { |
| res.add(floating); |
| } |
| floating = curr; |
| } |
| } |
| if (floating != null) { |
| res.add(floating); |
| } |
| return res; |
| } |
| |
| private void moveUp(List toMoveUp) { |
| if (toMoveUp.size() > 0) { |
| setElements(moveUp(fElements, toMoveUp)); |
| fTable.reveal(toMoveUp.get(0)); |
| } |
| } |
| |
| private void moveDown(List toMoveDown) { |
| if (toMoveDown.size() > 0) { |
| setElements(reverse(moveUp(reverse(fElements), toMoveDown))); |
| fTable.reveal(toMoveDown.get(toMoveDown.size() - 1)); |
| } |
| } |
| |
| private List reverse(List p) { |
| List reverse = new ArrayList(p.size()); |
| for (int i = p.size() - 1; i >= 0; i--) { |
| reverse.add(p.get(i)); |
| } |
| return reverse; |
| } |
| |
| private void remove() { |
| removeElements(getSelectedElements()); |
| } |
| |
| private void up() { |
| moveUp(getSelectedElements()); |
| } |
| |
| private void down() { |
| moveDown(getSelectedElements()); |
| } |
| |
| private boolean canMoveUp() { |
| if (isOkToUse(fTableControl)) { |
| int[] indc = fTableControl.getSelectionIndices(); |
| for (int i = 0; i < indc.length; i++) { |
| if (indc[i] != i) { |
| return true; |
| } |
| } |
| } |
| return false; |
| } |
| |
| private boolean canMoveDown() { |
| if (isOkToUse(fTableControl)) { |
| int[] indc = fTableControl.getSelectionIndices(); |
| int k = fElements.size() - 1; |
| for (int i = indc.length - 1; i >= 0; i--, k--) { |
| if (indc[i] != k) { |
| return true; |
| } |
| } |
| } |
| return false; |
| } |
| |
| /** |
| * Returns the selected elements. |
| */ |
| public List getSelectedElements() { |
| List result = new ArrayList(); |
| if (fTable != null) { |
| ISelection selection = fTable.getSelection(); |
| if (selection instanceof IStructuredSelection) { |
| Iterator iter = ((IStructuredSelection) selection).iterator(); |
| while (iter.hasNext()) { |
| result.add(iter.next()); |
| } |
| } |
| } |
| return result; |
| } |
| |
| // ------- ListViewerAdapter |
| |
| private class ListViewerAdapter implements IStructuredContentProvider, ISelectionChangedListener { |
| |
| // ------- ITableContentProvider Interface ------------ |
| |
| @Override |
| public void inputChanged(Viewer viewer, Object oldInput, Object newInput) { |
| // will never happen |
| } |
| |
| @Override |
| public void dispose() { |
| } |
| |
| @Override |
| public Object[] getElements(Object obj) { |
| return fElements.toArray(); |
| } |
| |
| // ------- ISelectionChangedListener Interface ------------ |
| |
| @Override |
| public void selectionChanged(SelectionChangedEvent event) { |
| doListSelected(event); |
| } |
| |
| } |
| |
| protected void doListSelected(SelectionChangedEvent event) { |
| updateButtonState(); |
| if (fListAdapter != null) { |
| fListAdapter.selectionChanged(this); |
| } |
| } |
| |
| } |