Package org.eclipse.ui.ide.dialogs

Class EncodingFieldEditor

java.lang.Object

org.eclipse.jface.preference.FieldEditor

org.eclipse.ui.ide.dialogs.AbstractEncodingFieldEditor

org.eclipse.ui.ide.dialogs.EncodingFieldEditor

public final class EncodingFieldEditor
extends AbstractEncodingFieldEditor

The EncodingFieldEditor is a field editor that allows the user to set an encoding on a preference in a preference store.

This class may be instantiated; it is not intended to be subclassed.

Since:

3.1

Field Summary

Fields inherited from class org.eclipse.jface.preference.FieldEditor

HORIZONTAL_GAP, IS_VALID, VALUE

Constructor Summary

Constructors

Constructor	Description
EncodingFieldEditor(String name, String labelText, String groupTitle, Composite parent)	Creates a new encoding field editor with the given preference name, label and parent.
EncodingFieldEditor(String name, String labelText, Composite parent)	Create a new instance of the receiver on the preference called name with a label of labelText.

Method Summary

Modifier and Type	Method	Description
protected void	doStore()	Stores the preference value from this field editor into the preference store.
protected String	getStoredValue()	Returns the value that is currently stored for the encoding.

Methods inherited from class org.eclipse.ui.ide.dialogs.AbstractEncodingFieldEditor

adjustForNumColumns, createEncodingGroup, defaultButtonText, doFillIntoGrid, doLoad, doLoadDefault, findDefaultEncoding, getDefaultEnc, getNumberOfControls, getSelectedEncoding, hasSameEncoding, isValid, refreshValidState, setEnabled, setGroupTitle, setPreferenceStore

Methods inherited from class org.eclipse.jface.preference.FieldEditor

applyFont, checkParent, clearErrorMessage, clearMessage, convertHorizontalDLUsToPixels, convertVerticalDLUsToPixels, createControl, dispose, fillIntoGrid, fireStateChanged, fireValueChanged, getFieldEditorFontName, getLabelControl, getLabelControl, getLabelText, getPage, getPreferenceName, getPreferencePage, getPreferenceStore, init, load, loadDefault, presentsDefaultValue, setButtonLayoutData, setFocus, setLabelText, setPage, setPreferenceName, setPreferencePage, setPresentsDefaultValue, setPropertyChangeListener, showErrorMessage, showMessage, store

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

EncodingFieldEditor

public EncodingFieldEditor(String name,
                           String labelText,
                           String groupTitle,
                           Composite parent)

Creates a new encoding field editor with the given preference name, label and parent.

Parameters:

name - the name of the preference this field editor works on

labelText - the label text of the field editor

groupTitle - the title for the field editor's control. If groupTitle is null the control will be unlabelled (by default a Composite instead of a Group.

parent - the parent of the field editor's control

Since:

3.3

See Also:

AbstractEncodingFieldEditor.setGroupTitle(String)

EncodingFieldEditor

public EncodingFieldEditor(String name,
                           String labelText,
                           Composite parent)

Create a new instance of the receiver on the preference called name with a label of labelText.

Parameters:

name - the name of the preference this field editor works on

labelText - the label text of the field editor

parent - the parent of the field editor's control

Method Detail

getStoredValue

protected String getStoredValue()

Description copied from class: AbstractEncodingFieldEditor

Returns the value that is currently stored for the encoding.

Specified by:

getStoredValue in class AbstractEncodingFieldEditor

Returns:

the currently stored encoding

doStore

protected void doStore()

Description copied from class: FieldEditor

Stores the preference value from this field editor into the preference store.

Subclasses must implement this method to save the entered value into the preference store.

Specified by:

doStore in class FieldEditor