Eclipse Platform
Release 3.1

org.eclipse.ui.ide.dialogs
Class ResourceEncodingFieldEditor

java.lang.Object
  extended byorg.eclipse.jface.preference.FieldEditor
      extended byorg.eclipse.ui.ide.dialogs.AbstractEncodingFieldEditor
          extended byorg.eclipse.ui.ide.dialogs.ResourceEncodingFieldEditor

public final class ResourceEncodingFieldEditor
extends AbstractEncodingFieldEditor

The ResourceEncodingFieldEditor is a field editor for editing the encoding of a resource and does not use 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
ResourceEncodingFieldEditor(String labelText, Composite parent, IResource charsetResource)
          Creates a new encoding field editor for setting the encoding on the given resource.
 
Method Summary
protected  Composite createEncodingGroup(Composite parent, int numColumns)
          Creates a composite with all the encoding controls.
protected  String defaultButtonText()
          Returns the text for the default encoding button.
protected  void doStore()
          Stores the preference value from this field editor into the preference store.
protected  String findDefaultEncoding()
          Returns the default encoding for the object being shown.
protected  String getStoredValue()
          Returns the value that is currently stored for the encoding.
 void load()
          Initializes this field editor with the preference value from the preference store.
 void loadDefault()
          Initializes this field editor with the default preference value from the preference store.
 void store()
          Stores this field editor's value back into the preference store.
 
Methods inherited from class org.eclipse.ui.ide.dialogs.AbstractEncodingFieldEditor
adjustForNumColumns, doFillIntoGrid, doLoad, doLoadDefault, getDefaultEnc, getNumberOfControls, getSelectedEncoding, hasSameEncoding, isValid, refreshValidState, 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, presentsDefaultValue, setButtonLayoutData, setEnabled, setFocus, setLabelText, setPage, setPreferenceName, setPreferencePage, setPresentsDefaultValue, setPropertyChangeListener, showErrorMessage, showMessage
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

ResourceEncodingFieldEditor

public ResourceEncodingFieldEditor(String labelText,
                                   Composite parent,
                                   IResource charsetResource)
Creates a new encoding field editor for setting the encoding on the given resource.

Parameters:
labelText - the label text of the field editor
parent - the parent of the field editor's control
charsetResource - must be an IContainer or an IFile.
See Also:
IContainer.getDefaultCharset(), IFile.getCharset()
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

store

public void store()
Description copied from class: FieldEditor
Stores this field editor's value back into the preference store.

Overrides:
store in class FieldEditor

load

public void load()
Description copied from class: FieldEditor
Initializes this field editor with the preference value from the preference store.

Overrides:
load in class FieldEditor

loadDefault

public void loadDefault()
Description copied from class: FieldEditor
Initializes this field editor with the default preference value from the preference store.

Overrides:
loadDefault in class FieldEditor

findDefaultEncoding

protected String findDefaultEncoding()
Description copied from class: AbstractEncodingFieldEditor
Returns the default encoding for the object being shown.

Overrides:
findDefaultEncoding in class AbstractEncodingFieldEditor
Returns:
the default encoding for the object being shown

defaultButtonText

protected String defaultButtonText()
Description copied from class: AbstractEncodingFieldEditor
Returns the text for the default encoding button.

Overrides:
defaultButtonText in class AbstractEncodingFieldEditor
Returns:
the text for the default encoding button

createEncodingGroup

protected Composite createEncodingGroup(Composite parent,
                                        int numColumns)
Description copied from class: AbstractEncodingFieldEditor
Creates a composite with all the encoding controls.

Subclasses may extend.

Overrides:
createEncodingGroup in class AbstractEncodingFieldEditor
Parameters:
parent - the parent widget
numColumns - the number of columns in the parent
Returns:
the group control

Eclipse Platform
Release 3.1

Guidelines for using Eclipse APIs.

Copyright (c) IBM Corp. and others 2000, 2005. All rights reserved.