Fix for Bug 169697 [Preferences] Need a way to set EncodingFieldEditor group name
diff --git a/bundles/org.eclipse.ui.ide/src/org/eclipse/ui/ide/dialogs/AbstractEncodingFieldEditor.java b/bundles/org.eclipse.ui.ide/src/org/eclipse/ui/ide/dialogs/AbstractEncodingFieldEditor.java
index bcfd87c..71f1f4a 100644
--- a/bundles/org.eclipse.ui.ide/src/org/eclipse/ui/ide/dialogs/AbstractEncodingFieldEditor.java
+++ b/bundles/org.eclipse.ui.ide/src/org/eclipse/ui/ide/dialogs/AbstractEncodingFieldEditor.java
@@ -23,7 +23,6 @@
import org.eclipse.swt.events.KeyEvent;
import org.eclipse.swt.events.SelectionAdapter;
import org.eclipse.swt.events.SelectionEvent;
-import org.eclipse.swt.graphics.Font;
import org.eclipse.swt.layout.GridData;
import org.eclipse.swt.layout.GridLayout;
import org.eclipse.swt.widgets.Button;
@@ -35,17 +34,19 @@
import org.eclipse.ui.internal.ide.IDEWorkbenchMessages;
/**
- * The abstract superclass of field editors used to set an encoding.
- * Any user entered encodings will be added to the list of encodings available via {@link org.eclipse.ui.ide.IDEEncoding}.
+ * The abstract superclass of field editors used to set an encoding. Any user
+ * entered encodings will be added to the list of encodings available via
+ * {@link org.eclipse.ui.ide.IDEEncoding}.
* <p>
- * Subclasses may extend, but must call <code>createEncodingGroup</code> during <code>doFillIntoGrid</code>.
+ * Subclasses may extend, but must call <code>createEncodingGroup</code>
+ * during <code>doFillIntoGrid</code>.
* </p>
*
* @see org.eclipse.ui.ide.IDEEncoding
* @since 3.1
*/
public abstract class AbstractEncodingFieldEditor extends FieldEditor {
-
+
private Composite container;
private Button defaultEncodingButton;
@@ -60,6 +61,8 @@
private String oldSelectedEncoding;
+ private String groupTitle = IDEWorkbenchMessages.WorkbenchPreference_encoding;
+
/**
* Creates a new encoding field editor with no settings set.
*/
@@ -68,31 +71,67 @@
}
/**
- * Creates a new encoding field editor with the given preference name, label and parent.
- *
- * @param name the name of the preference this field editor works on
- * @param labelText the label text of the field editor
- * @param parent the parent of the field editor's control
+ * Creates a new encoding field editor with the given preference name, label
+ * and parent.
+ *
+ * @param name
+ * the name of the preference this field editor works on
+ * @param labelText
+ * the label text of the field editor
+ * @param parent
+ * the parent of the field editor's control
*/
- protected AbstractEncodingFieldEditor(String name, String labelText, Composite parent) {
+ protected AbstractEncodingFieldEditor(String name, String labelText,
+ Composite parent) {
super(name, labelText, parent);
}
- /* (non-Javadoc)
+ /**
+ * Creates a new encoding field editor with the given preference name, label
+ * and parent.
+ *
+ * @param name
+ * the name of the preference this field editor works on
+ * @param labelText
+ * the label text of the field editor
+ * @param groupTitle
+ * the title for the field editor's control. If groupTitle is
+ * <code>null</code> the control will be unlabelled
+ * (by default a {@link Composite} instead of a {@link Group}.
+ * @param parent
+ * the parent of the field editor's control
+ * @see AbstractEncodingFieldEditor#setGroupTitle(String)
+ * @since 3.3
+ */
+ protected AbstractEncodingFieldEditor(String name, String labelText,
+ String groupTitle, Composite parent) {
+ init(name, labelText);
+ this.groupTitle = groupTitle;
+ createControl(parent);
+ }
+
+ /*
+ * (non-Javadoc)
+ *
* @see org.eclipse.jface.preference.FieldEditor#adjustForNumColumns(int)
*/
protected void adjustForNumColumns(int numColumns) {
((GridData) getContainer().getLayoutData()).horizontalSpan = numColumns;
}
- /* (non-Javadoc)
- * @see org.eclipse.jface.preference.FieldEditor#doFillIntoGrid(org.eclipse.swt.widgets.Composite, int)
+ /*
+ * (non-Javadoc)
+ *
+ * @see org.eclipse.jface.preference.FieldEditor#doFillIntoGrid(org.eclipse.swt.widgets.Composite,
+ * int)
*/
protected void doFillIntoGrid(Composite parent, int numColumns) {
container = createEncodingGroup(parent, numColumns);
}
- /* (non-Javadoc)
+ /*
+ * (non-Javadoc)
+ *
* @see org.eclipse.jface.preference.FieldEditor#doLoad()
*/
protected void doLoad() {
@@ -106,40 +145,50 @@
/**
* Returns the value that is currently stored for the encoding.
- *
+ *
* @return the currently stored encoding
*/
protected abstract String getStoredValue();
- /* (non-Javadoc)
+ /*
+ * (non-Javadoc)
+ *
* @see org.eclipse.jface.preference.FieldEditor#doLoadDefault()
*/
protected void doLoadDefault() {
updateEncodingState(true);
}
- /* (non-Javadoc)
+ /*
+ * (non-Javadoc)
+ *
* @see org.eclipse.jface.preference.FieldEditor#getNumberOfControls()
*/
public int getNumberOfControls() {
return 1;
}
- /* (non-Javadoc)
+ /*
+ * (non-Javadoc)
+ *
* @see org.eclipse.jface.preference.FieldEditor#isValid()
*/
public boolean isValid() {
return isValid;
}
- /* (non-Javadoc)
+ /*
+ * (non-Javadoc)
+ *
* @see org.eclipse.jface.preference.FieldEditor#refreshValidState()
*/
protected void refreshValidState() {
updateValidState();
}
- /* (non-Javadoc)
+ /*
+ * (non-Javadoc)
+ *
* @see org.eclipse.jface.preference.FieldEditor#setPreferenceStore(org.eclipse.jface.preference.IPreferenceStore)
*/
public void setPreferenceStore(IPreferenceStore store) {
@@ -158,25 +207,36 @@
/**
* Creates a composite with all the encoding controls.
- * <p>
- * Subclasses may extend.
- * </p>
- *
- * @param parent the parent widget
- * @param numColumns the number of columns in the parent
+ * <p>
+ * Subclasses may extend.
+ * </p>
+ *
+ * @param parent
+ * the parent widget
+ * @param numColumns
+ * the number of columns in the parent
* @return the group control
*/
protected Composite createEncodingGroup(Composite parent, int numColumns) {
- Font font = parent.getFont();
- Group group = new Group(parent, SWT.NONE);
- GridData data = new GridData(GridData.FILL_HORIZONTAL);
- group.setLayoutData(data);
+ Composite topControl;
GridLayout layout = new GridLayout();
layout.numColumns = 2;
- group.setLayout(layout);
- group.setText(IDEWorkbenchMessages.WorkbenchPreference_encoding);
- group.setFont(font);
+
+ if (groupTitle == null){
+ topControl = new Composite(parent, SWT.NONE);
+ layout.marginWidth = 0;
+ layout.marginHeight = 0;
+ }
+ else {
+ Group top = new Group(parent, SWT.NONE);
+ top.setText(groupTitle);
+ topControl = top;
+ }
+
+ GridData data = new GridData(GridData.FILL_HORIZONTAL);
+ topControl.setLayoutData(data);
+ topControl.setLayout(layout);
SelectionAdapter buttonListener = new SelectionAdapter() {
public void widgetSelected(SelectionEvent e) {
@@ -185,34 +245,36 @@
}
};
- defaultEncodingButton = new Button(group, SWT.RADIO);
+ defaultEncodingButton = new Button(topControl, SWT.RADIO);
defaultEnc = findDefaultEncoding();
- defaultEncodingButton.setText(defaultButtonText());
+ defaultEncodingButton.setText(defaultButtonText());
data = new GridData();
data.horizontalSpan = 2;
defaultEncodingButton.setLayoutData(data);
defaultEncodingButton.addSelectionListener(buttonListener);
- defaultEncodingButton.setFont(font);
- otherEncodingButton = new Button(group, SWT.RADIO);
- otherEncodingButton.setText(IDEWorkbenchMessages.WorkbenchPreference_otherEncoding);
+ otherEncodingButton = new Button(topControl, SWT.RADIO);
+ otherEncodingButton
+ .setText(IDEWorkbenchMessages.WorkbenchPreference_otherEncoding);
otherEncodingButton.addSelectionListener(buttonListener);
- otherEncodingButton.setFont(font);
- encodingCombo = new Combo(group, SWT.NONE);
+ encodingCombo = new Combo(topControl, SWT.NONE);
data = new GridData();
- encodingCombo.setFont(font);
encodingCombo.setLayoutData(data);
- encodingCombo.addSelectionListener(new SelectionAdapter(){
- /* (non-Javadoc)
+ encodingCombo.addSelectionListener(new SelectionAdapter() {
+ /*
+ * (non-Javadoc)
+ *
* @see org.eclipse.swt.events.SelectionListener#widgetSelected(org.eclipse.swt.events.SelectionEvent)
*/
public void widgetSelected(SelectionEvent e) {
updateValidState();
}
});
- encodingCombo.addKeyListener(new KeyAdapter(){
- /* (non-Javadoc)
+ encodingCombo.addKeyListener(new KeyAdapter() {
+ /*
+ * (non-Javadoc)
+ *
* @see org.eclipse.swt.events.KeyListener#keyReleased(org.eclipse.swt.events.KeyEvent)
*/
public void keyReleased(KeyEvent e) {
@@ -220,12 +282,14 @@
}
});
-
- return group;
+ return topControl;
}
- /* (non-Javadoc)
- * @see org.eclipse.jface.preference.FieldEditor#setEnabled(boolean, org.eclipse.swt.widgets.Composite)
+ /*
+ * (non-Javadoc)
+ *
+ * @see org.eclipse.jface.preference.FieldEditor#setEnabled(boolean,
+ * org.eclipse.swt.widgets.Composite)
* @since 3.3
*/
public void setEnabled(boolean enabled, Composite parent) {
@@ -242,7 +306,7 @@
/**
* Returns the default encoding for the object being shown.
- *
+ *
* @return the default encoding for the object being shown
*/
protected String findDefaultEncoding() {
@@ -251,19 +315,24 @@
/**
* Returns the text for the default encoding button.
- *
- * @return the text for the default encoding button
+ *
+ * @return the text for the default encoding button
*/
protected String defaultButtonText() {
- return NLS.bind(IDEWorkbenchMessages.WorkbenchPreference_defaultEncoding, defaultEnc);
+ return NLS.bind(
+ IDEWorkbenchMessages.WorkbenchPreference_defaultEncoding,
+ defaultEnc);
}
/**
- * Populates the encodings combo. Sets the text based on the
- * selected encoding. If there is no selected encoding, the text is set to the default encoding.
- *
- * @param encodings the list of encodings (list of String)
- * @param selectedEncoding the selected encoding, or <code>null</code>
+ * Populates the encodings combo. Sets the text based on the selected
+ * encoding. If there is no selected encoding, the text is set to the
+ * default encoding.
+ *
+ * @param encodings
+ * the list of encodings (list of String)
+ * @param selectedEncoding
+ * the selected encoding, or <code>null</code>
*/
private void populateEncodingsCombo(List encodings, String selectedEncoding) {
String[] encodingStrings = new String[encodings.size()];
@@ -280,7 +349,7 @@
private void updateEncodingState(boolean useDefault) {
defaultEncodingButton.setSelection(useDefault);
otherEncodingButton.setSelection(!useDefault);
- if(useDefault) {
+ if (useDefault) {
encodingCombo.setText(getDefaultEnc());
}
encodingCombo.setEnabled(!useDefault);
@@ -309,7 +378,7 @@
/**
* Returns the currently selected encoding.
- *
+ *
* @return the currently selected encoding
*/
protected String getSelectedEncoding() {
@@ -320,28 +389,31 @@
}
private boolean isEncodingValid() {
- return defaultEncodingButton.getSelection() || isValidEncoding(encodingCombo.getText());
+ return defaultEncodingButton.getSelection()
+ || isValidEncoding(encodingCombo.getText());
}
/**
* Returns whether or not the given encoding is valid.
- *
- * @param enc the encoding to validate
- * @return <code>true</code> if the encoding is valid, <code>false</code> otherwise
+ *
+ * @param enc
+ * the encoding to validate
+ * @return <code>true</code> if the encoding is valid, <code>false</code>
+ * otherwise
*/
private boolean isValidEncoding(String enc) {
try {
return Charset.isSupported(enc);
} catch (IllegalCharsetNameException e) {
- //This is a valid exception
+ // This is a valid exception
return false;
}
-
+
}
/**
* Returns the default encoding.
- *
+ *
* @return the default encoding
*/
protected String getDefaultEnc() {
@@ -350,17 +422,18 @@
/**
* Returns whether or not the encoding setting changed.
- *
- * @param encodingSetting the setting from the page.
- * @return boolean <code>true</code> if the resource encoding
- * is the same as before.
+ *
+ * @param encodingSetting
+ * the setting from the page.
+ * @return boolean <code>true</code> if the resource encoding is the same
+ * as before.
*/
protected boolean hasSameEncoding(String encodingSetting) {
String current = getStoredValue();
if (encodingSetting == null) {
- //Changed if default is selected and there is no setting
+ // Changed if default is selected and there is no setting
return current == null || current.length() == 0;
}
return encodingSetting.equals(current);
@@ -368,11 +441,27 @@
/**
* Return whether or not the default has been selected.
- * @return <code>true</code> if the default button has been
- * selected.
+ *
+ * @return <code>true</code> if the default button has been selected.
*/
boolean isDefaultSelected() {
return defaultEncodingButton.getSelection();
}
+ /**
+ * Set the title of the group to groupTitle. If this is not called a default
+ * title is used. If groupTitle is <code>null</code> the control will be
+ * unlabelled (by default a {@link Composite} instead of a {@link Group}.
+ *
+ * <strong>NOTE</strong> this value must be set before
+ * {@link #createControl(Composite)} is called or it will be ignored.
+ *
+ * @param groupTitle
+ * The groupTitle to set.
+ * @since 3.3
+ */
+ public void setGroupTitle(String groupTitle) {
+ this.groupTitle = groupTitle;
+ }
+
}
diff --git a/bundles/org.eclipse.ui.ide/src/org/eclipse/ui/ide/dialogs/EncodingFieldEditor.java b/bundles/org.eclipse.ui.ide/src/org/eclipse/ui/ide/dialogs/EncodingFieldEditor.java
index c6cab81..ae73c28 100644
--- a/bundles/org.eclipse.ui.ide/src/org/eclipse/ui/ide/dialogs/EncodingFieldEditor.java
+++ b/bundles/org.eclipse.ui.ide/src/org/eclipse/ui/ide/dialogs/EncodingFieldEditor.java
@@ -11,6 +11,7 @@
package org.eclipse.ui.ide.dialogs;
import org.eclipse.swt.widgets.Composite;
+import org.eclipse.swt.widgets.Group;
import org.eclipse.ui.ide.IDEEncoding;
/**
@@ -25,6 +26,28 @@
*/
public final class EncodingFieldEditor extends AbstractEncodingFieldEditor {
+
+ /**
+ * Creates a new encoding field editor with the given preference name, label
+ * and parent.
+ *
+ * @param name
+ * the name of the preference this field editor works on
+ * @param labelText
+ * the label text of the field editor
+ * @param groupTitle
+ * the title for the field editor's control. If groupTitle is
+ * <code>null</code> the control will be unlabelled
+ * (by default a {@link Composite} instead of a {@link Group}.
+ * @param parent
+ * the parent of the field editor's control
+ * @see AbstractEncodingFieldEditor#setGroupTitle(String)
+ * @since 3.3
+ */
+ public EncodingFieldEditor(String name, String labelText,
+ String groupTitle, Composite parent) {
+ super(name, labelText, groupTitle, parent);
+ }
/**
* Create a new instance of the receiver on the preference called name
* with a label of labelText.
diff --git a/bundles/org.eclipse.ui.ide/src/org/eclipse/ui/ide/dialogs/ResourceEncodingFieldEditor.java b/bundles/org.eclipse.ui.ide/src/org/eclipse/ui/ide/dialogs/ResourceEncodingFieldEditor.java
index c8d1c88..080ef36 100644
--- a/bundles/org.eclipse.ui.ide/src/org/eclipse/ui/ide/dialogs/ResourceEncodingFieldEditor.java
+++ b/bundles/org.eclipse.ui.ide/src/org/eclipse/ui/ide/dialogs/ResourceEncodingFieldEditor.java
@@ -29,6 +29,7 @@
import org.eclipse.swt.layout.GridData;
import org.eclipse.swt.widgets.Composite;
import org.eclipse.swt.widgets.Control;
+import org.eclipse.swt.widgets.Group;
import org.eclipse.swt.widgets.Label;
import org.eclipse.swt.widgets.Shell;
import org.eclipse.ui.WorkbenchEncoding;
@@ -72,11 +73,49 @@
public ResourceEncodingFieldEditor(String labelText, Composite parent,
IResource charsetResource) {
super();
+ setLabelAndResource(labelText, charsetResource);
+ createControl(parent);
+ }
+
+ /**
+ * Creates a new encoding field editor for setting the encoding on the given
+ * resource.
+ *
+ * @param labelText
+ * the label text of the field editor
+ * @param parent
+ * the parent of the field editor's control
+ * @param charsetResource
+ * must be an <code>IContainer</code> or an <code>IFile</code>.
+ * @param groupTitle
+ * the title for the field editor's control. If groupTitle is
+ * <code>null</code> the control will be unlabelled
+ * (by default a {@link Composite} instead of a {@link Group}.
+ *
+ * @see org.eclipse.core.resources.IContainer#getDefaultCharset()
+ * @see org.eclipse.core.resources.IFile#getCharset()
+ * @see AbstractEncodingFieldEditor#setGroupTitle(String)
+ * @since 3.3
+ */
+ public ResourceEncodingFieldEditor(String labelText, Composite parent,
+ IResource charsetResource,String groupTitle) {
+ super();
+ setLabelAndResource(labelText, charsetResource);
+ setGroupTitle(groupTitle);
+ createControl(parent);
+ }
+
+ /**
+ * Set the label text and the resource we are editing.
+ * @param labelText
+ * @param charsetResource
+ * @since 3.3
+ */
+ private void setLabelAndResource(String labelText, IResource charsetResource) {
Assert.isTrue(charsetResource instanceof IContainer
|| charsetResource instanceof IFile);
setLabelText(labelText);
this.resource = charsetResource;
- createControl(parent);
}
/*
