/*******************************************************************************
* Copyright (c) 2002, 2016 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 Rational Software - Initial API and implementation
* ARM Ltd. - basic tooltip support
*******************************************************************************/
package org.eclipse.cdt.managedbuilder.ui.properties;
import org.eclipse.cdt.utils.ui.controls.ControlFactory;
import org.eclipse.jface.preference.FieldEditor;
import org.eclipse.osgi.util.TextProcessor;
import org.eclipse.swt.SWTException;
import org.eclipse.swt.events.SelectionAdapter;
import org.eclipse.swt.events.SelectionEvent;
import org.eclipse.swt.layout.GridData;
import org.eclipse.swt.widgets.Combo;
import org.eclipse.swt.widgets.Composite;
import org.eclipse.swt.widgets.Label;
import org.eclipse.ui.PlatformUI;
/**
* @noextend This class is not intended to be subclassed by clients.
* @noinstantiate This class is not intended to be instantiated by clients.
*/
public class BuildOptionComboFieldEditor extends FieldEditor {
// Widgets and bookeeping variables
private Combo optionSelector;
private String [] options = new String[0];
private String selected;
/**
* @param name
* @param label
* @param opts
* @param sel
* @param parent
*/
public BuildOptionComboFieldEditor (String name, String label, String [] opts, String sel, Composite parent) {
init(name, label);
setOptions(opts);
selected = sel;
createControl(parent);
}
/**
* @param name
* @param label
* @param tooltip
* @param contextId
* @param opts
* @param sel
* @param parent
*/
public BuildOptionComboFieldEditor(String name, String label, String tooltip, String contextId, String [] opts, String sel, Composite parent) {
this(name, label, opts, sel, parent);
setToolTip(tooltip);
if (!contextId.isEmpty()) PlatformUI.getWorkbench().getHelpSystem().setHelp(optionSelector, contextId);
}
/**
* Sets the field editor's tool tip text to the argument, which
* may be null indicating that no tool tip text should be shown.
*
* @param string the new tool tip text (or null)
*
* @exception SWTException <ul>
* <li>ERROR_WIDGET_DISPOSED - if the field editor has been disposed</li>
* <li>ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the field editor</li>
* </ul>
*/
public void setToolTip(String tooltip) {
optionSelector.setToolTipText(tooltip);
getLabelControl().setToolTipText(tooltip);
}
/**
* Returns the field editor's tool tip text, or null if it has
* not been set.
*
* @return the field editor's tool tip text
*
* @exception SWTException <ul>
* <li>ERROR_WIDGET_DISPOSED - if the field editor has been disposed</li>
* <li>ERROR_THREAD_INVALID_ACCESS - if not called from the thread that created the field editor</li>
* </ul>
*/
public String getToolTipText() {
return optionSelector.getToolTipText();
}
/* (non-Javadoc)
* @see org.eclipse.jface.preference.FieldEditor#adjustForNumColumns(int)
*/
@Override
protected void adjustForNumColumns(int numColumns) {
// For now grab the excess space
GridData gd = (GridData)optionSelector.getLayoutData();
gd.horizontalSpan = numColumns - 1;
gd.grabExcessHorizontalSpace = true;
}
/* (non-Javadoc)
* @see org.eclipse.jface.preference.FieldEditor#doFillIntoGrid(org.eclipse.swt.widgets.Composite, int)
*/
@Override
protected void doFillIntoGrid(Composite parent, int numColumns) {
GridData gd = new GridData(GridData.FILL_HORIZONTAL);
gd.horizontalSpan = numColumns;
parent.setLayoutData(gd);
// Add the label
Label label = getLabelControl(parent);
GridData labelData = new GridData();
labelData.horizontalSpan = 1;
labelData.grabExcessHorizontalSpace = false;
label.setLayoutData(labelData);
// Now add the combo selector
optionSelector = ControlFactory.createSelectCombo(parent, getOptions(), selected);
GridData selectorData = (GridData) optionSelector.getLayoutData();
selectorData.horizontalSpan = numColumns - 1;
selectorData.grabExcessHorizontalSpace = true;
optionSelector.setLayoutData(selectorData);
optionSelector.addSelectionListener(new SelectionAdapter() {
@Override
public void widgetSelected(SelectionEvent evt) {
String oldValue = selected;
int index = optionSelector.getSelectionIndex();
selected = index == -1 ? "" : optionSelector.getItem(index); //$NON-NLS-1$
setPresentsDefaultValue(false);
fireValueChanged(VALUE, oldValue, selected);
}
});
}
/* (non-Javadoc)
* @see org.eclipse.jface.preference.FieldEditor#doLoad()
*/
@Override
protected void doLoad() {
// set all the options to option selector
optionSelector.removeAll();
optionSelector.setItems(getOptions());
// get the selected option from preference store
selected = getPreferenceStore().getString(getPreferenceName());
// Set the index of selection in the combo box
int index = optionSelector.indexOf(selected);
optionSelector.select(index >= 0 ? index : 0);
}
/* (non-Javadoc)
* @see org.eclipse.jface.preference.FieldEditor#doLoadDefault()
*/
@Override
protected void doLoadDefault() {
doLoad();
}
/* (non-Javadoc)
* @see org.eclipse.jface.preference.FieldEditor#doStore()
*/
@Override
protected void doStore() {
// Save the selected item in the store
int index = optionSelector.getSelectionIndex();
selected = index == -1 ? "" : optionSelector.getItem(index); //$NON-NLS-1$
getPreferenceStore().setValue(getPreferenceName(), selected);
}
public String getSelection(){
return selected;
}
/* (non-Javadoc)
* @see org.eclipse.jface.preference.FieldEditor#getNumberOfControls()
*/
@Override
public int getNumberOfControls() {
// There is just the label from the parent and the combo
return 2;
}
/**
* Returns this field editor's text control.
*
* @return the text control, or <code>null</code> if no
* text field is created yet
*/
protected Combo getComboControl() {
return optionSelector;
}
/**
* Returns this field editor's text control.
*
* @return the text control, or <code>null</code> if no
* text field is created yet
*/
public Combo getComboControl(Composite parent) {
checkParent(optionSelector, parent);
return optionSelector;
}
/**
* Set whether or not the controls in the field editor
* are enabled.
* @param enabled The enabled state.
* @param parent The parent of the controls in the group.
* Used to create the controls if required.
*/
@Override
public void setEnabled(boolean enabled, Composite parent) {
getLabelControl(parent).setEnabled(enabled);
optionSelector.setEnabled(enabled);
}
/**
* Set the list of enum values for this combo field editor
*/
public void setOptions(String[] options){
//bug 235327
for (int i = 0; i < options.length; i++) {
options[i] = TextProcessor.process(options[i]);
}
this.options = options;
}
/**
* Set the list of enum values for this combo field editor
*/
public String[] getOptions(){
return options;
}
}