Package org.eclipse.jface.preference
Class FileFieldEditor
- java.lang.Object
-
- org.eclipse.jface.preference.FieldEditor
-
- org.eclipse.jface.preference.StringFieldEditor
-
- org.eclipse.jface.preference.StringButtonFieldEditor
-
- org.eclipse.jface.preference.FileFieldEditor
-
public class FileFieldEditor extends StringButtonFieldEditor
A field editor for a file path type preference. A standard file dialog appears when the user presses the change button.
-
-
Field Summary
-
Fields inherited from class org.eclipse.jface.preference.StringFieldEditor
oldValue, 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
Constructors Modifier Constructor Description protected
FileFieldEditor()
Creates a new file field editorFileFieldEditor(String name, String labelText, boolean enforceAbsolute, int validationStrategy, Composite parent)
Creates a file field editor.FileFieldEditor(String name, String labelText, boolean enforceAbsolute, Composite parent)
Creates a file field editor.FileFieldEditor(String name, String labelText, Composite parent)
Creates a file field editor.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description protected String
changePressed()
Notifies that this field editor's change button has been pressed.protected boolean
checkState()
Checks whether the text input field contains a valid value or not.void
setFileExtensions(String[] extensions)
Sets this file field editor's file extension filter.void
setFilterPath(File path)
Sets the initial path for the Browse dialog.-
Methods inherited from class org.eclipse.jface.preference.StringButtonFieldEditor
adjustForNumColumns, doFillIntoGrid, getChangeControl, getNumberOfControls, getShell, setChangeButtonText, setEnabled
-
Methods inherited from class org.eclipse.jface.preference.StringFieldEditor
createTextWidget, doCheckState, 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, getPage, getPreferenceName, getPreferencePage, getPreferenceStore, init, load, loadDefault, presentsDefaultValue, setButtonLayoutData, setLabelText, setPage, setPreferenceName, setPreferencePage, setPreferenceStore, setPresentsDefaultValue, setPropertyChangeListener, showErrorMessage, showMessage, store
-
-
-
-
Constructor Detail
-
FileFieldEditor
protected FileFieldEditor()
Creates a new file field editor
-
FileFieldEditor
public FileFieldEditor(String name, String labelText, Composite parent)
Creates a file field editor.- Parameters:
name
- the name of the preference this field editor works onlabelText
- the label text of the field editorparent
- the parent of the field editor's control
-
FileFieldEditor
public FileFieldEditor(String name, String labelText, boolean enforceAbsolute, Composite parent)
Creates a file field editor.- Parameters:
name
- the name of the preference this field editor works onlabelText
- the label text of the field editorenforceAbsolute
-true
if the file path must be absolute, andfalse
otherwiseparent
- the parent of the field editor's control
-
FileFieldEditor
public FileFieldEditor(String name, String labelText, boolean enforceAbsolute, int validationStrategy, Composite parent)
Creates a file field editor.- Parameters:
name
- the name of the preference this field editor works onlabelText
- the label text of the field editorenforceAbsolute
-true
if the file path must be absolute, andfalse
otherwisevalidationStrategy
- eitherStringFieldEditor.VALIDATE_ON_KEY_STROKE
to perform on the fly checking, orStringFieldEditor.VALIDATE_ON_FOCUS_LOST
(the default) to perform validation only after the text has been typed inparent
- the parent of the field editor's control.- Since:
- 3.4
- See Also:
StringFieldEditor.VALIDATE_ON_KEY_STROKE
,StringFieldEditor.VALIDATE_ON_FOCUS_LOST
-
-
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 classStringButtonFieldEditor
- Returns:
- the new string to display, or
null
to leave the old string showing
-
checkState
protected boolean checkState()
Description copied from class:StringFieldEditor
Checks whether the text input field contains a valid value or not.- Overrides:
checkState
in classStringFieldEditor
- Returns:
true
if the field value is valid, andfalse
if invalid
-
setFileExtensions
public void setFileExtensions(String[] extensions)
Sets this file field editor's file extension filter.- Parameters:
extensions
- a list of file extension, ornull
to set the filter to the system's default value
-
setFilterPath
public void setFilterPath(File path)
Sets the initial path for the Browse dialog.- Parameters:
path
- initial path for the Browse dialog- Since:
- 3.6
-
-