org.eclipse.jface.viewers.ComboBoxViewerCellEditor Maven / Gradle / Ivy
The newest version!
/*******************************************************************************
* Copyright (c) 2006, 2019 Tom Schindl 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:
* Tom Schindl - initial API and implementation
* bugfix in 174739
* Eric Rizzo - bug 213315
*******************************************************************************/
package org.eclipse.jface.viewers;
import java.text.MessageFormat; // Not using ICU to support standalone JFace
// scenario
import org.eclipse.core.runtime.Assert;
import org.eclipse.swt.SWT;
import org.eclipse.swt.custom.CCombo;
import org.eclipse.swt.events.FocusAdapter;
import org.eclipse.swt.events.FocusEvent;
import org.eclipse.swt.events.KeyAdapter;
import org.eclipse.swt.events.KeyEvent;
import org.eclipse.swt.events.SelectionAdapter;
import org.eclipse.swt.events.SelectionEvent;
import org.eclipse.swt.graphics.GC;
import org.eclipse.swt.widgets.Composite;
import org.eclipse.swt.widgets.Control;
/**
* A cell editor that presents a list of items in a combo box. In contrast to
* {@link ComboBoxCellEditor} it wraps the underlying {@link CCombo} using a
* {@link ComboViewer}
* @since 3.4
*/
public class ComboBoxViewerCellEditor extends AbstractComboBoxCellEditor {
/**
* The custom combo box control.
*/
ComboViewer viewer;
Object selectedValue;
/**
* Default ComboBoxCellEditor style
*/
private static final int defaultStyle = SWT.NONE;
/**
* Creates a new cell editor with a combo viewer and a default style
*
* @param parent
* the parent control
*/
public ComboBoxViewerCellEditor(Composite parent) {
this(parent, defaultStyle);
}
/**
* Creates a new cell editor with a combo viewer and the given style
*
* @param parent
* the parent control
* @param style
* the style bits
*/
public ComboBoxViewerCellEditor(Composite parent, int style) {
super(parent, style);
setValueValid(true);
}
@Override
protected Control createControl(Composite parent) {
CCombo comboBox = new CCombo(parent, getStyle());
comboBox.setFont(parent.getFont());
viewer = new ComboViewer(comboBox);
comboBox.addKeyListener(new KeyAdapter() {
// hook key pressed - see PR 14201
@Override
public void keyPressed(KeyEvent e) {
keyReleaseOccured(e);
}
});
comboBox.addSelectionListener(new SelectionAdapter() {
@Override
public void widgetDefaultSelected(SelectionEvent event) {
applyEditorValueAndDeactivate();
}
@Override
public void widgetSelected(SelectionEvent event) {
IStructuredSelection selection = viewer.getStructuredSelection();
if (selection.isEmpty()) {
selectedValue = null;
} else {
selectedValue = selection.getFirstElement();
}
}
});
comboBox.addTraverseListener(e -> {
if (e.detail == SWT.TRAVERSE_ESCAPE
|| e.detail == SWT.TRAVERSE_RETURN) {
e.doit = false;
}
});
comboBox.addFocusListener(new FocusAdapter() {
@Override
public void focusLost(FocusEvent e) {
ComboBoxViewerCellEditor.this.focusLost();
}
});
return comboBox;
}
/**
* The ComboBoxCellEditor implementation of this
* CellEditor framework method returns the zero-based index
* of the current selection.
*
* @return the zero-based index of the current selection wrapped as an
* Integer
*/
@Override
protected Object doGetValue() {
return selectedValue;
}
@Override
protected void doSetFocus() {
viewer.getControl().setFocus();
}
/**
* The ComboBoxCellEditor implementation of this
* CellEditor framework method sets the minimum width of the
* cell. The minimum width is 10 characters if comboBox is
* not null or disposed eles it is 60 pixels
* to make sure the arrow button and some text is visible. The list of
* CCombo will be wide enough to show its longest item.
*/
@Override
public LayoutData getLayoutData() {
LayoutData layoutData = super.getLayoutData();
if ((viewer.getControl() == null) || viewer.getControl().isDisposed()) {
layoutData.minimumWidth = 60;
} else {
// make the comboBox 10 characters wide
GC gc = new GC(viewer.getControl());
layoutData.minimumWidth = (int) ((gc.getFontMetrics().getAverageCharacterWidth() * 10) + 10);
gc.dispose();
}
return layoutData;
}
/**
* Set a new value
*
* @param value
* the new value
*/
@Override
protected void doSetValue(Object value) {
Assert.isTrue(viewer != null);
selectedValue = value;
if (value == null) {
viewer.setSelection(StructuredSelection.EMPTY);
} else {
viewer.setSelection(new StructuredSelection(value));
}
}
/**
* @param labelProvider
* the label provider used
* @see StructuredViewer#setLabelProvider(IBaseLabelProvider)
*/
public void setLabelProvider(IBaseLabelProvider labelProvider) {
viewer.setLabelProvider(labelProvider);
}
/**
* @param provider
* the content provider used
* @see StructuredViewer#setContentProvider(IContentProvider)
* @since 3.7
*/
public void setContentProvider(IStructuredContentProvider provider) {
viewer.setContentProvider(provider);
}
/**
* @param provider
* the content provider used
* @see StructuredViewer#setContentProvider(IContentProvider)
* @deprecated As of 3.7, replaced by
* {@link #setContentProvider(IStructuredContentProvider)}
*/
@Deprecated
public void setContenProvider(IStructuredContentProvider provider) {
viewer.setContentProvider(provider);
}
/**
* @param input
* the input used
* @see StructuredViewer#setInput(Object)
*/
public void setInput(Object input) {
viewer.setInput(input);
}
/**
* @return get the viewer
*/
public ComboViewer getViewer() {
return viewer;
}
/**
* Applies the currently selected value and deactiavates the cell editor
*/
void applyEditorValueAndDeactivate() {
// must set the selection before getting value
IStructuredSelection selection = viewer.getStructuredSelection();
if (selection.isEmpty()) {
selectedValue = null;
} else {
selectedValue = selection.getFirstElement();
}
Object newValue = doGetValue();
markDirty();
boolean isValid = isCorrect(newValue);
setValueValid(isValid);
if (!isValid) {
MessageFormat.format(getErrorMessage(), selectedValue);
}
fireApplyEditorValue();
deactivate();
}
@Override
protected void focusLost() {
if (isActivated()) {
applyEditorValueAndDeactivate();
}
}
@Override
protected void keyReleaseOccured(KeyEvent keyEvent) {
if (keyEvent.character == '\u001b') { // Escape character
fireCancelEditor();
} else if (keyEvent.character == '\t') { // tab key
applyEditorValueAndDeactivate();
}
}
}