org.eclipse.jface.preference
Class DirectoryFieldEditor

java.lang.Object
  |
  +--org.eclipse.jface.preference.FieldEditor
        |
        +--org.eclipse.jface.preference.StringFieldEditor
              |
              +--org.eclipse.jface.preference.StringButtonFieldEditor
                    |
                    +--org.eclipse.jface.preference.DirectoryFieldEditor

public class DirectoryFieldEditor

extends StringButtonFieldEditor

A field editor for a directory path type preference. A standard directory dialog appears when the user presses the change button.

Field Summary

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

UNLIMITED, VALIDATE_ON_FOCUS_LOST, VALIDATE_ON_KEY_STROKE

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

HORIZONTAL_GAP, IS_VALID, VALUE

Constructor Summary

protected	DirectoryFieldEditor() Creates a new directory field editor
	DirectoryFieldEditor(String name, String labelText, Composite parent) Creates a directory field editor.

Method Summary

protected String	changePressed() Notifies that this field editor's change button has been pressed.
protected boolean	doCheckState() Hook for subclasses to do specific state checks.

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

adjustForNumColumns, doFillIntoGrid, getChangeControl, getNumberOfControls, getShell, setChangeButtonText

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

checkState, doLoad, doLoadDefault, doStore, getErrorMessage, getStringValue, getTextControl, getTextControl, isEmptyStringAllowed, isValid, refreshValidState, setEmptyStringAllowed, setErrorMessage, setFocus, setStringValue, setTextLimit, setValidateStrategy, showErrorMessage, valueChanged

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

applyFont, checkParent, clearErrorMessage, clearMessage, convertHorizontalDLUsToPixels, convertVerticalDLUsToPixels, createControl, dispose, fillIntoGrid, fireStateChanged, fireValueChanged, getFieldEditorFontName, getLabelControl, getLabelControl, getLabelText, getPreferenceName, getPreferencePage, getPreferenceStore, init, load, loadDefault, presentsDefaultValue, setLabelText, setPreferenceName, setPreferencePage, setPreferenceStore, 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

DirectoryFieldEditor

protected DirectoryFieldEditor()

Creates a new directory field editor

DirectoryFieldEditor

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

Creates a directory field editor.

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

changePressed

protected String changePressed()

Description copied from class: StringButtonFieldEditor

Notifies that this field editor's change button has been pressed.

Subclasses must implement this method to provide a corresponding new string for the text field. If the returned value is null, the currently displayed value remains.

Specified by:

changePressed in class StringButtonFieldEditor

Returns:

the new string to display, or null to leave the old string showing

doCheckState

protected boolean doCheckState()

Description copied from class: StringFieldEditor

Hook for subclasses to do specific state checks.

The default implementation of this framework method does nothing and returns true. Subclasses should override this method to specific state checks.

Overrides:

doCheckState in class StringFieldEditor

Returns:

true if the field value is valid, and false if invalid