Class StringFieldEditor
- java.lang.Object
-
- org.eclipse.jface.preference.FieldEditor
-
- org.eclipse.jface.preference.StringFieldEditor
-
- Direct Known Subclasses:
IntegerFieldEditor,StringButtonFieldEditor
public class StringFieldEditor extends FieldEditor
A field editor for a string type preference.This class may be used as is, or subclassed as required.
-
-
Field Summary
Fields Modifier and Type Field Description protected StringoldValueOld text value.static intUNLIMITEDText limit constant (value-1) indicating unlimited text limit and width.static intVALIDATE_ON_FOCUS_LOSTValidation strategy constant (value1) indicating that the editor should perform validation only when the text widget loses focus.static intVALIDATE_ON_KEY_STROKEValidation strategy constant (value0) indicating that the editor should perform validation after every key stroke.-
Fields inherited from class org.eclipse.jface.preference.FieldEditor
HORIZONTAL_GAP, IS_VALID, VALUE
-
-
Constructor Summary
Constructors Modifier Constructor Description protectedStringFieldEditor()Creates a new string field editorStringFieldEditor(String name, String labelText, int widthInChars, int heigthInChars, int strategy, Composite parent)Creates a string field editor.StringFieldEditor(String name, String labelText, int width, int strategy, Composite parent)Creates a string field editor.StringFieldEditor(String name, String labelText, int width, Composite parent)Creates a string field editor.StringFieldEditor(String name, String labelText, Composite parent)Creates a string field editor of unlimited width.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description protected voidadjustForNumColumns(int numColumns)Adjusts the horizontal span of this field editor's basic controls.protected booleancheckState()Checks whether the text input field contains a valid value or not.protected TextcreateTextWidget(Composite parent)Create the text widget.protected booleandoCheckState()Hook for subclasses to do specific state checks.protected voiddoFillIntoGrid(Composite parent, int numColumns)Fills this field editor's basic controls into the given parent.protected voiddoLoad()Initializes this field editor with the preference value from the preference store.protected voiddoLoadDefault()Initializes this field editor with the default preference value from the preference store.protected voiddoStore()Stores the preference value from this field editor into the preference store.StringgetErrorMessage()Returns the error message that will be displayed when and if an error occurs.intgetNumberOfControls()Returns the number of basic controls this field editor consists of.StringgetStringValue()Returns the field editor's value.protected TextgetTextControl()Returns this field editor's text control.TextgetTextControl(Composite parent)Returns this field editor's text control.booleanisEmptyStringAllowed()Returns whether an empty string is a valid value.booleanisValid()Returns whether this field editor contains a valid value.protected voidrefreshValidState()Refreshes this field editor's valid state after a value change and fires anIS_VALIDproperty change event if warranted.voidsetEmptyStringAllowed(boolean b)Sets whether the empty string is a valid value or not.voidsetEnabled(boolean enabled, Composite parent)Set whether or not the controls in the field editor are enabled.voidsetErrorMessage(String message)Sets the error message that will be displayed when and if an error occurs.voidsetFocus()Sets the focus to this field editor.voidsetStringValue(String value)Sets this field editor's value.voidsetTextLimit(int limit)Sets this text field's text limit.voidsetValidateStrategy(int value)Sets the strategy for validating the text.voidshowErrorMessage()Shows the error message set viasetErrorMessage.protected voidvalueChanged()Informs this field editor's listener, if it has one, about a change to the value (VALUEproperty) provided that the old and new values are different.-
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
-
-
-
-
Field Detail
-
VALIDATE_ON_KEY_STROKE
public static final int VALIDATE_ON_KEY_STROKE
Validation strategy constant (value0) indicating that the editor should perform validation after every key stroke.- See Also:
setValidateStrategy(int), Constant Field Values
-
VALIDATE_ON_FOCUS_LOST
public static final int VALIDATE_ON_FOCUS_LOST
Validation strategy constant (value1) indicating that the editor should perform validation only when the text widget loses focus.- See Also:
setValidateStrategy(int), Constant Field Values
-
UNLIMITED
public static int UNLIMITED
Text limit constant (value-1) indicating unlimited text limit and width.
-
oldValue
protected String oldValue
Old text value.- Since:
- 3.4 this field is protected.
-
-
Constructor Detail
-
StringFieldEditor
protected StringFieldEditor()
Creates a new string field editor
-
StringFieldEditor
public StringFieldEditor(String name, String labelText, int widthInChars, int heigthInChars, int strategy, Composite parent)
Creates a string field editor. Use the methodsetTextLimitto limit the text.- Parameters:
name- the name of the preference this field editor works onlabelText- the label text of the field editorwidthInChars- the width of the text input field in characters, orUNLIMITEDfor no limitheigthInChars- the height of the text input field in characters.strategy- eitherVALIDATE_ON_KEY_STROKEto perform on the fly checking (the default), orVALIDATE_ON_FOCUS_LOSTto perform validation only after the text has been typed inparent- the parent of the field editor's control- Since:
- 3.17
-
StringFieldEditor
public StringFieldEditor(String name, String labelText, int width, int strategy, Composite parent)
Creates a string field editor. Use the methodsetTextLimitto limit the text.- Parameters:
name- the name of the preference this field editor works onlabelText- the label text of the field editorwidth- the width of the text input field in characters, orUNLIMITEDfor no limitstrategy- eitherVALIDATE_ON_KEY_STROKEto perform on the fly checking (the default), orVALIDATE_ON_FOCUS_LOSTto perform validation only after the text has been typed inparent- the parent of the field editor's control- Since:
- 2.0
-
StringFieldEditor
public StringFieldEditor(String name, String labelText, int width, Composite parent)
Creates a string field editor. Use the methodsetTextLimitto limit the text.- Parameters:
name- the name of the preference this field editor works onlabelText- the label text of the field editorwidth- the width of the text input field in characters, orUNLIMITEDfor no limitparent- the parent of the field editor's control
-
StringFieldEditor
public StringFieldEditor(String name, String labelText, Composite parent)
Creates a string field editor of unlimited width. Use the methodsetTextLimitto limit the text.- 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
-
-
Method Detail
-
adjustForNumColumns
protected void adjustForNumColumns(int numColumns)
Description copied from class:FieldEditorAdjusts the horizontal span of this field editor's basic controls.Subclasses must implement this method to adjust the horizontal span of controls so they appear correct in the given number of columns.
The number of columns will always be equal to or greater than the value returned by this editor's
getNumberOfControlsmethod.- Specified by:
adjustForNumColumnsin classFieldEditor- Parameters:
numColumns- the number of columns
-
checkState
protected boolean checkState()
Checks whether the text input field contains a valid value or not.- Returns:
trueif the field value is valid, andfalseif invalid
-
doCheckState
protected boolean doCheckState()
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.- Returns:
trueif the field value is valid, andfalseif invalid
-
doFillIntoGrid
protected void doFillIntoGrid(Composite parent, int numColumns)
Fills this field editor's basic controls into the given parent.The string field implementation of this
FieldEditorframework method contributes the text field. Subclasses may override but must callsuper.doFillIntoGrid.- Specified by:
doFillIntoGridin classFieldEditor- Parameters:
parent- the composite used as a parent for the basic controls; the parent's layout must be aGridLayoutnumColumns- the number of columns
-
doLoad
protected void doLoad()
Description copied from class:FieldEditorInitializes this field editor with the preference value from the preference store.Subclasses must implement this method to properly initialize the field editor.
- Specified by:
doLoadin classFieldEditor
-
doLoadDefault
protected void doLoadDefault()
Description copied from class:FieldEditorInitializes this field editor with the default preference value from the preference store.Subclasses must implement this method to properly initialize the field editor.
- Specified by:
doLoadDefaultin classFieldEditor
-
doStore
protected void doStore()
Description copied from class:FieldEditorStores 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:
doStorein classFieldEditor
-
getErrorMessage
public String getErrorMessage()
Returns the error message that will be displayed when and if an error occurs.- Returns:
- the error message, or
nullif none
-
getNumberOfControls
public int getNumberOfControls()
Description copied from class:FieldEditorReturns the number of basic controls this field editor consists of.- Specified by:
getNumberOfControlsin classFieldEditor- Returns:
- the number of controls
-
getStringValue
public String getStringValue()
Returns the field editor's value.- Returns:
- the current value
-
getTextControl
protected Text getTextControl()
Returns this field editor's text control.- Returns:
- the text control, or
nullif no text field is created yet
-
getTextControl
public Text getTextControl(Composite parent)
Returns this field editor's text control.The control is created if it does not yet exist
- Parameters:
parent- the parent- Returns:
- the text control
-
createTextWidget
protected Text createTextWidget(Composite parent)
Create the text widget.- Parameters:
parent- the parent composite- Returns:
- The widget
- Since:
- 3.17
-
isEmptyStringAllowed
public boolean isEmptyStringAllowed()
Returns whether an empty string is a valid value.- Returns:
trueif an empty string is a valid value, andfalseif an empty string is invalid- See Also:
setEmptyStringAllowed(boolean)
-
isValid
public boolean isValid()
Description copied from class:FieldEditorReturns whether this field editor contains a valid value.The default implementation of this framework method returns
true. Subclasses wishing to perform validation should override both this method andrefreshValidState.- Overrides:
isValidin classFieldEditor- Returns:
trueif the field value is valid, andfalseif invalid- See Also:
FieldEditor.refreshValidState()
-
refreshValidState
protected void refreshValidState()
Description copied from class:FieldEditorRefreshes this field editor's valid state after a value change and fires anIS_VALIDproperty change event if warranted.The default implementation of this framework method does nothing. Subclasses wishing to perform validation should override both this method and
isValid.- Overrides:
refreshValidStatein classFieldEditor- See Also:
FieldEditor.isValid()
-
setEmptyStringAllowed
public void setEmptyStringAllowed(boolean b)
Sets whether the empty string is a valid value or not.- Parameters:
b-trueif the empty string is allowed, andfalseif it is considered invalid
-
setErrorMessage
public void setErrorMessage(String message)
Sets the error message that will be displayed when and if an error occurs.- Parameters:
message- the error message
-
setFocus
public void setFocus()
Description copied from class:FieldEditorSets the focus to this field editor.The default implementation of this framework method does nothing. Subclasses may reimplement.
- Overrides:
setFocusin classFieldEditor
-
setStringValue
public void setStringValue(String value)
Sets this field editor's value.- Parameters:
value- the new value, ornullmeaning the empty string
-
setTextLimit
public void setTextLimit(int limit)
Sets this text field's text limit.- Parameters:
limit- the limit on the number of character in the text input field, orUNLIMITEDfor no limit
-
setValidateStrategy
public void setValidateStrategy(int value)
Sets the strategy for validating the text.Calling this method has no effect after
createPartControlis called. Thus this method is really only useful for subclasses to call in their constructor. However, it has public visibility for backward compatibility.- Parameters:
value- eitherVALIDATE_ON_KEY_STROKEto perform on the fly checking (the default), orVALIDATE_ON_FOCUS_LOSTto perform validation only after the text has been typed in
-
showErrorMessage
public void showErrorMessage()
Shows the error message set viasetErrorMessage.
-
valueChanged
protected void valueChanged()
Informs this field editor's listener, if it has one, about a change to the value (VALUEproperty) provided that the old and new values are different.This hook is not called when the text is initialized (or reset to the default value) from the preference store.
-
setEnabled
public void setEnabled(boolean enabled, Composite parent)Description copied from class:FieldEditorSet whether or not the controls in the field editor are enabled.- Overrides:
setEnabledin classFieldEditor- Parameters:
enabled- The enabled state.parent- The parent of the controls in the group. Used to create the controls if required.
-
-